describe_global_clusters¶
Operation¶
describe_global_clusters
async
¶
describe_global_clusters(request: DescribeGlobalClustersInput | DescribeGlobalClustersInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeGlobalClustersOutput
describe_global_clusters(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGlobalClustersInputDict]) -> DescribeGlobalClustersOutput
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeGlobalClustersOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeGlobalClustersInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeGlobalClustersInput structure.
Attributes¶
filters
class-attribute
instance-attribute
¶
A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.
Currently, the only supported filter is region.
If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.
global_cluster_identifier
class-attribute
instance-attribute
¶
global_cluster_identifier: str | None = ...
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
- If supplied, must match an existing DBClusterIdentifier.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeGlobalClusters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
max_records
class-attribute
instance-attribute
¶
max_records: int | None = ...
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token
called a marker is included in the response so that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Dictionaries¶
DescribeGlobalClustersInputDict
¶
Bases: TypedDict
Dictionary form of DescribeGlobalClustersInput.
Attributes¶
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.
Currently, the only supported filter is region.
If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.
global_cluster_identifier
instance-attribute
¶
global_cluster_identifier: str | None
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
- If supplied, must match an existing DBClusterIdentifier.
marker
instance-attribute
¶
marker: str | None
An optional pagination token provided by a previous
DescribeGlobalClusters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
max_records
instance-attribute
¶
max_records: int | None
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token
called a marker is included in the response so that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Output¶
DescribeGlobalClustersOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeGlobalClustersOutput structure.
Attributes¶
global_clusters
class-attribute
instance-attribute
¶
global_clusters: list[GlobalCluster] | None = ...
The list of global clusters returned by this request.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeGlobalClusters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.