Skip to content

/AWS1/CL_NEP=>DESCRIBEDBCLUSTERENDPOINTS()

About DescribeDBClusterEndpoints

Returns information about endpoints for an Amazon Neptune DB cluster.

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

Method Signature

IMPORTING

Optional arguments:

IV_DBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

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

IV_DBCLUSTERENDPOINTID TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

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

IT_FILTERS TYPE /AWS1/CL_NEPFILTER=>TT_FILTERLIST TT_FILTERLIST

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.

IV_MAXRECORDS TYPE /AWS1/NEPINTEGEROPTIONAL /AWS1/NEPINTEGEROPTIONAL

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.

IV_MARKER TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_NEPDBCLUSTENDPTMSG /AWS1/CL_NEPDBCLUSTENDPTMSG