DescribeEndpointAccess - Amazon Redshift
Request ParametersResponse ElementsErrorsSee Also
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 (PDF).

DescribeEndpointAccess

Describes a Redshift-managed VPC endpoint.

Request Parameters

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

ClusterIdentifier

The cluster identifier associated with the described endpoint.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

EndpointName

The name of the endpoint to be described.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Marker

An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Type: String

Length Constraints: Maximum length of 2147483647.

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.

Type: Integer

Required: No

ResourceOwner

The Amazon Web Services account ID of the owner of the cluster.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

VpcId

The virtual private cloud (VPC) identifier with access to the cluster.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Response Elements

The following elements are returned by the service.

EndpointAccessList.member.N

The list of endpoints with access to the cluster.

Type: Array of EndpointAccess objects

Marker

An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Type: String

Length Constraints: Maximum length of 2147483647.

Errors

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

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

EndpointNotFound

The endpoint name doesn't refer to an existing endpoint.

HTTP Status Code: 404

InvalidClusterState

The specified cluster is not in the available state.

HTTP Status Code: 400

See Also

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