Request Parameters Response Elements Errors See Also

DescribeDBClusterEndpoints

Returns information about endpoints for an Amazon Neptune DB cluster.

Note

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

Request Parameters

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

DBClusterEndpointIdentifier

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

Type: String

Required: No

DBClusterIdentifier

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

Type: String

Required: No

Filters.Filter.N

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

Type: Array of Filter objects

Required: No

Marker

An optional pagination token provided by a previous DescribeDBClusterEndpoints 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

DBClusterEndpoints.DBClusterEndpointList.N

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

Type: Array of DBClusterEndpoint objects

Marker

n optional pagination token provided by a previous DescribeDBClusterEndpoints 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.

DBClusterNotFoundFault

DBClusterIdentifier does not refer to an existing DB cluster.

HTTP Status Code: 404