Amazon AppIntegrations Service

2021/09/27 - Amazon AppIntegrations Service - 6 new api methods

Changes  The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.

GetDataIntegration (new) Link ¶

Returns information about the DataIntegration.

See also: AWS API Documentation

Request Syntax

client.get_data_integration(
    Identifier='string'
)
type Identifier:

string

param Identifier:

[REQUIRED]

A unique identifier.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'KmsKey': 'string',
    'SourceURI': 'string',
    'ScheduleConfiguration': {
        'FirstExecutionFrom': 'string',
        'Object': 'string',
        'ScheduleExpression': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) for the DataIntegration.

    • Id (string) --

      A unique identifier.

    • Name (string) --

      The name of the DataIntegration.

    • Description (string) --

      The KMS key for the DataIntegration.

    • KmsKey (string) --

      The KMS key for the DataIntegration.

    • SourceURI (string) --

      The URI of the data source.

    • ScheduleConfiguration (dict) --

      The name of the data and how often it should be pulled from the source.

      • FirstExecutionFrom (string) --

        The start date for objects to import in the first flow run.

      • Object (string) --

        The name of the object to pull from the data source.

      • ScheduleExpression (string) --

        How often the data should be pulled from data source.

    • Tags (dict) --

      One or more tags.

      • (string) --

        • (string) --

UpdateDataIntegration (new) Link ¶

Updates the description of a DataIntegration.

See also: AWS API Documentation

Request Syntax

client.update_data_integration(
    Identifier='string',
    Name='string',
    Description='string'
)
type Identifier:

string

param Identifier:

[REQUIRED]

A unique identifier for the DataIntegration.

type Name:

string

param Name:

The name of the DataIntegration.

type Description:

string

param Description:

A description of the DataIntegration.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

CreateDataIntegration (new) Link ¶

Creates and persists a DataIntegration resource.

See also: AWS API Documentation

Request Syntax

client.create_data_integration(
    Name='string',
    Description='string',
    KmsKey='string',
    SourceURI='string',
    ScheduleConfig={
        'FirstExecutionFrom': 'string',
        'Object': 'string',
        'ScheduleExpression': 'string'
    },
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)
type Name:

string

param Name:

[REQUIRED]

The name of the DataIntegration.

type Description:

string

param Description:

A description of the DataIntegration.

type KmsKey:

string

param KmsKey:

The KMS key for the DataIntegration.

type SourceURI:

string

param SourceURI:

The URI of the data source.

type ScheduleConfig:

dict

param ScheduleConfig:

The name of the data and how often it should be pulled from the source.

  • FirstExecutionFrom (string) --

    The start date for objects to import in the first flow run.

  • Object (string) --

    The name of the object to pull from the data source.

  • ScheduleExpression (string) --

    How often the data should be pulled from data source.

type Tags:

dict

param Tags:

One or more tags.

  • (string) --

    • (string) --

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'KmsKey': 'string',
    'SourceURI': 'string',
    'ScheduleConfiguration': {
        'FirstExecutionFrom': 'string',
        'Object': 'string',
        'ScheduleExpression': 'string'
    },
    'Tags': {
        'string': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN)

    • Id (string) --

      A unique identifier.

    • Name (string) --

      The name of the DataIntegration.

    • Description (string) --

      A description of the DataIntegration.

    • KmsKey (string) --

      The KMS key for the DataIntegration.

    • SourceURI (string) --

      The URI of the data source.

    • ScheduleConfiguration (dict) --

      The name of the data and how often it should be pulled from the source.

      • FirstExecutionFrom (string) --

        The start date for objects to import in the first flow run.

      • Object (string) --

        The name of the object to pull from the data source.

      • ScheduleExpression (string) --

        How often the data should be pulled from data source.

    • Tags (dict) --

      One or more tags.

      • (string) --

        • (string) --

    • ClientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

DeleteDataIntegration (new) Link ¶

Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role.

See also: AWS API Documentation

Request Syntax

client.delete_data_integration(
    DataIntegrationIdentifier='string'
)
type DataIntegrationIdentifier:

string

param DataIntegrationIdentifier:

[REQUIRED]

A unique identifier for the DataIntegration.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListDataIntegrationAssociations (new) Link ¶

Returns a paginated list of DataIntegration associations in the account.

See also: AWS API Documentation

Request Syntax

client.list_data_integration_associations(
    DataIntegrationIdentifier='string',
    NextToken='string',
    MaxResults=123
)
type DataIntegrationIdentifier:

string

param DataIntegrationIdentifier:

[REQUIRED]

A unique identifier for the DataIntegration.

type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

dict

returns:

Response Syntax

{
    'DataIntegrationAssociations': [
        {
            'DataIntegrationAssociationArn': 'string',
            'DataIntegrationArn': 'string',
            'ClientId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DataIntegrationAssociations (list) --

      The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.

      • (dict) --

        Summary information about the DataIntegration association.

        • DataIntegrationAssociationArn (string) --

          The Amazon Resource Name (ARN) of the DataIntegration association.

        • DataIntegrationArn (string) --

          The Amazon Resource Name (ARN)of the DataIntegration.

        • ClientId (string) --

          The identifier for teh client that is associated with the DataIntegration association.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

ListDataIntegrations (new) Link ¶

Returns a paginated list of DataIntegrations in the account.

See also: AWS API Documentation

Request Syntax

client.list_data_integrations(
    NextToken='string',
    MaxResults=123
)
type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

dict

returns:

Response Syntax

{
    'DataIntegrations': [
        {
            'Arn': 'string',
            'Name': 'string',
            'SourceURI': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DataIntegrations (list) --

      The DataIntegrations associated with this account.

      • (dict) --

        Summary information about the DataIntegration.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the DataIntegration.

        • Name (string) --

          The name of the DataIntegration.

        • SourceURI (string) --

          The URI of the data source.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.