amazonka-sqs-2.0: Amazon Simple Queue Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SQS.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

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

Errors

_BatchEntryIdsNotDistinct :: AsError a => Fold a ServiceError Source #

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

_BatchRequestTooLong :: AsError a => Fold a ServiceError Source #

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

_EmptyBatchRequest :: AsError a => Fold a ServiceError Source #

The batch request doesn't contain any entries.

_InvalidAttributeName :: AsError a => Fold a ServiceError Source #

The specified attribute doesn't exist.

_InvalidBatchEntryId :: AsError a => Fold a ServiceError Source #

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

_InvalidIdFormat :: AsError a => Fold a ServiceError Source #

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

_InvalidMessageContents :: AsError a => Fold a ServiceError Source #

The message contains characters outside the allowed set.

_MessageNotInflight :: AsError a => Fold a ServiceError Source #

The specified message isn't in flight.

_OverLimit :: AsError a => Fold a ServiceError Source #

The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.

_PurgeQueueInProgress :: AsError a => Fold a ServiceError Source #

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).

_QueueDeletedRecently :: AsError a => Fold a ServiceError Source #

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

_QueueDoesNotExist :: AsError a => Fold a ServiceError Source #

The specified queue doesn't exist.

_QueueNameExists :: AsError a => Fold a ServiceError Source #

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

_ReceiptHandleIsInvalid :: AsError a => Fold a ServiceError Source #

The specified receipt handle isn't valid.

_TooManyEntriesInBatchRequest :: AsError a => Fold a ServiceError Source #

The batch request contains more entries than permissible.

_UnsupportedOperation :: AsError a => Fold a ServiceError Source #

Error code 400. Unsupported operation.

MessageAttribute

newtype MessageAttribute Source #

Instances

Instances details
FromJSON MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

FromJSONKey MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToJSON MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToJSONKey MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToByteString MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToHeader MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToLog MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToQuery MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

FromText MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToText MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

FromXML MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

ToXML MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

Generic MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

Associated Types

type Rep MessageAttribute :: Type -> Type #

Read MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

Show MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

NFData MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

Methods

rnf :: MessageAttribute -> () #

Eq MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

Ord MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

Hashable MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

type Rep MessageAttribute Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttribute

type Rep MessageAttribute = D1 ('MetaData "MessageAttribute" "Amazonka.SQS.Types.MessageAttribute" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'True) (C1 ('MetaCons "MessageAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMessageAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MessageSystemAttributeNameForSends

newtype MessageSystemAttributeNameForSends Source #

Instances

Instances details
FromJSON MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

FromJSONKey MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToJSON MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToJSONKey MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToByteString MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToHeader MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToLog MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToQuery MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

FromText MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToText MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

FromXML MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

ToXML MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

Generic MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

Associated Types

type Rep MessageSystemAttributeNameForSends :: Type -> Type #

Read MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

Show MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

NFData MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

Eq MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

Ord MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

Hashable MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

type Rep MessageSystemAttributeNameForSends Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeNameForSends

type Rep MessageSystemAttributeNameForSends = D1 ('MetaData "MessageSystemAttributeNameForSends" "Amazonka.SQS.Types.MessageSystemAttributeNameForSends" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'True) (C1 ('MetaCons "MessageSystemAttributeNameForSends'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMessageSystemAttributeNameForSends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueueAttributeName

newtype QueueAttributeName Source #

Bundled Patterns

pattern QueueAttributeName_All :: QueueAttributeName 
pattern QueueAttributeName_ApproximateNumberOfMessages :: QueueAttributeName 
pattern QueueAttributeName_ApproximateNumberOfMessagesDelayed :: QueueAttributeName 
pattern QueueAttributeName_ApproximateNumberOfMessagesNotVisible :: QueueAttributeName 
pattern QueueAttributeName_ContentBasedDeduplication :: QueueAttributeName 
pattern QueueAttributeName_CreatedTimestamp :: QueueAttributeName 
pattern QueueAttributeName_DeduplicationScope :: QueueAttributeName 
pattern QueueAttributeName_DelaySeconds :: QueueAttributeName 
pattern QueueAttributeName_FifoQueue :: QueueAttributeName 
pattern QueueAttributeName_FifoThroughputLimit :: QueueAttributeName 
pattern QueueAttributeName_KmsDataKeyReusePeriodSeconds :: QueueAttributeName 
pattern QueueAttributeName_KmsMasterKeyId :: QueueAttributeName 
pattern QueueAttributeName_LastModifiedTimestamp :: QueueAttributeName 
pattern QueueAttributeName_MaximumMessageSize :: QueueAttributeName 
pattern QueueAttributeName_MessageRetentionPeriod :: QueueAttributeName 
pattern QueueAttributeName_Policy :: QueueAttributeName 
pattern QueueAttributeName_QueueArn :: QueueAttributeName 
pattern QueueAttributeName_ReceiveMessageWaitTimeSeconds :: QueueAttributeName 
pattern QueueAttributeName_RedriveAllowPolicy :: QueueAttributeName 
pattern QueueAttributeName_RedrivePolicy :: QueueAttributeName 
pattern QueueAttributeName_SqsManagedSseEnabled :: QueueAttributeName 
pattern QueueAttributeName_VisibilityTimeout :: QueueAttributeName 

Instances

Instances details
FromJSON QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

FromJSONKey QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToJSON QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToJSONKey QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToByteString QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToHeader QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToLog QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToQuery QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

FromText QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToText QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

FromXML QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

ToXML QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

Generic QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

Associated Types

type Rep QueueAttributeName :: Type -> Type #

Read QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

Show QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

NFData QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

Methods

rnf :: QueueAttributeName -> () #

Eq QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

Ord QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

Hashable QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

type Rep QueueAttributeName Source # 
Instance details

Defined in Amazonka.SQS.Types.QueueAttributeName

type Rep QueueAttributeName = D1 ('MetaData "QueueAttributeName" "Amazonka.SQS.Types.QueueAttributeName" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'True) (C1 ('MetaCons "QueueAttributeName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueueAttributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

BatchResultErrorEntry

data BatchResultErrorEntry Source #

Gives a detailed description of the result of an action on each entry in the request.

See: newBatchResultErrorEntry smart constructor.

Constructors

BatchResultErrorEntry' 

Fields

  • message :: Maybe Text

    A message explaining why the action failed on this entry.

  • id :: Text

    The Id of an entry in a batch request.

  • senderFault :: Bool

    Specifies whether the error happened due to the caller of the batch API action.

  • code :: Text

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

Instances

Instances details
FromXML BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

Generic BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

Associated Types

type Rep BatchResultErrorEntry :: Type -> Type #

Read BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

Show BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

NFData BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

Methods

rnf :: BatchResultErrorEntry -> () #

Eq BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

Hashable BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

type Rep BatchResultErrorEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.BatchResultErrorEntry

type Rep BatchResultErrorEntry = D1 ('MetaData "BatchResultErrorEntry" "Amazonka.SQS.Types.BatchResultErrorEntry" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "BatchResultErrorEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "senderFault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newBatchResultErrorEntry Source #

Create a value of BatchResultErrorEntry 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:

$sel:message:BatchResultErrorEntry', batchResultErrorEntry_message - A message explaining why the action failed on this entry.

$sel:id:BatchResultErrorEntry', batchResultErrorEntry_id - The Id of an entry in a batch request.

$sel:senderFault:BatchResultErrorEntry', batchResultErrorEntry_senderFault - Specifies whether the error happened due to the caller of the batch API action.

$sel:code:BatchResultErrorEntry', batchResultErrorEntry_code - An error code representing why the action failed on this entry.

batchResultErrorEntry_message :: Lens' BatchResultErrorEntry (Maybe Text) Source #

A message explaining why the action failed on this entry.

batchResultErrorEntry_id :: Lens' BatchResultErrorEntry Text Source #

The Id of an entry in a batch request.

batchResultErrorEntry_senderFault :: Lens' BatchResultErrorEntry Bool Source #

Specifies whether the error happened due to the caller of the batch API action.

batchResultErrorEntry_code :: Lens' BatchResultErrorEntry Text Source #

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

ChangeMessageVisibilityBatchRequestEntry

data ChangeMessageVisibilityBatchRequestEntry Source #

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

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:

&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

See: newChangeMessageVisibilityBatchRequestEntry smart constructor.

Constructors

ChangeMessageVisibilityBatchRequestEntry' 

Fields

  • visibilityTimeout :: Maybe Int

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

  • id :: Text

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

    The Ids of a batch request need to be unique within a request.

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

  • receiptHandle :: Text

    A receipt handle.

Instances

Instances details
ToQuery ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

Generic ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

Read ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

Show ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

NFData ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

Eq ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

Hashable ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

type Rep ChangeMessageVisibilityBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry

type Rep ChangeMessageVisibilityBatchRequestEntry = D1 ('MetaData "ChangeMessageVisibilityBatchRequestEntry" "Amazonka.SQS.Types.ChangeMessageVisibilityBatchRequestEntry" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "ChangeMessageVisibilityBatchRequestEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "visibilityTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "receiptHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newChangeMessageVisibilityBatchRequestEntry Source #

Create a value of ChangeMessageVisibilityBatchRequestEntry 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:

$sel:visibilityTimeout:ChangeMessageVisibilityBatchRequestEntry', changeMessageVisibilityBatchRequestEntry_visibilityTimeout - The new value (in seconds) for the message's visibility timeout.

$sel:id:ChangeMessageVisibilityBatchRequestEntry', changeMessageVisibilityBatchRequestEntry_id - An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

$sel:receiptHandle:ChangeMessageVisibilityBatchRequestEntry', changeMessageVisibilityBatchRequestEntry_receiptHandle - A receipt handle.

changeMessageVisibilityBatchRequestEntry_id :: Lens' ChangeMessageVisibilityBatchRequestEntry Text Source #

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

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

ChangeMessageVisibilityBatchResultEntry

data ChangeMessageVisibilityBatchResultEntry Source #

Encloses the Id of an entry in ChangeMessageVisibilityBatch.

See: newChangeMessageVisibilityBatchResultEntry smart constructor.

Constructors

ChangeMessageVisibilityBatchResultEntry' 

Fields

  • id :: Text

    Represents a message whose visibility timeout has been changed successfully.

Instances

Instances details
FromXML ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

Generic ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

Read ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

Show ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

NFData ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

Eq ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

Hashable ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

type Rep ChangeMessageVisibilityBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry

type Rep ChangeMessageVisibilityBatchResultEntry = D1 ('MetaData "ChangeMessageVisibilityBatchResultEntry" "Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "ChangeMessageVisibilityBatchResultEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newChangeMessageVisibilityBatchResultEntry Source #

Create a value of ChangeMessageVisibilityBatchResultEntry 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:

$sel:id:ChangeMessageVisibilityBatchResultEntry', changeMessageVisibilityBatchResultEntry_id - Represents a message whose visibility timeout has been changed successfully.

changeMessageVisibilityBatchResultEntry_id :: Lens' ChangeMessageVisibilityBatchResultEntry Text Source #

Represents a message whose visibility timeout has been changed successfully.

DeleteMessageBatchRequestEntry

data DeleteMessageBatchRequestEntry Source #

Encloses a receipt handle and an identifier for it.

See: newDeleteMessageBatchRequestEntry smart constructor.

Constructors

DeleteMessageBatchRequestEntry' 

Fields

  • id :: Text

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

    The Ids of a batch request need to be unique within a request.

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

  • receiptHandle :: Text

    A receipt handle.

Instances

Instances details
ToQuery DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

Generic DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

Associated Types

type Rep DeleteMessageBatchRequestEntry :: Type -> Type #

Read DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

Show DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

NFData DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

Eq DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

Hashable DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

type Rep DeleteMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchRequestEntry

type Rep DeleteMessageBatchRequestEntry = D1 ('MetaData "DeleteMessageBatchRequestEntry" "Amazonka.SQS.Types.DeleteMessageBatchRequestEntry" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "DeleteMessageBatchRequestEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "receiptHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteMessageBatchRequestEntry Source #

Create a value of DeleteMessageBatchRequestEntry 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:

$sel:id:DeleteMessageBatchRequestEntry', deleteMessageBatchRequestEntry_id - An identifier for this particular receipt handle. This is used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

$sel:receiptHandle:DeleteMessageBatchRequestEntry', deleteMessageBatchRequestEntry_receiptHandle - A receipt handle.

deleteMessageBatchRequestEntry_id :: Lens' DeleteMessageBatchRequestEntry Text Source #

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

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

DeleteMessageBatchResultEntry

data DeleteMessageBatchResultEntry Source #

Encloses the Id of an entry in DeleteMessageBatch.

See: newDeleteMessageBatchResultEntry smart constructor.

Constructors

DeleteMessageBatchResultEntry' 

Fields

  • id :: Text

    Represents a successfully deleted message.

Instances

Instances details
FromXML DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

Generic DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

Associated Types

type Rep DeleteMessageBatchResultEntry :: Type -> Type #

Read DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

Show DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

NFData DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

Eq DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

Hashable DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

type Rep DeleteMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.DeleteMessageBatchResultEntry

type Rep DeleteMessageBatchResultEntry = D1 ('MetaData "DeleteMessageBatchResultEntry" "Amazonka.SQS.Types.DeleteMessageBatchResultEntry" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "DeleteMessageBatchResultEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteMessageBatchResultEntry Source #

Create a value of DeleteMessageBatchResultEntry 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:

$sel:id:DeleteMessageBatchResultEntry', deleteMessageBatchResultEntry_id - Represents a successfully deleted message.

Message

data Message Source #

An Amazon SQS message.

See: newMessage smart constructor.

Constructors

Message' 

Fields

  • attributes :: Maybe (HashMap MessageAttribute Text)

    A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

    • ApproximateReceiveCount
    • ApproximateFirstReceiveTimestamp
    • MessageDeduplicationId
    • MessageGroupId
    • SenderId
    • SentTimestamp
    • SequenceNumber

    ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

  • body :: Maybe Text

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

  • mD5OfBody :: Maybe Text

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

  • mD5OfMessageAttributes :: 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.

  • messageAttributes :: Maybe (HashMap Text MessageAttributeValue)

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

  • messageId :: Maybe Text

    A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

  • receiptHandle :: 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.

Instances

Instances details
FromXML Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

Generic Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

Associated Types

type Rep Message :: Type -> Type #

Methods

from :: Message -> Rep Message x #

to :: Rep Message x -> Message #

Read Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

Show Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

NFData Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

Methods

rnf :: Message -> () #

Eq Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

Methods

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

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

Hashable Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

Methods

hashWithSalt :: Int -> Message -> Int #

hash :: Message -> Int #

type Rep Message Source # 
Instance details

Defined in Amazonka.SQS.Types.Message

newMessage :: Message Source #

Create a value of Message 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:

$sel:attributes:Message', message_attributes - A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

  • ApproximateReceiveCount
  • ApproximateFirstReceiveTimestamp
  • MessageDeduplicationId
  • MessageGroupId
  • SenderId
  • SentTimestamp
  • SequenceNumber

ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

$sel:body:Message', message_body - The message's contents (not URL-encoded).

$sel:mD5OfBody:Message', message_mD5OfBody - An MD5 digest of the non-URL-encoded message body string.

$sel:mD5OfMessageAttributes:Message', message_mD5OfMessageAttributes - 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.

$sel:messageAttributes:Message', message_messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

$sel:messageId:Message', message_messageId - A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

$sel:receiptHandle:Message', message_receiptHandle - 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.

message_attributes :: Lens' Message (Maybe (HashMap MessageAttribute Text)) Source #

A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

  • ApproximateReceiveCount
  • ApproximateFirstReceiveTimestamp
  • MessageDeduplicationId
  • MessageGroupId
  • SenderId
  • SentTimestamp
  • SequenceNumber

ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

message_body :: Lens' Message (Maybe Text) Source #

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

message_mD5OfBody :: Lens' Message (Maybe Text) Source #

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

message_mD5OfMessageAttributes :: Lens' Message (Maybe Text) Source #

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.

message_messageAttributes :: Lens' Message (Maybe (HashMap Text MessageAttributeValue)) Source #

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

message_messageId :: Lens' Message (Maybe Text) Source #

A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

message_receiptHandle :: Lens' Message (Maybe Text) Source #

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.

MessageAttributeValue

data MessageAttributeValue Source #

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: newMessageAttributeValue smart constructor.

Constructors

MessageAttributeValue' 

Fields

Instances

Instances details
ToQuery MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

FromXML MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

Generic MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

Associated Types

type Rep MessageAttributeValue :: Type -> Type #

Read MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

Show MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

NFData MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

Methods

rnf :: MessageAttributeValue -> () #

Eq MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

Hashable MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

type Rep MessageAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageAttributeValue

type Rep MessageAttributeValue = D1 ('MetaData "MessageAttributeValue" "Amazonka.SQS.Types.MessageAttributeValue" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "MessageAttributeValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "binaryListValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Base64])) :*: S1 ('MetaSel ('Just "binaryValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :*: (S1 ('MetaSel ('Just "stringListValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "stringValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newMessageAttributeValue Source #

Create a value of MessageAttributeValue 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:

$sel:binaryListValues:MessageAttributeValue', messageAttributeValue_binaryListValues - Not implemented. Reserved for future use.

$sel:binaryValue:MessageAttributeValue', messageAttributeValue_binaryValue - 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.

$sel:stringListValues:MessageAttributeValue', messageAttributeValue_stringListValues - Not implemented. Reserved for future use.

$sel:stringValue:MessageAttributeValue', messageAttributeValue_stringValue - Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

$sel:dataType:MessageAttributeValue', messageAttributeValue_dataType - 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 Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

messageAttributeValue_binaryValue :: Lens' MessageAttributeValue (Maybe ByteString) Source #

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.

messageAttributeValue_stringListValues :: Lens' MessageAttributeValue (Maybe [Text]) Source #

Not implemented. Reserved for future use.

messageAttributeValue_stringValue :: Lens' MessageAttributeValue (Maybe Text) Source #

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

messageAttributeValue_dataType :: Lens' MessageAttributeValue Text Source #

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 Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

MessageSystemAttributeValue

data MessageSystemAttributeValue Source #

The user-specified message system 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.

See: newMessageSystemAttributeValue smart constructor.

Constructors

MessageSystemAttributeValue' 

Fields

Instances

Instances details
ToQuery MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

Generic MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

Associated Types

type Rep MessageSystemAttributeValue :: Type -> Type #

Read MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

Show MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

NFData MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

Eq MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

Hashable MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

type Rep MessageSystemAttributeValue Source # 
Instance details

Defined in Amazonka.SQS.Types.MessageSystemAttributeValue

type Rep MessageSystemAttributeValue = D1 ('MetaData "MessageSystemAttributeValue" "Amazonka.SQS.Types.MessageSystemAttributeValue" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "MessageSystemAttributeValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "binaryListValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Base64])) :*: S1 ('MetaSel ('Just "binaryValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :*: (S1 ('MetaSel ('Just "stringListValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "stringValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newMessageSystemAttributeValue Source #

Create a value of MessageSystemAttributeValue 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:

$sel:binaryListValues:MessageSystemAttributeValue', messageSystemAttributeValue_binaryListValues - Not implemented. Reserved for future use.

$sel:binaryValue:MessageSystemAttributeValue', messageSystemAttributeValue_binaryValue - 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.

$sel:stringListValues:MessageSystemAttributeValue', messageSystemAttributeValue_stringListValues - Not implemented. Reserved for future use.

$sel:stringValue:MessageSystemAttributeValue', messageSystemAttributeValue_stringValue - Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

$sel:dataType:MessageSystemAttributeValue', messageSystemAttributeValue_dataType - 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 Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

messageSystemAttributeValue_binaryValue :: Lens' MessageSystemAttributeValue (Maybe ByteString) Source #

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.

messageSystemAttributeValue_stringValue :: Lens' MessageSystemAttributeValue (Maybe Text) Source #

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

messageSystemAttributeValue_dataType :: Lens' MessageSystemAttributeValue Text Source #

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 Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

SendMessageBatchRequestEntry

data SendMessageBatchRequestEntry Source #

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

See: newSendMessageBatchRequestEntry smart constructor.

Constructors

SendMessageBatchRequestEntry' 

Fields

  • delaySeconds :: 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.

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

  • messageAttributes :: Maybe (HashMap Text MessageAttributeValue)

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

  • messageDeduplicationId :: 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 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.
    • 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 MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    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 SQS Developer Guide.

  • messageGroupId :: 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 consumers 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: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

  • messageSystemAttributes :: Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue)

    The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

    • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.
    • The size of a message system attribute doesn't count towards the total size of a message.
  • id :: Text

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

    The Ids of a batch request need to be unique within a request.

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

  • messageBody :: Text

    The body of the message.

Instances

Instances details
ToQuery SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

Generic SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

Associated Types

type Rep SendMessageBatchRequestEntry :: Type -> Type #

Read SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

Show SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

NFData SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

Eq SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

Hashable SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

type Rep SendMessageBatchRequestEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchRequestEntry

type Rep SendMessageBatchRequestEntry = D1 ('MetaData "SendMessageBatchRequestEntry" "Amazonka.SQS.Types.SendMessageBatchRequestEntry" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "SendMessageBatchRequestEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "delaySeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "messageAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MessageAttributeValue))) :*: S1 ('MetaSel ('Just "messageDeduplicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "messageGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageSystemAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue)))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "messageBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSendMessageBatchRequestEntry Source #

Create a value of SendMessageBatchRequestEntry 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:

$sel:delaySeconds:SendMessageBatchRequestEntry', sendMessageBatchRequestEntry_delaySeconds - 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.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

$sel:messageAttributes:SendMessageBatchRequestEntry', sendMessageBatchRequestEntry_messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

$sel:messageDeduplicationId:SendMessageBatchRequestEntry', sendMessageBatchRequestEntry_messageDeduplicationId - 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 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.
  • 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 MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

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 SQS Developer Guide.

$sel:messageGroupId:SendMessageBatchRequestEntry', sendMessageBatchRequestEntry_messageGroupId - 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 consumers 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: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

$sel:messageSystemAttributes:SendMessageBatchRequestEntry', sendMessageBatchRequestEntry_messageSystemAttributes - The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

  • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.
  • The size of a message system attribute doesn't count towards the total size of a message.

$sel:id:SendMessageBatchRequestEntry', sendMessageBatchRequestEntry_id - An identifier for a message in this batch used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

$sel:messageBody:SendMessageBatchRequestEntry', sendMessageBatchRequestEntry_messageBody - The body of the message.

sendMessageBatchRequestEntry_delaySeconds :: Lens' SendMessageBatchRequestEntry (Maybe Int) Source #

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.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

sendMessageBatchRequestEntry_messageAttributes :: Lens' SendMessageBatchRequestEntry (Maybe (HashMap Text MessageAttributeValue)) Source #

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

sendMessageBatchRequestEntry_messageDeduplicationId :: Lens' SendMessageBatchRequestEntry (Maybe Text) Source #

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 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.
  • 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 MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

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 SQS Developer Guide.

sendMessageBatchRequestEntry_messageGroupId :: Lens' SendMessageBatchRequestEntry (Maybe Text) Source #

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 consumers 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: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

sendMessageBatchRequestEntry_messageSystemAttributes :: Lens' SendMessageBatchRequestEntry (Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue)) Source #

The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

  • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.
  • The size of a message system attribute doesn't count towards the total size of a message.

sendMessageBatchRequestEntry_id :: Lens' SendMessageBatchRequestEntry Text Source #

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

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

SendMessageBatchResultEntry

data SendMessageBatchResultEntry Source #

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

See: newSendMessageBatchResultEntry smart constructor.

Constructors

SendMessageBatchResultEntry' 

Fields

  • mD5OfMessageAttributes :: 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.

  • mD5OfMessageSystemAttributes :: Maybe Text

    An MD5 digest of the non-URL-encoded message system 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.

  • sequenceNumber :: 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.

  • id :: Text

    An identifier for the message in this batch.

  • messageId :: Text

    An identifier for the message.

  • mD5OfMessageBody :: Text

    An MD5 digest of the non-URL-encoded message body 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.

Instances

Instances details
FromXML SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

Generic SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

Associated Types

type Rep SendMessageBatchResultEntry :: Type -> Type #

Read SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

Show SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

NFData SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

Eq SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

Hashable SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

type Rep SendMessageBatchResultEntry Source # 
Instance details

Defined in Amazonka.SQS.Types.SendMessageBatchResultEntry

type Rep SendMessageBatchResultEntry = D1 ('MetaData "SendMessageBatchResultEntry" "Amazonka.SQS.Types.SendMessageBatchResultEntry" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "SendMessageBatchResultEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mD5OfMessageAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "mD5OfMessageSystemAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "mD5OfMessageBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSendMessageBatchResultEntry Source #

Create a value of SendMessageBatchResultEntry 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:

$sel:mD5OfMessageAttributes:SendMessageBatchResultEntry', sendMessageBatchResultEntry_mD5OfMessageAttributes - 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.

$sel:mD5OfMessageSystemAttributes:SendMessageBatchResultEntry', sendMessageBatchResultEntry_mD5OfMessageSystemAttributes - An MD5 digest of the non-URL-encoded message system 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.

$sel:sequenceNumber:SendMessageBatchResultEntry', sendMessageBatchResultEntry_sequenceNumber - 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.

$sel:id:SendMessageBatchResultEntry', sendMessageBatchResultEntry_id - An identifier for the message in this batch.

$sel:messageId:SendMessageBatchResultEntry', sendMessageBatchResultEntry_messageId - An identifier for the message.

$sel:mD5OfMessageBody:SendMessageBatchResultEntry', sendMessageBatchResultEntry_mD5OfMessageBody - An MD5 digest of the non-URL-encoded message body 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.

sendMessageBatchResultEntry_mD5OfMessageAttributes :: Lens' SendMessageBatchResultEntry (Maybe Text) Source #

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.

sendMessageBatchResultEntry_mD5OfMessageSystemAttributes :: Lens' SendMessageBatchResultEntry (Maybe Text) Source #

An MD5 digest of the non-URL-encoded message system 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.

sendMessageBatchResultEntry_sequenceNumber :: Lens' SendMessageBatchResultEntry (Maybe Text) Source #

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.

sendMessageBatchResultEntry_id :: Lens' SendMessageBatchResultEntry Text Source #

An identifier for the message in this batch.

sendMessageBatchResultEntry_mD5OfMessageBody :: Lens' SendMessageBatchResultEntry Text Source #

An MD5 digest of the non-URL-encoded message body 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.