RDS / Client / delete_integration

delete_integration

RDS.Client.delete_integration(**kwargs)

Deletes a zero-ETL integration with Amazon Redshift.

See also: AWS API Documentation

Request Syntax

response = client.delete_integration(
    IntegrationIdentifier='string'
)

Parameters:

IntegrationIdentifier (string) –

[REQUIRED]

The unique identifier of the integration.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  A zero-ETL integration with Amazon Redshift.

  • SourceArn (string) –

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

  • TargetArn (string) –

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

  • IntegrationName (string) –

    The name of the integration.

  • IntegrationArn (string) –

    The ARN of the integration.

  • KMSKeyId (string) –

    The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to 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) –

  • Status (string) –

    The current status of the integration.

  • Tags (list) –

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

    • (dict) –

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • Key (string) –

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

      • Value (string) –

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

  • CreateTime (datetime) –

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

  • Errors (list) –

    Any errors associated with the integration.

    • (dict) –

      An error associated with a zero-ETL integration with Amazon Redshift.

      • ErrorCode (string) –

        The error code associated with the integration.

      • ErrorMessage (string) –

        A message explaining the error.

  • DataFilter (string) –

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

  • Description (string) –

    A description of the integration.

Exceptions

• RDS.Client.exceptions.IntegrationNotFoundFault

• RDS.Client.exceptions.IntegrationConflictOperationFault

• RDS.Client.exceptions.InvalidIntegrationStateFault