{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.SQS.CreateQueue -- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 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@ -- module Network.AWS.SQS.CreateQueue ( -- * Creating a Request createQueue , CreateQueue -- * Request Lenses , cqAttributes , cqQueueName -- * Destructuring the Response , createQueueResponse , CreateQueueResponse -- * Response Lenses , cqrsQueueURL , cqrsResponseStatus ) where import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response import Network.AWS.SQS.Types import Network.AWS.SQS.Types.Product -- | -- -- -- -- /See:/ 'createQueue' smart constructor. data CreateQueue = CreateQueue' { _cqAttributes :: !(Maybe (Map QueueAttributeName Text)) , _cqQueueName :: !Text } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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 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 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 in the /Amazon SQS Developer Guide/ . The following attributes apply only to : * @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 in the /Amazon SQS Developer Guide/ . * @ContentBasedDeduplication@ - Enables content-based deduplication. For more information, see 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. createQueue :: Text -- ^ 'cqQueueName' -> CreateQueue createQueue pQueueName_ = CreateQueue' { _cqAttributes = Nothing , _cqQueueName = pQueueName_ } -- | 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 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 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 in the /Amazon SQS Developer Guide/ . The following attributes apply only to : * @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 in the /Amazon SQS Developer Guide/ . * @ContentBasedDeduplication@ - Enables content-based deduplication. For more information, see 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. cqAttributes :: Lens' CreateQueue (HashMap QueueAttributeName Text) cqAttributes = lens _cqAttributes (\ s a -> s{_cqAttributes = a}) . _Default . _Map; -- | 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. cqQueueName :: Lens' CreateQueue Text cqQueueName = lens _cqQueueName (\ s a -> s{_cqQueueName = a}); instance AWSRequest CreateQueue where type Rs CreateQueue = CreateQueueResponse request = postQuery sqs response = receiveXMLWrapper "CreateQueueResult" (\ s h x -> CreateQueueResponse' <$> (x .@? "QueueUrl") <*> (pure (fromEnum s))) instance Hashable CreateQueue instance NFData CreateQueue instance ToHeaders CreateQueue where toHeaders = const mempty instance ToPath CreateQueue where toPath = const "/" instance ToQuery CreateQueue where toQuery CreateQueue'{..} = mconcat ["Action" =: ("CreateQueue" :: ByteString), "Version" =: ("2012-11-05" :: ByteString), toQuery (toQueryMap "Attribute" "Name" "Value" <$> _cqAttributes), "QueueName" =: _cqQueueName] -- | Returns the QueueUrl element of the created queue. -- -- -- -- /See:/ 'createQueueResponse' smart constructor. data CreateQueueResponse = CreateQueueResponse' { _cqrsQueueURL :: !(Maybe Text) , _cqrsResponseStatus :: !Int } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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. createQueueResponse :: Int -- ^ 'cqrsResponseStatus' -> CreateQueueResponse createQueueResponse pResponseStatus_ = CreateQueueResponse' { _cqrsQueueURL = Nothing , _cqrsResponseStatus = pResponseStatus_ } -- | The URL for the created Amazon SQS queue. cqrsQueueURL :: Lens' CreateQueueResponse (Maybe Text) cqrsQueueURL = lens _cqrsQueueURL (\ s a -> s{_cqrsQueueURL = a}); -- | -- | The response status code. cqrsResponseStatus :: Lens' CreateQueueResponse Int cqrsResponseStatus = lens _cqrsResponseStatus (\ s a -> s{_cqrsResponseStatus = a}); instance NFData CreateQueueResponse