Amazon AppIntegrations Service
Amazon AppIntegrations actions Amazon AppIntegrations data types The Amazon AppIntegrations service enables you to configure and reuse connections to external…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon AppIntegrations
actions
Amazon AppIntegrations
data types
The Amazon AppIntegrations service enables you to configure and reuse connections to external
applications.
For information about how you can use external applications with Connect Customer, see
the following topics in the Connect Customer Administrator
Guide :
Third-party
applications (3p apps) in the agent workspace
Use
Amazon Q in Connect for generative AI–powered agent assistance in
real-time
Endpoints 23
- GETList applications
/applications?nextToken=string&maxResults=0&applicationType=stringLists applications in the account. - POSTCreate application
/applicationsCreates and persists an Application resource. - GETList data integrations
/dataIntegrations?nextToken=string&maxResults=0Returns a paginated list of DataIntegrations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously… - POSTCreate data integration
/dataIntegrationsCreates and persists a DataIntegration resource. You cannot create a DataIntegration association for a DataIntegration that has been previously associated.… - GETList data integration associations
/dataIntegrations/:DataIntegrationIdentifier/associations?nextToken=string&maxResults=0Returns a paginated list of DataIntegration associations in the account. You cannot create a DataIntegration association for a DataIntegration that has been… - POSTCreate data integration association
/dataIntegrations/:DataIntegrationIdentifier/associationsCreates and persists a DataIntegrationAssociation resource. - GETList event integrations
/eventIntegrations?nextToken=string&maxResults=0Returns a paginated list of event integrations in the account. - POSTCreate event integration
/eventIntegrationsCreates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that… - GETGet application
/applications/:ArnGet an Application resource. - DELETEDelete application
/applications/:Arn?force=trueDeletes an application. If the application has associations, you must delete them first. Alternatively, use the force option to delete the application and… - PATCHUpdate application
/applications/:ArnUpdates and persists an Application resource. - DELETEDelete data integration
/dataIntegrations/:DataIntegrationIdentifierDeletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the… - GETGet event integration
/eventIntegrations/:NameReturns information about the event integration. - DELETEDelete event integration
/eventIntegrations/:NameDeletes the specified existing event integration. If the event integration is associated with clients, the request is rejected. - PATCHUpdate event integration
/eventIntegrations/:NameUpdates the description of an event integration. - GETGet data integration
/dataIntegrations/:IdentifierReturns information about the DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use… - PATCHUpdate data integration
/dataIntegrations/:IdentifierUpdates the description of a DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a… - GETList application associations
/applications/:ApplicationId/associations?nextToken=string&maxResults=0Returns a paginated list of application associations for an application. - GETList event integration associations
/eventIntegrations/:EventIntegrationName/associations?nextToken=string&maxResults=0Returns a paginated list of event integration associations in the account. - GETList tags for resource
/tags/:resourceArnLists the tags for the specified resource. - POSTTag resource
/tags/:resourceArnAdds the specified tags to the specified resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes the specified tags from the specified resource. - PATCHUpdate data integration association
/dataIntegrations/:DataIntegrationIdentifier/associations/:DataIntegrationAssociationIdentifierUpdates and persists a DataIntegrationAssociation resource. Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job.
API details
- Base URL
https://app-integrations.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 23 operations on 12 pathsGET 10POST 5PATCH 4DELETE 4
- Description format
- AWS Smithy model, API version
2020-07-29 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon AppIntegrations Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon AppIntegrations Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List applications” (GET /applications?nextToken=string&maxResults=0&applicationType=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon AppIntegrations Service?
Amazon AppIntegrations actions Amazon AppIntegrations data types The Amazon AppIntegrations service enables you to configure and reuse connections to external… It is listed under Developer tools and has 23 endpoints.
Who publishes the Amazon AppIntegrations Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon AppIntegrations Service?
Requests go to https://app-integrations.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon AppIntegrations Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon AppIntegrations Service have?
23 operations on 12 paths (10 GET, 5 POST, 4 PATCH, 4 DELETE).
Is forking the Amazon AppIntegrations Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.