amazonka-sqs-1.6.0: Amazon Simple Queue Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SQS

Contents

Description

Welcome to the Amazon Simple Queue Service API Reference .

Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

  • Cryptographically sign your service requests
  • Retry requests
  • Handle error responses

Additional Information

Synopsis

Service Configuration

sqs :: Service #

API version 2012-11-05 of the Amazon Simple Queue Service SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by SQS.

InvalidBatchEntryId

_InvalidBatchEntryId :: AsError a => Getting (First ServiceError) a ServiceError #

The Id of a batch entry in a batch request doesn't abide by the specification.

TooManyEntriesInBatchRequest

_TooManyEntriesInBatchRequest :: AsError a => Getting (First ServiceError) a ServiceError #

The batch request contains more entries than permissible.

QueueDeletedRecently

_QueueDeletedRecently :: AsError a => Getting (First ServiceError) a ServiceError #

You must wait 60 seconds after deleting a queue before you can create another one with the same name.

QueueDoesNotExist

_QueueDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError #

The queue referred to doesn't exist.

InvalidAttributeName

_InvalidAttributeName :: AsError a => Getting (First ServiceError) a ServiceError #

The attribute referred to doesn't exist.

UnsupportedOperation

_UnsupportedOperation :: AsError a => Getting (First ServiceError) a ServiceError #

Error code 400. Unsupported operation.

InvalidMessageContents

_InvalidMessageContents :: AsError a => Getting (First ServiceError) a ServiceError #

The message contains characters outside the allowed set.

BatchRequestTooLong

_BatchRequestTooLong :: AsError a => Getting (First ServiceError) a ServiceError #

The length of all the messages put together is more than the limit.

OverLimit

_OverLimit :: AsError a => Getting (First ServiceError) a ServiceError #

The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.

QueueNameExists

_QueueNameExists :: AsError a => Getting (First ServiceError) a ServiceError #

A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.

PurgeQueueInProgress

_PurgeQueueInProgress :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

InvalidIdFormat

_InvalidIdFormat :: AsError a => Getting (First ServiceError) a ServiceError #

The receipt handle isn't valid for the current version.

ReceiptHandleIsInvalid

_ReceiptHandleIsInvalid :: AsError a => Getting (First ServiceError) a ServiceError #

The receipt handle provided isn't valid.

EmptyBatchRequest

_EmptyBatchRequest :: AsError a => Getting (First ServiceError) a ServiceError #

The batch request doesn't contain any entries.

BatchEntryIdsNotDistinct

_BatchEntryIdsNotDistinct :: AsError a => Getting (First ServiceError) a ServiceError #

Two or more batch entries in the request have the same Id .

MessageNotInflight

_MessageNotInflight :: AsError a => Getting (First ServiceError) a ServiceError #

The message referred to isn't in flight.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetQueueURL

PurgeQueue

ChangeMessageVisibilityBatch

SendMessage

RemovePermission

GetQueueAttributes

ListQueues

ReceiveMessage

DeleteQueue

TagQueue

DeleteMessageBatch

SetQueueAttributes

ListDeadLetterSourceQueues

AddPermission

DeleteMessage

ListQueueTags

CreateQueue

UntagQueue

SendMessageBatch

ChangeMessageVisibility

Types

MessageAttribute

data MessageAttribute #

Instances

Bounded MessageAttribute # 
Enum MessageAttribute # 
Eq MessageAttribute # 
Data MessageAttribute # 

Methods

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

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

toConstr :: MessageAttribute -> Constr #

dataTypeOf :: MessageAttribute -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> MessageAttribute -> MessageAttribute #

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

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

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

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

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

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

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

Ord MessageAttribute # 
Read MessageAttribute # 
Show MessageAttribute # 
Generic MessageAttribute # 
Hashable MessageAttribute # 
NFData MessageAttribute # 

Methods

rnf :: MessageAttribute -> () #

FromXML MessageAttribute # 
ToHeader MessageAttribute # 
ToQuery MessageAttribute # 
ToByteString MessageAttribute # 
FromText MessageAttribute # 
ToText MessageAttribute # 
type Rep MessageAttribute # 
type Rep MessageAttribute = D1 * (MetaData "MessageAttribute" "Network.AWS.SQS.Types.Sum" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) ((:+:) * ((:+:) * (C1 * (MetaCons "All" PrefixI False) (U1 *)) (C1 * (MetaCons "ApproximateFirstReceiveTimestamp" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "ApproximateReceiveCount" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "SenderId" PrefixI False) (U1 *)) (C1 * (MetaCons "SentTimestamp" PrefixI False) (U1 *)))))

QueueAttributeName

data QueueAttributeName #

Instances

Bounded QueueAttributeName # 
Enum QueueAttributeName # 
Eq QueueAttributeName # 
Data QueueAttributeName # 

Methods

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

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

toConstr :: QueueAttributeName -> Constr #

dataTypeOf :: QueueAttributeName -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> QueueAttributeName -> QueueAttributeName #

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

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

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

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

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

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

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

Ord QueueAttributeName # 
Read QueueAttributeName # 
Show QueueAttributeName # 
Generic QueueAttributeName # 
Hashable QueueAttributeName # 
NFData QueueAttributeName # 

Methods

rnf :: QueueAttributeName -> () #

FromXML QueueAttributeName # 
ToHeader QueueAttributeName # 
ToQuery QueueAttributeName # 
ToByteString QueueAttributeName # 
FromText QueueAttributeName # 
ToText QueueAttributeName # 
type Rep QueueAttributeName # 
type Rep QueueAttributeName = D1 * (MetaData "QueueAttributeName" "Network.AWS.SQS.Types.Sum" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) ((:+:) * ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "QANAll" PrefixI False) (U1 *)) (C1 * (MetaCons "QANApproximateNumberOfMessages" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "QANApproximateNumberOfMessagesDelayed" PrefixI False) (U1 *)) (C1 * (MetaCons "QANApproximateNumberOfMessagesNotVisible" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "QANContentBasedDeduplication" PrefixI False) (U1 *)) (C1 * (MetaCons "QANCreatedTimestamp" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "QANDelaySeconds" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "QANFifoQueue" PrefixI False) (U1 *)) (C1 * (MetaCons "QANKMSDataKeyReusePeriodSeconds" PrefixI False) (U1 *)))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "QANKMSMasterKeyId" PrefixI False) (U1 *)) (C1 * (MetaCons "QANLastModifiedTimestamp" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "QANMaximumMessageSize" PrefixI False) (U1 *)) (C1 * (MetaCons "QANMessageRetentionPeriod" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "QANPolicy" PrefixI False) (U1 *)) (C1 * (MetaCons "QANQueueARN" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "QANReceiveMessageWaitTimeSeconds" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "QANRedrivePolicy" PrefixI False) (U1 *)) (C1 * (MetaCons "QANVisibilityTimeout" PrefixI False) (U1 *)))))))

BatchResultErrorEntry

data BatchResultErrorEntry #

This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.

See: batchResultErrorEntry smart constructor.

Instances

Eq BatchResultErrorEntry # 
Data BatchResultErrorEntry # 

Methods

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

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

toConstr :: BatchResultErrorEntry -> Constr #

dataTypeOf :: BatchResultErrorEntry -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> BatchResultErrorEntry -> BatchResultErrorEntry #

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

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

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

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

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

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

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

Read BatchResultErrorEntry # 
Show BatchResultErrorEntry # 
Generic BatchResultErrorEntry # 
Hashable BatchResultErrorEntry # 
NFData BatchResultErrorEntry # 

Methods

rnf :: BatchResultErrorEntry -> () #

FromXML BatchResultErrorEntry # 
type Rep BatchResultErrorEntry # 
type Rep BatchResultErrorEntry = D1 * (MetaData "BatchResultErrorEntry" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) (C1 * (MetaCons "BatchResultErrorEntry'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_breeMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_breeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_breeSenderFault") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool)) (S1 * (MetaSel (Just Symbol "_breeCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

batchResultErrorEntry #

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

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

  • breeMessage - A message explaining why the action failed on this entry.
  • breeId - The Id of an entry in a batch request.
  • breeSenderFault - Specifies whether the error happened due to the sender's fault.
  • breeCode - An error code representing why the action failed on this entry.

breeMessage :: Lens' BatchResultErrorEntry (Maybe Text) #

A message explaining why the action failed on this entry.

breeId :: Lens' BatchResultErrorEntry Text #

The Id of an entry in a batch request.

breeSenderFault :: Lens' BatchResultErrorEntry Bool #

Specifies whether the error happened due to the sender's fault.

breeCode :: Lens' BatchResultErrorEntry Text #

An error code representing why the action failed on this entry.

ChangeMessageVisibilityBatchRequestEntry

data ChangeMessageVisibilityBatchRequestEntry #

Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch .

Important: All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n , where n is an integer value starting with 1 . For example, a parameter list for this action might look like this:

&amp;ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&amp;ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=replaceableYour_Receipt_Handle/replaceable
&amp;ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

See: changeMessageVisibilityBatchRequestEntry smart constructor.

Instances

Eq ChangeMessageVisibilityBatchRequestEntry # 
Data ChangeMessageVisibilityBatchRequestEntry # 

Methods

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

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

toConstr :: ChangeMessageVisibilityBatchRequestEntry -> Constr #

dataTypeOf :: ChangeMessageVisibilityBatchRequestEntry -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ChangeMessageVisibilityBatchRequestEntry -> ChangeMessageVisibilityBatchRequestEntry #

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

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

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

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

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

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

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

Read ChangeMessageVisibilityBatchRequestEntry # 
Show ChangeMessageVisibilityBatchRequestEntry # 
Generic ChangeMessageVisibilityBatchRequestEntry # 
Hashable ChangeMessageVisibilityBatchRequestEntry # 
NFData ChangeMessageVisibilityBatchRequestEntry # 
ToQuery ChangeMessageVisibilityBatchRequestEntry # 
type Rep ChangeMessageVisibilityBatchRequestEntry # 
type Rep ChangeMessageVisibilityBatchRequestEntry = D1 * (MetaData "ChangeMessageVisibilityBatchRequestEntry" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) (C1 * (MetaCons "ChangeMessageVisibilityBatchRequestEntry'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cVisibilityTimeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cReceiptHandle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

changeMessageVisibilityBatchRequestEntry #

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

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

  • cVisibilityTimeout - The new value (in seconds) for the message's visibility timeout.
  • cId - An identifier for this particular receipt handle used to communicate the result.
  • cReceiptHandle - A receipt handle.

cVisibilityTimeout :: Lens' ChangeMessageVisibilityBatchRequestEntry (Maybe Int) #

The new value (in seconds) for the message's visibility timeout.

cId :: Lens' ChangeMessageVisibilityBatchRequestEntry Text #

An identifier for this particular receipt handle used to communicate the result.

ChangeMessageVisibilityBatchResultEntry

data ChangeMessageVisibilityBatchResultEntry #

Encloses the Id of an entry in ChangeMessageVisibilityBatch .

See: changeMessageVisibilityBatchResultEntry smart constructor.

Instances

Eq ChangeMessageVisibilityBatchResultEntry # 
Data ChangeMessageVisibilityBatchResultEntry # 

Methods

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

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

toConstr :: ChangeMessageVisibilityBatchResultEntry -> Constr #

dataTypeOf :: ChangeMessageVisibilityBatchResultEntry -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ChangeMessageVisibilityBatchResultEntry -> ChangeMessageVisibilityBatchResultEntry #

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

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

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

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

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

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

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

Read ChangeMessageVisibilityBatchResultEntry # 
Show ChangeMessageVisibilityBatchResultEntry # 
Generic ChangeMessageVisibilityBatchResultEntry # 
Hashable ChangeMessageVisibilityBatchResultEntry # 
NFData ChangeMessageVisibilityBatchResultEntry # 
FromXML ChangeMessageVisibilityBatchResultEntry # 
type Rep ChangeMessageVisibilityBatchResultEntry # 
type Rep ChangeMessageVisibilityBatchResultEntry = D1 * (MetaData "ChangeMessageVisibilityBatchResultEntry" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" True) (C1 * (MetaCons "ChangeMessageVisibilityBatchResultEntry'" PrefixI True) (S1 * (MetaSel (Just Symbol "_cmvbreId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

changeMessageVisibilityBatchResultEntry #

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

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

  • cmvbreId - Represents a message whose visibility timeout has been changed successfully.

cmvbreId :: Lens' ChangeMessageVisibilityBatchResultEntry Text #

Represents a message whose visibility timeout has been changed successfully.

DeleteMessageBatchRequestEntry

data DeleteMessageBatchRequestEntry #

Encloses a receipt handle and an identifier for it.

See: deleteMessageBatchRequestEntry smart constructor.

Instances

Eq DeleteMessageBatchRequestEntry # 
Data DeleteMessageBatchRequestEntry # 

Methods

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

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

toConstr :: DeleteMessageBatchRequestEntry -> Constr #

dataTypeOf :: DeleteMessageBatchRequestEntry -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DeleteMessageBatchRequestEntry -> DeleteMessageBatchRequestEntry #

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

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

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

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

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

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

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

Read DeleteMessageBatchRequestEntry # 
Show DeleteMessageBatchRequestEntry # 
Generic DeleteMessageBatchRequestEntry # 
Hashable DeleteMessageBatchRequestEntry # 
NFData DeleteMessageBatchRequestEntry # 
ToQuery DeleteMessageBatchRequestEntry # 
type Rep DeleteMessageBatchRequestEntry # 
type Rep DeleteMessageBatchRequestEntry = D1 * (MetaData "DeleteMessageBatchRequestEntry" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) (C1 * (MetaCons "DeleteMessageBatchRequestEntry'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmbreId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_dmbreReceiptHandle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

deleteMessageBatchRequestEntry #

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

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

  • dmbreId - An identifier for this particular receipt handle. This is used to communicate the result.
  • dmbreReceiptHandle - A receipt handle.

dmbreId :: Lens' DeleteMessageBatchRequestEntry Text #

An identifier for this particular receipt handle. This is used to communicate the result.

DeleteMessageBatchResultEntry

data DeleteMessageBatchResultEntry #

Encloses the Id of an entry in DeleteMessageBatch .

See: deleteMessageBatchResultEntry smart constructor.

Instances

Eq DeleteMessageBatchResultEntry # 
Data DeleteMessageBatchResultEntry # 

Methods

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

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

toConstr :: DeleteMessageBatchResultEntry -> Constr #

dataTypeOf :: DeleteMessageBatchResultEntry -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DeleteMessageBatchResultEntry -> DeleteMessageBatchResultEntry #

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

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

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

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

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

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

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

Read DeleteMessageBatchResultEntry # 
Show DeleteMessageBatchResultEntry # 
Generic DeleteMessageBatchResultEntry # 
Hashable DeleteMessageBatchResultEntry # 
NFData DeleteMessageBatchResultEntry # 
FromXML DeleteMessageBatchResultEntry # 
type Rep DeleteMessageBatchResultEntry # 
type Rep DeleteMessageBatchResultEntry = D1 * (MetaData "DeleteMessageBatchResultEntry" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" True) (C1 * (MetaCons "DeleteMessageBatchResultEntry'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

deleteMessageBatchResultEntry #

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

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

  • dId - Represents a successfully deleted message.

dId :: Lens' DeleteMessageBatchResultEntry Text #

Represents a successfully deleted message.

Message

data Message #

An Amazon SQS message.

See: message smart constructor.

Instances

Eq Message # 

Methods

(==) :: Message -> Message -> Bool #

(/=) :: Message -> Message -> Bool #

Data Message # 

Methods

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

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

toConstr :: Message -> Constr #

dataTypeOf :: Message -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> Message -> Message #

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

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

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

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

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

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

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

Read Message # 
Show Message # 
Generic Message # 

Associated Types

type Rep Message :: * -> * #

Methods

from :: Message -> Rep Message x #

to :: Rep Message x -> Message #

Hashable Message # 

Methods

hashWithSalt :: Int -> Message -> Int #

hash :: Message -> Int #

NFData Message # 

Methods

rnf :: Message -> () #

FromXML Message # 
type Rep Message # 

message :: Message #

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

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

  • mMessageAttributes - Each message attribute consists of a Name , Type , and Value . For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .
  • mMD5OfBody - An MD5 digest of the non-URL-encoded message body string.
  • mBody - The message's contents (not URL-encoded).
  • mAttributes - SenderId , SentTimestamp , ApproximateReceiveCount , andor ApproximateFirstReceiveTimestamp . SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the <http:en.wikipedia.orgwiki/Unix_time epoch time> in milliseconds.
  • mReceiptHandle - An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
  • mMessageId - A unique identifier for the message. A MessageId is considered unique across all AWS accounts for an extended period of time.
  • mMD5OfMessageAttributes - An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .

mMessageAttributes :: Lens' Message (HashMap Text MessageAttributeValue) #

Each message attribute consists of a Name , Type , and Value . For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .

mMD5OfBody :: Lens' Message (Maybe Text) #

An MD5 digest of the non-URL-encoded message body string.

mBody :: Lens' Message (Maybe Text) #

The message's contents (not URL-encoded).

mAttributes :: Lens' Message (HashMap MessageAttribute Text) #

SenderId , SentTimestamp , ApproximateReceiveCount , andor ApproximateFirstReceiveTimestamp . SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the <http:en.wikipedia.orgwiki/Unix_time epoch time> in milliseconds.

mReceiptHandle :: Lens' Message (Maybe Text) #

An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

mMessageId :: Lens' Message (Maybe Text) #

A unique identifier for the message. A MessageId is considered unique across all AWS accounts for an extended period of time.

mMD5OfMessageAttributes :: Lens' Message (Maybe Text) #

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .

MessageAttributeValue

data MessageAttributeValue #

The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage .

Name , type , value and the message body must not be empty or null. All parts of the message attribute, including Name , Type , and Value , are part of the message size restriction (256 KB or 262,144 bytes).

See: messageAttributeValue smart constructor.

Instances

Eq MessageAttributeValue # 
Data MessageAttributeValue # 

Methods

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

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

toConstr :: MessageAttributeValue -> Constr #

dataTypeOf :: MessageAttributeValue -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> MessageAttributeValue -> MessageAttributeValue #

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

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

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

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

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

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

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

Read MessageAttributeValue # 
Show MessageAttributeValue # 
Generic MessageAttributeValue # 
Hashable MessageAttributeValue # 
NFData MessageAttributeValue # 

Methods

rnf :: MessageAttributeValue -> () #

FromXML MessageAttributeValue # 
ToQuery MessageAttributeValue # 
type Rep MessageAttributeValue # 
type Rep MessageAttributeValue = D1 * (MetaData "MessageAttributeValue" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) (C1 * (MetaCons "MessageAttributeValue'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mavBinaryValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Base64))) (S1 * (MetaSel (Just Symbol "_mavStringListValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mavStringValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mavBinaryListValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Base64]))) (S1 * (MetaSel (Just Symbol "_mavDataType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

messageAttributeValue #

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

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

  • mavBinaryValue - Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • mavStringListValues - Not implemented. Reserved for future use.
  • mavStringValue - Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters .
  • mavBinaryListValues - Not implemented. Reserved for future use.
  • mavDataType - Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue . You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon Simple Queue Service Developer Guide .

mavBinaryValue :: Lens' MessageAttributeValue (Maybe ByteString) #

Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

mavStringListValues :: Lens' MessageAttributeValue [Text] #

Not implemented. Reserved for future use.

mavStringValue :: Lens' MessageAttributeValue (Maybe Text) #

Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters .

mavBinaryListValues :: Lens' MessageAttributeValue [ByteString] #

Not implemented. Reserved for future use.

mavDataType :: Lens' MessageAttributeValue Text #

Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue . You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon Simple Queue Service Developer Guide .

SendMessageBatchRequestEntry

data SendMessageBatchRequestEntry #

Contains the details of a single Amazon SQS message along with an Id .

See: sendMessageBatchRequestEntry smart constructor.

Instances

Eq SendMessageBatchRequestEntry # 
Data SendMessageBatchRequestEntry # 

Methods

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

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

toConstr :: SendMessageBatchRequestEntry -> Constr #

dataTypeOf :: SendMessageBatchRequestEntry -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SendMessageBatchRequestEntry -> SendMessageBatchRequestEntry #

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

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

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

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

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

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

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

Read SendMessageBatchRequestEntry # 
Show SendMessageBatchRequestEntry # 
Generic SendMessageBatchRequestEntry # 
Hashable SendMessageBatchRequestEntry # 
NFData SendMessageBatchRequestEntry # 
ToQuery SendMessageBatchRequestEntry # 
type Rep SendMessageBatchRequestEntry # 
type Rep SendMessageBatchRequestEntry = D1 * (MetaData "SendMessageBatchRequestEntry" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) (C1 * (MetaCons "SendMessageBatchRequestEntry'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sMessageAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text MessageAttributeValue)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sDelaySeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_sMessageDeduplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sMessageGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sMessageBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

sendMessageBatchRequestEntry #

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

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

  • sMessageAttributes - Each message attribute consists of a Name , Type , and Value . For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .
  • sDelaySeconds - The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.
  • sMessageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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. * 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. The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z , A-Z , 0-9 ) and punctuation (!"#$%&'()*+,-./:;=?[]^_`{|}~ ). For best practices of using MessageDeduplicationId@ , see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide .
  • sMessageGroupId - This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion. * You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId , the action fails. * ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId , the messages are sorted by time sent. The caller can't specify a MessageGroupId . The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;=?[]^_`{|}~) . For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide . Important: MessageGroupId@ is required for FIFO queues. You can't use it for Standard queues.
  • sId - An identifier for a message in this batch used to communicate the result.
  • sMessageBody - The body of the message.

sMessageAttributes :: Lens' SendMessageBatchRequestEntry (HashMap Text MessageAttributeValue) #

Each message attribute consists of a Name , Type , and Value . For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .

sDelaySeconds :: Lens' SendMessageBatchRequestEntry (Maybe Int) #

The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.

sMessageDeduplicationId :: Lens' SendMessageBatchRequestEntry (Maybe Text) #

This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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. * 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. The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z , A-Z , 0-9 ) and punctuation (!"#$%&'()*+,-./:;=?[]^_`{|}~ ). For best practices of using MessageDeduplicationId@ , see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide .

sMessageGroupId :: Lens' SendMessageBatchRequestEntry (Maybe Text) #

This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion. * You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId , the action fails. * ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId , the messages are sorted by time sent. The caller can't specify a MessageGroupId . The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;=?[]^_`{|}~) . For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide . Important: MessageGroupId@ is required for FIFO queues. You can't use it for Standard queues.

sId :: Lens' SendMessageBatchRequestEntry Text #

An identifier for a message in this batch used to communicate the result.

SendMessageBatchResultEntry

data SendMessageBatchResultEntry #

Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch .

See: sendMessageBatchResultEntry smart constructor.

Instances

Eq SendMessageBatchResultEntry # 
Data SendMessageBatchResultEntry # 

Methods

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

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

toConstr :: SendMessageBatchResultEntry -> Constr #

dataTypeOf :: SendMessageBatchResultEntry -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SendMessageBatchResultEntry -> SendMessageBatchResultEntry #

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

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

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

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

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

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

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

Read SendMessageBatchResultEntry # 
Show SendMessageBatchResultEntry # 
Generic SendMessageBatchResultEntry # 
Hashable SendMessageBatchResultEntry # 
NFData SendMessageBatchResultEntry # 
FromXML SendMessageBatchResultEntry # 
type Rep SendMessageBatchResultEntry # 
type Rep SendMessageBatchResultEntry = D1 * (MetaData "SendMessageBatchResultEntry" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.0-6AKMU5Om8FbICeCVgWDhlE" False) (C1 * (MetaCons "SendMessageBatchResultEntry'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_smbreSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_smbreMD5OfMessageAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smbreId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_smbreMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_smbreMD5OfMessageBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

sendMessageBatchResultEntry #

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

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

  • smbreSequenceNumber - This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message. The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId .
  • smbreMD5OfMessageAttributes - An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .
  • smbreId - An identifier for the message in this batch.
  • smbreMessageId - An identifier for the message.
  • smbreMD5OfMessageBody - An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .

smbreSequenceNumber :: Lens' SendMessageBatchResultEntry (Maybe Text) #

This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message. The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId .

smbreMD5OfMessageAttributes :: Lens' SendMessageBatchResultEntry (Maybe Text) #

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .

smbreId :: Lens' SendMessageBatchResultEntry Text #

An identifier for the message in this batch.

smbreMessageId :: Lens' SendMessageBatchResultEntry Text #

An identifier for the message.

smbreMD5OfMessageBody :: Lens' SendMessageBatchResultEntry Text #

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .