Paginators#
Auto-generated documentation for DocDB type annotations stubs module mypy-boto3-docdb.
DescribeCertificatesPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_certificates")
.
boto3 documentation
# DescribeCertificatesPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeCertificatesPaginator
def get_describe_certificates_paginator() -> DescribeCertificatesPaginator:
return Session().client("docdb").get_paginator("describe_certificates")
# DescribeCertificatesPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeCertificatesPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeCertificatesPaginator = client.get_paginator("describe_certificates") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeCertificatesPaginator
- item: CertificateMessageTypeDef
paginate#
Type annotations and code completion for DescribeCertificatesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
CertificateIdentifier: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[CertificateMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef = { # (1)
"CertificateIdentifier": ...,
}
parent.paginate(**kwargs)
DescribeDBClusterParameterGroupsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_cluster_parameter_groups")
.
boto3 documentation
# DescribeDBClusterParameterGroupsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClusterParameterGroupsPaginator
def get_describe_db_cluster_parameter_groups_paginator() -> DescribeDBClusterParameterGroupsPaginator:
return Session().client("docdb").get_paginator("describe_db_cluster_parameter_groups")
# DescribeDBClusterParameterGroupsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClusterParameterGroupsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeDBClusterParameterGroupsPaginator = client.get_paginator("describe_db_cluster_parameter_groups") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeDBClusterParameterGroupsPaginator
- item: DBClusterParameterGroupsMessageTypeDef
paginate#
Type annotations and code completion for DescribeDBClusterParameterGroupsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
DBClusterParameterGroupName: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DBClusterParameterGroupsMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef = { # (1)
"DBClusterParameterGroupName": ...,
}
parent.paginate(**kwargs)
DescribeDBClusterParametersPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_cluster_parameters")
.
boto3 documentation
# DescribeDBClusterParametersPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClusterParametersPaginator
def get_describe_db_cluster_parameters_paginator() -> DescribeDBClusterParametersPaginator:
return Session().client("docdb").get_paginator("describe_db_cluster_parameters")
# DescribeDBClusterParametersPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClusterParametersPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeDBClusterParametersPaginator = client.get_paginator("describe_db_cluster_parameters") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeDBClusterParametersPaginator
- item: DBClusterParameterGroupDetailsTypeDef
paginate#
Type annotations and code completion for DescribeDBClusterParametersPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
DBClusterParameterGroupName: str,
Source: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DBClusterParameterGroupDetailsTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef = { # (1)
"DBClusterParameterGroupName": ...,
}
parent.paginate(**kwargs)
DescribeDBClusterSnapshotsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_cluster_snapshots")
.
boto3 documentation
# DescribeDBClusterSnapshotsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClusterSnapshotsPaginator
def get_describe_db_cluster_snapshots_paginator() -> DescribeDBClusterSnapshotsPaginator:
return Session().client("docdb").get_paginator("describe_db_cluster_snapshots")
# DescribeDBClusterSnapshotsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClusterSnapshotsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeDBClusterSnapshotsPaginator = client.get_paginator("describe_db_cluster_snapshots") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeDBClusterSnapshotsPaginator
- item: DBClusterSnapshotMessageTypeDef
paginate#
Type annotations and code completion for DescribeDBClusterSnapshotsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
DBClusterIdentifier: str = ...,
DBClusterSnapshotIdentifier: str = ...,
SnapshotType: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
IncludeShared: bool = ...,
IncludePublic: bool = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DBClusterSnapshotMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef = { # (1)
"DBClusterIdentifier": ...,
}
parent.paginate(**kwargs)
DescribeDBClustersPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_clusters")
.
boto3 documentation
# DescribeDBClustersPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClustersPaginator
def get_describe_db_clusters_paginator() -> DescribeDBClustersPaginator:
return Session().client("docdb").get_paginator("describe_db_clusters")
# DescribeDBClustersPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBClustersPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeDBClustersPaginator = client.get_paginator("describe_db_clusters") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeDBClustersPaginator
- item: DBClusterMessageTypeDef
paginate#
Type annotations and code completion for DescribeDBClustersPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
DBClusterIdentifier: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DBClusterMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef = { # (1)
"DBClusterIdentifier": ...,
}
parent.paginate(**kwargs)
DescribeDBEngineVersionsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_engine_versions")
.
boto3 documentation
# DescribeDBEngineVersionsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBEngineVersionsPaginator
def get_describe_db_engine_versions_paginator() -> DescribeDBEngineVersionsPaginator:
return Session().client("docdb").get_paginator("describe_db_engine_versions")
# DescribeDBEngineVersionsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBEngineVersionsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeDBEngineVersionsPaginator = client.get_paginator("describe_db_engine_versions") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeDBEngineVersionsPaginator
- item: DBEngineVersionMessageTypeDef
paginate#
Type annotations and code completion for DescribeDBEngineVersionsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
Engine: str = ...,
EngineVersion: str = ...,
DBParameterGroupFamily: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
DefaultOnly: bool = ...,
ListSupportedCharacterSets: bool = ...,
ListSupportedTimezones: bool = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DBEngineVersionMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef = { # (1)
"Engine": ...,
}
parent.paginate(**kwargs)
DescribeDBInstancesPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_instances")
.
boto3 documentation
# DescribeDBInstancesPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBInstancesPaginator
def get_describe_db_instances_paginator() -> DescribeDBInstancesPaginator:
return Session().client("docdb").get_paginator("describe_db_instances")
# DescribeDBInstancesPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBInstancesPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeDBInstancesPaginator = client.get_paginator("describe_db_instances") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeDBInstancesPaginator
- item: DBInstanceMessageTypeDef
paginate#
Type annotations and code completion for DescribeDBInstancesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
DBInstanceIdentifier: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DBInstanceMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef = { # (1)
"DBInstanceIdentifier": ...,
}
parent.paginate(**kwargs)
DescribeDBSubnetGroupsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_subnet_groups")
.
boto3 documentation
# DescribeDBSubnetGroupsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBSubnetGroupsPaginator
def get_describe_db_subnet_groups_paginator() -> DescribeDBSubnetGroupsPaginator:
return Session().client("docdb").get_paginator("describe_db_subnet_groups")
# DescribeDBSubnetGroupsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeDBSubnetGroupsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeDBSubnetGroupsPaginator = client.get_paginator("describe_db_subnet_groups") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeDBSubnetGroupsPaginator
- item: DBSubnetGroupMessageTypeDef
paginate#
Type annotations and code completion for DescribeDBSubnetGroupsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
DBSubnetGroupName: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DBSubnetGroupMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef = { # (1)
"DBSubnetGroupName": ...,
}
parent.paginate(**kwargs)
DescribeEventSubscriptionsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_event_subscriptions")
.
boto3 documentation
# DescribeEventSubscriptionsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeEventSubscriptionsPaginator
def get_describe_event_subscriptions_paginator() -> DescribeEventSubscriptionsPaginator:
return Session().client("docdb").get_paginator("describe_event_subscriptions")
# DescribeEventSubscriptionsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeEventSubscriptionsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeEventSubscriptionsPaginator = client.get_paginator("describe_event_subscriptions") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeEventSubscriptionsPaginator
- item: EventSubscriptionsMessageTypeDef
paginate#
Type annotations and code completion for DescribeEventSubscriptionsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
SubscriptionName: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[EventSubscriptionsMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef = { # (1)
"SubscriptionName": ...,
}
parent.paginate(**kwargs)
DescribeEventsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_events")
.
boto3 documentation
# DescribeEventsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeEventsPaginator
def get_describe_events_paginator() -> DescribeEventsPaginator:
return Session().client("docdb").get_paginator("describe_events")
# DescribeEventsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeEventsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeEventsPaginator = client.get_paginator("describe_events") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeEventsPaginator
- item: EventsMessageTypeDef
paginate#
Type annotations and code completion for DescribeEventsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
SourceIdentifier: str = ...,
SourceType: SourceTypeType = ..., # (1)
StartTime: TimestampTypeDef = ...,
EndTime: TimestampTypeDef = ...,
Duration: int = ...,
EventCategories: Sequence[str] = ...,
Filters: Sequence[FilterTypeDef] = ..., # (2)
PaginationConfig: PaginatorConfigTypeDef = ..., # (3)
) -> _PageIterator[EventsMessageTypeDef]: # (4)
...
- See SourceTypeType
- See FilterTypeDef
- See PaginatorConfigTypeDef
- See EventsMessageTypeDef
# paginate method usage example with argument unpacking
kwargs: DescribeEventsMessageDescribeEventsPaginateTypeDef = { # (1)
"SourceIdentifier": ...,
}
parent.paginate(**kwargs)
DescribeGlobalClustersPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_global_clusters")
.
boto3 documentation
# DescribeGlobalClustersPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeGlobalClustersPaginator
def get_describe_global_clusters_paginator() -> DescribeGlobalClustersPaginator:
return Session().client("docdb").get_paginator("describe_global_clusters")
# DescribeGlobalClustersPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeGlobalClustersPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeGlobalClustersPaginator = client.get_paginator("describe_global_clusters") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeGlobalClustersPaginator
- item: GlobalClustersMessageTypeDef
paginate#
Type annotations and code completion for DescribeGlobalClustersPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
GlobalClusterIdentifier: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[GlobalClustersMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef = { # (1)
"GlobalClusterIdentifier": ...,
}
parent.paginate(**kwargs)
DescribeOrderableDBInstanceOptionsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_orderable_db_instance_options")
.
boto3 documentation
# DescribeOrderableDBInstanceOptionsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeOrderableDBInstanceOptionsPaginator
def get_describe_orderable_db_instance_options_paginator() -> DescribeOrderableDBInstanceOptionsPaginator:
return Session().client("docdb").get_paginator("describe_orderable_db_instance_options")
# DescribeOrderableDBInstanceOptionsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribeOrderableDBInstanceOptionsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribeOrderableDBInstanceOptionsPaginator = client.get_paginator("describe_orderable_db_instance_options") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribeOrderableDBInstanceOptionsPaginator
- item: OrderableDBInstanceOptionsMessageTypeDef
paginate#
Type annotations and code completion for DescribeOrderableDBInstanceOptionsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
Engine: str,
EngineVersion: str = ...,
DBInstanceClass: str = ...,
LicenseModel: str = ...,
Vpc: bool = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[OrderableDBInstanceOptionsMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef = { # (1)
"Engine": ...,
}
parent.paginate(**kwargs)
DescribePendingMaintenanceActionsPaginator#
Type annotations and code completion for boto3.client("docdb").get_paginator("describe_pending_maintenance_actions")
.
boto3 documentation
# DescribePendingMaintenanceActionsPaginator usage example
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribePendingMaintenanceActionsPaginator
def get_describe_pending_maintenance_actions_paginator() -> DescribePendingMaintenanceActionsPaginator:
return Session().client("docdb").get_paginator("describe_pending_maintenance_actions")
# DescribePendingMaintenanceActionsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_docdb.paginator import DescribePendingMaintenanceActionsPaginator
session = Session()
client = Session().client("docdb") # (1)
paginator: DescribePendingMaintenanceActionsPaginator = client.get_paginator("describe_pending_maintenance_actions") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: DocDBClient
- paginator: DescribePendingMaintenanceActionsPaginator
- item: PendingMaintenanceActionsMessageTypeDef
paginate#
Type annotations and code completion for DescribePendingMaintenanceActionsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
ResourceIdentifier: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[PendingMaintenanceActionsMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef = { # (1)
"ResourceIdentifier": ...,
}
parent.paginate(**kwargs)