Skip to content

DescribeDBProxyEndpointsRequest

Source code in docs_src/capo_rds/types/describe_db_proxy_endpoints_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class DescribeDBProxyEndpointsRequest(TypedDict, closed=True):
    db_proxy_name: NotRequired["capo_rds.types.db_proxy_name.DBProxyName"]
    """<p>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.</p>"""
    db_proxy_endpoint_name: NotRequired[
        "capo_rds.types.db_proxy_endpoint_name.DBProxyEndpointName"
    ]
    """<p>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.</p>"""
    filters: NotRequired["capo_rds.types.filter_list.FilterList"]
    """<p>This parameter is not currently supported.</p>"""
    marker: NotRequired["capo_rds.types.string.String"]
    """<p>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 <code>MaxRecords</code>.</p>"""
    max_records: NotRequired["capo_rds.types.max_records.MaxRecords"]
    """<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"""

db_proxy_endpoint_name instance-attribute 

db_proxy_endpoint_name: NotRequired[DBProxyEndpointName]

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: NotRequired[DBProxyName]

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: NotRequired[FilterList]

This parameter is not currently supported.

marker instance-attribute 

marker: NotRequired[String]

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: NotRequired[MaxRecords]

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.