describe_db_proxies¶
Operation¶
describe_db_proxies
¶
describe_db_proxies(request: DescribeDBProxiesInput | DescribeDBProxiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBProxiesInputDict]) -> DescribeDBProxiesOutput
Returns information about DB proxies.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBProxiesInput | DescribeDBProxiesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeDBProxiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBProxiesOutput
|
An instance of |
describe_db_proxies
async
¶
describe_db_proxies(request: DescribeDBProxiesInput | DescribeDBProxiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBProxiesInputDict]) -> DescribeDBProxiesOutput
Returns information about DB proxies.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBProxiesInput | DescribeDBProxiesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeDBProxiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBProxiesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeDBProxiesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBProxiesInput.
Attributes¶
db_proxy_name
instance-attribute
¶
db_proxy_name: str | None
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
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.
DescribeDBProxiesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBProxiesInput structure.
Attributes¶
db_proxy_name
class-attribute
instance-attribute
¶
db_proxy_name: str | None = ...
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
filters
class-attribute
instance-attribute
¶
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.
Output¶
DescribeDBProxiesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBProxiesOutput structure.
Attributes¶
db_proxies
class-attribute
instance-attribute
¶
A return value representing an arbitrary number of DBProxy data
structures.
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
¶
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.