Skip to content

Paginators#

Index > S3 > Paginators

Auto-generated documentation for S3 type annotations stubs module mypy-boto3-s3.

ListBucketsPaginator#

Type annotations and code completion for boto3.client("s3").get_paginator("list_buckets"). boto3 documentation

# ListBucketsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3.paginator import ListBucketsPaginator

def get_list_buckets_paginator() -> ListBucketsPaginator:
    return Session().client("s3").get_paginator("list_buckets")
# ListBucketsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3.paginator import ListBucketsPaginator

session = Session()

client = Session().client("s3")  # (1)
paginator: ListBucketsPaginator = client.get_paginator("list_buckets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: S3Client
  2. paginator: ListBucketsPaginator
  3. item: ListBucketsOutputTypeDef

paginate#

Type annotations and code completion for ListBucketsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Prefix: str = ...,
    BucketRegion: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListBucketsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListBucketsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListBucketsRequestPaginateTypeDef = {  # (1)
    "Prefix": ...,
}

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

ListDirectoryBucketsPaginator#

Type annotations and code completion for boto3.client("s3").get_paginator("list_directory_buckets"). boto3 documentation

# ListDirectoryBucketsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3.paginator import ListDirectoryBucketsPaginator

def get_list_directory_buckets_paginator() -> ListDirectoryBucketsPaginator:
    return Session().client("s3").get_paginator("list_directory_buckets")
# ListDirectoryBucketsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3.paginator import ListDirectoryBucketsPaginator

session = Session()

client = Session().client("s3")  # (1)
paginator: ListDirectoryBucketsPaginator = client.get_paginator("list_directory_buckets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: S3Client
  2. paginator: ListDirectoryBucketsPaginator
  3. item: ListDirectoryBucketsOutputTypeDef

paginate#

Type annotations and code completion for ListDirectoryBucketsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListDirectoryBucketsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListDirectoryBucketsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListDirectoryBucketsRequestPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

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

ListMultipartUploadsPaginator#

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

# ListMultipartUploadsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3.paginator import ListMultipartUploadsPaginator

def get_list_multipart_uploads_paginator() -> ListMultipartUploadsPaginator:
    return Session().client("s3").get_paginator("list_multipart_uploads")
# ListMultipartUploadsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3.paginator import ListMultipartUploadsPaginator

session = Session()

client = Session().client("s3")  # (1)
paginator: ListMultipartUploadsPaginator = client.get_paginator("list_multipart_uploads")  # (2)
for item in paginator.paginate(...):
    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)
) -> PageIterator[ListMultipartUploadsOutputTypeDef]:  # (4)
    ...
  1. See EncodingTypeType
  2. See RequestPayerType
  3. See PaginatorConfigTypeDef
  4. See ListMultipartUploadsOutputTypeDef 
# paginate method usage example with argument unpacking

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

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

ListObjectVersionsPaginator#

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

# ListObjectVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3.paginator import ListObjectVersionsPaginator

def get_list_object_versions_paginator() -> ListObjectVersionsPaginator:
    return Session().client("s3").get_paginator("list_object_versions")
# ListObjectVersionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3.paginator import ListObjectVersionsPaginator

session = Session()

client = Session().client("s3")  # (1)
paginator: ListObjectVersionsPaginator = client.get_paginator("list_object_versions")  # (2)
for item in paginator.paginate(...):
    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)
) -> PageIterator[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: ListObjectVersionsRequestPaginateTypeDef = {  # (1)
    "Bucket": ...,
}

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

ListObjectsPaginator#

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

# ListObjectsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3.paginator import ListObjectsPaginator

def get_list_objects_paginator() -> ListObjectsPaginator:
    return Session().client("s3").get_paginator("list_objects")
# ListObjectsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3.paginator import ListObjectsPaginator

session = Session()

client = Session().client("s3")  # (1)
paginator: ListObjectsPaginator = client.get_paginator("list_objects")  # (2)
for item in paginator.paginate(...):
    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)
) -> PageIterator[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: ListObjectsRequestPaginateTypeDef = {  # (1)
    "Bucket": ...,
}

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

ListObjectsV2Paginator#

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

# ListObjectsV2Paginator usage example

from boto3.session import Session

from mypy_boto3_s3.paginator import ListObjectsV2Paginator

def get_list_objects_v2_paginator() -> ListObjectsV2Paginator:
    return Session().client("s3").get_paginator("list_objects_v2")
# ListObjectsV2Paginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3.paginator import ListObjectsV2Paginator

session = Session()

client = Session().client("s3")  # (1)
paginator: ListObjectsV2Paginator = client.get_paginator("list_objects_v2")  # (2)
for item in paginator.paginate(...):
    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)
) -> PageIterator[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: ListObjectsV2RequestPaginateTypeDef = {  # (1)
    "Bucket": ...,
}

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

ListPartsPaginator#

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

# ListPartsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3.paginator import ListPartsPaginator

def get_list_parts_paginator() -> ListPartsPaginator:
    return Session().client("s3").get_paginator("list_parts")
# ListPartsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3.paginator import ListPartsPaginator

session = Session()

client = Session().client("s3")  # (1)
paginator: ListPartsPaginator = client.get_paginator("list_parts")  # (2)
for item in paginator.paginate(...):
    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: Union[str, bytes] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ListPartsOutputTypeDef]:  # (3)
    ...
  1. See RequestPayerType
  2. See PaginatorConfigTypeDef
  3. See ListPartsOutputTypeDef 
# paginate method usage example with argument unpacking

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

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