Interface SupportAppClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 SupportAppClientBuilder
builder()
Create a builder that can be used to configure and create aSupportAppClient
.static SupportAppClient
create()
Create aSupportAppClient
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.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.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 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.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 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.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., ClientOverrideConfigurationstatic ServiceMetadata
updateSlackChannelConfiguration
(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 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:
-
-
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 viaCreateSlackChannelConfigurationRequest.builder()
- Parameters:
createSlackChannelConfigurationRequest
- AConsumer
that will call methods onCreateSlackChannelConfigurationRequest.Builder
to create a request.- Returns:
- Result of the CreateSlackChannelConfiguration operation returned by the service.
- See Also:
-
-
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:
-
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 viaDeleteAccountAliasRequest.builder()
- Parameters:
deleteAccountAliasRequest
- AConsumer
that will call methods onDeleteAccountAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccountAlias operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteSlackChannelConfigurationRequest.builder()
- Parameters:
deleteSlackChannelConfigurationRequest
- AConsumer
that will call methods onDeleteSlackChannelConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteSlackChannelConfiguration operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteSlackWorkspaceConfigurationRequest.builder()
- Parameters:
deleteSlackWorkspaceConfigurationRequest
- AConsumer
that will call methods onDeleteSlackWorkspaceConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteSlackWorkspaceConfiguration operation returned by the service.
- See Also:
-
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:
-
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 viaGetAccountAliasRequest.builder()
- Parameters:
getAccountAliasRequest
- AConsumer
that will call methods onGetAccountAliasRequest.Builder
to create a request.- Returns:
- Result of the GetAccountAlias operation returned by the service.
- See Also:
-
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:
-
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 viaListSlackChannelConfigurationsRequest.builder()
- Parameters:
listSlackChannelConfigurationsRequest
- AConsumer
that will call methods onListSlackChannelConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListSlackChannelConfigurations operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client.listSlackChannelConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackChannelConfigurationsIterable responses = client.listSlackChannelConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListSlackChannelConfigurationsRequest.builder()
- Parameters:
listSlackChannelConfigurationsRequest
- AConsumer
that will call methods onListSlackChannelConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListSlackWorkspaceConfigurationsRequest.builder()
- Parameters:
listSlackWorkspaceConfigurationsRequest
- AConsumer
that will call methods onListSlackWorkspaceConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListSlackWorkspaceConfigurations operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client.listSlackWorkspaceConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.supportapp.paginators.ListSlackWorkspaceConfigurationsIterable responses = client.listSlackWorkspaceConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListSlackWorkspaceConfigurationsRequest.builder()
- Parameters:
listSlackWorkspaceConfigurationsRequest
- AConsumer
that will call methods onListSlackWorkspaceConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaPutAccountAliasRequest.builder()
- Parameters:
putAccountAliasRequest
- AConsumer
that will call methods onPutAccountAliasRequest.Builder
to create a request.- Returns:
- Result of the PutAccountAlias operation returned by the service.
- See Also:
-
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:
-
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:
- Result of the RegisterSlackWorkspaceForOrganization operation returned by the service.
- See Also:
-
-
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:
-
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:
- Result of the RegisterSlackWorkspaceForOrganization operation returned by the service.
- See Also:
-
-
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:
-
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 viaUpdateSlackChannelConfigurationRequest.builder()
- Parameters:
updateSlackChannelConfigurationRequest
- AConsumer
that will call methods onUpdateSlackChannelConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateSlackChannelConfiguration operation returned by the service.
- See Also:
-
create
Create aSupportAppClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSupportAppClient
. -
serviceMetadata
-
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
-