Paginators

Index > SQS > Paginators

Auto-generated documentation for SQS type annotations stubs module types-boto3-sqs.

ListDeadLetterSourceQueuesPaginator

Type annotations and code completion for boto3.client("sqs").get_paginator("list_dead_letter_source_queues"). boto3 documentation

# ListDeadLetterSourceQueuesPaginator usage example

from boto3.session import Session

from types_boto3_sqs.paginator import ListDeadLetterSourceQueuesPaginator

def get_list_dead_letter_source_queues_paginator() -> ListDeadLetterSourceQueuesPaginator:
    return Session().client("sqs").get_paginator("list_dead_letter_source_queues")

# ListDeadLetterSourceQueuesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_sqs.paginator import ListDeadLetterSourceQueuesPaginator

session = Session()

client = Session().client("sqs")  # (1)
paginator: ListDeadLetterSourceQueuesPaginator = client.get_paginator("list_dead_letter_source_queues")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SQSClient
2. paginator: ListDeadLetterSourceQueuesPaginator
3. item: PageIterator[ListDeadLetterSourceQueuesResultTypeDef]

paginate

Type annotations and code completion for ListDeadLetterSourceQueuesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    QueueUrl: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListDeadLetterSourceQueuesResultTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListDeadLetterSourceQueuesResultTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListDeadLetterSourceQueuesRequestPaginateTypeDef = {  # (1)
    "QueueUrl": ...,
}

parent.paginate(**kwargs)

1. See ListDeadLetterSourceQueuesRequestPaginateTypeDef

ListQueuesPaginator

Type annotations and code completion for boto3.client("sqs").get_paginator("list_queues"). boto3 documentation

# ListQueuesPaginator usage example

from boto3.session import Session

from types_boto3_sqs.paginator import ListQueuesPaginator

def get_list_queues_paginator() -> ListQueuesPaginator:
    return Session().client("sqs").get_paginator("list_queues")

# ListQueuesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_sqs.paginator import ListQueuesPaginator

session = Session()

client = Session().client("sqs")  # (1)
paginator: ListQueuesPaginator = client.get_paginator("list_queues")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SQSClient
2. paginator: ListQueuesPaginator
3. item: PageIterator[ListQueuesResultTypeDef]

paginate

Type annotations and code completion for ListQueuesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    QueueNamePrefix: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListQueuesResultTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListQueuesResultTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListQueuesRequestPaginateTypeDef = {  # (1)
    "QueueNamePrefix": ...,
}

parent.paginate(**kwargs)

1. See ListQueuesRequestPaginateTypeDef