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 staticbuilder()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:
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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateSlackChannelConfigurationRequest.builder()- Parameters:
createSlackChannelConfigurationRequest- AConsumerthat will call methods onCreateSlackChannelConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateSlackChannelConfiguration operation returned by the service.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.
- Throws:
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.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteAccountAliasRequest.builder()- Parameters:
deleteAccountAliasRequest- AConsumerthat will call methods onDeleteAccountAliasRequest.Builderto create a request.- Returns:
- Result of the DeleteAccountAlias operation returned by the service.
- Throws:
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.AwsServiceException- 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.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteSlackChannelConfigurationRequest.builder()- Parameters:
deleteSlackChannelConfigurationRequest- AConsumerthat will call methods onDeleteSlackChannelConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteSlackChannelConfiguration operation returned by the service.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteSlackWorkspaceConfigurationRequest.builder()- Parameters:
deleteSlackWorkspaceConfigurationRequest- AConsumerthat will call methods onDeleteSlackWorkspaceConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteSlackWorkspaceConfiguration operation returned by the service.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.
- Throws:
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.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetAccountAliasRequest.builder()- Parameters:
getAccountAliasRequest- AConsumerthat will call methods onGetAccountAliasRequest.Builderto create a request.- Returns:
- Result of the GetAccountAlias operation returned by the service.
- Throws:
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.AwsServiceException- 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.
- Throws:
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.AwsServiceException- 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.Builderavoiding the need to create one manually viaListSlackChannelConfigurationsRequest.builder()- Parameters:
listSlackChannelConfigurationsRequest- AConsumerthat will call methods onListSlackChannelConfigurationsRequest.Builderto create a request.- Returns:
- Result of the ListSlackChannelConfigurations operation returned by the service.
- Throws:
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.AwsServiceException- 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
2) Using For loopsoftware.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.
- Throws:
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.AwsServiceException- 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
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListSlackChannelConfigurationsRequest.builder()- Parameters:
listSlackChannelConfigurationsRequest- AConsumerthat will call methods onListSlackChannelConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- 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.
- Throws:
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.AwsServiceException- 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.Builderavoiding the need to create one manually viaListSlackWorkspaceConfigurationsRequest.builder()- Parameters:
listSlackWorkspaceConfigurationsRequest- AConsumerthat will call methods onListSlackWorkspaceConfigurationsRequest.Builderto create a request.- Returns:
- Result of the ListSlackWorkspaceConfigurations operation returned by the service.
- Throws:
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.AwsServiceException- 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
2) Using For loopsoftware.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.
- Throws:
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.AwsServiceException- 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
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListSlackWorkspaceConfigurationsRequest.builder()- Parameters:
listSlackWorkspaceConfigurationsRequest- AConsumerthat will call methods onListSlackWorkspaceConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- 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.
- Throws:
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.AwsServiceException- 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.Builderavoiding the need to create one manually viaPutAccountAliasRequest.builder()- Parameters:
putAccountAliasRequest- AConsumerthat will call methods onPutAccountAliasRequest.Builderto create a request.- Returns:
- Result of the PutAccountAlias operation returned by the service.
- Throws:
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.AwsServiceException- 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:
-
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
RegisterSlackWorkspaceForOrganizationAPI 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.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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:
-
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
RegisterSlackWorkspaceForOrganizationAPI 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.Builderavoiding the need to create one manually viaRegisterSlackWorkspaceForOrganizationRequest.builder()- Parameters:
registerSlackWorkspaceForOrganizationRequest- AConsumerthat will call methods onRegisterSlackWorkspaceForOrganizationRequest.Builderto create a request.- Returns:
- Result of the RegisterSlackWorkspaceForOrganization operation returned by the service.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdateSlackChannelConfigurationRequest.builder()- Parameters:
updateSlackChannelConfigurationRequest- AConsumerthat will call methods onUpdateSlackChannelConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateSlackChannelConfiguration operation returned by the service.
- Throws:
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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. -
Call the
RegisterSlackWorkspaceForOrganizationAPI 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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static SupportAppClient create()
Create aSupportAppClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SupportAppClientBuilder builder()
Create a builder that can be used to configure and create aSupportAppClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SupportAppServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-