AWS API Changes

2024/10/15 - Amazon Redshift - 4 new api methods

Changes This release launches the CreateIntegration, DeleteIntegration, DescribeIntegrations and ModifyIntegration APIs to create and manage Amazon Redshift Zero-ETL Integrations.

DeleteIntegration (new)

Link ¶

Deletes a zero-ETL integration with Amazon Redshift.

See also: AWS API Documentation

Request Syntax

client.delete_integration(
    IntegrationArn='string'
)

type IntegrationArn:

string

param IntegrationArn:

[REQUIRED]

The unique identifier of the integration to delete.

rtype:

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.

ModifyIntegration (new)

Link ¶

Modifies a zero-ETL integration with Amazon Redshift.

See also: AWS API Documentation

Request Syntax

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

type IntegrationArn:

string

param IntegrationArn:

[REQUIRED]

The unique identifier of the integration to modify.

type Description:

string

param Description:

A new description for the integration.

type IntegrationName:

string

param IntegrationName:

A new name for the integration.

rtype:

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.

CreateIntegration (new)

Link ¶

Creates a zero-ETL integration with Amazon Redshift.

See also: AWS API Documentation

Request Syntax

client.create_integration(
    SourceArn='string',
    TargetArn='string',
    IntegrationName='string',
    KMSKeyId='string',
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AdditionalEncryptionContext={
        'string': 'string'
    },
    Description='string'
)

type SourceArn:

string

param SourceArn:

[REQUIRED]

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

type TargetArn:

string

param TargetArn:

[REQUIRED]

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

type IntegrationName:

string

param IntegrationName:

[REQUIRED]

The name of the integration.

type KMSKeyId:

string

param KMSKeyId:

An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.

type TagList:

list

param TagList:

A list of tags.

(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.

type AdditionalEncryptionContext:

dict

param AdditionalEncryptionContext:

An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

You can only include this parameter if you specify the KMSKeyId parameter.

(string) --
- (string) --

type Description:

string

param Description:

A description of the integration.

rtype:

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.

DescribeIntegrations (new)

Link ¶

Describes one or more zero-ETL integrations with Amazon Redshift.

See also: AWS API Documentation

Request Syntax

client.describe_integrations(
    IntegrationArn='string',
    MaxRecords=123,
    Marker='string',
    Filters=[
        {
            'Name': 'integration-arn'|'source-arn'|'source-types'|'status',
            'Values': [
                'string',
            ]
        },
    ]
)

type IntegrationArn:

string

param IntegrationArn:

The unique identifier of the integration.

type MaxRecords:

integer

param MaxRecords:

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

type Marker:

string

param Marker:

An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

type Filters:

list

param Filters:

A filter that specifies one or more resources to return.

(dict) --

A set of elements to filter the returned integrations.
- Name (string) -- [REQUIRED]
  
  Specifies the type of integration filter.
- Values (list) -- [REQUIRED]
  
  Specifies the values to filter on.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'Integrations': [
        {
            '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) --
- Marker (string) --
  
  A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
- Integrations (list) --
  
  List of integrations that are described.
  - (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.