RDS / Client / describe_db_proxy_endpoints

describe_db_proxy_endpoints#

RDS.Client.describe_db_proxy_endpoints(**kwargs)#

Returns information about DB proxy endpoints.

See also: AWS API Documentation

Request Syntax

response = client.describe_db_proxy_endpoints(
    DBProxyName='string',
    DBProxyEndpointName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)
Parameters:

  • DBProxyName (string) – 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.

  • DBProxyEndpointName (string) – 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.

  • Filters (list) –

    This parameter is not currently supported.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

      Note

      Currently, wildcards are not supported in filters.

      The following actions can be filtered:

      • DescribeDBClusterBacktracks

      • DescribeDBClusterEndpoints

      • DescribeDBClusters

      • DescribeDBInstances

      • DescribePendingMaintenanceActions

      • Name (string) – [REQUIRED]

        The name of the filter. Filter names are case-sensitive.

      • Values (list) – [REQUIRED]

        One or more filter values. Filter values are case-sensitive.

        • (string) –

  • Marker (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.

  • MaxRecords (integer) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'DBProxyEndpoints': [
        {
            'DBProxyEndpointName': 'string',
            'DBProxyEndpointArn': 'string',
            'DBProxyName': 'string',
            'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
            'VpcId': 'string',
            'VpcSecurityGroupIds': [
                'string',
            ],
            'VpcSubnetIds': [
                'string',
            ],
            'Endpoint': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'TargetRole': 'READ_WRITE'|'READ_ONLY',
            'IsDefault': True|False
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –

    • DBProxyEndpoints (list) –

      The list of ProxyEndpoint objects returned by the API operation.

      • (dict) –

        The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.

        This data type is used as a response element in the DescribeDBProxyEndpoints operation.

        • DBProxyEndpointName (string) –

          The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.

        • DBProxyEndpointArn (string) –

          The Amazon Resource Name (ARN) for the DB proxy endpoint.

        • DBProxyName (string) –

          The identifier for the DB proxy that is associated with this DB proxy endpoint.

        • Status (string) –

          The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

        • VpcId (string) –

          Provides the VPC ID of the DB proxy endpoint.

        • VpcSecurityGroupIds (list) –

          Provides a list of VPC security groups that the DB proxy endpoint belongs to.

          • (string) –

        • VpcSubnetIds (list) –

          The EC2 subnet IDs for the DB proxy endpoint.

          • (string) –

        • Endpoint (string) –

          The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

        • CreatedDate (datetime) –

          The date and time when the DB proxy endpoint was first created.

        • TargetRole (string) –

          A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

        • IsDefault (boolean) –

          Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

    • Marker (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.

Exceptions

  • RDS.Client.exceptions.DBProxyNotFoundFault

  • RDS.Client.exceptions.DBProxyEndpointNotFoundFault