describe_db_cluster_endpoints¶
Operation¶
describe_db_cluster_endpoints
async
¶
describe_db_cluster_endpoints(request: DescribeDBClusterEndpointsInput | DescribeDBClusterEndpointsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBClusterEndpointsOutput
describe_db_cluster_endpoints(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterEndpointsInputDict]) -> DescribeDBClusterEndpointsOutput
Returns information about endpoints for an Amazon Aurora DB cluster.
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 |
|---|---|
DescribeDBClusterEndpointsOutput
|
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¶
DescribeDBClusterEndpointsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBClusterEndpointsInput structure.
Attributes¶
db_cluster_endpoint_identifier
class-attribute
instance-attribute
¶
db_cluster_endpoint_identifier: str | None = ...
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
db_cluster_identifier
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
filters
class-attribute
instance-attribute
¶
A set of name-value pairs that define which endpoints to include in the
output. The filters are specified as name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
Name can be one of: db-cluster-endpoint-type,
db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
db-cluster-endpoint-status. Values for the
db-cluster-endpoint-type filter can be one or more of: reader,
writer, custom. Values for the db-cluster-endpoint-custom-type
filter can be one or more of: reader, any. Values for the
db-cluster-endpoint-status filter can be one or more of: available,
creating, deleting, inactive, modifying.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBClusterEndpoints 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 you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Dictionaries¶
DescribeDBClusterEndpointsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBClusterEndpointsInput.
Attributes¶
db_cluster_endpoint_identifier
instance-attribute
¶
db_cluster_endpoint_identifier: str | None
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
db_cluster_identifier
instance-attribute
¶
db_cluster_identifier: str | None
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
A set of name-value pairs that define which endpoints to include in the
output. The filters are specified as name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
Name can be one of: db-cluster-endpoint-type,
db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
db-cluster-endpoint-status. Values for the
db-cluster-endpoint-type filter can be one or more of: reader,
writer, custom. Values for the db-cluster-endpoint-custom-type
filter can be one or more of: reader, any. Values for the
db-cluster-endpoint-status filter can be one or more of: available,
creating, deleting, inactive, modifying.
marker
instance-attribute
¶
marker: str | None
An optional pagination token provided by a previous
DescribeDBClusterEndpoints 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 you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Output¶
DescribeDBClusterEndpointsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBClusterEndpointsOutput structure.
Attributes¶
db_cluster_endpoints
class-attribute
instance-attribute
¶
db_cluster_endpoints: list[DBClusterEndpoint] | None = ...
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBClusterEndpoints 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.