Redshift / Client / modify_integration

modify_integration#

Redshift.Client.modify_integration(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.modify_integration(
    IntegrationArn='string',
    Description='string',
    IntegrationName='string'
)
Parameters:

  • IntegrationArn (string) –

    [REQUIRED]

    The unique identifier of the integration to modify.

  • Description (string) – A new description for the integration.

  • IntegrationName (string) – A new name for the integration.

Return type:

dict

Returns:

Response Syntax

{
    'IntegrationArn': 'string',
    'IntegrationName': 'string',
    'SourceArn': 'string',
    'TargetArn': 'string',
    'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
    'Errors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'CreateTime': datetime(2015, 1, 1),
    'Description': 'string',
    'KMSKeyId': 'string',
    'AdditionalEncryptionContext': {
        'string': 'string'
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • IntegrationArn (string) –

      The Amazon Resource Name (ARN) of the integration.

    • IntegrationName (string) –

      The name of the integration.

    • SourceArn (string) –

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

    • TargetArn (string) –

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

    • Status (string) –

      The current status of the integration.

    • Errors (list) –

      Any errors associated with the integration.

      • (dict) –

        The error of an inbound integration.

        • ErrorCode (string) –

          The error code of an inbound integration error.

        • ErrorMessage (string) –

          The error message of an inbound integration error.

    • CreateTime (datetime) –

      The time (UTC) when the integration was created.

    • Description (string) –

      The description of the integration.

    • KMSKeyId (string) –

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

    • AdditionalEncryptionContext (dict) –

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

      • (string) –

        • (string) –

    • Tags (list) –

      The list of tags associated with the integration.

      • (dict) –

        A tag consisting of a name/value pair for a resource.

        • Key (string) –

          The key, or name, for the resource tag.

        • Value (string) –

          The value for the resource tag.

Exceptions

  • Redshift.Client.exceptions.IntegrationNotFoundFault

  • Redshift.Client.exceptions.IntegrationConflictStateFault

  • Redshift.Client.exceptions.IntegrationConflictOperationFault

  • Redshift.Client.exceptions.IntegrationAlreadyExistsFault

  • Redshift.Client.exceptions.UnsupportedOperationFault