Glue / Client / modify_integration

modify_integration#

Glue.Client.modify_integration(**kwargs)#

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

Request Syntax

response = client.modify_integration(
    IntegrationIdentifier='string',
    Description='string',
    DataFilter='string',
    IntegrationName='string'
)

Parameters:

IntegrationIdentifier (string) –
[REQUIRED]

The Amazon Resource Name (ARN) for the integration.
Description (string) – A description of the integration.
DataFilter (string) – Selects source tables for the integration using Maxwell filter syntax.
IntegrationName (string) – A unique name for an integration in Glue.

Return type:

dict

Returns:

Response Syntax

{
    'SourceArn': 'string',
    'TargetArn': 'string',
    'IntegrationName': 'string',
    'Description': 'string',
    'IntegrationArn': 'string',
    'KmsKeyId': 'string',
    'AdditionalEncryptionContext': {
        'string': 'string'
    },
    'Tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'Status': 'CREATING'|'ACTIVE'|'MODIFYING'|'FAILED'|'DELETING'|'SYNCING'|'NEEDS_ATTENTION',
    'CreateTime': datetime(2015, 1, 1),
    'Errors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'DataFilter': 'string'
}

Response Structure

(dict) –
- SourceArn (string) –
  
  The ARN of the source for the integration.
- TargetArn (string) –
  
  The ARN of the target for the integration.
- IntegrationName (string) –
  
  A unique name for an integration in Glue.
- Description (string) –
  
  A description of the integration.
- IntegrationArn (string) –
  
  The Amazon Resource Name (ARN) for the integration.
- KmsKeyId (string) –
  
  The ARN of a KMS key used for encrypting the channel.
- AdditionalEncryptionContext (dict) –
  
  An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
  - (string) –
    - (string) –
- Tags (list) –
  
  Metadata assigned to the resource consisting of a list of key-value pairs.
  - (dict) –
    
    The Tag object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
    
    For more information about tags, and controlling access to resources in Glue, see Amazon Web Services Tags in Glue and Specifying Glue Resource ARNs in the developer guide.
    - key (string) –
      
      The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.
    - value (string) –
      
      The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.
- Status (string) –
  
  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.
- CreateTime (datetime) –
  
  The time when the integration was created, in UTC.
- Errors (list) –
  
  A list of errors associated with the integration modification.
  - (dict) –
    
    An error associated with a zero-ETL integration.
    - ErrorCode (string) –
      
      The code associated with this error.
    - ErrorMessage (string) –
      
      A message describing the error.
- DataFilter (string) –
  
  Selects source tables for the integration using Maxwell filter syntax.

Exceptions

Glue.Client.exceptions.ValidationException
Glue.Client.exceptions.AccessDeniedException
Glue.Client.exceptions.InternalServerException
Glue.Client.exceptions.IntegrationNotFoundFault
Glue.Client.exceptions.IntegrationConflictOperationFault
Glue.Client.exceptions.InvalidIntegrationStateFault
Glue.Client.exceptions.EntityNotFoundException
Glue.Client.exceptions.InternalServiceException
Glue.Client.exceptions.ConflictException
Glue.Client.exceptions.InvalidStateException
Glue.Client.exceptions.InvalidInputException