Amazon AppIntegrations Service 2020-07-29
- 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 */)
.
- CreateDataIntegration ( array $params = [] )
Creates and persists a DataIntegration 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.
- DeleteDataIntegration ( array $params = [] )
Deletes the DataIntegration.
- DeleteEventIntegration ( array $params = [] )
Deletes the specified existing event integration.
- GetDataIntegration ( array $params = [] )
Returns information about the DataIntegration.
- GetEventIntegration ( array $params = [] )
Returns information about the event integration.
- 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.
- UpdateDataIntegration ( array $params = [] )
Updates the description of a DataIntegration.
- UpdateEventIntegration ( array $params = [] )
Updates the description of an event integration.
Operations
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>', 'KmsKey' => '<string>', 'Name' => '<string>', // REQUIRED 'ScheduleConfig' => [ 'FirstExecutionFrom' => '<string>', 'Object' => '<string>', 'ScheduleExpression' => '<string>', ], '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.
- Description
-
- Type: string
A description of the DataIntegration.
- KmsKey
-
- Type: string
The KMS key for the DataIntegration.
- Name
-
- Required: Yes
- Type: string
The name of the DataIntegration.
- 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
One or more tags.
Result Syntax
[ 'Arn' => '<string>', 'ClientToken' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'KmsKey' => '<string>', 'Name' => '<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.
- Description
-
- Type: string
A description of the DataIntegration.
- Id
-
- Type: string
A unique identifier.
- KmsKey
-
- Type: string
The KMS key for the DataIntegration.
- Name
-
- Type: string
The name of the DataIntegration.
- 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
One or more tags.
Errors
-
Request processing failed due to an error or failure with the service.
-
ResourceQuotaExceededException:
The allowed quota for the resource has been exceeded.
-
A resource with the specified name already exists.
-
The throttling limit has been exceeded.
-
The request is not valid.
-
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.
- 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
One or more tags.
Result Syntax
[ 'EventIntegrationArn' => '<string>', ]
Result Details
Errors
-
Request processing failed due to an error or failure with the service.
-
ResourceQuotaExceededException:
The allowed quota for the resource has been exceeded.
-
A resource with the specified name already exists.
-
The throttling limit has been exceeded.
-
The request is not valid.
-
You do not have sufficient access to perform this action.
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
Result Syntax
[]
Result Details
Errors
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
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
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
You do not have sufficient access to perform this action.
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
Result Syntax
[ 'Arn' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'KmsKey' => '<string>', 'Name' => '<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 for the DataIntegration.
- Id
-
- Type: string
A unique identifier.
- KmsKey
-
- Type: string
The KMS key for the DataIntegration.
- Name
-
- Type: string
The name of the DataIntegration.
- 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
One or more tags.
Errors
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
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
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
One or more tags.
Errors
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
You do not have sufficient access to perform this action.
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>', ], // ... ], '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
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
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
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
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The request is not valid.
-
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
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
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
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
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The request is not valid.
-
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
Members
Errors
-
The request is not valid.
-
Request processing failed due to an error or failure with the service.
-
The specified resource was not found.
-
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
Result Syntax
[]
Result Details
Errors
-
The request is not valid.
-
Request processing failed due to an error or failure with the service.
-
The specified resource was not found.
-
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
Result Syntax
[]
Result Details
Errors
-
The request is not valid.
-
Request processing failed due to an error or failure with the service.
-
The specified resource was not found.
-
The throttling limit has been exceeded.
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
Result Syntax
[]
Result Details
Errors
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
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
Result Syntax
[]
Result Details
Errors
-
Request processing failed due to an error or failure with the service.
-
The throttling limit has been exceeded.
-
The specified resource was not found.
-
The request is not valid.
-
You do not have sufficient access to perform this action.
Shapes
AccessDeniedException
DataIntegrationAssociationSummary
Description
Summary information about the DataIntegration association.
Members
- ClientId
-
- Type: string
The identifier for teh 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.
DataIntegrationSummary
Description
Summary information about the DataIntegration.
Members
DuplicateResourceException
EventFilter
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.
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.
InternalServiceError
Description
Request processing failed due to an error or failure with the service.
Members
InvalidRequestException
ResourceNotFoundException
ResourceQuotaExceededException
ScheduleConfiguration
Description
The name of the data and how often it should be pulled from the source.