Interface SupportAppClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SupportAppClient
extends AwsClient

Service client for accessing SupportApp. This can be created using the static builder() method.

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.

• 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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SupportAppClientBuilder	builder()	Create a builder that can be used to configure and create a SupportAppClient.
static SupportAppClient	create()	Create a SupportAppClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateSlackChannelConfigurationResponse	createSlackChannelConfiguration(Consumer<CreateSlackChannelConfigurationRequest.Builder> createSlackChannelConfigurationRequest)	Creates a Slack channel configuration for your Amazon Web Services account.
default CreateSlackChannelConfigurationResponse	createSlackChannelConfiguration(CreateSlackChannelConfigurationRequest createSlackChannelConfigurationRequest)	Creates a Slack channel configuration for your Amazon Web Services account.
default DeleteAccountAliasResponse	deleteAccountAlias(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest)	Deletes an alias for an Amazon Web Services account ID.
default DeleteAccountAliasResponse	deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)	Deletes an alias for an Amazon Web Services account ID.
default DeleteSlackChannelConfigurationResponse	deleteSlackChannelConfiguration(Consumer<DeleteSlackChannelConfigurationRequest.Builder> deleteSlackChannelConfigurationRequest)	Deletes a Slack channel configuration from your Amazon Web Services account.
default DeleteSlackChannelConfigurationResponse	deleteSlackChannelConfiguration(DeleteSlackChannelConfigurationRequest deleteSlackChannelConfigurationRequest)	Deletes a Slack channel configuration from your Amazon Web Services account.
default DeleteSlackWorkspaceConfigurationResponse	deleteSlackWorkspaceConfiguration(Consumer<DeleteSlackWorkspaceConfigurationRequest.Builder> deleteSlackWorkspaceConfigurationRequest)	Deletes a Slack workspace configuration from your Amazon Web Services account.
default DeleteSlackWorkspaceConfigurationResponse	deleteSlackWorkspaceConfiguration(DeleteSlackWorkspaceConfigurationRequest deleteSlackWorkspaceConfigurationRequest)	Deletes a Slack workspace configuration from your Amazon Web Services account.
default GetAccountAliasResponse	getAccountAlias(Consumer<GetAccountAliasRequest.Builder> getAccountAliasRequest)	Retrieves the alias from an Amazon Web Services account ID.
default GetAccountAliasResponse	getAccountAlias(GetAccountAliasRequest getAccountAliasRequest)	Retrieves the alias from an Amazon Web Services account ID.
default ListSlackChannelConfigurationsResponse	listSlackChannelConfigurations(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest)	Lists the Slack channel configurations for an Amazon Web Services account.
default ListSlackChannelConfigurationsResponse	listSlackChannelConfigurations(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest)	Lists the Slack channel configurations for an Amazon Web Services account.
default ListSlackChannelConfigurationsIterable	listSlackChannelConfigurationsPaginator(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest)	This is a variant of listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest) operation.
default ListSlackChannelConfigurationsIterable	listSlackChannelConfigurationsPaginator(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest)	This is a variant of listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest) operation.
default ListSlackWorkspaceConfigurationsResponse	listSlackWorkspaceConfigurations(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest)	Lists the Slack workspace configurations for an Amazon Web Services account.
default ListSlackWorkspaceConfigurationsResponse	listSlackWorkspaceConfigurations(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest)	Lists the Slack workspace configurations for an Amazon Web Services account.
default ListSlackWorkspaceConfigurationsIterable	listSlackWorkspaceConfigurationsPaginator(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest)	This is a variant of listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest) operation.
default ListSlackWorkspaceConfigurationsIterable	listSlackWorkspaceConfigurationsPaginator(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest)	This is a variant of listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest) operation.
default PutAccountAliasResponse	putAccountAlias(Consumer<PutAccountAliasRequest.Builder> putAccountAliasRequest)	Creates or updates an individual alias for each Amazon Web Services account ID.
default PutAccountAliasResponse	putAccountAlias(PutAccountAliasRequest putAccountAliasRequest)	Creates or updates an individual alias for each Amazon Web Services account ID.
default RegisterSlackWorkspaceForOrganizationResponse	registerSlackWorkspaceForOrganization(Consumer<RegisterSlackWorkspaceForOrganizationRequest.Builder> registerSlackWorkspaceForOrganizationRequest)	Registers a Slack workspace for your Amazon Web Services account.
default RegisterSlackWorkspaceForOrganizationResponse	registerSlackWorkspaceForOrganization(RegisterSlackWorkspaceForOrganizationRequest registerSlackWorkspaceForOrganizationRequest)	Registers a Slack workspace for your Amazon Web Services account.
default SupportAppServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateSlackChannelConfigurationResponse	updateSlackChannelConfiguration(Consumer<UpdateSlackChannelConfigurationRequest.Builder> updateSlackChannelConfigurationRequest)	Updates the configuration for a Slack channel, such as case update notifications.
default UpdateSlackChannelConfigurationResponse	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createSlackChannelConfiguration

default CreateSlackChannelConfigurationResponse createSlackChannelConfiguration(CreateSlackChannelConfigurationRequest createSlackChannelConfigurationRequest)
                                                                         throws ServiceQuotaExceededException,
ConflictException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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:

Result of the CreateSlackChannelConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createSlackChannelConfiguration

default CreateSlackChannelConfigurationResponse createSlackChannelConfiguration(Consumer<CreateSlackChannelConfigurationRequest.Builder> createSlackChannelConfigurationRequest)
                                                                         throws ServiceQuotaExceededException,
ConflictException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via CreateSlackChannelConfigurationRequest.builder()

Parameters:

createSlackChannelConfigurationRequest - A Consumer that will call methods on CreateSlackChannelConfigurationRequest.Builder to create a request.

Returns:

Result of the CreateSlackChannelConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteAccountAlias

default DeleteAccountAliasResponse deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
                                               throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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:

Result of the DeleteAccountAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteAccountAlias

default DeleteAccountAliasResponse deleteAccountAlias(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest)
                                               throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via DeleteAccountAliasRequest.builder()

Parameters:

deleteAccountAliasRequest - A Consumer that will call methods on DeleteAccountAliasRequest.Builder to create a request.

Returns:

Result of the DeleteAccountAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteSlackChannelConfiguration

default DeleteSlackChannelConfigurationResponse deleteSlackChannelConfiguration(DeleteSlackChannelConfigurationRequest deleteSlackChannelConfigurationRequest)
                                                                         throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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

Parameters:

deleteSlackChannelConfigurationRequest -

Returns:

Result of the DeleteSlackChannelConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteSlackChannelConfiguration

default DeleteSlackChannelConfigurationResponse deleteSlackChannelConfiguration(Consumer<DeleteSlackChannelConfigurationRequest.Builder> deleteSlackChannelConfigurationRequest)
                                                                         throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via DeleteSlackChannelConfigurationRequest.builder()

Parameters:

deleteSlackChannelConfigurationRequest - A Consumer that will call methods on DeleteSlackChannelConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteSlackChannelConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteSlackWorkspaceConfiguration

default DeleteSlackWorkspaceConfigurationResponse deleteSlackWorkspaceConfiguration(DeleteSlackWorkspaceConfigurationRequest deleteSlackWorkspaceConfigurationRequest)
                                                                             throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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

Parameters:

deleteSlackWorkspaceConfigurationRequest -

Returns:

Result of the DeleteSlackWorkspaceConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteSlackWorkspaceConfiguration

default DeleteSlackWorkspaceConfigurationResponse deleteSlackWorkspaceConfiguration(Consumer<DeleteSlackWorkspaceConfigurationRequest.Builder> deleteSlackWorkspaceConfigurationRequest)
                                                                             throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via DeleteSlackWorkspaceConfigurationRequest.builder()

Parameters:

deleteSlackWorkspaceConfigurationRequest - A Consumer that will call methods on DeleteSlackWorkspaceConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteSlackWorkspaceConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getAccountAlias

default GetAccountAliasResponse getAccountAlias(GetAccountAliasRequest getAccountAliasRequest)
                                         throws InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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:

Result of the GetAccountAlias operation returned by the service.

See Also:

• AWS API Documentation

getAccountAlias

default GetAccountAliasResponse getAccountAlias(Consumer<GetAccountAliasRequest.Builder> getAccountAliasRequest)
                                         throws InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via GetAccountAliasRequest.builder()

Parameters:

getAccountAliasRequest - A Consumer that will call methods on GetAccountAliasRequest.Builder to create a request.

Returns:

Result of the GetAccountAlias operation returned by the service.

See Also:

• AWS API Documentation

listSlackChannelConfigurations

default ListSlackChannelConfigurationsResponse listSlackChannelConfigurations(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest)
                                                                       throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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

Parameters:

listSlackChannelConfigurationsRequest -

Returns:

Result of the ListSlackChannelConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listSlackChannelConfigurations

default ListSlackChannelConfigurationsResponse listSlackChannelConfigurations(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest)
                                                                       throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via ListSlackChannelConfigurationsRequest.builder()

Parameters:

listSlackChannelConfigurationsRequest - A Consumer that will call methods on ListSlackChannelConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListSlackChannelConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listSlackChannelConfigurationsPaginator

default ListSlackChannelConfigurationsIterable listSlackChannelConfigurationsPaginator(ListSlackChannelConfigurationsRequest listSlackChannelConfigurationsRequest)
                                                                                throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

This is a variant of listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client.listSlackChannelConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client
             .listSlackChannelConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client.listSlackChannelConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSlackChannelConfigurationsPaginator

default ListSlackChannelConfigurationsIterable listSlackChannelConfigurationsPaginator(Consumer<ListSlackChannelConfigurationsRequest.Builder> listSlackChannelConfigurationsRequest)
                                                                                throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

This is a variant of listSlackChannelConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client.listSlackChannelConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client
             .listSlackChannelConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.supportapp.model.ListSlackChannelConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client.listSlackChannelConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListSlackChannelConfigurationsRequest.builder()

Parameters:

listSlackChannelConfigurationsRequest - A Consumer that will call methods on ListSlackChannelConfigurationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSlackWorkspaceConfigurations

default ListSlackWorkspaceConfigurationsResponse listSlackWorkspaceConfigurations(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest)
                                                                           throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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

Parameters:

listSlackWorkspaceConfigurationsRequest -

Returns:

Result of the ListSlackWorkspaceConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listSlackWorkspaceConfigurations

default ListSlackWorkspaceConfigurationsResponse listSlackWorkspaceConfigurations(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest)
                                                                           throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via ListSlackWorkspaceConfigurationsRequest.builder()

Parameters:

listSlackWorkspaceConfigurationsRequest - A Consumer that will call methods on ListSlackWorkspaceConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListSlackWorkspaceConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listSlackWorkspaceConfigurationsPaginator

default ListSlackWorkspaceConfigurationsIterable listSlackWorkspaceConfigurationsPaginator(ListSlackWorkspaceConfigurationsRequest listSlackWorkspaceConfigurationsRequest)
                                                                                    throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

This is a variant of listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client.listSlackWorkspaceConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client
             .listSlackWorkspaceConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client.listSlackWorkspaceConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSlackWorkspaceConfigurationsPaginator

default ListSlackWorkspaceConfigurationsIterable listSlackWorkspaceConfigurationsPaginator(Consumer<ListSlackWorkspaceConfigurationsRequest.Builder> listSlackWorkspaceConfigurationsRequest)
                                                                                    throws AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAppException

This is a variant of listSlackWorkspaceConfigurations(software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client.listSlackWorkspaceConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client
             .listSlackWorkspaceConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.supportapp.model.ListSlackWorkspaceConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client.listSlackWorkspaceConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListSlackWorkspaceConfigurationsRequest.builder()

Parameters:

listSlackWorkspaceConfigurationsRequest - A Consumer that will call methods on ListSlackWorkspaceConfigurationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putAccountAlias

default PutAccountAliasResponse putAccountAlias(PutAccountAliasRequest putAccountAliasRequest)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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:

Result of the PutAccountAlias operation returned by the service.

See Also:

• AWS API Documentation

putAccountAlias

default PutAccountAliasResponse putAccountAlias(Consumer<PutAccountAliasRequest.Builder> putAccountAliasRequest)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via PutAccountAliasRequest.builder()

Parameters:

putAccountAliasRequest - A Consumer that will call methods on PutAccountAliasRequest.Builder to create a request.

Returns:

Result of the PutAccountAlias operation returned by the service.

See Also:

• AWS API Documentation

registerSlackWorkspaceForOrganization

default RegisterSlackWorkspaceForOrganizationResponse registerSlackWorkspaceForOrganization(RegisterSlackWorkspaceForOrganizationRequest registerSlackWorkspaceForOrganizationRequest)
                                                                                     throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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:

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

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

Result of the RegisterSlackWorkspaceForOrganization operation returned by the service.

See Also:

• AWS API Documentation

registerSlackWorkspaceForOrganization

default RegisterSlackWorkspaceForOrganizationResponse registerSlackWorkspaceForOrganization(Consumer<RegisterSlackWorkspaceForOrganizationRequest.Builder> registerSlackWorkspaceForOrganizationRequest)
                                                                                     throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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:

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

2. 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 via RegisterSlackWorkspaceForOrganizationRequest.builder()

Parameters:

registerSlackWorkspaceForOrganizationRequest - A Consumer that will call methods on RegisterSlackWorkspaceForOrganizationRequest.Builder to create a request.

Returns:

Result of the RegisterSlackWorkspaceForOrganization operation returned by the service.

See Also:

• AWS API Documentation

updateSlackChannelConfiguration

default UpdateSlackChannelConfigurationResponse updateSlackChannelConfiguration(UpdateSlackChannelConfigurationRequest updateSlackChannelConfigurationRequest)
                                                                         throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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

Parameters:

updateSlackChannelConfigurationRequest -

Returns:

Result of the UpdateSlackChannelConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateSlackChannelConfiguration

default UpdateSlackChannelConfigurationResponse updateSlackChannelConfiguration(Consumer<UpdateSlackChannelConfigurationRequest.Builder> updateSlackChannelConfigurationRequest)
                                                                         throws ConflictException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SupportAppException

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 via UpdateSlackChannelConfigurationRequest.builder()

Parameters:

updateSlackChannelConfigurationRequest - A Consumer that will call methods on UpdateSlackChannelConfigurationRequest.Builder to create a request.

Returns:

Result of the UpdateSlackChannelConfiguration operation returned by the service.

See Also:

• AWS API Documentation

create

static SupportAppClient create()

Create a SupportAppClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SupportAppClientBuilder builder()

Create a builder that can be used to configure and create a SupportAppClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SupportAppServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration