APIHub
Back to Explore

Amazon AppIntegrations Service

The Amazon AppIntegrations Service API lets you create, retrieve, update, list, and delete DataIntegration and EventIntegration resources, manage their associations, and add or remove tags on those resources.

Cloud
apiKeyHeader
No HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

468ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/dataIntegrations

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.

GET

/dataIntegrations

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.

  • nextToken (query) — 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.
  • maxResults (query, limit) — The maximum number of results to return per page.
POST

/eventIntegrations

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.

GET

/eventIntegrations

Returns a paginated list of event integrations in the account.

  • nextToken (query) — 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.
  • maxResults (query, limit) — The maximum number of results to return per page.
DELETE

/dataIntegrations/{Identifier}

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.

  • Identifier (path, required) — A unique identifier for the DataIntegration.
GET

/dataIntegrations/{Identifier}

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.

  • Identifier (path, required) — A unique identifier.
PATCH

/dataIntegrations/{Identifier}

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.

  • Identifier (path, required) — A unique identifier for the DataIntegration.
DELETE

/eventIntegrations/{Name}

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

  • Name (path, required) — The name of the event integration.
GET

/eventIntegrations/{Name}

Returns information about the event integration.

  • Name (path, required) — The name of the event integration.
PATCH

/eventIntegrations/{Name}

Updates the description of an event integration.

  • Name (path, required) — The name of the event integration.
GET

/dataIntegrations/{Identifier}/associations

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.

  • Identifier (path, required) — A unique identifier for the DataIntegration.
  • nextToken (query) — 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.
  • maxResults (query, limit) — The maximum number of results to return per page.
GET

/eventIntegrations/{Name}/associations

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

  • Name (path, required) — The name of the event integration.
  • nextToken (query) — 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.
  • maxResults (query, limit) — The maximum number of results to return per page.
GET

/tags/{resourceArn}

Lists the tags for the specified resource.

  • resourceArn (path, required) — The Amazon Resource Name (ARN) of the resource.
POST

/tags/{resourceArn}

Adds the specified tags to the specified resource.

  • resourceArn (path, required) — The Amazon Resource Name (ARN) of the resource.
DELETE

/tags/{resourceArn}#tagKeys

Removes the specified tags from the specified resource.

  • resourceArn (path, required) — The Amazon Resource Name (ARN) of the resource.
  • tagKeys (query, required) — The tag keys.

15 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X POST \
  "https://github.com/mermade/aws2openapi/dataIntegrations" \
  -H "Authorization: YOUR_API_KEY"

github.com · HTTPS only