Network.AWS.SQS.CreateQueue

Creates a new standard or FIFO queue or returns the URL of an existing queue. You can pass one or more attributes in the request.

• If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
• If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
• If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter.

• If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
• If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.

Some API actions take lists of parameters. Specify these lists using the param.n notation. Values of n are integers starting from 1. The following is an example of a parameter list with two elements:

&Attribute.1=this

&Attribute.2=that

Creating a Request

createQueue

Arguments

:: Text

cqQueueName

-> CreateQueue

Creates a value of CreateQueue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cqAttributes - A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses: * DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero). * MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). * MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days). * Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide . * ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0. * RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide . * VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide . The following attributes apply only to FIFO (first-in-first-out) queues : * FifoQueue - Designates a queue as FIFO. You can provide this attribute only during queue creation; you can't change it for an existing queue. When you set this attribute, you must provide a MessageGroupId explicitly. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide . * ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide . * Every message must have a unique MessageDeduplicationId , * You may provide a MessageDeduplicationId explicitly. * If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). * If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. * If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. * When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. * You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates. * If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId , the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages , ApproximateNumberOfMessagesDelayed , ApproximateNumberOfMessagesNotVisible , CreatedTimestamp , LastModifiedTimestamp , and QueueArn ) will be ignored.
• cqQueueName - The name of the new queue. The following limits apply to this name: * A queue name can have up to 80 characters. * The following are accepted: alphanumeric chatacters, hyphens (- ), and underscores (_ ). * A FIFO queue name must end with the .fifo suffix. Queue names are case-sensitive.

data CreateQueue

See: createQueue smart constructor.

Instances

Eq CreateQueue

Methods

(==) :: CreateQueue -> CreateQueue -> Bool

(/=) :: CreateQueue -> CreateQueue -> Bool

Data CreateQueue

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateQueue -> c CreateQueue

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateQueue

toConstr :: CreateQueue -> Constr

dataTypeOf :: CreateQueue -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateQueue)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateQueue)

gmapT :: (forall b. Data b => b -> b) -> CreateQueue -> CreateQueue

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateQueue -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateQueue -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateQueue -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateQueue -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateQueue -> m CreateQueue

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateQueue -> m CreateQueue

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateQueue -> m CreateQueue

Read CreateQueue

Methods

readsPrec :: Int -> ReadS CreateQueue

readList :: ReadS [CreateQueue]

readPrec :: ReadPrec CreateQueue

readListPrec :: ReadPrec [CreateQueue]

Show CreateQueue

Methods

showsPrec :: Int -> CreateQueue -> ShowS

show :: CreateQueue -> String

showList :: [CreateQueue] -> ShowS

Generic CreateQueue

Associated Types

type Rep CreateQueue :: * -> *

Methods

from :: CreateQueue -> Rep CreateQueue x

to :: Rep CreateQueue x -> CreateQueue

Hashable CreateQueue

Methods

hashWithSalt :: Int -> CreateQueue -> Int

hash :: CreateQueue -> Int

NFData CreateQueue

Methods

rnf :: CreateQueue -> ()

AWSRequest CreateQueue

Associated Types

type Rs CreateQueue :: *

Methods

request :: CreateQueue -> Request CreateQueue

response :: MonadResource m => Logger -> Service -> Proxy * CreateQueue -> ClientResponse -> m (Response CreateQueue)

ToPath CreateQueue

Methods

toPath :: CreateQueue -> ByteString

ToHeaders CreateQueue

Methods

toHeaders :: CreateQueue -> [Header]

ToQuery CreateQueue

Methods

toQuery :: CreateQueue -> QueryString

type Rep CreateQueue

type Rep CreateQueue = D1 (MetaData "CreateQueue" "Network.AWS.SQS.CreateQueue" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "CreateQueue'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cqAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map QueueAttributeName Text)))) (S1 (MetaSel (Just Symbol "_cqQueueName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs CreateQueue

type Rs CreateQueue = CreateQueueResponse

Request Lenses

cqAttributes :: Lens' CreateQueue (HashMap QueueAttributeName Text)

A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses: * DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero). * MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). * MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days). * Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide . * ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0. * RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide . * VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide . The following attributes apply only to FIFO (first-in-first-out) queues : * FifoQueue - Designates a queue as FIFO. You can provide this attribute only during queue creation; you can't change it for an existing queue. When you set this attribute, you must provide a MessageGroupId explicitly. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide . * ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide . * Every message must have a unique MessageDeduplicationId , * You may provide a MessageDeduplicationId explicitly. * If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). * If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. * If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. * When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. * You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates. * If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId , the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages , ApproximateNumberOfMessagesDelayed , ApproximateNumberOfMessagesNotVisible , CreatedTimestamp , LastModifiedTimestamp , and QueueArn ) will be ignored.

cqQueueName :: Lens' CreateQueue Text

The name of the new queue. The following limits apply to this name: * A queue name can have up to 80 characters. * The following are accepted: alphanumeric chatacters, hyphens (- ), and underscores (_ ). * A FIFO queue name must end with the .fifo suffix. Queue names are case-sensitive.

Destructuring the Response

createQueueResponse

Arguments

:: Int

cqrsResponseStatus

-> CreateQueueResponse

Creates a value of CreateQueueResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cqrsQueueURL - The URL for the created Amazon SQS queue.
• cqrsResponseStatus - -- | The response status code.

data CreateQueueResponse

Returns the QueueUrl element of the created queue.

See: createQueueResponse smart constructor.

Instances

Eq CreateQueueResponse

Methods

(==) :: CreateQueueResponse -> CreateQueueResponse -> Bool

(/=) :: CreateQueueResponse -> CreateQueueResponse -> Bool

Data CreateQueueResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateQueueResponse -> c CreateQueueResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateQueueResponse

toConstr :: CreateQueueResponse -> Constr

dataTypeOf :: CreateQueueResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateQueueResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateQueueResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateQueueResponse -> CreateQueueResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateQueueResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateQueueResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateQueueResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateQueueResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateQueueResponse -> m CreateQueueResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateQueueResponse -> m CreateQueueResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateQueueResponse -> m CreateQueueResponse

Read CreateQueueResponse

Methods

readsPrec :: Int -> ReadS CreateQueueResponse

readList :: ReadS [CreateQueueResponse]

readPrec :: ReadPrec CreateQueueResponse

readListPrec :: ReadPrec [CreateQueueResponse]

Show CreateQueueResponse

Methods

showsPrec :: Int -> CreateQueueResponse -> ShowS

show :: CreateQueueResponse -> String

showList :: [CreateQueueResponse] -> ShowS

Generic CreateQueueResponse

Associated Types

type Rep CreateQueueResponse :: * -> *

Methods

from :: CreateQueueResponse -> Rep CreateQueueResponse x

to :: Rep CreateQueueResponse x -> CreateQueueResponse

NFData CreateQueueResponse

Methods

rnf :: CreateQueueResponse -> ()

type Rep CreateQueueResponse

type Rep CreateQueueResponse = D1 (MetaData "CreateQueueResponse" "Network.AWS.SQS.CreateQueue" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "CreateQueueResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cqrsQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cqrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cqrsQueueURL :: Lens' CreateQueueResponse (Maybe Text)

The URL for the created Amazon SQS queue.

cqrsResponseStatus :: Lens' CreateQueueResponse Int

• - | The response status code.