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 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.

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()
CreateEventIntegrationResult	createEventIntegration(CreateEventIntegrationRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.
DeleteEventIntegrationResult	deleteEventIntegration(DeleteEventIntegrationRequest request) The Amazon AppIntegrations APIs are in preview release and are 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.
GetEventIntegrationResult	getEventIntegration(GetEventIntegrationRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.
ListEventIntegrationAssociationsResult	listEventIntegrationAssociations(ListEventIntegrationAssociationsRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.
ListEventIntegrationsResult	listEventIntegrations(ListEventIntegrationsRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.
UntagResourceResult	untagResource(UntagResourceRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.
UpdateEventIntegrationResult	updateEventIntegration(UpdateEventIntegrationRequest request) The Amazon AppIntegrations APIs are in preview release and are subject to change.

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()

createEventIntegration

public CreateEventIntegrationResult createEventIntegration(CreateEventIntegrationRequest request)

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.

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

deleteEventIntegration

public DeleteEventIntegrationResult deleteEventIntegration(DeleteEventIntegrationRequest request)

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.

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

getEventIntegration

public GetEventIntegrationResult getEventIntegration(GetEventIntegrationRequest request)

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

Return 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

listEventIntegrationAssociations

public ListEventIntegrationAssociationsResult listEventIntegrationAssociations(ListEventIntegrationAssociationsRequest request)

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

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)

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

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)

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

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)

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

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)

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

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

updateEventIntegration

public UpdateEventIntegrationResult updateEventIntegration(UpdateEventIntegrationRequest request)

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

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