{ "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": { "CreateApplication": { "name": "CreateApplication", "http": { "method": "POST", "requestUri": "/applications" }, "input": { "shape": "CreateApplicationRequest" }, "output": { "shape": "CreateApplicationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ResourceQuotaExceededException" }, { "shape": "DuplicateResourceException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

This API is in preview release and subject to change.

Creates and persists an Application resource.

" }, "CreateDataIntegration": { "name": "CreateDataIntegration", "http": { "method": "POST", "requestUri": "/dataIntegrations" }, "input": { "shape": "CreateDataIntegrationRequest" }, "output": { "shape": "CreateDataIntegrationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ResourceQuotaExceededException" }, { "shape": "DuplicateResourceException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

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.

" }, "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": "

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.

" }, "DeleteApplication": { "name": "DeleteApplication", "http": { "method": "DELETE", "requestUri": "/applications/{ApplicationIdentifier}" }, "input": { "shape": "DeleteApplicationRequest" }, "output": { "shape": "DeleteApplicationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

Deletes the Application. Only Applications that don't have any Application Associations can be deleted.

" }, "DeleteDataIntegration": { "name": "DeleteDataIntegration", "http": { "method": "DELETE", "requestUri": "/dataIntegrations/{Identifier}" }, "input": { "shape": "DeleteDataIntegrationRequest" }, "output": { "shape": "DeleteDataIntegrationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

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.

" }, "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": "

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

" }, "GetApplication": { "name": "GetApplication", "http": { "method": "GET", "requestUri": "/applications/{ApplicationIdentifier}" }, "input": { "shape": "GetApplicationRequest" }, "output": { "shape": "GetApplicationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

This API is in preview release and subject to change.

Get an Application resource.

" }, "GetDataIntegration": { "name": "GetDataIntegration", "http": { "method": "GET", "requestUri": "/dataIntegrations/{Identifier}" }, "input": { "shape": "GetDataIntegrationRequest" }, "output": { "shape": "GetDataIntegrationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

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.

" }, "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": "

Returns information about the event integration.

" }, "ListApplicationAssociations": { "name": "ListApplicationAssociations", "http": { "method": "GET", "requestUri": "/applications/{ApplicationIdentifier}/associations" }, "input": { "shape": "ListApplicationAssociationsRequest" }, "output": { "shape": "ListApplicationAssociationsResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

Returns a paginated list of application associations for an application.

" }, "ListApplications": { "name": "ListApplications", "http": { "method": "GET", "requestUri": "/applications" }, "input": { "shape": "ListApplicationsRequest" }, "output": { "shape": "ListApplicationsResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

This API is in preview release and subject to change.

Lists applications in the account.

" }, "ListDataIntegrationAssociations": { "name": "ListDataIntegrationAssociations", "http": { "method": "GET", "requestUri": "/dataIntegrations/{Identifier}/associations" }, "input": { "shape": "ListDataIntegrationAssociationsRequest" }, "output": { "shape": "ListDataIntegrationAssociationsResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

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.

" }, "ListDataIntegrations": { "name": "ListDataIntegrations", "http": { "method": "GET", "requestUri": "/dataIntegrations" }, "input": { "shape": "ListDataIntegrationsRequest" }, "output": { "shape": "ListDataIntegrationsResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

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.

" }, "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": "

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": "

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": "

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": "

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": "

Removes the specified tags from the specified resource.

" }, "UpdateApplication": { "name": "UpdateApplication", "http": { "method": "PATCH", "requestUri": "/applications/{ApplicationIdentifier}" }, "input": { "shape": "UpdateApplicationRequest" }, "output": { "shape": "UpdateApplicationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

This API is in preview release and subject to change.

Updates and persists an Application resource.

" }, "UpdateDataIntegration": { "name": "UpdateDataIntegration", "http": { "method": "PATCH", "requestUri": "/dataIntegrations/{Identifier}" }, "input": { "shape": "UpdateDataIntegrationRequest" }, "output": { "shape": "UpdateDataIntegrationResponse" }, "errors": [ { "shape": "InternalServiceError" }, { "shape": "ThrottlingException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" } ], "documentation": "

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.

" }, "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": "

Updates the description of an event integration.

" } }, "shapes": { "ApplicationApprovedOrigins": { "type": "list", "member": { "shape": "ApplicationTrustedSource" }, "max": 50, "min": 1 }, "ApplicationAssociationSummary": { "type": "structure", "members": { "ApplicationAssociationArn": { "shape": "Arn", "documentation": "

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

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

The Amazon Resource Name (ARN) of the Application.

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

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

" } }, "documentation": "

Summary information about the Application Association.

" }, "ApplicationAssociationsList": { "type": "list", "member": { "shape": "ApplicationAssociationSummary" }, "max": 50, "min": 1 }, "ApplicationName": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._ \\-]+$" }, "ApplicationNamespace": { "type": "string", "max": 32, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" }, "ApplicationSourceConfig": { "type": "structure", "members": { "ExternalUrlConfig": { "shape": "ExternalUrlConfig", "documentation": "

The external URL source for the application.

" } }, "documentation": "

The configuration for where the application should be loaded from.

" }, "ApplicationSummary": { "type": "structure", "members": { "Arn": { "shape": "Arn", "documentation": "

The Amazon Resource Name (ARN) of the Application.

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

A unique identifier for the Application.

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

The name of the application.

" }, "Namespace": { "shape": "ApplicationNamespace", "documentation": "

The namespace of the application.

" }, "CreatedTime": { "shape": "Timestamp", "documentation": "

The time when the application was created.

" }, "LastModifiedTime": { "shape": "Timestamp", "documentation": "

The time when the application was last modified.

" } }, "documentation": "

Summary information about the Application.

" }, "ApplicationTrustedSource": { "type": "string", "max": 128, "min": 1, "pattern": "^\\w+\\:\\/\\/.*$" }, "ApplicationsList": { "type": "list", "member": { "shape": "ApplicationSummary" }, "max": 50, "min": 1 }, "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}$" }, "ArnOrUUID": { "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}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\\w\\$]+)?$" }, "ClientAssociationMetadata": { "type": "map", "key": { "shape": "NonBlankString" }, "value": { "shape": "NonBlankString" } }, "ClientId": { "type": "string", "max": 255, "min": 1, "pattern": ".*" }, "CreateApplicationRequest": { "type": "structure", "required": [ "Name", "Namespace", "ApplicationSourceConfig" ], "members": { "Name": { "shape": "ApplicationName", "documentation": "

The name of the application.

" }, "Namespace": { "shape": "ApplicationNamespace", "documentation": "

The namespace of the application.

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

The description of the application.

" }, "ApplicationSourceConfig": { "shape": "ApplicationSourceConfig", "documentation": "

The configuration for where the application should be loaded from.

" }, "Subscriptions": { "shape": "SubscriptionList", "documentation": "

The events that the application subscribes.

", "deprecated": true, "deprecatedMessage": "Subscriptions has been replaced with Permissions" }, "Publications": { "shape": "PublicationList", "documentation": "

The events that the application publishes.

", "deprecated": true, "deprecatedMessage": "Publications has been replaced with Permissions" }, "ClientToken": { "shape": "IdempotencyToken", "documentation": "

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.

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

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

" }, "Permissions": { "shape": "PermissionList", "documentation": "

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

" } } }, "CreateApplicationResponse": { "type": "structure", "members": { "Arn": { "shape": "Arn", "documentation": "

The Amazon Resource Name (ARN) of the Application.

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

A unique identifier for the Application.

" } } }, "CreateDataIntegrationRequest": { "type": "structure", "required": [ "Name", "KmsKey", "SourceURI" ], "members": { "Name": { "shape": "Name", "documentation": "

The name of the DataIntegration.

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

A description of the DataIntegration.

" }, "KmsKey": { "shape": "NonBlankString", "documentation": "

The KMS key for the DataIntegration.

" }, "SourceURI": { "shape": "SourceURI", "documentation": "

The URI of the data source.

" }, "ScheduleConfig": { "shape": "ScheduleConfiguration", "documentation": "

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

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

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

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

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.

", "idempotencyToken": true }, "FileConfiguration": { "shape": "FileConfiguration", "documentation": "

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

" }, "ObjectConfiguration": { "shape": "ObjectConfiguration", "documentation": "

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

" } } }, "CreateDataIntegrationResponse": { "type": "structure", "members": { "Arn": { "shape": "Arn", "documentation": "

The Amazon Resource Name (ARN)

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

A unique identifier.

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

The name of the DataIntegration.

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

A description of the DataIntegration.

" }, "KmsKey": { "shape": "NonBlankString", "documentation": "

The KMS key for the DataIntegration.

" }, "SourceURI": { "shape": "SourceURI", "documentation": "

The URI of the data source.

" }, "ScheduleConfiguration": { "shape": "ScheduleConfiguration", "documentation": "

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

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

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

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

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.

" }, "FileConfiguration": { "shape": "FileConfiguration", "documentation": "

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

" }, "ObjectConfiguration": { "shape": "ObjectConfiguration", "documentation": "

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

" } } }, "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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

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

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

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

" } } }, "DataIntegrationAssociationSummary": { "type": "structure", "members": { "DataIntegrationAssociationArn": { "shape": "Arn", "documentation": "

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

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

The Amazon Resource Name (ARN) of the DataIntegration.

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

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

" } }, "documentation": "

Summary information about the DataIntegration association.

" }, "DataIntegrationAssociationsList": { "type": "list", "member": { "shape": "DataIntegrationAssociationSummary" }, "max": 50, "min": 1 }, "DataIntegrationSummary": { "type": "structure", "members": { "Arn": { "shape": "Arn", "documentation": "

The Amazon Resource Name (ARN) of the DataIntegration.

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

The name of the DataIntegration.

" }, "SourceURI": { "shape": "SourceURI", "documentation": "

The URI of the data source.

" } }, "documentation": "

Summary information about the DataIntegration.

" }, "DataIntegrationsList": { "type": "list", "member": { "shape": "DataIntegrationSummary" }, "max": 50, "min": 1 }, "DeleteApplicationRequest": { "type": "structure", "required": [ "Arn" ], "members": { "Arn": { "shape": "ArnOrUUID", "documentation": "

The Amazon Resource Name (ARN) of the Application.

", "location": "uri", "locationName": "ApplicationIdentifier" } } }, "DeleteApplicationResponse": { "type": "structure", "members": {} }, "DeleteDataIntegrationRequest": { "type": "structure", "required": [ "DataIntegrationIdentifier" ], "members": { "DataIntegrationIdentifier": { "shape": "Identifier", "documentation": "

A unique identifier for the DataIntegration.

", "location": "uri", "locationName": "Identifier" } } }, "DeleteDataIntegrationResponse": { "type": "structure", "members": {} }, "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": 0, "pattern": ".*" }, "EventBridgeBus": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" }, "EventBridgeRuleName": { "type": "string", "max": 2048, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" }, "EventDefinitionSchema": { "type": "string", "max": 10240, "min": 1, "pattern": "^.*$" }, "EventFilter": { "type": "structure", "required": [ "Source" ], "members": { "Source": { "shape": "Source", "documentation": "

The source of the events.

" } }, "documentation": "

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 used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" } }, "documentation": "

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 event integration association.

" }, "EventIntegrationAssociationsList": { "type": "list", "member": { "shape": "EventIntegrationAssociation" }, "max": 50, "min": 1 }, "EventIntegrationsList": { "type": "list", "member": { "shape": "EventIntegration" }, "max": 50, "min": 1 }, "EventName": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-]+::[a-zA-Z0-9\\/\\._\\-]+(?:\\*)?$" }, "ExternalUrlConfig": { "type": "structure", "required": [ "AccessUrl" ], "members": { "AccessUrl": { "shape": "URL", "documentation": "

The URL to access the application.

" }, "ApprovedOrigins": { "shape": "ApplicationApprovedOrigins", "documentation": "

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

" } }, "documentation": "

The external URL source for the application.

" }, "Fields": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" }, "FieldsList": { "type": "list", "member": { "shape": "Fields" }, "max": 2048, "min": 1 }, "FieldsMap": { "type": "map", "key": { "shape": "NonBlankString" }, "value": { "shape": "FieldsList" } }, "FileConfiguration": { "type": "structure", "required": [ "Folders" ], "members": { "Folders": { "shape": "FolderList", "documentation": "

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

" }, "Filters": { "shape": "FieldsMap", "documentation": "

Restrictions for what files should be pulled from the source.

" } }, "documentation": "

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

" }, "FolderList": { "type": "list", "member": { "shape": "NonBlankLongString" }, "max": 10, "min": 1 }, "GetApplicationRequest": { "type": "structure", "required": [ "Arn" ], "members": { "Arn": { "shape": "ArnOrUUID", "documentation": "

The Amazon Resource Name (ARN) of the Application.

", "location": "uri", "locationName": "ApplicationIdentifier" } } }, "GetApplicationResponse": { "type": "structure", "members": { "Arn": { "shape": "Arn", "documentation": "

The Amazon Resource Name (ARN) of the Application.

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

A unique identifier for the Application.

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

The name of the application.

" }, "Namespace": { "shape": "ApplicationNamespace", "documentation": "

The namespace of the application.

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

The description of the application.

" }, "ApplicationSourceConfig": { "shape": "ApplicationSourceConfig", "documentation": "

The configuration for where the application should be loaded from.

" }, "Subscriptions": { "shape": "SubscriptionList", "documentation": "

The events that the application subscribes.

", "deprecated": true, "deprecatedMessage": "Subscriptions has been replaced with Permissions" }, "Publications": { "shape": "PublicationList", "documentation": "

The events that the application publishes.

", "deprecated": true, "deprecatedMessage": "Publications has been replaced with Permissions" }, "CreatedTime": { "shape": "Timestamp", "documentation": "

The created time of the Application.

" }, "LastModifiedTime": { "shape": "Timestamp", "documentation": "

The last modified time of the Application.

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

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

" }, "Permissions": { "shape": "PermissionList", "documentation": "

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

" } } }, "GetDataIntegrationRequest": { "type": "structure", "required": [ "Identifier" ], "members": { "Identifier": { "shape": "Identifier", "documentation": "

A unique identifier.

", "location": "uri", "locationName": "Identifier" } } }, "GetDataIntegrationResponse": { "type": "structure", "members": { "Arn": { "shape": "Arn", "documentation": "

The Amazon Resource Name (ARN) for the DataIntegration.

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

A unique identifier.

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

The name of the DataIntegration.

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

The KMS key for the DataIntegration.

" }, "KmsKey": { "shape": "NonBlankString", "documentation": "

The KMS key for the DataIntegration.

" }, "SourceURI": { "shape": "SourceURI", "documentation": "

The URI of the data source.

" }, "ScheduleConfiguration": { "shape": "ScheduleConfiguration", "documentation": "

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

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

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

" }, "FileConfiguration": { "shape": "FileConfiguration", "documentation": "

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

" }, "ObjectConfiguration": { "shape": "ObjectConfiguration", "documentation": "

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

" } } }, "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": "

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

" } } }, "IdempotencyToken": { "type": "string", "max": 2048, "min": 1, "pattern": ".*" }, "Identifier": { "type": "string", "max": 255, "min": 1, "pattern": ".*\\S.*" }, "ListApplicationAssociationsRequest": { "type": "structure", "required": [ "ApplicationId" ], "members": { "ApplicationId": { "shape": "ArnOrUUID", "documentation": "

A unique identifier for the Application.

", "location": "uri", "locationName": "ApplicationIdentifier" }, "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" } } }, "ListApplicationAssociationsResponse": { "type": "structure", "members": { "ApplicationAssociations": { "shape": "ApplicationAssociationsList", "documentation": "

List of Application Associations for the Application.

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

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

" } } }, "ListApplicationsRequest": { "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" } } }, "ListApplicationsResponse": { "type": "structure", "members": { "Applications": { "shape": "ApplicationsList", "documentation": "

The Applications associated with this account.

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

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

" } } }, "ListDataIntegrationAssociationsRequest": { "type": "structure", "required": [ "DataIntegrationIdentifier" ], "members": { "DataIntegrationIdentifier": { "shape": "Identifier", "documentation": "

A unique identifier for the DataIntegration.

", "location": "uri", "locationName": "Identifier" }, "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" } } }, "ListDataIntegrationAssociationsResponse": { "type": "structure", "members": { "DataIntegrationAssociations": { "shape": "DataIntegrationAssociationsList", "documentation": "

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

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

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

" } } }, "ListDataIntegrationsRequest": { "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" } } }, "ListDataIntegrationsResponse": { "type": "structure", "members": { "DataIntegrations": { "shape": "DataIntegrationsList", "documentation": "

The DataIntegrations associated with this account.

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

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

" } } }, "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 }, "Name": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" }, "NextToken": { "type": "string", "max": 1000, "min": 1, "pattern": ".*" }, "NonBlankLongString": { "type": "string", "max": 200, "min": 1, "pattern": ".*\\S.*" }, "NonBlankString": { "type": "string", "max": 255, "min": 1, "pattern": ".*\\S.*" }, "Object": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" }, "ObjectConfiguration": { "type": "map", "key": { "shape": "NonBlankString" }, "value": { "shape": "FieldsMap" }, "documentation": "

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

" }, "Permission": { "type": "string", "documentation": "

The permission of an event or request that the application has access to.

", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9\\/\\._\\-\\*]+$" }, "PermissionList": { "type": "list", "member": { "shape": "Permission" }, "max": 150, "min": 0 }, "Publication": { "type": "structure", "required": [ "Event", "Schema" ], "members": { "Event": { "shape": "EventName", "documentation": "

The name of the publication.

" }, "Schema": { "shape": "EventDefinitionSchema", "documentation": "

The JSON schema of the publication event.

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

The description of the publication.

" } }, "documentation": "

The configuration of an event that the application publishes.

" }, "PublicationList": { "type": "list", "member": { "shape": "Publication" }, "max": 50, "min": 0 }, "ScheduleConfiguration": { "type": "structure", "required": [ "ScheduleExpression" ], "members": { "FirstExecutionFrom": { "shape": "NonBlankString", "documentation": "

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": { "shape": "Object", "documentation": "

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

" }, "ScheduleExpression": { "shape": "NonBlankString", "documentation": "

How often the data should be pulled from data source.

" } }, "documentation": "

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

" }, "Source": { "type": "string", "max": 256, "min": 1, "pattern": "^aws\\.partner\\/.*$" }, "SourceURI": { "type": "string", "max": 1000, "min": 1, "pattern": "^(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+$)|(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+[\\w/!@#+=.-]+[\\w/!@#+=.,-]+$)" }, "Subscription": { "type": "structure", "required": [ "Event" ], "members": { "Event": { "shape": "EventName", "documentation": "

The name of the subscription.

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

The description of the subscription.

" } }, "documentation": "

The configuration of an event that the application subscribes.

" }, "SubscriptionList": { "type": "list", "member": { "shape": "Subscription" }, "max": 50, "min": 0 }, "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": "

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

" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256 }, "Timestamp": { "type": "timestamp" }, "URL": { "type": "string", "max": 1000, "min": 1, "pattern": "^\\w+\\:\\/\\/.*$" }, "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": {} }, "UpdateApplicationRequest": { "type": "structure", "required": [ "Arn" ], "members": { "Arn": { "shape": "ArnOrUUID", "documentation": "

The Amazon Resource Name (ARN) of the Application.

", "location": "uri", "locationName": "ApplicationIdentifier" }, "Name": { "shape": "ApplicationName", "documentation": "

The name of the application.

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

The description of the application.

" }, "ApplicationSourceConfig": { "shape": "ApplicationSourceConfig", "documentation": "

The configuration for where the application should be loaded from.

" }, "Subscriptions": { "shape": "SubscriptionList", "documentation": "

The events that the application subscribes.

", "deprecated": true, "deprecatedMessage": "Subscriptions has been replaced with Permissions" }, "Publications": { "shape": "PublicationList", "documentation": "

The events that the application publishes.

", "deprecated": true, "deprecatedMessage": "Publications has been replaced with Permissions" }, "Permissions": { "shape": "PermissionList", "documentation": "

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

" } } }, "UpdateApplicationResponse": { "type": "structure", "members": {} }, "UpdateDataIntegrationRequest": { "type": "structure", "required": [ "Identifier" ], "members": { "Identifier": { "shape": "Identifier", "documentation": "

A unique identifier for the DataIntegration.

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

The name of the DataIntegration.

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

A description of the DataIntegration.

" } } }, "UpdateDataIntegrationResponse": { "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 integration.

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

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 and Deliver information to agents using Amazon Connect Wisdom in the Amazon Connect Administrator Guide.

" }