Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ModifyIntegration

Modifies a Zero-ETL integration in the caller's account.

Request Syntax


{
   "DataFilter": "string",
   "Description": "string",
   "IntegrationConfig": { 
      "ContinuousSync": boolean,
      "RefreshInterval": "string",
      "SourceProperties": { 
         "string" : "string" 
      }
   },
   "IntegrationIdentifier": "string",
   "IntegrationName": "string"
}

Request Parameters

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

The request accepts the following data in JSON format.

DataFilter

Selects source tables for the integration using Maxwell filter syntax.

Type: String

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

Required: No

Description

A description of the integration.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\S\s]*

Required: No

IntegrationConfig

The configuration settings for the integration. Currently, only the RefreshInterval can be modified.

Type: IntegrationConfig object

Required: No

IntegrationIdentifier

The Amazon Resource Name (ARN) for the integration.

Type: String

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

Required: Yes

IntegrationName

A unique name for an integration in AWS Glue.

Type: String

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

Required: No

Response Syntax


{
   "AdditionalEncryptionContext": { 
      "string" : "string" 
   },
   "CreateTime": number,
   "DataFilter": "string",
   "Description": "string",
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string"
      }
   ],
   "IntegrationArn": "string",
   "IntegrationConfig": { 
      "ContinuousSync": boolean,
      "RefreshInterval": "string",
      "SourceProperties": { 
         "string" : "string" 
      }
   },
   "IntegrationName": "string",
   "KmsKeyId": "string",
   "SourceArn": "string",
   "Status": "string",
   "Tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "TargetArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AdditionalEncryptionContext

An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

Type: String to string map

CreateTime

The time when the integration was created, in UTC.

Type: Timestamp

DataFilter

Selects source tables for the integration using Maxwell filter syntax.

Type: String

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

Description

A description of the integration.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\S\s]*

Errors

A list of errors associated with the integration modification.

Type: Array of IntegrationError objects

IntegrationArn

The Amazon Resource Name (ARN) for the integration.

Type: String

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

IntegrationConfig

The updated configuration settings for the integration.

Type: IntegrationConfig object

IntegrationName

A unique name for an integration in AWS Glue.

Type: String

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

KmsKeyId

The ARN of a KMS key used for encrypting the channel.

Type: String

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

SourceArn

The ARN of the source for the integration.

Type: String

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

Status

The status of the integration being modified.

The possible statuses are:

CREATING: The integration is being created.
ACTIVE: The integration creation succeeds.
MODIFYING: The integration is being modified.
FAILED: The integration creation fails.
DELETING: The integration is deleted.
SYNCING: The integration is synchronizing.
NEEDS_ATTENTION: The integration needs attention, such as synchronization.

Type: String

Tags

Metadata assigned to the resource consisting of a list of key-value pairs.

Type: Array of Tag objects

TargetArn

The ARN of the target for the integration.

Type: String

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

Errors

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

AccessDeniedException

Access to a resource was denied.

Message: A message describing the problem.

HTTP Status Code: 400

ConflictException

The CreatePartitions API was called on a table that has indexes enabled.

Message: A message describing the problem.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

IntegrationConflictOperationFault

The requested operation conflicts with another operation.

Message: A message describing the problem.

HTTP Status Code: 400

IntegrationNotFoundFault

The specified integration could not be found.

Message: A message describing the problem.

HTTP Status Code: 400

InternalServerException

An internal server error occurred.

Message: A message describing the problem.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

InvalidIntegrationStateFault

The integration is in an invalid state.

Message: A message describing the problem.

HTTP Status Code: 400

InvalidStateException

An error that indicates your data is in an invalid state.

Message: A message describing the problem.

HTTP Status Code: 400

ValidationException

A value could not be validated.

Message: A message describing the problem.

HTTP Status Code: 400