Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Connect.CreateQueue

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This API is in preview release for Amazon Connect and is subject to change.

Creates a new queue for the specified Amazon Connect instance.

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Synopsis

data CreateQueue = CreateQueue' {
- description :: Maybe Text
- maxContacts :: Maybe Natural
- outboundCallerConfig :: Maybe OutboundCallerConfig
- quickConnectIds :: Maybe (NonEmpty Text)
- tags :: Maybe (HashMap Text Text)
- instanceId :: Text
- name :: Text
- hoursOfOperationId :: Text
}
newCreateQueue :: Text -> Text -> Text -> CreateQueue
createQueue_description :: Lens' CreateQueue (Maybe Text)
createQueue_maxContacts :: Lens' CreateQueue (Maybe Natural)
createQueue_outboundCallerConfig :: Lens' CreateQueue (Maybe OutboundCallerConfig)
createQueue_quickConnectIds :: Lens' CreateQueue (Maybe (NonEmpty Text))
createQueue_tags :: Lens' CreateQueue (Maybe (HashMap Text Text))
createQueue_instanceId :: Lens' CreateQueue Text
createQueue_name :: Lens' CreateQueue Text
createQueue_hoursOfOperationId :: Lens' CreateQueue Text
data CreateQueueResponse = CreateQueueResponse' {
- queueArn :: Maybe Text
- queueId :: Maybe Text
- httpStatus :: Int
}
newCreateQueueResponse :: Int -> CreateQueueResponse
createQueueResponse_queueArn :: Lens' CreateQueueResponse (Maybe Text)
createQueueResponse_queueId :: Lens' CreateQueueResponse (Maybe Text)
createQueueResponse_httpStatus :: Lens' CreateQueueResponse Int

Creating a Request

data CreateQueue Source #

See: newCreateQueue smart constructor.

Constructors

CreateQueue'

Fields

description :: Maybe Text
The description of the queue.
maxContacts :: Maybe Natural
The maximum number of contacts that can be in the queue before it is considered full.
outboundCallerConfig :: Maybe OutboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
quickConnectIds :: Maybe (NonEmpty Text)
The quick connects available to agents who are working the queue.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name :: Text
The name of the queue.
hoursOfOperationId :: Text
The identifier for the hours of operation.

Instances

Instances details

ToJSON CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods toJSON :: CreateQueue -> Value # toEncoding :: CreateQueue -> Encoding # toJSONList :: [CreateQueue] -> Value # toEncodingList :: [CreateQueue] -> Encoding #
ToHeaders CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods toHeaders :: CreateQueue -> [Header] #
ToPath CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods toPath :: CreateQueue -> ByteString #
ToQuery CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods toQuery :: CreateQueue -> QueryString #
AWSRequest CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Associated Types type AWSResponse CreateQueue # Methods request :: (Service -> Service) -> CreateQueue -> Request CreateQueue # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateQueue -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateQueue))) #
Generic CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Associated Types type Rep CreateQueue :: Type -> Type # Methods from :: CreateQueue -> Rep CreateQueue x # to :: Rep CreateQueue x -> CreateQueue #
Read CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods readsPrec :: Int -> ReadS CreateQueue # readList :: ReadS [CreateQueue] # readPrec :: ReadPrec CreateQueue # readListPrec :: ReadPrec [CreateQueue] #
Show CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods showsPrec :: Int -> CreateQueue -> ShowS # show :: CreateQueue -> String # showList :: [CreateQueue] -> ShowS #
NFData CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods rnf :: CreateQueue -> () #
Eq CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods (==) :: CreateQueue -> CreateQueue -> Bool # (/=) :: CreateQueue -> CreateQueue -> Bool #
Hashable CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods hashWithSalt :: Int -> CreateQueue -> Int # hash :: CreateQueue -> Int #
type AWSResponse CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue type AWSResponse CreateQueue = CreateQueueResponse
type Rep CreateQueue Source #
Instance details Defined in Amazonka.Connect.CreateQueue type Rep CreateQueue = D1 ('MetaData "CreateQueue" "Amazonka.Connect.CreateQueue" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "CreateQueue'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxContacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "outboundCallerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutboundCallerConfig)) :: S1 ('MetaSel ('Just "quickConnectIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hoursOfOperationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateQueue Source #

Arguments

:: Text	`CreateQueue`
-> Text	`CreateQueue`
-> Text	`CreateQueue`
-> CreateQueue

Create a value of CreateQueue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateQueue, createQueue_description - The description of the queue.

CreateQueue, createQueue_maxContacts - The maximum number of contacts that can be in the queue before it is considered full.

CreateQueue, createQueue_outboundCallerConfig - The outbound caller ID name, number, and outbound whisper flow.

$sel:quickConnectIds:CreateQueue', createQueue_quickConnectIds - The quick connects available to agents who are working the queue.

CreateQueue, createQueue_tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

CreateQueue, createQueue_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

CreateQueue, createQueue_name - The name of the queue.

CreateQueue, createQueue_hoursOfOperationId - The identifier for the hours of operation.

Request Lenses

createQueue_description :: Lens' CreateQueue (Maybe Text) Source #

The description of the queue.

createQueue_maxContacts :: Lens' CreateQueue (Maybe Natural) Source #

The maximum number of contacts that can be in the queue before it is considered full.

createQueue_outboundCallerConfig :: Lens' CreateQueue (Maybe OutboundCallerConfig) Source #

The outbound caller ID name, number, and outbound whisper flow.

createQueue_quickConnectIds :: Lens' CreateQueue (Maybe (NonEmpty Text)) Source #

The quick connects available to agents who are working the queue.

createQueue_tags :: Lens' CreateQueue (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createQueue_instanceId :: Lens' CreateQueue Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createQueue_name :: Lens' CreateQueue Text Source #

The name of the queue.

createQueue_hoursOfOperationId :: Lens' CreateQueue Text Source #

The identifier for the hours of operation.

Destructuring the Response

data CreateQueueResponse Source #

See: newCreateQueueResponse smart constructor.

Constructors

CreateQueueResponse'
Fields queueArn :: Maybe Text The Amazon Resource Name (ARN) of the queue. queueId :: Maybe Text The identifier for the queue. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateQueueResponse Source #
Instance details Defined in Amazonka.Connect.CreateQueue Associated Types type Rep CreateQueueResponse :: Type -> Type # Methods from :: CreateQueueResponse -> Rep CreateQueueResponse x # to :: Rep CreateQueueResponse x -> CreateQueueResponse #
Read CreateQueueResponse Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods readsPrec :: Int -> ReadS CreateQueueResponse # readList :: ReadS [CreateQueueResponse] # readPrec :: ReadPrec CreateQueueResponse # readListPrec :: ReadPrec [CreateQueueResponse] #
Show CreateQueueResponse Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods showsPrec :: Int -> CreateQueueResponse -> ShowS # show :: CreateQueueResponse -> String # showList :: [CreateQueueResponse] -> ShowS #
NFData CreateQueueResponse Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods rnf :: CreateQueueResponse -> () #
Eq CreateQueueResponse Source #
Instance details Defined in Amazonka.Connect.CreateQueue Methods (==) :: CreateQueueResponse -> CreateQueueResponse -> Bool # (/=) :: CreateQueueResponse -> CreateQueueResponse -> Bool #
type Rep CreateQueueResponse Source #
Instance details Defined in Amazonka.Connect.CreateQueue type Rep CreateQueueResponse = D1 ('MetaData "CreateQueueResponse" "Amazonka.Connect.CreateQueue" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "CreateQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queueArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "queueId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateQueueResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateQueueResponse'`
-> CreateQueueResponse

Create a value of CreateQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateQueueResponse, createQueueResponse_queueArn - The Amazon Resource Name (ARN) of the queue.

CreateQueueResponse, createQueueResponse_queueId - The identifier for the queue.

$sel:httpStatus:CreateQueueResponse', createQueueResponse_httpStatus - The response's http status code.

Response Lenses

createQueueResponse_queueArn :: Lens' CreateQueueResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the queue.

createQueueResponse_queueId :: Lens' CreateQueueResponse (Maybe Text) Source #

The identifier for the queue.

createQueueResponse_httpStatus :: Lens' CreateQueueResponse Int Source #

The response's http status code.