Interface SupportAppAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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:
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.
-
You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.
-
For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General Reference.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SupportAppAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSupportAppAsyncClient
.static SupportAppAsyncClient
create()
Create aSupportAppAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createSlackChannelConfiguration
(Consumer<CreateSlackChannelConfigurationRequest.Builder> createSlackChannelConfigurationRequest) Creates a Slack channel configuration for your Amazon Web Services account.createSlackChannelConfiguration
(CreateSlackChannelConfigurationRequest createSlackChannelConfigurationRequest) Creates a Slack channel configuration for your Amazon Web Services account.deleteAccountAlias
(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest) Deletes an alias for an Amazon Web Services account ID.deleteAccountAlias
(DeleteAccountAliasRequest deleteAccountAliasRequest) Deletes an alias for an Amazon Web Services account ID.deleteSlackChannelConfiguration
(Consumer<DeleteSlackChannelConfigurationRequest.Builder> deleteSlackChannelConfigurationRequest) Deletes a Slack channel configuration from your Amazon Web Services account.deleteSlackChannelConfiguration
(DeleteSlackChannelConfigurationRequest deleteSlackChannelConfigurationRequest) Deletes a Slack channel configuration from your Amazon Web Services account.deleteSlackWorkspaceConfiguration
(Consumer<DeleteSlackWorkspaceConfigurationRequest.Builder> deleteSlackWorkspaceConfigurationRequest) Deletes a Slack workspace configuration from your Amazon Web Services account.deleteSlackWorkspaceConfiguration
(DeleteSlackWorkspaceConfigurationRequest deleteSlackWorkspaceConfigurationRequest) Deletes a Slack workspace configuration from your Amazon Web Services account.default CompletableFuture
<GetAccountAliasResponse> getAccountAlias
(Consumer<GetAccountAliasRequest.Builder> getAccountAliasRequest) Retrieves the alias from an Amazon Web Services account ID.default CompletableFuture
<GetAccountAliasResponse> getAccountAlias
(GetAccountAliasRequest getAccountAliasRequest) Retrieves the alias from an Amazon Web Services account ID.listSlackChannelConfigurations
(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest) Lists the Slack channel configurations for an Amazon Web Services account.listSlackChannelConfigurations
(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest) Lists the Slack channel configurations for an Amazon Web Services account.listSlackChannelConfigurationsPaginator
(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest) This is a variant oflistSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest)
operation.listSlackChannelConfigurationsPaginator
(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest) This is a variant oflistSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest)
operation.listSlackWorkspaceConfigurations
(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest) Lists the Slack workspace configurations for an Amazon Web Services account.listSlackWorkspaceConfigurations
(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest) Lists the Slack workspace configurations for an Amazon Web Services account.listSlackWorkspaceConfigurationsPaginator
(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest) This is a variant oflistSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest)
operation.listSlackWorkspaceConfigurationsPaginator
(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest) This is a variant oflistSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest)
operation.default CompletableFuture
<PutAccountAliasResponse> putAccountAlias
(Consumer<PutAccountAliasRequest.Builder> putAccountAliasRequest) Creates or updates an individual alias for each Amazon Web Services account ID.default CompletableFuture
<PutAccountAliasResponse> putAccountAlias
(PutAccountAliasRequest putAccountAliasRequest) Creates or updates an individual alias for each Amazon Web Services account ID.registerSlackWorkspaceForOrganization
(Consumer<RegisterSlackWorkspaceForOrganizationRequest.Builder> registerSlackWorkspaceForOrganizationRequest) Registers a Slack workspace for your Amazon Web Services account.registerSlackWorkspaceForOrganization
(RegisterSlackWorkspaceForOrganizationRequest registerSlackWorkspaceForOrganizationRequest) Registers a Slack workspace for your Amazon Web Services account.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationupdateSlackChannelConfiguration
(Consumer<UpdateSlackChannelConfigurationRequest.Builder> updateSlackChannelConfigurationRequest) Updates the configuration for a Slack channel, such as case update notifications.updateSlackChannelConfiguration
(UpdateSlackChannelConfigurationRequest updateSlackChannelConfigurationRequest) Updates the configuration for a Slack channel, such as case update notifications.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createSlackChannelConfiguration
default CompletableFuture<CreateSlackChannelConfigurationResponse> createSlackChannelConfiguration(CreateSlackChannelConfigurationRequest createSlackChannelConfigurationRequest) 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.
- Parameters:
createSlackChannelConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateSlackChannelConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException Your Service Quotas request exceeds the quota for the service. For example, your Service Quotas request to Amazon Web Services Support App might exceed the maximum number of workspaces or channels per account, or the maximum number of accounts per Slack channel.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createSlackChannelConfiguration
default CompletableFuture<CreateSlackChannelConfigurationResponse> createSlackChannelConfiguration(Consumer<CreateSlackChannelConfigurationRequest.Builder> createSlackChannelConfigurationRequest) 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.
This is a convenience which creates an instance of the
CreateSlackChannelConfigurationRequest.Builder
avoiding the need to create one manually viaCreateSlackChannelConfigurationRequest.builder()
- Parameters:
createSlackChannelConfigurationRequest
- AConsumer
that will call methods onCreateSlackChannelConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSlackChannelConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException Your Service Quotas request exceeds the quota for the service. For example, your Service Quotas request to Amazon Web Services Support App might exceed the maximum number of workspaces or channels per account, or the maximum number of accounts per Slack channel.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteAccountAlias
default CompletableFuture<DeleteAccountAliasResponse> deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest) 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.
- Parameters:
deleteAccountAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccountAlias
default CompletableFuture<DeleteAccountAliasResponse> deleteAccountAlias(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest) 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.
This is a convenience which creates an instance of the
DeleteAccountAliasRequest.Builder
avoiding the need to create one manually viaDeleteAccountAliasRequest.builder()
- Parameters:
deleteAccountAliasRequest
- AConsumer
that will call methods onDeleteAccountAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSlackChannelConfiguration
default CompletableFuture<DeleteSlackChannelConfigurationResponse> deleteSlackChannelConfiguration(DeleteSlackChannelConfigurationRequest deleteSlackChannelConfigurationRequest) Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.
- Parameters:
deleteSlackChannelConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteSlackChannelConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
deleteSlackChannelConfiguration
default CompletableFuture<DeleteSlackChannelConfigurationResponse> deleteSlackChannelConfiguration(Consumer<DeleteSlackChannelConfigurationRequest.Builder> deleteSlackChannelConfigurationRequest) Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.
This is a convenience which creates an instance of the
DeleteSlackChannelConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteSlackChannelConfigurationRequest.builder()
- Parameters:
deleteSlackChannelConfigurationRequest
- AConsumer
that will call methods onDeleteSlackChannelConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSlackChannelConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
deleteSlackWorkspaceConfiguration
default CompletableFuture<DeleteSlackWorkspaceConfigurationResponse> deleteSlackWorkspaceConfiguration(DeleteSlackWorkspaceConfigurationRequest deleteSlackWorkspaceConfigurationRequest) Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.
- Parameters:
deleteSlackWorkspaceConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteSlackWorkspaceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
deleteSlackWorkspaceConfiguration
default CompletableFuture<DeleteSlackWorkspaceConfigurationResponse> deleteSlackWorkspaceConfiguration(Consumer<DeleteSlackWorkspaceConfigurationRequest.Builder> deleteSlackWorkspaceConfigurationRequest) Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.
This is a convenience which creates an instance of the
DeleteSlackWorkspaceConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteSlackWorkspaceConfigurationRequest.builder()
- Parameters:
deleteSlackWorkspaceConfigurationRequest
- AConsumer
that will call methods onDeleteSlackWorkspaceConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSlackWorkspaceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
getAccountAlias
default CompletableFuture<GetAccountAliasResponse> getAccountAlias(GetAccountAliasRequest getAccountAliasRequest) 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.
- Parameters:
getAccountAliasRequest
-- Returns:
- A Java Future containing the result of the GetAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountAlias
default CompletableFuture<GetAccountAliasResponse> getAccountAlias(Consumer<GetAccountAliasRequest.Builder> getAccountAliasRequest) 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.
This is a convenience which creates an instance of the
GetAccountAliasRequest.Builder
avoiding the need to create one manually viaGetAccountAliasRequest.builder()
- Parameters:
getAccountAliasRequest
- AConsumer
that will call methods onGetAccountAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackChannelConfigurations
default CompletableFuture<ListSlackChannelConfigurationsResponse> listSlackChannelConfigurations(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest) Lists the Slack channel configurations for an Amazon Web Services account.
- Parameters:
listSlackChannelConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListSlackChannelConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackChannelConfigurations
default CompletableFuture<ListSlackChannelConfigurationsResponse> listSlackChannelConfigurations(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest) Lists the Slack channel configurations for an Amazon Web Services account.
This is a convenience which creates an instance of the
ListSlackChannelConfigurationsRequest.Builder
avoiding the need to create one manually viaListSlackChannelConfigurationsRequest.builder()
- Parameters:
listSlackChannelConfigurationsRequest
- AConsumer
that will call methods onListSlackChannelConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSlackChannelConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackChannelConfigurationsPaginator
default ListSlackChannelConfigurationsPublisher listSlackChannelConfigurationsPaginator(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest) This is a variant of
listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsPublisher publisher = client.listSlackChannelConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsPublisher publisher = client.listSlackChannelConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest)
operation.- Parameters:
listSlackChannelConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackChannelConfigurationsPaginator
default ListSlackChannelConfigurationsPublisher listSlackChannelConfigurationsPaginator(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest) This is a variant of
listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsPublisher publisher = client.listSlackChannelConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsPublisher publisher = client.listSlackChannelConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListSlackChannelConfigurationsRequest.Builder
avoiding the need to create one manually viaListSlackChannelConfigurationsRequest.builder()
- Parameters:
listSlackChannelConfigurationsRequest
- AConsumer
that will call methods onListSlackChannelConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackWorkspaceConfigurations
default CompletableFuture<ListSlackWorkspaceConfigurationsResponse> listSlackWorkspaceConfigurations(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest) Lists the Slack workspace configurations for an Amazon Web Services account.
- Parameters:
listSlackWorkspaceConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListSlackWorkspaceConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackWorkspaceConfigurations
default CompletableFuture<ListSlackWorkspaceConfigurationsResponse> listSlackWorkspaceConfigurations(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest) Lists the Slack workspace configurations for an Amazon Web Services account.
This is a convenience which creates an instance of the
ListSlackWorkspaceConfigurationsRequest.Builder
avoiding the need to create one manually viaListSlackWorkspaceConfigurationsRequest.builder()
- Parameters:
listSlackWorkspaceConfigurationsRequest
- AConsumer
that will call methods onListSlackWorkspaceConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSlackWorkspaceConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackWorkspaceConfigurationsPaginator
default ListSlackWorkspaceConfigurationsPublisher listSlackWorkspaceConfigurationsPaginator(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest) This is a variant of
listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsPublisher publisher = client.listSlackWorkspaceConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsPublisher publisher = client.listSlackWorkspaceConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest)
operation.- Parameters:
listSlackWorkspaceConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSlackWorkspaceConfigurationsPaginator
default ListSlackWorkspaceConfigurationsPublisher listSlackWorkspaceConfigurationsPaginator(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest) This is a variant of
listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsPublisher publisher = client.listSlackWorkspaceConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsPublisher publisher = client.listSlackWorkspaceConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListSlackWorkspaceConfigurationsRequest.Builder
avoiding the need to create one manually viaListSlackWorkspaceConfigurationsRequest.builder()
- Parameters:
listSlackWorkspaceConfigurationsRequest
- AConsumer
that will call methods onListSlackWorkspaceConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccountAlias
default CompletableFuture<PutAccountAliasResponse> putAccountAlias(PutAccountAliasRequest putAccountAliasRequest) 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.
- Parameters:
putAccountAliasRequest
-- Returns:
- A Java Future containing the result of the PutAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccountAlias
default CompletableFuture<PutAccountAliasResponse> putAccountAlias(Consumer<PutAccountAliasRequest.Builder> putAccountAliasRequest) 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.
This is a convenience which creates an instance of the
PutAccountAliasRequest.Builder
avoiding the need to create one manually viaPutAccountAliasRequest.builder()
- Parameters:
putAccountAliasRequest
- AConsumer
that will call methods onPutAccountAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerSlackWorkspaceForOrganization
default CompletableFuture<RegisterSlackWorkspaceForOrganizationResponse> registerSlackWorkspaceForOrganization(RegisterSlackWorkspaceForOrganizationRequest registerSlackWorkspaceForOrganizationRequest) Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.
If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:
-
Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.
-
Call the
RegisterSlackWorkspaceForOrganization
API to authorize each Slack workspace for the organization.
After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.
To use the Amazon Web Services Support App, each account must then complete the following tasks:
-
Create an Identity and Access Management (IAM) role with the required permission. For more information, see Managing access to the Amazon Web Services Support App.
-
Configure a Slack channel to use the Amazon Web Services Support App for support cases for that account. For more information, see Configuring a Slack channel.
- Parameters:
registerSlackWorkspaceForOrganizationRequest
-- Returns:
- A Java Future containing the result of the RegisterSlackWorkspaceForOrganization operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
-
registerSlackWorkspaceForOrganization
default CompletableFuture<RegisterSlackWorkspaceForOrganizationResponse> registerSlackWorkspaceForOrganization(Consumer<RegisterSlackWorkspaceForOrganizationRequest.Builder> registerSlackWorkspaceForOrganizationRequest) Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.
If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:
-
Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.
-
Call the
RegisterSlackWorkspaceForOrganization
API to authorize each Slack workspace for the organization.
After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.
To use the Amazon Web Services Support App, each account must then complete the following tasks:
-
Create an Identity and Access Management (IAM) role with the required permission. For more information, see Managing access to the Amazon Web Services Support App.
-
Configure a Slack channel to use the Amazon Web Services Support App for support cases for that account. For more information, see Configuring a Slack channel.
This is a convenience which creates an instance of the
RegisterSlackWorkspaceForOrganizationRequest.Builder
avoiding the need to create one manually viaRegisterSlackWorkspaceForOrganizationRequest.builder()
- Parameters:
registerSlackWorkspaceForOrganizationRequest
- AConsumer
that will call methods onRegisterSlackWorkspaceForOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterSlackWorkspaceForOrganization operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
-
updateSlackChannelConfiguration
default CompletableFuture<UpdateSlackChannelConfigurationResponse> updateSlackChannelConfiguration(UpdateSlackChannelConfigurationRequest updateSlackChannelConfigurationRequest) Updates the configuration for a Slack channel, such as case update notifications.
- Parameters:
updateSlackChannelConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateSlackChannelConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
updateSlackChannelConfiguration
default CompletableFuture<UpdateSlackChannelConfigurationResponse> updateSlackChannelConfiguration(Consumer<UpdateSlackChannelConfigurationRequest.Builder> updateSlackChannelConfigurationRequest) Updates the configuration for a Slack channel, such as case update notifications.
This is a convenience which creates an instance of the
UpdateSlackChannelConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateSlackChannelConfigurationRequest.builder()
- Parameters:
updateSlackChannelConfigurationRequest
- AConsumer
that will call methods onUpdateSlackChannelConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSlackChannelConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
-
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
-
Add a Slack channel configuration that already exists in your Amazon Web Services account.
-
Delete a Slack channel configuration for a live chat channel.
-
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
-
Call the
RegisterSlackWorkspaceForOrganization
API from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganization
API from a member account, but the management account hasn't registered that workspace yet for the organization.
-
- ResourceNotFoundException The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
- AccessDeniedException You don't have sufficient permission to perform this action.
- InternalServerException We can’t process your request right now because of a server issue. Try again later.
- ValidationException Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SupportAppException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException Your request has a conflict. For example, you might receive this error if you try
the following:
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSupportAppAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSupportAppAsyncClient
.
-