describe_db_proxy_endpoints¶
Operation¶
async
¶
describe_db_proxy_endpoints(input: DescribeDBProxyEndpointsInput, plugins: list[Plugin] | None = None) -> DescribeDBProxyEndpointsOutput
Returns information about DB proxy endpoints.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeDBProxyEndpointsInput
|
An instance of |
required |
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 |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBProxyEndpointsInput structure.
Attributes¶
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.
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.
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
This parameter is not currently supported.
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.
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¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBProxyEndpointsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
db_proxy_endpoints: list[DBProxyEndpoint] | None = ...
The list of ProxyEndpoint objects returned by the API operation.
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.
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.