Network.AWS.SQS.CreateQueue

Creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues.

If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes.

Use GetQueueUrl to get a queue's URL. 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 do not match an existing queue, CreateQueue returns an error.

Some API actions take lists of parameters. These lists are specified using the 'param.n' notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

'&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
• cqQueueName

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)

ToQuery CreateQueue

Methods

toQuery :: CreateQueue -> QueryString

ToPath CreateQueue

Methods

toPath :: CreateQueue -> ByteString

ToHeaders CreateQueue

Methods

toHeaders :: CreateQueue -> [Header]

type Rep CreateQueue

type Rep CreateQueue = D1 (MetaData "CreateQueue" "Network.AWS.SQS.CreateQueue" "amazonka-sqs-1.4.3-EAMo5disTZNCNkt77bXGB0" 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 the CreateQueue action uses:

• DelaySeconds - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).
• MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
• MessageRetentionPeriod - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (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 time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0.
• VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

cqQueueName :: Lens' CreateQueue Text

The name for the queue to be created.

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
• cqrsResponseStatus

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.3-EAMo5disTZNCNkt77bXGB0" False) (C1 (MetaCons "CreateQueueResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cqrsQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cqrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.