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

Description

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

The ListDeadLetterSourceQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to ListDeadLetterSourceQueues to receive the next page of results.

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDeadLetterSourceQueues Source #

See: newListDeadLetterSourceQueues smart constructor.

Constructors

ListDeadLetterSourceQueues' 

Fields

  • maxResults :: Maybe Int

    Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

  • nextToken :: Maybe Text

    Pagination token to request the next set of results.

  • queueUrl :: Text

    The URL of a dead-letter queue.

    Queue URLs and names are case-sensitive.

Instances

Instances details
ToHeaders ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

ToPath ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

ToQuery ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

AWSPager ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

AWSRequest ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Generic ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Associated Types

type Rep ListDeadLetterSourceQueues :: Type -> Type #

Read ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Show ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

NFData ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Eq ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Hashable ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

type AWSResponse ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

type Rep ListDeadLetterSourceQueues Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

type Rep ListDeadLetterSourceQueues = D1 ('MetaData "ListDeadLetterSourceQueues" "Amazonka.SQS.ListDeadLetterSourceQueues" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "ListDeadLetterSourceQueues'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDeadLetterSourceQueues Source #

Create a value of ListDeadLetterSourceQueues 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:maxResults:ListDeadLetterSourceQueues', listDeadLetterSourceQueues_maxResults - Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

ListDeadLetterSourceQueues, listDeadLetterSourceQueues_nextToken - Pagination token to request the next set of results.

$sel:queueUrl:ListDeadLetterSourceQueues', listDeadLetterSourceQueues_queueUrl - The URL of a dead-letter queue.

Queue URLs and names are case-sensitive.

Request Lenses

listDeadLetterSourceQueues_maxResults :: Lens' ListDeadLetterSourceQueues (Maybe Int) Source #

Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

listDeadLetterSourceQueues_nextToken :: Lens' ListDeadLetterSourceQueues (Maybe Text) Source #

Pagination token to request the next set of results.

listDeadLetterSourceQueues_queueUrl :: Lens' ListDeadLetterSourceQueues Text Source #

The URL of a dead-letter queue.

Queue URLs and names are case-sensitive.

Destructuring the Response

data ListDeadLetterSourceQueuesResponse Source #

A list of your dead letter source queues.

See: newListDeadLetterSourceQueuesResponse smart constructor.

Constructors

ListDeadLetterSourceQueuesResponse' 

Fields

  • nextToken :: Maybe Text

    Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

  • httpStatus :: Int

    The response's http status code.

  • queueUrls :: [Text]

    A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

Instances

Instances details
Generic ListDeadLetterSourceQueuesResponse Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Associated Types

type Rep ListDeadLetterSourceQueuesResponse :: Type -> Type #

Read ListDeadLetterSourceQueuesResponse Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Show ListDeadLetterSourceQueuesResponse Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

NFData ListDeadLetterSourceQueuesResponse Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

Eq ListDeadLetterSourceQueuesResponse Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

type Rep ListDeadLetterSourceQueuesResponse Source # 
Instance details

Defined in Amazonka.SQS.ListDeadLetterSourceQueues

type Rep ListDeadLetterSourceQueuesResponse = D1 ('MetaData "ListDeadLetterSourceQueuesResponse" "Amazonka.SQS.ListDeadLetterSourceQueues" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "ListDeadLetterSourceQueuesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "queueUrls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListDeadLetterSourceQueuesResponse Source #

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

ListDeadLetterSourceQueues, listDeadLetterSourceQueuesResponse_nextToken - Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

$sel:httpStatus:ListDeadLetterSourceQueuesResponse', listDeadLetterSourceQueuesResponse_httpStatus - The response's http status code.

$sel:queueUrls:ListDeadLetterSourceQueuesResponse', listDeadLetterSourceQueuesResponse_queueUrls - A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

Response Lenses

listDeadLetterSourceQueuesResponse_nextToken :: Lens' ListDeadLetterSourceQueuesResponse (Maybe Text) Source #

Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

listDeadLetterSourceQueuesResponse_queueUrls :: Lens' ListDeadLetterSourceQueuesResponse [Text] Source #

A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.