Request Parameters Response Elements Errors Examples See Also

ModifyIntegration

Modifies a zero-ETL integration with Amazon Redshift.

Note

Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.

Request Parameters

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

IntegrationIdentifier

The unique identifier of the integration to modify.

Type: String

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

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

Required: Yes

DataFilter

A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.

Type: String

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

Pattern: [a-zA-Z0-9_ "\\\-$,*.:?+\/]*

Required: No

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

CreateTime

The time when the integration was created, in Universal Coordinated Time (UTC).

Type: Timestamp

DataFilter

Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.

Type: String

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

Pattern: [a-zA-Z0-9_ "\\\-$,*.:?+\/]*

Description

A description of the integration.

Type: String

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

Pattern: .*

Errors.IntegrationError.N

Any errors associated with the integration.

Type: Array of IntegrationError objects

IntegrationArn

The ARN of the integration.

Type: String

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

Pattern: arn:aws[a-z\-]*:rds(-[a-z]*)?:[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 System (AWS KMS) key identifier for the key used to to encrypt the integration.

Type: String

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\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*

Status

The current status of the integration.

Type: String

Tags.Tag.N

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Type: Array of Tag objects

TargetArn

The ARN of the Redshift data warehouse used as the target for replication.

Type: String

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

Errors

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

IntegrationConflictOperationFault

A conflicting conditional operation is currently in progress against this resource. 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

IntegrationNotFoundFault

The specified integration could not be found.

HTTP Status Code: 404

InvalidIntegrationStateFault

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

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ModifyIntegration.

Sample Request



https://rds.us-east-1.amazonaws.com/
   ?Action=ModifyIntegration
   &IntegrationIdentifier=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
   &IntegrationName=my-renamed-integration
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T183020Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=3d85bdfaf13861e93a9528824d9876ed87e6e01aaf43a962ce6f2a39247cf33a

Sample Response



<ModifyIntegrationResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
    <ModifyIntegrationResult>
        <SourceArn>arn:aws:rds:us-east-1:123456789012:cluster:my-cluster</SourceArn>
        <IntegrationName>my-renamed-integration</IntegrationName>
        <IntegrationArn>arn:aws:rds:us-east-1:123456789012:integration:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</IntegrationArn>
        <TargetArn>arn:aws:redshift-serverless:us-east-1:123456789012:namespace/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</TargetArn>
        <Tags/>
        <DataFilter>include: *.*</DataFilter>
        <CreateTime>2023-12-28T17:20:20.629Z</CreateTime>
        <KMSKeyId>arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa</KMSKeyId>
        <Status>active</Status>
    </ModifyIntegrationResult>
    <ResponseMetadata>
        <RequestId>7581f213-c5a1-42a5-b2cd-e151a1e1c129</RequestId>
    </ResponseMetadata>
</ModifyIntegrationResponse>