DescribePartners - Amazon Redshift

DescribePartners

Returns information about the partner integrations defined for a cluster.

Request Parameters

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

AccountId

The AWS account ID that owns the cluster.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]+$

Required: Yes

ClusterIdentifier

The cluster identifier of the cluster whose partner integration is being described.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9\-]+$

Required: Yes

DatabaseName

The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.

Type: String

Length Constraints: Maximum length of 127.

Pattern: ^[\p{L}_][\p{L}\p{N}@$#_]+$

Required: No

PartnerName

The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

Type: String

Length Constraints: Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-_]+$

Required: No

Response Elements

The following element is returned by the service.

PartnerIntegrationInfoList.PartnerIntegrationInfo.N

A list of partner integrations.

Type: Array of PartnerIntegrationInfo objects

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

UnauthorizedPartnerIntegration

The partner integration is not authorized.

HTTP Status Code: 401

See Also

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