Skip to content

RDS  >  Operations  >  describe_db_proxy_targets

describe_db_proxy_targets

Operation

describe_db_proxy_targets async

describe_db_proxy_targets(request: DescribeDBProxyTargetsInput | DescribeDBProxyTargetsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBProxyTargetsOutput
describe_db_proxy_targets(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBProxyTargetsInputDict]) -> DescribeDBProxyTargetsOutput

Returns information about DBProxyTarget objects. This API supports pagination.

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
DescribeDBProxyTargetsOutput

An instance of DescribeDBProxyTargetsOutput.

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

DescribeDBProxyTargetsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBProxyTargetsInput structure.

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

The identifier of the DBProxyTarget to describe.

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.

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

The identifier of the DBProxyTargetGroup to describe.

Dictionaries

DescribeDBProxyTargetsInputDict

Bases: TypedDict

Dictionary form of DescribeDBProxyTargetsInput.

Attributes
db_proxy_name instance-attribute
db_proxy_name: Required[str]

The identifier of the DBProxyTarget to describe.

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.

target_group_name instance-attribute
target_group_name: str | None

The identifier of the DBProxyTargetGroup to describe.

Output

DescribeDBProxyTargetsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBProxyTargetsOutput structure.

Attributes

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.

targets class-attribute instance-attribute
targets: list[DBProxyTarget] | None = ...

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.