{ "version":"2.0", "metadata":{ "apiVersion":"2020-07-29", "endpointPrefix":"app-integrations", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"Amazon AppIntegrations Service", "serviceId":"AppIntegrations", "signatureVersion":"v4", "signingName":"app-integrations", "uid":"appintegrations-2020-07-29" }, "operations":{ "CreateEventIntegration":{ "name":"CreateEventIntegration", "http":{ "method":"POST", "requestUri":"/eventIntegrations" }, "input":{"shape":"CreateEventIntegrationRequest"}, "output":{"shape":"CreateEventIntegrationResponse"}, "errors":[ {"shape":"InternalServiceError"}, {"shape":"ResourceQuotaExceededException"}, {"shape":"DuplicateResourceException"}, {"shape":"ThrottlingException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

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 will push events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

" }, "DeleteEventIntegration":{ "name":"DeleteEventIntegration", "http":{ "method":"DELETE", "requestUri":"/eventIntegrations/{Name}" }, "input":{"shape":"DeleteEventIntegrationRequest"}, "output":{"shape":"DeleteEventIntegrationResponse"}, "errors":[ {"shape":"InternalServiceError"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

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

" }, "GetEventIntegration":{ "name":"GetEventIntegration", "http":{ "method":"GET", "requestUri":"/eventIntegrations/{Name}" }, "input":{"shape":"GetEventIntegrationRequest"}, "output":{"shape":"GetEventIntegrationResponse"}, "errors":[ {"shape":"InternalServiceError"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Return information about the event integration.

" }, "ListEventIntegrationAssociations":{ "name":"ListEventIntegrationAssociations", "http":{ "method":"GET", "requestUri":"/eventIntegrations/{Name}/associations" }, "input":{"shape":"ListEventIntegrationAssociationsRequest"}, "output":{"shape":"ListEventIntegrationAssociationsResponse"}, "errors":[ {"shape":"InternalServiceError"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

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

" }, "ListEventIntegrations":{ "name":"ListEventIntegrations", "http":{ "method":"GET", "requestUri":"/eventIntegrations" }, "input":{"shape":"ListEventIntegrationsRequest"}, "output":{"shape":"ListEventIntegrationsResponse"}, "errors":[ {"shape":"InternalServiceError"}, {"shape":"ThrottlingException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Returns a paginated list of event integrations in the account.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceError"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Lists the tags for the specified resource.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceError"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Adds the specified tags to the specified resource.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceError"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Removes the specified tags from the specified resource.

" }, "UpdateEventIntegration":{ "name":"UpdateEventIntegration", "http":{ "method":"PATCH", "requestUri":"/eventIntegrations/{Name}" }, "input":{"shape":"UpdateEventIntegrationRequest"}, "output":{"shape":"UpdateEventIntegrationResponse"}, "errors":[ {"shape":"InternalServiceError"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"} ], "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Updates the description of an event integration.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

You do not have sufficient access to perform this action.

", "error":{"httpStatusCode":403}, "exception":true }, "Arn":{ "type":"string", "max":2048, "min":1, "pattern":"^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" }, "ClientAssociationMetadata":{ "type":"map", "key":{"shape":"NonBlankString"}, "value":{"shape":"NonBlankString"} }, "ClientId":{ "type":"string", "max":255, "min":1, "pattern":".*" }, "CreateEventIntegrationRequest":{ "type":"structure", "required":[ "Name", "EventFilter", "EventBridgeBus" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the event integration.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the event integration.

" }, "EventFilter":{ "shape":"EventFilter", "documentation":"

The event filter.

" }, "EventBridgeBus":{ "shape":"EventBridgeBus", "documentation":"

The Eventbridge bus.

" }, "ClientToken":{ "shape":"IdempotencyToken", "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "idempotencyToken":true }, "Tags":{ "shape":"TagMap", "documentation":"

One or more tags.

" } } }, "CreateEventIntegrationResponse":{ "type":"structure", "members":{ "EventIntegrationArn":{ "shape":"Arn", "documentation":"

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

" } } }, "DeleteEventIntegrationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the event integration.

", "location":"uri", "locationName":"Name" } } }, "DeleteEventIntegrationResponse":{ "type":"structure", "members":{ } }, "Description":{ "type":"string", "max":1000, "min":1, "pattern":".*" }, "DuplicateResourceException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

A resource with the specified name already exists.

", "error":{"httpStatusCode":409}, "exception":true }, "EventBridgeBus":{ "type":"string", "max":255, "min":1, "pattern":"^[a-zA-Z0-9\\/\\._\\-]+$" }, "EventBridgeRuleName":{ "type":"string", "max":2048, "min":1, "pattern":"^[a-zA-Z0-9\\/\\._\\-]+$" }, "EventFilter":{ "type":"structure", "required":["Source"], "members":{ "Source":{ "shape":"Source", "documentation":"

The source of the events.

" } }, "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

The event filter.

" }, "EventIntegration":{ "type":"structure", "members":{ "EventIntegrationArn":{ "shape":"Arn", "documentation":"

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

" }, "Name":{ "shape":"Name", "documentation":"

The name of the event integration.

" }, "Description":{ "shape":"Description", "documentation":"

The event integration description.

" }, "EventFilter":{ "shape":"EventFilter", "documentation":"

The event integration filter.

" }, "EventBridgeBus":{ "shape":"EventBridgeBus", "documentation":"

The Amazon Eventbridge bus for the event integration.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags.

" } }, "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

The event integration.

" }, "EventIntegrationAssociation":{ "type":"structure", "members":{ "EventIntegrationAssociationArn":{ "shape":"Arn", "documentation":"

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

" }, "EventIntegrationAssociationId":{ "shape":"UUID", "documentation":"

The identifier for the event integration association.

" }, "EventIntegrationName":{ "shape":"Name", "documentation":"

The name of the event integration.

" }, "ClientId":{ "shape":"ClientId", "documentation":"

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

" }, "EventBridgeRuleName":{ "shape":"EventBridgeRuleName", "documentation":"

The name of the Eventbridge rule.

" }, "ClientAssociationMetadata":{ "shape":"ClientAssociationMetadata", "documentation":"

The metadata associated with the client.

" } }, "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

The event integration association.

" }, "EventIntegrationAssociationsList":{ "type":"list", "member":{"shape":"EventIntegrationAssociation"}, "max":50, "min":1 }, "EventIntegrationsList":{ "type":"list", "member":{"shape":"EventIntegration"}, "max":50, "min":1 }, "GetEventIntegrationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the event integration.

", "location":"uri", "locationName":"Name" } } }, "GetEventIntegrationResponse":{ "type":"structure", "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the event integration.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the event integration.

" }, "EventIntegrationArn":{ "shape":"Arn", "documentation":"

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

" }, "EventBridgeBus":{ "shape":"EventBridgeBus", "documentation":"

The Eventbridge bus.

" }, "EventFilter":{ "shape":"EventFilter", "documentation":"

The event filter.

" }, "Tags":{ "shape":"TagMap", "documentation":"

One or more tags.

" } } }, "IdempotencyToken":{ "type":"string", "max":2048, "min":1, "pattern":".*" }, "InternalServiceError":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

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

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InvalidRequestException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

The request is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "ListEventIntegrationAssociationsRequest":{ "type":"structure", "required":["EventIntegrationName"], "members":{ "EventIntegrationName":{ "shape":"Name", "documentation":"

The name of the event integration.

", "location":"uri", "locationName":"Name" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return per page.

", "location":"querystring", "locationName":"maxResults" } } }, "ListEventIntegrationAssociationsResponse":{ "type":"structure", "members":{ "EventIntegrationAssociations":{ "shape":"EventIntegrationAssociationsList", "documentation":"

The event integration associations.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ListEventIntegrationsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return per page.

", "location":"querystring", "locationName":"maxResults" } } }, "ListEventIntegrationsResponse":{ "type":"structure", "members":{ "EventIntegrations":{ "shape":"EventIntegrationsList", "documentation":"

The event integrations.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"

Information about the tags.

" } } }, "MaxResults":{ "type":"integer", "max":50, "min":1 }, "Message":{"type":"string"}, "Name":{ "type":"string", "max":255, "min":1, "pattern":"^[a-zA-Z0-9\\/\\._\\-]+$" }, "NextToken":{ "type":"string", "max":1000, "min":1, "pattern":".*" }, "NonBlankString":{ "type":"string", "max":255, "min":1, "pattern":".*\\S.*" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

The specified resource was not found.

", "error":{"httpStatusCode":404}, "exception":true }, "ResourceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

The allowed quota for the resource has been exceeded.

", "error":{"httpStatusCode":429}, "exception":true }, "Source":{ "type":"string", "max":256, "min":1, "pattern":"^aws\\.partner\\/.*$" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"

One or more tags.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256 }, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

The throttling limit has been exceeded.

", "error":{"httpStatusCode":429}, "exception":true }, "UUID":{ "type":"string", "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

The tag keys.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateEventIntegrationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the event integration.

", "location":"uri", "locationName":"Name" }, "Description":{ "shape":"Description", "documentation":"

The description of the event inegration.

" } } }, "UpdateEventIntegrationResponse":{ "type":"structure", "members":{ } } }, "documentation":"

The Amazon AppIntegrations APIs are in preview release and are subject to change.

The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.

For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations in the Amazon Connect Administrator Guide.

" }