com.amazonaws.services.appintegrations

Interface AmazonAppIntegrations

All Known Subinterfaces:

AmazonAppIntegrationsAsync

All Known Implementing Classes:

AbstractAmazonAppIntegrations, AbstractAmazonAppIntegrationsAsync, AmazonAppIntegrationsAsyncClient, AmazonAppIntegrationsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppIntegrations

Interface for accessing Amazon AppIntegrations Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAppIntegrations instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateDataIntegrationResult	createDataIntegration(CreateDataIntegrationRequest createDataIntegrationRequest) Creates and persists a DataIntegration resource.
CreateEventIntegrationResult	createEventIntegration(CreateEventIntegrationRequest createEventIntegrationRequest) 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.
DeleteDataIntegrationResult	deleteDataIntegration(DeleteDataIntegrationRequest deleteDataIntegrationRequest) Deletes the DataIntegration.
DeleteEventIntegrationResult	deleteEventIntegration(DeleteEventIntegrationRequest deleteEventIntegrationRequest) Deletes the specified existing event integration.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDataIntegrationResult	getDataIntegration(GetDataIntegrationRequest getDataIntegrationRequest) Returns information about the DataIntegration.
GetEventIntegrationResult	getEventIntegration(GetEventIntegrationRequest getEventIntegrationRequest) Returns information about the event integration.
ListDataIntegrationAssociationsResult	listDataIntegrationAssociations(ListDataIntegrationAssociationsRequest listDataIntegrationAssociationsRequest) Returns a paginated list of DataIntegration associations in the account.
ListDataIntegrationsResult	listDataIntegrations(ListDataIntegrationsRequest listDataIntegrationsRequest) Returns a paginated list of DataIntegrations in the account.
ListEventIntegrationAssociationsResult	listEventIntegrationAssociations(ListEventIntegrationAssociationsRequest listEventIntegrationAssociationsRequest) Returns a paginated list of event integration associations in the account.
ListEventIntegrationsResult	listEventIntegrations(ListEventIntegrationsRequest listEventIntegrationsRequest) Returns a paginated list of event integrations in the account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
UpdateDataIntegrationResult	updateDataIntegration(UpdateDataIntegrationRequest updateDataIntegrationRequest) Updates the description of a DataIntegration.
UpdateEventIntegrationResult	updateEventIntegration(UpdateEventIntegrationRequest updateEventIntegrationRequest) Updates the description of an event integration.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createDataIntegration

CreateDataIntegrationResult createDataIntegration(CreateDataIntegrationRequest createDataIntegrationRequest)

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.

Parameters:

createDataIntegrationRequest -

Returns:

Result of the CreateDataIntegration operation returned by the service.

Throws:

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

ResourceQuotaExceededException - The allowed quota for the resource has been exceeded.

DuplicateResourceException - A resource with the specified name already exists.

ThrottlingException - The throttling limit has been exceeded.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

createEventIntegration

CreateEventIntegrationResult createEventIntegration(CreateEventIntegrationRequest createEventIntegrationRequest)

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.

Parameters:

createEventIntegrationRequest -

Returns:

Result of the CreateEventIntegration operation returned by the service.

Throws:

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

ResourceQuotaExceededException - The allowed quota for the resource has been exceeded.

DuplicateResourceException - A resource with the specified name already exists.

ThrottlingException - The throttling limit has been exceeded.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

deleteDataIntegration

DeleteDataIntegrationResult deleteDataIntegration(DeleteDataIntegrationRequest deleteDataIntegrationRequest)

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.

Parameters:

deleteDataIntegrationRequest -

Returns:

Result of the DeleteDataIntegration operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

deleteEventIntegration

DeleteEventIntegrationResult deleteEventIntegration(DeleteEventIntegrationRequest deleteEventIntegrationRequest)

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

Parameters:

deleteEventIntegrationRequest -

Returns:

Result of the DeleteEventIntegration operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

getDataIntegration

GetDataIntegrationResult getDataIntegration(GetDataIntegrationRequest getDataIntegrationRequest)

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.

Parameters:

getDataIntegrationRequest -

Returns:

Result of the GetDataIntegration operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

getEventIntegration

GetEventIntegrationResult getEventIntegration(GetEventIntegrationRequest getEventIntegrationRequest)

Returns information about the event integration.

Parameters:

getEventIntegrationRequest -

Returns:

Result of the GetEventIntegration operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listDataIntegrationAssociations

ListDataIntegrationAssociationsResult listDataIntegrationAssociations(ListDataIntegrationAssociationsRequest listDataIntegrationAssociationsRequest)

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.

Parameters:

listDataIntegrationAssociationsRequest -

Returns:

Result of the ListDataIntegrationAssociations operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listDataIntegrations

ListDataIntegrationsResult listDataIntegrations(ListDataIntegrationsRequest listDataIntegrationsRequest)

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.

Parameters:

listDataIntegrationsRequest -

Returns:

Result of the ListDataIntegrations operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listEventIntegrationAssociations

ListEventIntegrationAssociationsResult listEventIntegrationAssociations(ListEventIntegrationAssociationsRequest listEventIntegrationAssociationsRequest)

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

Parameters:

listEventIntegrationAssociationsRequest -

Returns:

Result of the ListEventIntegrationAssociations operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listEventIntegrations

ListEventIntegrationsResult listEventIntegrations(ListEventIntegrationsRequest listEventIntegrationsRequest)

Returns a paginated list of event integrations in the account.

Parameters:

listEventIntegrationsRequest -

Returns:

Result of the ListEventIntegrations operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

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

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds the specified tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

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

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

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

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

See Also:

AWS API Documentation

updateDataIntegration

UpdateDataIntegrationResult updateDataIntegration(UpdateDataIntegrationRequest updateDataIntegrationRequest)

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.

Parameters:

updateDataIntegrationRequest -

Returns:

Result of the UpdateDataIntegration operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

updateEventIntegration

UpdateEventIntegrationResult updateEventIntegration(UpdateEventIntegrationRequest updateEventIntegrationRequest)

Updates the description of an event integration.

Parameters:

updateEventIntegrationRequest -

Returns:

Result of the UpdateEventIntegration operation returned by the service.

Throws:

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.