Paginators

Index > S3 > Paginators

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

ListMultipartUploadsPaginator

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

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")

Usage example

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.

Method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    ExpectedBucketOwner: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListMultipartUploadsOutputTypeDef]:  # (3)
    ...

1. See EncodingTypeType
2. See PaginatorConfigTypeDef
3. See ListMultipartUploadsOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef

ListObjectVersionsPaginator

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

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")

Usage example

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.

Method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    ExpectedBucketOwner: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListObjectVersionsOutputTypeDef]:  # (3)
    ...

1. See EncodingTypeType
2. See PaginatorConfigTypeDef
3. See ListObjectVersionsOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListObjectVersionsRequestListObjectVersionsPaginateTypeDef

ListObjectsPaginator

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

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")

Usage example

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.

Method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    RequestPayer: RequestPayerType = ...,  # (2)
    ExpectedBucketOwner: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> _PageIterator[ListObjectsOutputTypeDef]:  # (4)
    ...

1. See EncodingTypeType
2. See RequestPayerType
3. See PaginatorConfigTypeDef
4. See ListObjectsOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListObjectsRequestListObjectsPaginateTypeDef

ListObjectsV2Paginator

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

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")

Usage example

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.

Method definition

def paginate(
    self,
    *,
    Bucket: str,
    Delimiter: str = ...,
    EncodingType: EncodingTypeType = ...,  # (1)
    Prefix: str = ...,
    FetchOwner: bool = ...,
    StartAfter: str = ...,
    RequestPayer: RequestPayerType = ...,  # (2)
    ExpectedBucketOwner: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> _PageIterator[ListObjectsV2OutputTypeDef]:  # (4)
    ...

1. See EncodingTypeType
2. See RequestPayerType
3. See PaginatorConfigTypeDef
4. See ListObjectsV2OutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListObjectsV2RequestListObjectsV2PaginateTypeDef

ListPartsPaginator

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

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")

Usage example

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.

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)
) -> _PageIterator[ListPartsOutputTypeDef]:  # (3)
    ...

1. See RequestPayerType
2. See PaginatorConfigTypeDef
3. See ListPartsOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListPartsRequestListPartsPaginateTypeDef