Skip to content

Paginators#

Index > Transfer > Paginators

Auto-generated documentation for Transfer type annotations stubs module types-boto3-transfer.

ListAccessesPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_accesses"). boto3 documentation

# ListAccessesPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListAccessesPaginator

def get_list_accesses_paginator() -> ListAccessesPaginator:
    return Session().client("transfer").get_paginator("list_accesses")
# ListAccessesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListAccessesPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListAccessesPaginator = client.get_paginator("list_accesses")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListAccessesPaginator
  3. item: PageIterator[ListAccessesResponseTypeDef]

paginate#

Type annotations and code completion for ListAccessesPaginator.paginate method.

# paginate method definition

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

kwargs: ListAccessesRequestPaginateTypeDef = {  # (1)
    "ServerId": ...,
}

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

ListAgreementsPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_agreements"). boto3 documentation

# ListAgreementsPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListAgreementsPaginator

def get_list_agreements_paginator() -> ListAgreementsPaginator:
    return Session().client("transfer").get_paginator("list_agreements")
# ListAgreementsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListAgreementsPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListAgreementsPaginator = client.get_paginator("list_agreements")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListAgreementsPaginator
  3. item: PageIterator[ListAgreementsResponseTypeDef]

paginate#

Type annotations and code completion for ListAgreementsPaginator.paginate method.

# paginate method definition

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

kwargs: ListAgreementsRequestPaginateTypeDef = {  # (1)
    "ServerId": ...,
}

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

ListCertificatesPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_certificates"). boto3 documentation

# ListCertificatesPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListCertificatesPaginator

def get_list_certificates_paginator() -> ListCertificatesPaginator:
    return Session().client("transfer").get_paginator("list_certificates")
# ListCertificatesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListCertificatesPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListCertificatesPaginator = client.get_paginator("list_certificates")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListCertificatesPaginator
  3. item: PageIterator[ListCertificatesResponseTypeDef]

paginate#

Type annotations and code completion for ListCertificatesPaginator.paginate method.

# paginate method definition

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

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

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

ListConnectorsPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_connectors"). boto3 documentation

# ListConnectorsPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListConnectorsPaginator

def get_list_connectors_paginator() -> ListConnectorsPaginator:
    return Session().client("transfer").get_paginator("list_connectors")
# ListConnectorsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListConnectorsPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListConnectorsPaginator = client.get_paginator("list_connectors")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListConnectorsPaginator
  3. item: PageIterator[ListConnectorsResponseTypeDef]

paginate#

Type annotations and code completion for ListConnectorsPaginator.paginate method.

# paginate method definition

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

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

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

ListExecutionsPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_executions"). boto3 documentation

# ListExecutionsPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListExecutionsPaginator

def get_list_executions_paginator() -> ListExecutionsPaginator:
    return Session().client("transfer").get_paginator("list_executions")
# ListExecutionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListExecutionsPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListExecutionsPaginator = client.get_paginator("list_executions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListExecutionsPaginator
  3. item: PageIterator[ListExecutionsResponseTypeDef]

paginate#

Type annotations and code completion for ListExecutionsPaginator.paginate method.

# paginate method definition

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

kwargs: ListExecutionsRequestPaginateTypeDef = {  # (1)
    "WorkflowId": ...,
}

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

ListFileTransferResultsPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_file_transfer_results"). boto3 documentation

# ListFileTransferResultsPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListFileTransferResultsPaginator

def get_list_file_transfer_results_paginator() -> ListFileTransferResultsPaginator:
    return Session().client("transfer").get_paginator("list_file_transfer_results")
# ListFileTransferResultsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListFileTransferResultsPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListFileTransferResultsPaginator = client.get_paginator("list_file_transfer_results")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListFileTransferResultsPaginator
  3. item: PageIterator[ListFileTransferResultsResponseTypeDef]

paginate#

Type annotations and code completion for ListFileTransferResultsPaginator.paginate method.

# paginate method definition

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

kwargs: ListFileTransferResultsRequestPaginateTypeDef = {  # (1)
    "ConnectorId": ...,
    "TransferId": ...,
}

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

ListProfilesPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_profiles"). boto3 documentation

# ListProfilesPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListProfilesPaginator

def get_list_profiles_paginator() -> ListProfilesPaginator:
    return Session().client("transfer").get_paginator("list_profiles")
# ListProfilesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListProfilesPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListProfilesPaginator = client.get_paginator("list_profiles")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListProfilesPaginator
  3. item: PageIterator[ListProfilesResponseTypeDef]

paginate#

Type annotations and code completion for ListProfilesPaginator.paginate method.

# paginate method definition

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

kwargs: ListProfilesRequestPaginateTypeDef = {  # (1)
    "ProfileType": ...,
}

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

ListSecurityPoliciesPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_security_policies"). boto3 documentation

# ListSecurityPoliciesPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListSecurityPoliciesPaginator

def get_list_security_policies_paginator() -> ListSecurityPoliciesPaginator:
    return Session().client("transfer").get_paginator("list_security_policies")
# ListSecurityPoliciesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListSecurityPoliciesPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListSecurityPoliciesPaginator = client.get_paginator("list_security_policies")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListSecurityPoliciesPaginator
  3. item: PageIterator[ListSecurityPoliciesResponseTypeDef]

paginate#

Type annotations and code completion for ListSecurityPoliciesPaginator.paginate method.

# paginate method definition

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

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

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

ListServersPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_servers"). boto3 documentation

# ListServersPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListServersPaginator

def get_list_servers_paginator() -> ListServersPaginator:
    return Session().client("transfer").get_paginator("list_servers")
# ListServersPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListServersPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListServersPaginator = client.get_paginator("list_servers")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListServersPaginator
  3. item: PageIterator[ListServersResponseTypeDef]

paginate#

Type annotations and code completion for ListServersPaginator.paginate method.

# paginate method definition

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

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

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

ListTagsForResourcePaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_tags_for_resource"). boto3 documentation

# ListTagsForResourcePaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListTagsForResourcePaginator

def get_list_tags_for_resource_paginator() -> ListTagsForResourcePaginator:
    return Session().client("transfer").get_paginator("list_tags_for_resource")
# ListTagsForResourcePaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListTagsForResourcePaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListTagsForResourcePaginator
  3. item: PageIterator[ListTagsForResourceResponseTypeDef]

paginate#

Type annotations and code completion for ListTagsForResourcePaginator.paginate method.

# paginate method definition

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

kwargs: ListTagsForResourceRequestPaginateTypeDef = {  # (1)
    "Arn": ...,
}

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

ListUsersPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_users"). boto3 documentation

# ListUsersPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListUsersPaginator

def get_list_users_paginator() -> ListUsersPaginator:
    return Session().client("transfer").get_paginator("list_users")
# ListUsersPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListUsersPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListUsersPaginator = client.get_paginator("list_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListUsersPaginator
  3. item: PageIterator[ListUsersResponseTypeDef]

paginate#

Type annotations and code completion for ListUsersPaginator.paginate method.

# paginate method definition

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

kwargs: ListUsersRequestPaginateTypeDef = {  # (1)
    "ServerId": ...,
}

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

ListWebAppsPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_web_apps"). boto3 documentation

# ListWebAppsPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListWebAppsPaginator

def get_list_web_apps_paginator() -> ListWebAppsPaginator:
    return Session().client("transfer").get_paginator("list_web_apps")
# ListWebAppsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListWebAppsPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListWebAppsPaginator = client.get_paginator("list_web_apps")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListWebAppsPaginator
  3. item: PageIterator[ListWebAppsResponseTypeDef]

paginate#

Type annotations and code completion for ListWebAppsPaginator.paginate method.

# paginate method definition

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

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

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

ListWorkflowsPaginator#

Type annotations and code completion for boto3.client("transfer").get_paginator("list_workflows"). boto3 documentation

# ListWorkflowsPaginator usage example

from boto3.session import Session

from types_boto3_transfer.paginator import ListWorkflowsPaginator

def get_list_workflows_paginator() -> ListWorkflowsPaginator:
    return Session().client("transfer").get_paginator("list_workflows")
# ListWorkflowsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_transfer.paginator import ListWorkflowsPaginator

session = Session()

client = Session().client("transfer")  # (1)
paginator: ListWorkflowsPaginator = client.get_paginator("list_workflows")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TransferClient
  2. paginator: ListWorkflowsPaginator
  3. item: PageIterator[ListWorkflowsResponseTypeDef]

paginate#

Type annotations and code completion for ListWorkflowsPaginator.paginate method.

# paginate method definition

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

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

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