Skip to content

RDS  >  Operations  >  describe_db_proxy_target_groups

describe_db_proxy_target_groups

Operation

describe_db_proxy_target_groups async

describe_db_proxy_target_groups(request: DescribeDBProxyTargetGroupsInput | DescribeDBProxyTargetGroupsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBProxyTargetGroupsOutput
describe_db_proxy_target_groups(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBProxyTargetGroupsInputDict]) -> DescribeDBProxyTargetGroupsOutput

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

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
DescribeDBProxyTargetGroupsOutput

An instance of DescribeDBProxyTargetGroupsOutput.

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

DescribeDBProxyTargetGroupsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBProxyTargetGroupsInput structure.

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

The identifier of the DBProxy associated with the target group.

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

DescribeDBProxyTargetGroupsInputDict

Bases: TypedDict

Dictionary form of DescribeDBProxyTargetGroupsInput.

Attributes
db_proxy_name instance-attribute
db_proxy_name: Required[str]

The identifier of the DBProxy associated with the target group.

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

DescribeDBProxyTargetGroupsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBProxyTargetGroupsOutput 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.

target_groups class-attribute instance-attribute
target_groups: list[DBProxyTargetGroup] | None = ...

An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.