Skip to content

RDS  >  Operations  >  describe_db_proxy_endpoints

describe_db_proxy_endpoints

Operation

describe_db_proxy_endpoints async

describe_db_proxy_endpoints(request: DescribeDBProxyEndpointsInput | DescribeDBProxyEndpointsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBProxyEndpointsOutput
describe_db_proxy_endpoints(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBProxyEndpointsInputDict]) -> DescribeDBProxyEndpointsOutput

Returns information about DB proxy endpoints.

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
DescribeDBProxyEndpointsOutput

An instance of DescribeDBProxyEndpointsOutput.

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

DescribeDBProxyEndpointsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBProxyEndpointsInput structure.

Attributes
db_proxy_endpoint_name class-attribute instance-attribute
db_proxy_endpoint_name: str | None = ...

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

db_proxy_name class-attribute instance-attribute
db_proxy_name: str | None = ...

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter is not currently supported.

marker class-attribute instance-attribute
marker: str | None = ...

An optional pagination token provided by a previous 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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Dictionaries

DescribeDBProxyEndpointsInputDict

Bases: TypedDict

Dictionary form of DescribeDBProxyEndpointsInput.

Attributes
db_proxy_endpoint_name instance-attribute
db_proxy_endpoint_name: str | None

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

db_proxy_name instance-attribute
db_proxy_name: str | None

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter is not currently supported.

marker instance-attribute
marker: str | None

An optional pagination token provided by a previous 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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Output

DescribeDBProxyEndpointsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBProxyEndpointsOutput structure.

Attributes

db_proxy_endpoints class-attribute instance-attribute
db_proxy_endpoints: list[DBProxyEndpoint] | None = ...

The list of ProxyEndpoint objects returned by the API operation.

marker class-attribute instance-attribute
marker: str | None = ...

An optional pagination token provided by a previous 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
response_metadata: ResponseMetadata = ...

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.