com.amazonaws.services.supportapp

Class AWSSupportAppAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.supportapp.AWSSupportAppClient

com.amazonaws.services.supportapp.AWSSupportAppAsyncClient

All Implemented Interfaces:

AWSSupportApp, AWSSupportAppAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSupportAppAsyncClient
extends AWSSupportAppClient
implements AWSSupportAppAsync

Client for accessing SupportApp asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon Web Services Support App in Slack

You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can perform the following tasks directly in your Slack channel:

• Create, search, update, and resolve your support cases

• Request service quota increases for your account

• Invite Amazon Web Services Support agents to your channel so that you can chat directly about your support cases

For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide:

• Amazon Web Services Support App in Slack

• Joining a live chat session with Amazon Web Services Support

• Requesting service quota increases

• Amazon Web Services Support App commands in Slack

You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack configurations. For more information, see Authorize a Slack workspace to enable the Amazon Web Services Support App.

  <note> <ul> <li> <p>You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API. </p> </li> <li> <p>For more information about the Amazon Web Services Support App endpoints, see the <a href="https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region">Amazon Web Services Support App in Slack endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> </ul> </note> 
 

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.supportapp.AWSSupportApp

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSupportAppAsyncClientBuilder	asyncBuilder()
Future<CreateSlackChannelConfigurationResult>	createSlackChannelConfigurationAsync(CreateSlackChannelConfigurationRequest request) Creates a Slack channel configuration for your Amazon Web Services account.
Future<CreateSlackChannelConfigurationResult>	createSlackChannelConfigurationAsync(CreateSlackChannelConfigurationRequest request, AsyncHandler<CreateSlackChannelConfigurationRequest,CreateSlackChannelConfigurationResult> asyncHandler) Creates a Slack channel configuration for your Amazon Web Services account.
Future<DeleteAccountAliasResult>	deleteAccountAliasAsync(DeleteAccountAliasRequest request) Deletes an alias for an Amazon Web Services account ID.
Future<DeleteAccountAliasResult>	deleteAccountAliasAsync(DeleteAccountAliasRequest request, AsyncHandler<DeleteAccountAliasRequest,DeleteAccountAliasResult> asyncHandler) Deletes an alias for an Amazon Web Services account ID.
Future<DeleteSlackChannelConfigurationResult>	deleteSlackChannelConfigurationAsync(DeleteSlackChannelConfigurationRequest request) Deletes a Slack channel configuration from your Amazon Web Services account.
Future<DeleteSlackChannelConfigurationResult>	deleteSlackChannelConfigurationAsync(DeleteSlackChannelConfigurationRequest request, AsyncHandler<DeleteSlackChannelConfigurationRequest,DeleteSlackChannelConfigurationResult> asyncHandler) Deletes a Slack channel configuration from your Amazon Web Services account.
Future<DeleteSlackWorkspaceConfigurationResult>	deleteSlackWorkspaceConfigurationAsync(DeleteSlackWorkspaceConfigurationRequest request) Deletes a Slack workspace configuration from your Amazon Web Services account.
Future<DeleteSlackWorkspaceConfigurationResult>	deleteSlackWorkspaceConfigurationAsync(DeleteSlackWorkspaceConfigurationRequest request, AsyncHandler<DeleteSlackWorkspaceConfigurationRequest,DeleteSlackWorkspaceConfigurationResult> asyncHandler) Deletes a Slack workspace configuration from your Amazon Web Services account.
Future<GetAccountAliasResult>	getAccountAliasAsync(GetAccountAliasRequest request) Retrieves the alias from an Amazon Web Services account ID.
Future<GetAccountAliasResult>	getAccountAliasAsync(GetAccountAliasRequest request, AsyncHandler<GetAccountAliasRequest,GetAccountAliasResult> asyncHandler) Retrieves the alias from an Amazon Web Services account ID.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListSlackChannelConfigurationsResult>	listSlackChannelConfigurationsAsync(ListSlackChannelConfigurationsRequest request) Lists the Slack channel configurations for an Amazon Web Services account.
Future<ListSlackChannelConfigurationsResult>	listSlackChannelConfigurationsAsync(ListSlackChannelConfigurationsRequest request, AsyncHandler<ListSlackChannelConfigurationsRequest,ListSlackChannelConfigurationsResult> asyncHandler) Lists the Slack channel configurations for an Amazon Web Services account.
Future<ListSlackWorkspaceConfigurationsResult>	listSlackWorkspaceConfigurationsAsync(ListSlackWorkspaceConfigurationsRequest request) Lists the Slack workspace configurations for an Amazon Web Services account.
Future<ListSlackWorkspaceConfigurationsResult>	listSlackWorkspaceConfigurationsAsync(ListSlackWorkspaceConfigurationsRequest request, AsyncHandler<ListSlackWorkspaceConfigurationsRequest,ListSlackWorkspaceConfigurationsResult> asyncHandler) Lists the Slack workspace configurations for an Amazon Web Services account.
Future<PutAccountAliasResult>	putAccountAliasAsync(PutAccountAliasRequest request) Creates or updates an individual alias for each Amazon Web Services account ID.
Future<PutAccountAliasResult>	putAccountAliasAsync(PutAccountAliasRequest request, AsyncHandler<PutAccountAliasRequest,PutAccountAliasResult> asyncHandler) Creates or updates an individual alias for each Amazon Web Services account ID.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<UpdateSlackChannelConfigurationResult>	updateSlackChannelConfigurationAsync(UpdateSlackChannelConfigurationRequest request) Updates the configuration for a Slack channel, such as case update notifications.
Future<UpdateSlackChannelConfigurationResult>	updateSlackChannelConfigurationAsync(UpdateSlackChannelConfigurationRequest request, AsyncHandler<UpdateSlackChannelConfigurationRequest,UpdateSlackChannelConfigurationResult> asyncHandler) Updates the configuration for a Slack channel, such as case update notifications.

Methods inherited from class com.amazonaws.services.supportapp.AWSSupportAppClient

builder, createSlackChannelConfiguration, deleteAccountAlias, deleteSlackChannelConfiguration, deleteSlackWorkspaceConfiguration, getAccountAlias, getCachedResponseMetadata, listSlackChannelConfigurations, listSlackWorkspaceConfigurations, putAccountAlias, updateSlackChannelConfiguration

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

Methods inherited from interface com.amazonaws.services.supportapp.AWSSupportApp

createSlackChannelConfiguration, deleteAccountAlias, deleteSlackChannelConfiguration, deleteSlackWorkspaceConfiguration, getAccountAlias, getCachedResponseMetadata, listSlackChannelConfigurations, listSlackWorkspaceConfigurations, putAccountAlias, updateSlackChannelConfiguration

Method Detail

asyncBuilder

public static AWSSupportAppAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createSlackChannelConfigurationAsync

public Future<CreateSlackChannelConfigurationResult> createSlackChannelConfigurationAsync(CreateSlackChannelConfigurationRequest request)

Description copied from interface: AWSSupportAppAsync

Creates a Slack channel configuration for your Amazon Web Services account.

• You can add up to 5 Slack workspaces for your account.

• You can add up to 20 Slack channels for your account.

A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel.

We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.

Specified by:

createSlackChannelConfigurationAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the CreateSlackChannelConfiguration operation returned by the service.

See Also:

AWS API Documentation

createSlackChannelConfigurationAsync

public Future<CreateSlackChannelConfigurationResult> createSlackChannelConfigurationAsync(CreateSlackChannelConfigurationRequest request,
                                                                                          AsyncHandler<CreateSlackChannelConfigurationRequest,CreateSlackChannelConfigurationResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Creates a Slack channel configuration for your Amazon Web Services account.

• You can add up to 5 Slack workspaces for your account.

• You can add up to 20 Slack channels for your account.

A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel.

We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.

Specified by:

createSlackChannelConfigurationAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateSlackChannelConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteAccountAliasAsync

public Future<DeleteAccountAliasResult> deleteAccountAliasAsync(DeleteAccountAliasRequest request)

Description copied from interface: AWSSupportAppAsync

Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Specified by:

deleteAccountAliasAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the DeleteAccountAlias operation returned by the service.

See Also:

AWS API Documentation

deleteAccountAliasAsync

public Future<DeleteAccountAliasResult> deleteAccountAliasAsync(DeleteAccountAliasRequest request,
                                                                AsyncHandler<DeleteAccountAliasRequest,DeleteAccountAliasResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Specified by:

deleteAccountAliasAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteAccountAlias operation returned by the service.

See Also:

AWS API Documentation

deleteSlackChannelConfigurationAsync

public Future<DeleteSlackChannelConfigurationResult> deleteSlackChannelConfigurationAsync(DeleteSlackChannelConfigurationRequest request)

Description copied from interface: AWSSupportAppAsync

Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.

Specified by:

deleteSlackChannelConfigurationAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the DeleteSlackChannelConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteSlackChannelConfigurationAsync

public Future<DeleteSlackChannelConfigurationResult> deleteSlackChannelConfigurationAsync(DeleteSlackChannelConfigurationRequest request,
                                                                                          AsyncHandler<DeleteSlackChannelConfigurationRequest,DeleteSlackChannelConfigurationResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.

Specified by:

deleteSlackChannelConfigurationAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteSlackChannelConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteSlackWorkspaceConfigurationAsync

public Future<DeleteSlackWorkspaceConfigurationResult> deleteSlackWorkspaceConfigurationAsync(DeleteSlackWorkspaceConfigurationRequest request)

Description copied from interface: AWSSupportAppAsync

Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.

Specified by:

deleteSlackWorkspaceConfigurationAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the DeleteSlackWorkspaceConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteSlackWorkspaceConfigurationAsync

public Future<DeleteSlackWorkspaceConfigurationResult> deleteSlackWorkspaceConfigurationAsync(DeleteSlackWorkspaceConfigurationRequest request,
                                                                                              AsyncHandler<DeleteSlackWorkspaceConfigurationRequest,DeleteSlackWorkspaceConfigurationResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.

Specified by:

deleteSlackWorkspaceConfigurationAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteSlackWorkspaceConfiguration operation returned by the service.

See Also:

AWS API Documentation

getAccountAliasAsync

public Future<GetAccountAliasResult> getAccountAliasAsync(GetAccountAliasRequest request)

Description copied from interface: AWSSupportAppAsync

Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Specified by:

getAccountAliasAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the GetAccountAlias operation returned by the service.

See Also:

AWS API Documentation

getAccountAliasAsync

public Future<GetAccountAliasResult> getAccountAliasAsync(GetAccountAliasRequest request,
                                                          AsyncHandler<GetAccountAliasRequest,GetAccountAliasResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Specified by:

getAccountAliasAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetAccountAlias operation returned by the service.

See Also:

AWS API Documentation

listSlackChannelConfigurationsAsync

public Future<ListSlackChannelConfigurationsResult> listSlackChannelConfigurationsAsync(ListSlackChannelConfigurationsRequest request)

Description copied from interface: AWSSupportAppAsync

Lists the Slack channel configurations for an Amazon Web Services account.

Specified by:

listSlackChannelConfigurationsAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the ListSlackChannelConfigurations operation returned by the service.

See Also:

AWS API Documentation

listSlackChannelConfigurationsAsync

public Future<ListSlackChannelConfigurationsResult> listSlackChannelConfigurationsAsync(ListSlackChannelConfigurationsRequest request,
                                                                                        AsyncHandler<ListSlackChannelConfigurationsRequest,ListSlackChannelConfigurationsResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Lists the Slack channel configurations for an Amazon Web Services account.

Specified by:

listSlackChannelConfigurationsAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListSlackChannelConfigurations operation returned by the service.

See Also:

AWS API Documentation

listSlackWorkspaceConfigurationsAsync

public Future<ListSlackWorkspaceConfigurationsResult> listSlackWorkspaceConfigurationsAsync(ListSlackWorkspaceConfigurationsRequest request)

Description copied from interface: AWSSupportAppAsync

Lists the Slack workspace configurations for an Amazon Web Services account.

Specified by:

listSlackWorkspaceConfigurationsAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the ListSlackWorkspaceConfigurations operation returned by the service.

See Also:

AWS API Documentation

listSlackWorkspaceConfigurationsAsync

public Future<ListSlackWorkspaceConfigurationsResult> listSlackWorkspaceConfigurationsAsync(ListSlackWorkspaceConfigurationsRequest request,
                                                                                            AsyncHandler<ListSlackWorkspaceConfigurationsRequest,ListSlackWorkspaceConfigurationsResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Lists the Slack workspace configurations for an Amazon Web Services account.

Specified by:

listSlackWorkspaceConfigurationsAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListSlackWorkspaceConfigurations operation returned by the service.

See Also:

AWS API Documentation

putAccountAliasAsync

public Future<PutAccountAliasResult> putAccountAliasAsync(PutAccountAliasRequest request)

Description copied from interface: AWSSupportAppAsync

Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Specified by:

putAccountAliasAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the PutAccountAlias operation returned by the service.

See Also:

AWS API Documentation

putAccountAliasAsync

public Future<PutAccountAliasResult> putAccountAliasAsync(PutAccountAliasRequest request,
                                                          AsyncHandler<PutAccountAliasRequest,PutAccountAliasResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Specified by:

putAccountAliasAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutAccountAlias operation returned by the service.

See Also:

AWS API Documentation

updateSlackChannelConfigurationAsync

public Future<UpdateSlackChannelConfigurationResult> updateSlackChannelConfigurationAsync(UpdateSlackChannelConfigurationRequest request)

Description copied from interface: AWSSupportAppAsync

Updates the configuration for a Slack channel, such as case update notifications.

Specified by:

updateSlackChannelConfigurationAsync in interface AWSSupportAppAsync

Returns:

A Java Future containing the result of the UpdateSlackChannelConfiguration operation returned by the service.

See Also:

AWS API Documentation

updateSlackChannelConfigurationAsync

public Future<UpdateSlackChannelConfigurationResult> updateSlackChannelConfigurationAsync(UpdateSlackChannelConfigurationRequest request,
                                                                                          AsyncHandler<UpdateSlackChannelConfigurationRequest,UpdateSlackChannelConfigurationResult> asyncHandler)

Description copied from interface: AWSSupportAppAsync

Updates the configuration for a Slack channel, such as case update notifications.

Specified by:

updateSlackChannelConfigurationAsync in interface AWSSupportAppAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateSlackChannelConfiguration operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSSupportApp

Overrides:

shutdown in class AWSSupportAppClient