ModifyIntegration - Amazon Redshift

ModifyIntegration

Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.

Request Parameters

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

IntegrationArn

The unique identifier of the integration to modify.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^arn:aws[a-z\-]*:redshift:[a-z0-9\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Description

A new description for the integration.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^.*$

Required: No

IntegrationName

A new name for the integration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$

Required: No

Response Elements

The following elements are returned by the service.

AdditionalEncryptionContext
AdditionalEncryptionContext.entry.N.key (key)
AdditionalEncryptionContext.entry.N.value (value)

The encryption context for the integration. For more information, see Encryption context in the AWS Key Management Service Developer Guide.

Type: String to string map

Key Length Constraints: Maximum length of 2147483647.

Value Length Constraints: Maximum length of 2147483647.

CreateTime

The time (UTC) when the integration was created.

Type: Timestamp

Description

The description of the integration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^.*$

Errors.IntegrationError.N

Any errors associated with the integration.

Type: Array of IntegrationError objects

IntegrationArn

The Amazon Resource Name (ARN) of the integration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^arn:aws[a-z\-]*:redshift:[a-z0-9\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

IntegrationName

The name of the integration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$

KMSKeyId

The AWS Key Management Service (AWS KMS) key identifier for the key used to encrypt the integration.

Type: String

Length Constraints: Maximum length of 2147483647.

SourceArn

The Amazon Resource Name (ARN) of the database used as the source for replication.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^arn:aws[a-z\-]*:(s3|dynamodb):.*:.*:[a-zA-Z0-9._\-\/]+$

Status

The current status of the integration.

Type: String

Valid Values: creating | active | modifying | failed | deleting | syncing | needs_attention

Tags.Tag.N

The list of tags associated with the integration.

Type: Array of Tag objects

TargetArn

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:redshift(-serverless)?:[a-z0-9\-]+:[0-9]{12}:(namespace\/|namespace:)[a-z0-9\-]+$

Errors

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

IntegrationAlreadyExistsFault

The integration you are trying to create already exists.

HTTP Status Code: 400

IntegrationConflictOperationFault

A conflicting conditional operation is currently in progress against this resource. This typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.

HTTP Status Code: 400

IntegrationConflictStateFault

The integration is in an invalid state and can't perform the requested operation.

HTTP Status Code: 400

IntegrationNotFoundFault

The integration can't be found.

HTTP Status Code: 404

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: