AddPartner
Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.
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 that receives data from the partner.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9\-]+$Required: Yes
- DatabaseName
-
The name of the database that receives data from the partner.
Type: String
Length Constraints: Maximum length of 127.
Pattern:
^[\p{L}_][\p{L}\p{N}@$#_]+$Required: Yes
- PartnerName
-
The name of the partner that is authorized to send data.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-_]+$Required: Yes
Response Elements
The following elements are returned by the service.
- DatabaseName
-
The name of the database that receives data from the partner.
Type: String
Length Constraints: Maximum length of 127.
Pattern:
^[\p{L}_][\p{L}\p{N}@$#_]+$ - PartnerName
-
The name of the partner that is authorized to send data.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-_]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- PartnerNotFound
-
The name of the partner was not found.
HTTP Status Code: 404
- UnauthorizedPartnerIntegration
-
The partner integration is not authorized.
HTTP Status Code: 401
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
