CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

This API is in preview release and subject to change.

Creates and persists an Application resource.

Parameter Syntax

$result = $client->createApplication([
    'ApplicationSourceConfig' => [ // REQUIRED
        'ExternalUrlConfig' => [
            'AccessUrl' => '<string>', // REQUIRED
            'ApprovedOrigins' => ['<string>', ...],
        ],
    ],
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
    'Permissions' => ['<string>', ...],
    'Publications' => [
        [
            'Description' => '<string>',
            'Event' => '<string>', // REQUIRED
            'Schema' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Subscriptions' => [
        [
            'Description' => '<string>',
            'Event' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ResourceQuotaExceededException:

The allowed quota for the resource has been exceeded.

DuplicateResourceException:

A resource with the specified name already exists.

ThrottlingException:

The throttling limit has been exceeded.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

UnsupportedOperationException:

The operation is not supported.

Examples

Example 1: To create an application

The following creates an application named My Application with access url https://example.com.

$result = $client->createApplication([
    'ApplicationSourceConfig' => [
        'ExternalUrlConfig' => [
            'AccessUrl' => 'https://example.com',
        ],
    ],
    'Description' => 'My first application.',
    'Name' => 'My Application',
    'Namespace' => 'myapplication',
]);

Result syntax:

[
    'Arn' => 'arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e',
    'Id' => '98542c53-e8ac-4570-9c85-c6552c8d9c5e',
]

CreateDataIntegration

$result = $client->createDataIntegration([/* ... */]);
$promise = $client->createDataIntegrationAsync([/* ... */]);

Creates and persists a DataIntegration resource.

Parameter Syntax

$result = $client->createDataIntegration([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'FileConfiguration' => [
        'Filters' => [
            '<NonBlankString>' => ['<string>', ...],
            // ...
        ],
        'Folders' => ['<string>', ...], // REQUIRED
    ],
    'KmsKey' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ObjectConfiguration' => [
        '<NonBlankString>' => [
            '<NonBlankString>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'ScheduleConfig' => [
        'FirstExecutionFrom' => '<string>',
        'Object' => '<string>',
        'ScheduleExpression' => '<string>', // REQUIRED
    ],
    'SourceURI' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'FileConfiguration' => [
        'Filters' => [
            '<NonBlankString>' => ['<string>', ...],
            // ...
        ],
        'Folders' => ['<string>', ...],
    ],
    'Id' => '<string>',
    'KmsKey' => '<string>',
    'Name' => '<string>',
    'ObjectConfiguration' => [
        '<NonBlankString>' => [
            '<NonBlankString>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'ScheduleConfiguration' => [
        'FirstExecutionFrom' => '<string>',
        'Object' => '<string>',
        'ScheduleExpression' => '<string>',
    ],
    'SourceURI' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ResourceQuotaExceededException:

The allowed quota for the resource has been exceeded.

DuplicateResourceException:

A resource with the specified name already exists.

ThrottlingException:

The throttling limit has been exceeded.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateEventIntegration

$result = $client->createEventIntegration([/* ... */]);
$promise = $client->createEventIntegrationAsync([/* ... */]);

Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

Parameter Syntax

$result = $client->createEventIntegration([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'EventBridgeBus' => '<string>', // REQUIRED
    'EventFilter' => [ // REQUIRED
        'Source' => '<string>', // REQUIRED
    ],
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'EventIntegrationArn' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ResourceQuotaExceededException:

The allowed quota for the resource has been exceeded.

DuplicateResourceException:

A resource with the specified name already exists.

ThrottlingException:

The throttling limit has been exceeded.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes the Application. Only Applications that don't have any Application Associations can be deleted.

Parameter Syntax

$result = $client->deleteApplication([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

Examples

Example 1: To delete an application

The following deletes an application.

$result = $client->deleteApplication([
    'Arn' => 'arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e',
]);

Result syntax:

[
]

DeleteDataIntegration

$result = $client->deleteDataIntegration([/* ... */]);
$promise = $client->deleteDataIntegrationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDataIntegration([
    'DataIntegrationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteEventIntegration

$result = $client->deleteEventIntegration([/* ... */]);
$promise = $client->deleteEventIntegrationAsync([/* ... */]);

Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

Parameter Syntax

$result = $client->deleteEventIntegration([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

This API is in preview release and subject to change.

Get an Application resource.

Parameter Syntax

$result = $client->getApplication([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationSourceConfig' => [
        'ExternalUrlConfig' => [
            'AccessUrl' => '<string>',
            'ApprovedOrigins' => ['<string>', ...],
        ],
    ],
    'Arn' => '<string>',
    'CreatedTime' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'Namespace' => '<string>',
    'Permissions' => ['<string>', ...],
    'Publications' => [
        [
            'Description' => '<string>',
            'Event' => '<string>',
            'Schema' => '<string>',
        ],
        // ...
    ],
    'Subscriptions' => [
        [
            'Description' => '<string>',
            'Event' => '<string>',
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

Examples

Example 1: To get an application

The following retrives an application.

$result = $client->getApplication([
    'Arn' => 'arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e',
]);

Result syntax:

[
    'ApplicationSourceConfig' => [
        'ExternalUrlConfig' => [
            'AccessUrl' => 'https://example.com',
        ],
    ],
    'Description' => 'My first application.',
    'Name' => 'My Application',
    'Namespace' => 'myapplication',
]

GetDataIntegration

$result = $client->getDataIntegration([/* ... */]);
$promise = $client->getDataIntegrationAsync([/* ... */]);

Returns information about the DataIntegration.

Parameter Syntax

$result = $client->getDataIntegration([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'FileConfiguration' => [
        'Filters' => [
            '<NonBlankString>' => ['<string>', ...],
            // ...
        ],
        'Folders' => ['<string>', ...],
    ],
    'Id' => '<string>',
    'KmsKey' => '<string>',
    'Name' => '<string>',
    'ObjectConfiguration' => [
        '<NonBlankString>' => [
            '<NonBlankString>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'ScheduleConfiguration' => [
        'FirstExecutionFrom' => '<string>',
        'Object' => '<string>',
        'ScheduleExpression' => '<string>',
    ],
    'SourceURI' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetEventIntegration

$result = $client->getEventIntegration([/* ... */]);
$promise = $client->getEventIntegrationAsync([/* ... */]);

Returns information about the event integration.

Parameter Syntax

$result = $client->getEventIntegration([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'EventBridgeBus' => '<string>',
    'EventFilter' => [
        'Source' => '<string>',
    ],
    'EventIntegrationArn' => '<string>',
    'Name' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListApplicationAssociations

$result = $client->listApplicationAssociations([/* ... */]);
$promise = $client->listApplicationAssociationsAsync([/* ... */]);

Returns a paginated list of application associations for an application.

Parameter Syntax

$result = $client->listApplicationAssociations([
    'ApplicationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationAssociations' => [
        [
            'ApplicationArn' => '<string>',
            'ApplicationAssociationArn' => '<string>',
            'ClientId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

Examples

Example 1: To list application associations of an application

The following retrives application associations of an application

$result = $client->listApplicationAssociations([
    'ApplicationId' => '98542c53-e8ac-4570-9c85-c6552c8d9c5e',
]);

Result syntax:

[
    'ApplicationAssociations' => [
        [
            'ApplicationArn' => 'arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e',
            'ApplicationAssociationArn' => 'arn:aws:app-integrations:us-west-2:0123456789012:application-association/98542c53-e8ac-4570-9c85-c6552c8d9c5e/461dfb57-320a-454d-9bba-bb560845ff38',
            'ClientId' => 'connect.amazonaws.com',
        ],
    ],
    'NextToken' => 'abc',
]

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

This API is in preview release and subject to change.

Lists applications in the account.

Parameter Syntax

$result = $client->listApplications([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Applications' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Id' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Namespace' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

Examples

Example 1: To list applications in the account

The following lists application summary in the account.

$result = $client->listApplications([
    'MaxResults' => 1,
]);

Result syntax:

[
    'Applications' => [
        [
            'Arn' => 'arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e',
            'Id' => '98542c53-e8ac-4570-9c85-c6552c8d9c5e',
            'Name' => 'My Application',
            'Namespace' => 'myapplication',
        ],
    ],
    'NextToken' => 'abc',
]

ListDataIntegrationAssociations

$result = $client->listDataIntegrationAssociations([/* ... */]);
$promise = $client->listDataIntegrationAssociationsAsync([/* ... */]);

Returns a paginated list of DataIntegration associations in the account.

Parameter Syntax

$result = $client->listDataIntegrationAssociations([
    'DataIntegrationIdentifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataIntegrationAssociations' => [
        [
            'ClientId' => '<string>',
            'DataIntegrationArn' => '<string>',
            'DataIntegrationAssociationArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListDataIntegrations

$result = $client->listDataIntegrations([/* ... */]);
$promise = $client->listDataIntegrationsAsync([/* ... */]);

Returns a paginated list of DataIntegrations in the account.

Parameter Syntax

$result = $client->listDataIntegrations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataIntegrations' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
            'SourceURI' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListEventIntegrationAssociations

$result = $client->listEventIntegrationAssociations([/* ... */]);
$promise = $client->listEventIntegrationAssociationsAsync([/* ... */]);

Returns a paginated list of event integration associations in the account.

Parameter Syntax

$result = $client->listEventIntegrationAssociations([
    'EventIntegrationName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventIntegrationAssociations' => [
        [
            'ClientAssociationMetadata' => ['<string>', ...],
            'ClientId' => '<string>',
            'EventBridgeRuleName' => '<string>',
            'EventIntegrationAssociationArn' => '<string>',
            'EventIntegrationAssociationId' => '<string>',
            'EventIntegrationName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListEventIntegrations

$result = $client->listEventIntegrations([/* ... */]);
$promise = $client->listEventIntegrationsAsync([/* ... */]);

Returns a paginated list of event integrations in the account.

Parameter Syntax

$result = $client->listEventIntegrations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventIntegrations' => [
        [
            'Description' => '<string>',
            'EventBridgeBus' => '<string>',
            'EventFilter' => [
                'Source' => '<string>',
            ],
            'EventIntegrationArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

InternalServiceError:

Request processing failed due to an error or failure with the service.

ResourceNotFoundException:

The specified resource was not found.

ThrottlingException:

The throttling limit has been exceeded.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is not valid.

InternalServiceError:

Request processing failed due to an error or failure with the service.

ResourceNotFoundException:

The specified resource was not found.

ThrottlingException:

The throttling limit has been exceeded.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is not valid.

InternalServiceError:

Request processing failed due to an error or failure with the service.

ResourceNotFoundException:

The specified resource was not found.

ThrottlingException:

The throttling limit has been exceeded.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

This API is in preview release and subject to change.

Updates and persists an Application resource.

Parameter Syntax

$result = $client->updateApplication([
    'ApplicationSourceConfig' => [
        'ExternalUrlConfig' => [
            'AccessUrl' => '<string>', // REQUIRED
            'ApprovedOrigins' => ['<string>', ...],
        ],
    ],
    'Arn' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>',
    'Permissions' => ['<string>', ...],
    'Publications' => [
        [
            'Description' => '<string>',
            'Event' => '<string>', // REQUIRED
            'Schema' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Subscriptions' => [
        [
            'Description' => '<string>',
            'Event' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

UnsupportedOperationException:

The operation is not supported.

Examples

Example 1: To update an application

The following updates an existing application named with a new name.

$result = $client->updateApplication([
    'Arn' => 'arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e',
    'Name' => 'My New Application Name',
]);

Result syntax:

[
]

UpdateDataIntegration

$result = $client->updateDataIntegration([/* ... */]);
$promise = $client->updateDataIntegrationAsync([/* ... */]);

Updates the description of a DataIntegration.

Parameter Syntax

$result = $client->updateDataIntegration([
    'Description' => '<string>',
    'Identifier' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

UpdateEventIntegration

$result = $client->updateEventIntegration([/* ... */]);
$promise = $client->updateEventIntegrationAsync([/* ... */]);

Updates the description of an event integration.

Parameter Syntax

$result = $client->updateEventIntegration([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

Request processing failed due to an error or failure with the service.

ThrottlingException:

The throttling limit has been exceeded.

ResourceNotFoundException:

The specified resource was not found.

InvalidRequestException:

The request is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.