com.amazonaws.services.appintegrations

Class AmazonAppIntegrationsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.appintegrations.AmazonAppIntegrationsClient

All Implemented Interfaces:

AmazonAppIntegrations

Direct Known Subclasses:

AmazonAppIntegrationsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAppIntegrationsClient
extends AmazonWebServiceClient
implements AmazonAppIntegrations

Client for accessing Amazon AppIntegrations Service. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.appintegrations.AmazonAppIntegrations

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonAppIntegrationsClientBuilder	builder()
CreateApplicationResult	createApplication(CreateApplicationRequest request) This API is in preview release and subject to change.
CreateDataIntegrationResult	createDataIntegration(CreateDataIntegrationRequest request) Creates and persists a DataIntegration resource.
CreateEventIntegrationResult	createEventIntegration(CreateEventIntegrationRequest request) 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.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes the Application.
DeleteDataIntegrationResult	deleteDataIntegration(DeleteDataIntegrationRequest request) Deletes the DataIntegration.
DeleteEventIntegrationResult	deleteEventIntegration(DeleteEventIntegrationRequest request) Deletes the specified existing event integration.
GetApplicationResult	getApplication(GetApplicationRequest request) This API is in preview release and subject to change.
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 request) Returns information about the DataIntegration.
GetEventIntegrationResult	getEventIntegration(GetEventIntegrationRequest request) Returns information about the event integration.
ListApplicationAssociationsResult	listApplicationAssociations(ListApplicationAssociationsRequest request) Returns a paginated list of application associations for an application.
ListApplicationsResult	listApplications(ListApplicationsRequest request) This API is in preview release and subject to change.
ListDataIntegrationAssociationsResult	listDataIntegrationAssociations(ListDataIntegrationAssociationsRequest request) Returns a paginated list of DataIntegration associations in the account.
ListDataIntegrationsResult	listDataIntegrations(ListDataIntegrationsRequest request) Returns a paginated list of DataIntegrations in the account.
ListEventIntegrationAssociationsResult	listEventIntegrationAssociations(ListEventIntegrationAssociationsRequest request) Returns a paginated list of event integration associations in the account.
ListEventIntegrationsResult	listEventIntegrations(ListEventIntegrationsRequest request) Returns a paginated list of event integrations in the account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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 request) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified resource.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) This API is in preview release and subject to change.
UpdateDataIntegrationResult	updateDataIntegration(UpdateDataIntegrationRequest request) Updates the description of a DataIntegration.
UpdateEventIntegrationResult	updateEventIntegration(UpdateEventIntegrationRequest request) Updates the description of an event integration.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonAppIntegrationsClientBuilder builder()

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

This API is in preview release and subject to change.

Creates and persists an Application resource.

Specified by:

createApplication in interface AmazonAppIntegrations

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication 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.

UnsupportedOperationException - The operation is not supported.

See Also:

AWS API Documentation

createDataIntegration

public CreateDataIntegrationResult createDataIntegration(CreateDataIntegrationRequest request)

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.

Specified by:

createDataIntegration in interface AmazonAppIntegrations

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

public CreateEventIntegrationResult createEventIntegration(CreateEventIntegrationRequest request)

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.

Specified by:

createEventIntegration in interface AmazonAppIntegrations

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

deleteApplication

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

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

Specified by:

deleteApplication in interface AmazonAppIntegrations

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication 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

deleteDataIntegration

public DeleteDataIntegrationResult deleteDataIntegration(DeleteDataIntegrationRequest request)

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.

Specified by:

deleteDataIntegration in interface AmazonAppIntegrations

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

public DeleteEventIntegrationResult deleteEventIntegration(DeleteEventIntegrationRequest request)

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

Specified by:

deleteEventIntegration in interface AmazonAppIntegrations

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

getApplication

public GetApplicationResult getApplication(GetApplicationRequest request)

This API is in preview release and subject to change.

Get an Application resource.

Specified by:

getApplication in interface AmazonAppIntegrations

Parameters:

getApplicationRequest -

Returns:

Result of the GetApplication 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

public GetDataIntegrationResult getDataIntegration(GetDataIntegrationRequest request)

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.

Specified by:

getDataIntegration in interface AmazonAppIntegrations

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

public GetEventIntegrationResult getEventIntegration(GetEventIntegrationRequest request)

Returns information about the event integration.

Specified by:

getEventIntegration in interface AmazonAppIntegrations

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

listApplicationAssociations

public ListApplicationAssociationsResult listApplicationAssociations(ListApplicationAssociationsRequest request)

Returns a paginated list of application associations for an application.

Specified by:

listApplicationAssociations in interface AmazonAppIntegrations

Parameters:

listApplicationAssociationsRequest -

Returns:

Result of the ListApplicationAssociations 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

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

This API is in preview release and subject to change.

Lists applications in the account.

Specified by:

listApplications in interface AmazonAppIntegrations

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications 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

listDataIntegrationAssociations

public ListDataIntegrationAssociationsResult listDataIntegrationAssociations(ListDataIntegrationAssociationsRequest request)

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.

Specified by:

listDataIntegrationAssociations in interface AmazonAppIntegrations

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

public ListDataIntegrationsResult listDataIntegrations(ListDataIntegrationsRequest request)

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.

Specified by:

listDataIntegrations in interface AmazonAppIntegrations

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

public ListEventIntegrationAssociationsResult listEventIntegrationAssociations(ListEventIntegrationAssociationsRequest request)

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

Specified by:

listEventIntegrationAssociations in interface AmazonAppIntegrations

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

public ListEventIntegrationsResult listEventIntegrations(ListEventIntegrationsRequest request)

Returns a paginated list of event integrations in the account.

Specified by:

listEventIntegrations in interface AmazonAppIntegrations

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AmazonAppIntegrations

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

public TagResourceResult tagResource(TagResourceRequest request)

Adds the specified tags to the specified resource.

Specified by:

tagResource in interface AmazonAppIntegrations

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags from the specified resource.

Specified by:

untagResource in interface AmazonAppIntegrations

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

updateApplication

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

This API is in preview release and subject to change.

Updates and persists an Application resource.

Specified by:

updateApplication in interface AmazonAppIntegrations

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication 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.

UnsupportedOperationException - The operation is not supported.

See Also:

AWS API Documentation

updateDataIntegration

public UpdateDataIntegrationResult updateDataIntegration(UpdateDataIntegrationRequest request)

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.

Specified by:

updateDataIntegration in interface AmazonAppIntegrations

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

public UpdateEventIntegrationResult updateEventIntegration(UpdateEventIntegrationRequest request)

Updates the description of an event integration.

Specified by:

updateEventIntegration in interface AmazonAppIntegrations

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonAppIntegrations

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonAppIntegrations

Overrides:

shutdown in class AmazonWebServiceClient