DescribeDBProxyEndpoints - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeDBProxyEndpoints

Returns information about DB proxy endpoints.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*

Required: No

Filters.Filter.N

This parameter is not currently supported.

Type: Array of Filter objects

Required: No

Marker

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.

Type: String

Required: No

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.

Type: Integer

Valid Range: Minimum value of 20. Maximum value of 100.

Required: No

Response Elements

The following elements are returned by the service.

DBProxyEndpoints.member.N

The list of ProxyEndpoint objects returned by the API operation.

Type: Array of DBProxyEndpoint objects

Marker

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DBProxyEndpointNotFoundFault

The DB proxy endpoint doesn't exist.

HTTP Status Code: 404

DBProxyNotFoundFault

The specified proxy name doesn't correspond to a proxy owned by your Amazon account in the specified Amazon Region.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: