Skip to content

Paginators#

Index > DirectoryService > Paginators

Auto-generated documentation for DirectoryService type annotations stubs module mypy-boto3-ds.

DescribeClientAuthenticationSettingsPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_client_authentication_settings"). boto3 documentation

# DescribeClientAuthenticationSettingsPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeClientAuthenticationSettingsPaginator

def get_describe_client_authentication_settings_paginator() -> DescribeClientAuthenticationSettingsPaginator:
    return Session().client("ds").get_paginator("describe_client_authentication_settings")
# DescribeClientAuthenticationSettingsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeClientAuthenticationSettingsPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeClientAuthenticationSettingsPaginator = client.get_paginator("describe_client_authentication_settings")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeClientAuthenticationSettingsPaginator
  3. item: DescribeClientAuthenticationSettingsResultTypeDef

paginate#

Type annotations and code completion for DescribeClientAuthenticationSettingsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryId: str,
    Type: ClientAuthenticationTypeType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[DescribeClientAuthenticationSettingsResultTypeDef]:  # (3)
    ...
  1. See ClientAuthenticationTypeType
  2. See PaginatorConfigTypeDef
  3. See DescribeClientAuthenticationSettingsResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeClientAuthenticationSettingsRequestDescribeClientAuthenticationSettingsPaginateTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

DescribeDirectoriesPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_directories"). boto3 documentation

# DescribeDirectoriesPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeDirectoriesPaginator

def get_describe_directories_paginator() -> DescribeDirectoriesPaginator:
    return Session().client("ds").get_paginator("describe_directories")
# DescribeDirectoriesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeDirectoriesPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeDirectoriesPaginator = client.get_paginator("describe_directories")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeDirectoriesPaginator
  3. item: DescribeDirectoriesResultTypeDef

paginate#

Type annotations and code completion for DescribeDirectoriesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeDirectoriesResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeDirectoriesResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeDirectoriesRequestDescribeDirectoriesPaginateTypeDef = {  # (1)
    "DirectoryIds": ...,
}

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

DescribeDomainControllersPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_domain_controllers"). boto3 documentation

# DescribeDomainControllersPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeDomainControllersPaginator

def get_describe_domain_controllers_paginator() -> DescribeDomainControllersPaginator:
    return Session().client("ds").get_paginator("describe_domain_controllers")
# DescribeDomainControllersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeDomainControllersPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeDomainControllersPaginator = client.get_paginator("describe_domain_controllers")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeDomainControllersPaginator
  3. item: DescribeDomainControllersResultTypeDef

paginate#

Type annotations and code completion for DescribeDomainControllersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryId: str,
    DomainControllerIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeDomainControllersResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeDomainControllersResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeDomainControllersRequestDescribeDomainControllersPaginateTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

DescribeLDAPSSettingsPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_ldaps_settings"). boto3 documentation

# DescribeLDAPSSettingsPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeLDAPSSettingsPaginator

def get_describe_ldaps_settings_paginator() -> DescribeLDAPSSettingsPaginator:
    return Session().client("ds").get_paginator("describe_ldaps_settings")
# DescribeLDAPSSettingsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeLDAPSSettingsPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeLDAPSSettingsPaginator = client.get_paginator("describe_ldaps_settings")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeLDAPSSettingsPaginator
  3. item: DescribeLDAPSSettingsResultTypeDef

paginate#

Type annotations and code completion for DescribeLDAPSSettingsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryId: str,
    Type: LDAPSTypeType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[DescribeLDAPSSettingsResultTypeDef]:  # (3)
    ...
  1. See LDAPSTypeType
  2. See PaginatorConfigTypeDef
  3. See DescribeLDAPSSettingsResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeLDAPSSettingsRequestDescribeLDAPSSettingsPaginateTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

DescribeRegionsPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_regions"). boto3 documentation

# DescribeRegionsPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeRegionsPaginator

def get_describe_regions_paginator() -> DescribeRegionsPaginator:
    return Session().client("ds").get_paginator("describe_regions")
# DescribeRegionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeRegionsPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeRegionsPaginator = client.get_paginator("describe_regions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeRegionsPaginator
  3. item: DescribeRegionsResultTypeDef

paginate#

Type annotations and code completion for DescribeRegionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryId: str,
    RegionName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeRegionsResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeRegionsResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeRegionsRequestDescribeRegionsPaginateTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

DescribeSharedDirectoriesPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_shared_directories"). boto3 documentation

# DescribeSharedDirectoriesPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeSharedDirectoriesPaginator

def get_describe_shared_directories_paginator() -> DescribeSharedDirectoriesPaginator:
    return Session().client("ds").get_paginator("describe_shared_directories")
# DescribeSharedDirectoriesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeSharedDirectoriesPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeSharedDirectoriesPaginator = client.get_paginator("describe_shared_directories")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeSharedDirectoriesPaginator
  3. item: DescribeSharedDirectoriesResultTypeDef

paginate#

Type annotations and code completion for DescribeSharedDirectoriesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OwnerDirectoryId: str,
    SharedDirectoryIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeSharedDirectoriesResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeSharedDirectoriesResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeSharedDirectoriesRequestDescribeSharedDirectoriesPaginateTypeDef = {  # (1)
    "OwnerDirectoryId": ...,
}

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

DescribeSnapshotsPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_snapshots"). boto3 documentation

# DescribeSnapshotsPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeSnapshotsPaginator

def get_describe_snapshots_paginator() -> DescribeSnapshotsPaginator:
    return Session().client("ds").get_paginator("describe_snapshots")
# DescribeSnapshotsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeSnapshotsPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeSnapshotsPaginator = client.get_paginator("describe_snapshots")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeSnapshotsPaginator
  3. item: DescribeSnapshotsResultTypeDef

paginate#

Type annotations and code completion for DescribeSnapshotsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryId: str = ...,
    SnapshotIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeSnapshotsResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeSnapshotsResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeSnapshotsRequestDescribeSnapshotsPaginateTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

DescribeTrustsPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_trusts"). boto3 documentation

# DescribeTrustsPaginator usage example

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeTrustsPaginator

def get_describe_trusts_paginator() -> DescribeTrustsPaginator:
    return Session().client("ds").get_paginator("describe_trusts")
# DescribeTrustsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds.paginator import DescribeTrustsPaginator

session = Session()

client = Session().client("ds")  # (1)
paginator: DescribeTrustsPaginator = client.get_paginator("describe_trusts")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeTrustsPaginator
  3. item: DescribeTrustsResultTypeDef

paginate#

Type annotations and code completion for DescribeTrustsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryId: str = ...,
    TrustIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeTrustsResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeTrustsResultTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeTrustsRequestDescribeTrustsPaginateTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

DescribeUpdateDirectoryPaginator#

Type annotations and code completion for boto3.client("ds").get_paginator("describe_update_directory").