Amazonka.SQS.ChangeMessageVisibilityBatch

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

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

&AttributeName.1=first

&AttributeName.2=second

Creating a Request

data ChangeMessageVisibilityBatch

See: newChangeMessageVisibilityBatch smart constructor.

Constructors

ChangeMessageVisibilityBatch'

Fields

• queueUrl :: Text

  The URL of the Amazon SQS queue whose messages' visibility is changed.

  Queue URLs and names are case-sensitive.

• entries :: [ChangeMessageVisibilityBatchRequestEntry]

  A list of receipt handles of the messages for which the visibility timeout must be changed.

Instances

ToHeaders ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

toHeaders :: ChangeMessageVisibilityBatch -> [Header]

ToPath ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

toPath :: ChangeMessageVisibilityBatch -> ByteString

ToQuery ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

toQuery :: ChangeMessageVisibilityBatch -> QueryString

AWSRequest ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Associated Types

type AWSResponse ChangeMessageVisibilityBatch

Methods

request :: (Service -> Service) -> ChangeMessageVisibilityBatch -> Request ChangeMessageVisibilityBatch

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ChangeMessageVisibilityBatch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ChangeMessageVisibilityBatch)))

Generic ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Associated Types

type Rep ChangeMessageVisibilityBatch :: Type -> Type

Methods

from :: ChangeMessageVisibilityBatch -> Rep ChangeMessageVisibilityBatch x

to :: Rep ChangeMessageVisibilityBatch x -> ChangeMessageVisibilityBatch

Read ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

readsPrec :: Int -> ReadS ChangeMessageVisibilityBatch

readList :: ReadS [ChangeMessageVisibilityBatch]

readPrec :: ReadPrec ChangeMessageVisibilityBatch

readListPrec :: ReadPrec [ChangeMessageVisibilityBatch]

Show ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

showsPrec :: Int -> ChangeMessageVisibilityBatch -> ShowS

show :: ChangeMessageVisibilityBatch -> String

showList :: [ChangeMessageVisibilityBatch] -> ShowS

NFData ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

rnf :: ChangeMessageVisibilityBatch -> ()

Eq ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

(==) :: ChangeMessageVisibilityBatch -> ChangeMessageVisibilityBatch -> Bool

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

Hashable ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

hashWithSalt :: Int -> ChangeMessageVisibilityBatch -> Int

hash :: ChangeMessageVisibilityBatch -> Int

type AWSResponse ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

type AWSResponse ChangeMessageVisibilityBatch = ChangeMessageVisibilityBatchResponse

type Rep ChangeMessageVisibilityBatch

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

type Rep ChangeMessageVisibilityBatch = D1 ('MetaData "ChangeMessageVisibilityBatch" "Amazonka.SQS.ChangeMessageVisibilityBatch" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "ChangeMessageVisibilityBatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ChangeMessageVisibilityBatchRequestEntry])))

newChangeMessageVisibilityBatch

Arguments

:: Text

$sel:queueUrl:ChangeMessageVisibilityBatch'

-> ChangeMessageVisibilityBatch

Create a value of ChangeMessageVisibilityBatch 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:queueUrl:ChangeMessageVisibilityBatch', changeMessageVisibilityBatch_queueUrl - The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs and names are case-sensitive.

$sel:entries:ChangeMessageVisibilityBatch', changeMessageVisibilityBatch_entries - A list of receipt handles of the messages for which the visibility timeout must be changed.

Request Lenses

changeMessageVisibilityBatch_queueUrl :: Lens' ChangeMessageVisibilityBatch Text

The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs and names are case-sensitive.

changeMessageVisibilityBatch_entries :: Lens' ChangeMessageVisibilityBatch [ChangeMessageVisibilityBatchRequestEntry]

A list of receipt handles of the messages for which the visibility timeout must be changed.

Destructuring the Response

data ChangeMessageVisibilityBatchResponse

For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

See: newChangeMessageVisibilityBatchResponse smart constructor.

Constructors

ChangeMessageVisibilityBatchResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• successful :: [ChangeMessageVisibilityBatchResultEntry]

  A list of ChangeMessageVisibilityBatchResultEntry items.

• failed :: [BatchResultErrorEntry]

  A list of BatchResultErrorEntry items.

Instances

Generic ChangeMessageVisibilityBatchResponse

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Associated Types

type Rep ChangeMessageVisibilityBatchResponse :: Type -> Type

Methods

from :: ChangeMessageVisibilityBatchResponse -> Rep ChangeMessageVisibilityBatchResponse x

to :: Rep ChangeMessageVisibilityBatchResponse x -> ChangeMessageVisibilityBatchResponse

Read ChangeMessageVisibilityBatchResponse

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

readsPrec :: Int -> ReadS ChangeMessageVisibilityBatchResponse

readList :: ReadS [ChangeMessageVisibilityBatchResponse]

readPrec :: ReadPrec ChangeMessageVisibilityBatchResponse

readListPrec :: ReadPrec [ChangeMessageVisibilityBatchResponse]

Show ChangeMessageVisibilityBatchResponse

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

showsPrec :: Int -> ChangeMessageVisibilityBatchResponse -> ShowS

show :: ChangeMessageVisibilityBatchResponse -> String

showList :: [ChangeMessageVisibilityBatchResponse] -> ShowS

NFData ChangeMessageVisibilityBatchResponse

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

rnf :: ChangeMessageVisibilityBatchResponse -> ()

Eq ChangeMessageVisibilityBatchResponse

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

Methods

(==) :: ChangeMessageVisibilityBatchResponse -> ChangeMessageVisibilityBatchResponse -> Bool

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

type Rep ChangeMessageVisibilityBatchResponse

Defined in Amazonka.SQS.ChangeMessageVisibilityBatch

type Rep ChangeMessageVisibilityBatchResponse = D1 ('MetaData "ChangeMessageVisibilityBatchResponse" "Amazonka.SQS.ChangeMessageVisibilityBatch" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "ChangeMessageVisibilityBatchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "successful") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ChangeMessageVisibilityBatchResultEntry]) :*: S1 ('MetaSel ('Just "failed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchResultErrorEntry]))))

newChangeMessageVisibilityBatchResponse

Arguments

:: Int

$sel:httpStatus:ChangeMessageVisibilityBatchResponse'

-> ChangeMessageVisibilityBatchResponse

Create a value of ChangeMessageVisibilityBatchResponse 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:httpStatus:ChangeMessageVisibilityBatchResponse', changeMessageVisibilityBatchResponse_httpStatus - The response's http status code.

$sel:successful:ChangeMessageVisibilityBatchResponse', changeMessageVisibilityBatchResponse_successful - A list of ChangeMessageVisibilityBatchResultEntry items.

$sel:failed:ChangeMessageVisibilityBatchResponse', changeMessageVisibilityBatchResponse_failed - A list of BatchResultErrorEntry items.

Response Lenses

changeMessageVisibilityBatchResponse_httpStatus :: Lens' ChangeMessageVisibilityBatchResponse Int

The response's http status code.

changeMessageVisibilityBatchResponse_successful :: Lens' ChangeMessageVisibilityBatchResponse [ChangeMessageVisibilityBatchResultEntry]

A list of ChangeMessageVisibilityBatchResultEntry items.

changeMessageVisibilityBatchResponse_failed :: Lens' ChangeMessageVisibilityBatchResponse [BatchResultErrorEntry]

A list of BatchResultErrorEntry items.