SDK for PHP 3.x

Client: Aws\AppIntegrationsService\AppIntegrationsServiceClient
Service ID: appintegrations
Version: 2020-07-29

This page describes the parameters and results for the operations of the Amazon AppIntegrations Service (2020-07-29), and shows how to use the Aws\AppIntegrationsService\AppIntegrationsServiceClient object to call the described operations. This documentation is specific to the 2020-07-29 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateApplication ( array $params = [] )
Creates and persists an Application resource.
CreateDataIntegration ( array $params = [] )
Creates and persists a DataIntegration resource.
CreateDataIntegrationAssociation ( array $params = [] )
Creates and persists a DataIntegrationAssociation resource.
CreateEventIntegration ( array $params = [] )
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.
DeleteApplication ( array $params = [] )
Deletes the Application.
DeleteDataIntegration ( array $params = [] )
Deletes the DataIntegration.
DeleteEventIntegration ( array $params = [] )
Deletes the specified existing event integration.
GetApplication ( array $params = [] )
Get an Application resource.
GetDataIntegration ( array $params = [] )
Returns information about the DataIntegration.
GetEventIntegration ( array $params = [] )
Returns information about the event integration.
ListApplicationAssociations ( array $params = [] )
Returns a paginated list of application associations for an application.
ListApplications ( array $params = [] )
Lists applications in the account.
ListDataIntegrationAssociations ( array $params = [] )
Returns a paginated list of DataIntegration associations in the account.
ListDataIntegrations ( array $params = [] )
Returns a paginated list of DataIntegrations in the account.
ListEventIntegrationAssociations ( array $params = [] )
Returns a paginated list of event integration associations in the account.
ListEventIntegrations ( array $params = [] )
Returns a paginated list of event integrations in the account.
ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
TagResource ( array $params = [] )
Adds the specified tags to the specified resource.
UntagResource ( array $params = [] )
Removes the specified tags from the specified resource.
UpdateApplication ( array $params = [] )
Updates and persists an Application resource.
UpdateDataIntegration ( array $params = [] )
Updates the description of a DataIntegration.
UpdateDataIntegrationAssociation ( array $params = [] )
Updates and persists a DataIntegrationAssociation resource.
UpdateEventIntegration ( array $params = [] )
Updates the description of an event integration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApplicationAssociations
ListApplications
ListDataIntegrationAssociations
ListDataIntegrations
ListEventIntegrationAssociations
ListEventIntegrations

Operations

CreateApplication

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

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

Members
ApplicationSourceConfig
Required: Yes
Type: ApplicationSourceConfig structure

The configuration for where the application should be loaded from.

ClientToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Description
Type: string

The description of the application.

Name
Required: Yes
Type: string

The name of the application.

Namespace
Required: Yes
Type: string

The namespace of the application.

Permissions
Type: Array of strings

The configuration of events or requests that the application has access to.

Publications
Type: Array of Publication structures

The events that the application publishes.

Subscriptions
Type: Array of Subscription structures

The events that the application subscribes.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

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

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the Application.

Id
Type: string

A unique identifier for the Application.

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.

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

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>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ClientToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Description
Type: string

A description of the DataIntegration.

FileConfiguration
Type: FileConfiguration structure

The configuration for what files should be pulled from the source.

KmsKey
Required: Yes
Type: string

The KMS key ARN for the DataIntegration.

Name
Required: Yes
Type: string

The name of the DataIntegration.

ObjectConfiguration
Type: Associative array of custom strings keys (NonBlankString) to maps

The configuration for what data should be pulled from the source.

ScheduleConfig
Type: ScheduleConfiguration structure

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

SourceURI
Type: string

The URI of the data source.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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

Members
Arn
Type: string

The Amazon Resource Name (ARN)

ClientToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Description
Type: string

A description of the DataIntegration.

FileConfiguration
Type: FileConfiguration structure

The configuration for what files should be pulled from the source.

Id
Type: string

A unique identifier.

KmsKey
Type: string

The KMS key ARN for the DataIntegration.

Name
Type: string

The name of the DataIntegration.

ObjectConfiguration
Type: Associative array of custom strings keys (NonBlankString) to maps

The configuration for what data should be pulled from the source.

ScheduleConfiguration
Type: ScheduleConfiguration structure

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

SourceURI
Type: string

The URI of the data source.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

CreateDataIntegrationAssociation

$result = $client->createDataIntegrationAssociation([/* ... */]);
$promise = $client->createDataIntegrationAssociationAsync([/* ... */]);

Creates and persists a DataIntegrationAssociation resource.

Parameter Syntax

$result = $client->createDataIntegrationAssociation([
    'ClientAssociationMetadata' => ['<string>', ...],
    'ClientId' => '<string>',
    'ClientToken' => '<string>',
    'DataIntegrationIdentifier' => '<string>', // REQUIRED
    'DestinationURI' => '<string>',
    'ExecutionConfiguration' => [
        'ExecutionMode' => 'ON_DEMAND|SCHEDULED', // REQUIRED
        'OnDemandConfiguration' => [
            'EndTime' => '<string>',
            'StartTime' => '<string>', // REQUIRED
        ],
        'ScheduleConfiguration' => [
            'FirstExecutionFrom' => '<string>',
            'Object' => '<string>',
            'ScheduleExpression' => '<string>', // REQUIRED
        ],
    ],
    'ObjectConfiguration' => [
        '<NonBlankString>' => [
            '<NonBlankString>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientAssociationMetadata
Type: Associative array of custom strings keys (NonBlankString) to strings

The mapping of metadata to be extracted from the data.

ClientId
Type: string

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

ClientToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

DataIntegrationIdentifier
Required: Yes
Type: string

A unique identifier for the DataIntegration.

DestinationURI
Type: string

The URI of the data destination.

ExecutionConfiguration
Type: ExecutionConfiguration structure

The configuration for how the files should be pulled from the source.

ObjectConfiguration
Type: Associative array of custom strings keys (NonBlankString) to maps

The configuration for what data should be pulled from the source.

Result Syntax

[
    'DataIntegrationArn' => '<string>',
    'DataIntegrationAssociationId' => '<string>',
]

Result Details

Members
DataIntegrationArn
Type: string

The Amazon Resource Name (ARN) for the DataIntegration.

DataIntegrationAssociationId
Type: string

A unique identifier. for the DataIntegrationAssociation.

Errors

InternalServiceError:

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

ResourceQuotaExceededException:

The allowed quota for the resource has been exceeded.

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.

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

Members
ClientToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Description
Type: string

The description of the event integration.

EventBridgeBus
Required: Yes
Type: string

The EventBridge bus.

EventFilter
Required: Yes
Type: EventFilter structure

The event filter.

Name
Required: Yes
Type: string

The name of the event integration.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

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

Result Details

Members
EventIntegrationArn
Type: string

The Amazon Resource Name (ARN) of the event integration.

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

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

Parameter Syntax

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

Parameter Details

Members
DataIntegrationIdentifier
Required: Yes
Type: string

A unique identifier for the DataIntegration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
Name
Required: Yes
Type: string

The name of the event integration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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([/* ... */]);

Get an Application resource.

Parameter Syntax

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

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Application.

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

Members
ApplicationSourceConfig
Type: ApplicationSourceConfig structure

The configuration for where the application should be loaded from.

Arn
Type: string

The Amazon Resource Name (ARN) of the Application.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The created time of the Application.

Description
Type: string

The description of the application.

Id
Type: string

A unique identifier for the Application.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last modified time of the Application.

Name
Type: string

The name of the application.

Namespace
Type: string

The namespace of the application.

Permissions
Type: Array of strings

The configuration of events or requests that the application has access to.

Publications
Type: Array of Publication structures

The events that the application publishes.

Subscriptions
Type: Array of Subscription structures

The events that the application subscribes.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

Parameter Syntax

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

Parameter Details

Members
Identifier
Required: Yes
Type: string

A unique identifier.

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

Members
Arn
Type: string

The Amazon Resource Name (ARN) for the DataIntegration.

Description
Type: string

The KMS key ARN for the DataIntegration.

FileConfiguration
Type: FileConfiguration structure

The configuration for what files should be pulled from the source.

Id
Type: string

A unique identifier.

KmsKey
Type: string

The KMS key ARN for the DataIntegration.

Name
Type: string

The name of the DataIntegration.

ObjectConfiguration
Type: Associative array of custom strings keys (NonBlankString) to maps

The configuration for what data should be pulled from the source.

ScheduleConfiguration
Type: ScheduleConfiguration structure

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

SourceURI
Type: string

The URI of the data source.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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

Members
Name
Required: Yes
Type: string

The name of the event integration.

Result Syntax

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

Result Details

Members
Description
Type: string

The description of the event integration.

EventBridgeBus
Type: string

The EventBridge bus.

EventFilter
Type: EventFilter structure

The event filter.

EventIntegrationArn
Type: string

The Amazon Resource Name (ARN) for the event integration.

Name
Type: string

The name of the event integration.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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

Members
ApplicationId
Required: Yes
Type: string

A unique identifier for the Application.

MaxResults
Type: int

The maximum number of results to return per page.

NextToken
Type: string

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.

Result Syntax

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

Result Details

Members
ApplicationAssociations
Type: Array of ApplicationAssociationSummary structures

List of Application Associations for the Application.

NextToken
Type: string

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

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([/* ... */]);

Lists applications in the account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return per page.

NextToken
Type: string

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.

Result Syntax

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

Result Details

Members
Applications
Type: Array of ApplicationSummary structures

The Applications associated with this account.

NextToken
Type: string

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

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.

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

Parameter Syntax

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

Parameter Details

Members
DataIntegrationIdentifier
Required: Yes
Type: string

A unique identifier for the DataIntegration.

MaxResults
Type: int

The maximum number of results to return per page.

NextToken
Type: string

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.

Result Syntax

[
    'DataIntegrationAssociations' => [
        [
            'ClientId' => '<string>',
            'DataIntegrationArn' => '<string>',
            'DataIntegrationAssociationArn' => '<string>',
            'DestinationURI' => '<string>',
            'ExecutionConfiguration' => [
                'ExecutionMode' => 'ON_DEMAND|SCHEDULED',
                'OnDemandConfiguration' => [
                    'EndTime' => '<string>',
                    'StartTime' => '<string>',
                ],
                'ScheduleConfiguration' => [
                    'FirstExecutionFrom' => '<string>',
                    'Object' => '<string>',
                    'ScheduleExpression' => '<string>',
                ],
            ],
            'LastExecutionStatus' => [
                'ExecutionStatus' => 'COMPLETED|IN_PROGRESS|FAILED',
                'StatusMessage' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DataIntegrationAssociations
Type: Array of DataIntegrationAssociationSummary structures

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

NextToken
Type: string

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

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.

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return per page.

NextToken
Type: string

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.

Result Syntax

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

Result Details

Members
DataIntegrations
Type: Array of DataIntegrationSummary structures

The DataIntegrations associated with this account.

NextToken
Type: string

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

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

Members
EventIntegrationName
Required: Yes
Type: string

The name of the event integration.

MaxResults
Type: int

The maximum number of results to return per page.

NextToken
Type: string

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.

Result Syntax

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

Result Details

Members
EventIntegrationAssociations
Type: Array of EventIntegrationAssociation structures

The event integration associations.

NextToken
Type: string

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

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

Members
MaxResults
Type: int

The maximum number of results to return per page.

NextToken
Type: string

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.

Result Syntax

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

Result Details

Members
EventIntegrations
Type: Array of EventIntegration structures

The event integrations.

NextToken
Type: string

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

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

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

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

Information about the tags.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys
Required: Yes
Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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([/* ... */]);

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

Members
ApplicationSourceConfig
Type: ApplicationSourceConfig structure

The configuration for where the application should be loaded from.

Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Application.

Description
Type: string

The description of the application.

Name
Type: string

The name of the application.

Permissions
Type: Array of strings

The configuration of events or requests that the application has access to.

Publications
Type: Array of Publication structures

The events that the application publishes.

Subscriptions
Type: Array of Subscription structures

The events that the application subscribes.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

Parameter Syntax

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

Parameter Details

Members
Description
Type: string

A description of the DataIntegration.

Identifier
Required: Yes
Type: string

A unique identifier for the DataIntegration.

Name
Type: string

The name of the DataIntegration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

UpdateDataIntegrationAssociation

$result = $client->updateDataIntegrationAssociation([/* ... */]);
$promise = $client->updateDataIntegrationAssociationAsync([/* ... */]);

Updates and persists a DataIntegrationAssociation resource.

Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job.

Parameter Syntax

$result = $client->updateDataIntegrationAssociation([
    'DataIntegrationAssociationIdentifier' => '<string>', // REQUIRED
    'DataIntegrationIdentifier' => '<string>', // REQUIRED
    'ExecutionConfiguration' => [ // REQUIRED
        'ExecutionMode' => 'ON_DEMAND|SCHEDULED', // REQUIRED
        'OnDemandConfiguration' => [
            'EndTime' => '<string>',
            'StartTime' => '<string>', // REQUIRED
        ],
        'ScheduleConfiguration' => [
            'FirstExecutionFrom' => '<string>',
            'Object' => '<string>',
            'ScheduleExpression' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
DataIntegrationAssociationIdentifier
Required: Yes
Type: string

A unique identifier. of the DataIntegrationAssociation resource

DataIntegrationIdentifier
Required: Yes
Type: string

A unique identifier for the DataIntegration.

ExecutionConfiguration
Required: Yes
Type: ExecutionConfiguration structure

The configuration for how the files should be pulled from the source.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
Description
Type: string

The description of the event integration.

Name
Required: Yes
Type: string

The name of the event integration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
Message
Type: string

ApplicationAssociationSummary

Description

Summary information about the Application Association.

Members
ApplicationArn
Type: string

The Amazon Resource Name (ARN) of the Application.

ApplicationAssociationArn
Type: string

The Amazon Resource Name (ARN) of the Application Association.

ClientId
Type: string

The identifier for the client that is associated with the Application Association.

ApplicationSourceConfig

Description

The configuration for where the application should be loaded from.

Members
ExternalUrlConfig
Type: ExternalUrlConfig structure

The external URL source for the application.

ApplicationSummary

Description

Summary information about the Application.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the Application.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the application was created.

Id
Type: string

A unique identifier for the Application.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the application was last modified.

Name
Type: string

The name of the application.

Namespace
Type: string

The namespace of the application.

DataIntegrationAssociationSummary

Description

Summary information about the DataIntegration association.

Members
ClientId
Type: string

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

DataIntegrationArn
Type: string

The Amazon Resource Name (ARN) of the DataIntegration.

DataIntegrationAssociationArn
Type: string

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

DestinationURI
Type: string

The URI of the data destination.

ExecutionConfiguration
Type: ExecutionConfiguration structure

The configuration for how the files should be pulled from the source.

LastExecutionStatus
Type: LastExecutionStatus structure

The execution status of the last job.

DataIntegrationSummary

Description

Summary information about the DataIntegration.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the DataIntegration.

Name
Type: string

The name of the DataIntegration.

SourceURI
Type: string

The URI of the data source.

DuplicateResourceException

Description

A resource with the specified name already exists.

Members
Message
Type: string

EventFilter

Description

The event filter.

Members
Source
Required: Yes
Type: string

The source of the events.

EventIntegration

Description

The event integration.

Members
Description
Type: string

The event integration description.

EventBridgeBus
Type: string

The Amazon EventBridge bus for the event integration.

EventFilter
Type: EventFilter structure

The event integration filter.

EventIntegrationArn
Type: string

The Amazon Resource Name (ARN) of the event integration.

Name
Type: string

The name of the event integration.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

EventIntegrationAssociation

Description

The event integration association.

Members
ClientAssociationMetadata
Type: Associative array of custom strings keys (NonBlankString) to strings

The metadata associated with the client.

ClientId
Type: string

The identifier for the client that is associated with the event integration.

EventBridgeRuleName
Type: string

The name of the EventBridge rule.

EventIntegrationAssociationArn
Type: string

The Amazon Resource Name (ARN) for the event integration association.

EventIntegrationAssociationId
Type: string

The identifier for the event integration association.

EventIntegrationName
Type: string

The name of the event integration.

ExecutionConfiguration

Description

The configuration for how the files should be pulled from the source.

Members
ExecutionMode
Required: Yes
Type: string

The mode for data import/export execution.

OnDemandConfiguration
Type: OnDemandConfiguration structure

The start and end time for data pull from the source.

ScheduleConfiguration
Type: ScheduleConfiguration structure

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

ExternalUrlConfig

Description

The external URL source for the application.

Members
AccessUrl
Required: Yes
Type: string

The URL to access the application.

ApprovedOrigins
Type: Array of strings

Additional URLs to allow list if different than the access URL.

FileConfiguration

Description

The configuration for what files should be pulled from the source.

Members
Filters
Type: Associative array of custom strings keys (NonBlankString) to stringss

Restrictions for what files should be pulled from the source.

Folders
Required: Yes
Type: Array of strings

Identifiers for the source folders to pull all files from recursively.

InternalServiceError

Description

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

Members
Message
Type: string

InvalidRequestException

Description

The request is not valid.

Members
Message
Type: string

LastExecutionStatus

Description

The execution status of the last job.

Members
ExecutionStatus
Type: string

The job status enum string.

StatusMessage
Type: string

The status message of a job.

OnDemandConfiguration

Description

The start and end time for data pull from the source.

Members
EndTime
Type: string

The end time for data pull from the source as an Unix/epoch string in milliseconds

StartTime
Required: Yes
Type: string

The start time for data pull from the source as an Unix/epoch string in milliseconds

Publication

Description

The configuration of an event that the application publishes.

Members
Description
Type: string

The description of the publication.

Event
Required: Yes
Type: string

The name of the publication.

Schema
Required: Yes
Type: string

The JSON schema of the publication event.

ResourceNotFoundException

Description

The specified resource was not found.

Members
Message
Type: string

ResourceQuotaExceededException

Description

The allowed quota for the resource has been exceeded.

Members
Message
Type: string

ScheduleConfiguration

Description

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

Members
FirstExecutionFrom
Type: string

The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format.

Object
Type: string

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

ScheduleExpression
Required: Yes
Type: string

How often the data should be pulled from data source.

Subscription

Description

The configuration of an event that the application subscribes.

Members
Description
Type: string

The description of the subscription.

Event
Required: Yes
Type: string

The name of the subscription.

ThrottlingException

Description

The throttling limit has been exceeded.

Members
Message
Type: string

UnsupportedOperationException

Description

The operation is not supported.

Members
Message
Type: string