Skip to content

Paginators#

Index > S3 > Paginators

Auto-generated documentation for S3 type annotations stubs module types-aiobotocore-s3.

ListMultipartUploadsPaginator#

Type annotations and code completion for session.create_client("s3").get_paginator("list_multipart_uploads"). boto3 documentation

# ListMultipartUploadsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_s3.paginator import ListMultipartUploadsPaginator

session = get_session()
async with session.create_client("s3") as client:  # (1)
    paginator: ListMultipartUploadsPaginator = client.get_paginator("list_multipart_uploads")  # (2)
    async for item in paginator.paginate(...):
        item: ListMultipartUploadsOutputTypeDef
        print(item)  # (3)
  1. client: S3Client
  2. paginator: ListMultipartUploadsPaginator
  3. item: ListMultipartUploadsOutputTypeDef

paginate#

Type annotations and code completion for ListMultipartUploadsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    ExpectedBucketOwner: str = ...,
    RequestPayer: RequestPayerType = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> AsyncIterator[ListMultipartUploadsOutputTypeDef]:  # (4)
    ...
  1. See EncodingTypeType
  2. See RequestPayerType
  3. See PaginatorConfigTypeDef
  4. See ListMultipartUploadsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef = {  # (1)
    "Bucket": ...,
}

parent.paginate(**kwargs)
  1. See ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef

ListObjectVersionsPaginator#

Type annotations and code completion for session.create_client("s3").get_paginator("list_object_versions"). boto3 documentation

# ListObjectVersionsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_s3.paginator import ListObjectVersionsPaginator

session = get_session()
async with session.create_client("s3") as client:  # (1)
    paginator: ListObjectVersionsPaginator = client.get_paginator("list_object_versions")  # (2)
    async for item in paginator.paginate(...):
        item: ListObjectVersionsOutputTypeDef
        print(item)  # (3)
  1. client: S3Client
  2. paginator: ListObjectVersionsPaginator
  3. item: ListObjectVersionsOutputTypeDef

paginate#

Type annotations and code completion for ListObjectVersionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    ExpectedBucketOwner: str = ...,
    RequestPayer: RequestPayerType = ...,  # (2)
    OptionalObjectAttributes: Sequence[OptionalObjectAttributesType] = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> AsyncIterator[ListObjectVersionsOutputTypeDef]:  # (5)
    ...
  1. See EncodingTypeType
  2. See RequestPayerType
  3. See OptionalObjectAttributesType
  4. See PaginatorConfigTypeDef
  5. See ListObjectVersionsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListObjectVersionsRequestListObjectVersionsPaginateTypeDef = {  # (1)
    "Bucket": ...,
}

parent.paginate(**kwargs)
  1. See ListObjectVersionsRequestListObjectVersionsPaginateTypeDef

ListObjectsPaginator#

Type annotations and code completion for session.create_client("s3").get_paginator("list_objects"). boto3 documentation

# ListObjectsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_s3.paginator import ListObjectsPaginator

session = get_session()
async with session.create_client("s3") as client:  # (1)
    paginator: ListObjectsPaginator = client.get_paginator("list_objects")  # (2)
    async for item in paginator.paginate(...):
        item: ListObjectsOutputTypeDef
        print(item)  # (3)
  1. client: S3Client
  2. paginator: ListObjectsPaginator
  3. item: ListObjectsOutputTypeDef

paginate#

Type annotations and code completion for ListObjectsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    RequestPayer: RequestPayerType = ...,  # (2)
    ExpectedBucketOwner: str = ...,
    OptionalObjectAttributes: Sequence[OptionalObjectAttributesType] = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> AsyncIterator[ListObjectsOutputTypeDef]:  # (5)
    ...
  1. See EncodingTypeType
  2. See RequestPayerType
  3. See OptionalObjectAttributesType
  4. See PaginatorConfigTypeDef
  5. See ListObjectsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListObjectsRequestListObjectsPaginateTypeDef = {  # (1)
    "Bucket": ...,
}

parent.paginate(**kwargs)
  1. See ListObjectsRequestListObjectsPaginateTypeDef

ListObjectsV2Paginator#

Type annotations and code completion for session.create_client("s3").get_paginator("list_objects_v2"). boto3 documentation

# ListObjectsV2Paginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_s3.paginator import ListObjectsV2Paginator

session = get_session()
async with session.create_client("s3") as client:  # (1)
    paginator: ListObjectsV2Paginator = client.get_paginator("list_objects_v2")  # (2)
    async for item in paginator.paginate(...):
        item: ListObjectsV2OutputTypeDef
        print(item)  # (3)
  1. client: S3Client
  2. paginator: ListObjectsV2Paginator
  3. item: ListObjectsV2OutputTypeDef

paginate#

Type annotations and code completion for ListObjectsV2Paginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    FetchOwner: bool = ...,
    StartAfter: str = ...,
    RequestPayer: RequestPayerType = ...,  # (2)
    ExpectedBucketOwner: str = ...,
    OptionalObjectAttributes: Sequence[OptionalObjectAttributesType] = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> AsyncIterator[ListObjectsV2OutputTypeDef]:  # (5)
    ...
  1. See EncodingTypeType
  2. See RequestPayerType
  3. See OptionalObjectAttributesType
  4. See PaginatorConfigTypeDef
  5. See ListObjectsV2OutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListObjectsV2RequestListObjectsV2PaginateTypeDef = {  # (1)
    "Bucket": ...,
}

parent.paginate(**kwargs)
  1. See ListObjectsV2RequestListObjectsV2PaginateTypeDef

ListPartsPaginator#

Type annotations and code completion for session.create_client("s3").get_paginator("list_parts"). boto3 documentation

# ListPartsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_s3.paginator import ListPartsPaginator

session = get_session()
async with session.create_client("s3") as client:  # (1)
    paginator: ListPartsPaginator = client.get_paginator("list_parts")  # (2)
    async for item in paginator.paginate(...):
        item: ListPartsOutputTypeDef
        print(item)  # (3)
  1. client: S3Client
  2. paginator: ListPartsPaginator
  3. item: ListPartsOutputTypeDef

paginate#

Type annotations and code completion for ListPartsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Bucket: str,
    Key: str,
    UploadId: str,
    RequestPayer: RequestPayerType = ...,  # (1)
    ExpectedBucketOwner: str = ...,
    SSECustomerAlgorithm: str = ...,
    SSECustomerKey: str = ...,
    SSECustomerKeyMD5: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[ListPartsOutputTypeDef]:  # (3)
    ...
  1. See RequestPayerType
  2. See PaginatorConfigTypeDef
  3. See ListPartsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListPartsRequestListPartsPaginateTypeDef = {  # (1)
    "Bucket": ...,
    "Key": ...,
    "UploadId": ...,
}

parent.paginate(**kwargs)
  1. See ListPartsRequestListPartsPaginateTypeDef