com.amazonaws.services.supportapp

Class AWSSupportAppClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.supportapp.AWSSupportAppClient

All Implemented Interfaces:

AWSSupportApp

Direct Known Subclasses:

AWSSupportAppAsyncClient

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

Client for accessing SupportApp. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Web Services Support App in Slack

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

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

• Request service quota increases for your account

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

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

• Amazon Web Services Support App in Slack

• Joining a live chat session with Amazon Web Services Support

• Requesting service quota increases

• Amazon Web Services Support App commands in Slack

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

• 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 and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSupportAppClientBuilder	builder()
CreateSlackChannelConfigurationResult	createSlackChannelConfiguration(CreateSlackChannelConfigurationRequest request) Creates a Slack channel configuration for your Amazon Web Services account.
DeleteAccountAliasResult	deleteAccountAlias(DeleteAccountAliasRequest request) Deletes an alias for an Amazon Web Services account ID.
DeleteSlackChannelConfigurationResult	deleteSlackChannelConfiguration(DeleteSlackChannelConfigurationRequest request) Deletes a Slack channel configuration from your Amazon Web Services account.
DeleteSlackWorkspaceConfigurationResult	deleteSlackWorkspaceConfiguration(DeleteSlackWorkspaceConfigurationRequest request) Deletes a Slack workspace configuration from your Amazon Web Services account.
GetAccountAliasResult	getAccountAlias(GetAccountAliasRequest request) Retrieves the alias from an Amazon Web Services account ID.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListSlackChannelConfigurationsResult	listSlackChannelConfigurations(ListSlackChannelConfigurationsRequest request) Lists the Slack channel configurations for an Amazon Web Services account.
ListSlackWorkspaceConfigurationsResult	listSlackWorkspaceConfigurations(ListSlackWorkspaceConfigurationsRequest request) Lists the Slack workspace configurations for an Amazon Web Services account.
PutAccountAliasResult	putAccountAlias(PutAccountAliasRequest request) Creates or updates an individual alias for each Amazon Web Services account ID.
RegisterSlackWorkspaceForOrganizationResult	registerSlackWorkspaceForOrganization(RegisterSlackWorkspaceForOrganizationRequest request) Registers a Slack workspace for your Amazon Web Services account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateSlackChannelConfigurationResult	updateSlackChannelConfiguration(UpdateSlackChannelConfigurationRequest request) Updates the configuration for a Slack channel, such as case update notifications.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSSupportAppClientBuilder builder()

createSlackChannelConfiguration

public CreateSlackChannelConfigurationResult createSlackChannelConfiguration(CreateSlackChannelConfigurationRequest request)

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

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

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

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

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

Specified by:

createSlackChannelConfiguration in interface AWSSupportApp

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 RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

• Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

AccessDeniedException - You don't have sufficient permission to perform this action.

InternalServerException - We can’t process your request right now because of a server issue. Try again later.

ValidationException - Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

See Also:

AWS API Documentation

deleteAccountAlias

public DeleteAccountAliasResult deleteAccountAlias(DeleteAccountAliasRequest request)

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

Specified by:

deleteAccountAlias in interface AWSSupportApp

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.

See Also:

AWS API Documentation

deleteSlackChannelConfiguration

public DeleteSlackChannelConfigurationResult deleteSlackChannelConfiguration(DeleteSlackChannelConfigurationRequest request)

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

Specified by:

deleteSlackChannelConfiguration in interface AWSSupportApp

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 RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

• Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException - The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException - You don't have sufficient permission to perform this action.

InternalServerException - We can’t process your request right now because of a server issue. Try again later.

ValidationException - Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

See Also:

AWS API Documentation

deleteSlackWorkspaceConfiguration

public DeleteSlackWorkspaceConfigurationResult deleteSlackWorkspaceConfiguration(DeleteSlackWorkspaceConfigurationRequest request)

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

Specified by:

deleteSlackWorkspaceConfiguration in interface AWSSupportApp

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 RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

• Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException - The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException - You don't have sufficient permission to perform this action.

InternalServerException - We can’t process your request right now because of a server issue. Try again later.

ValidationException - Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

See Also:

AWS API Documentation

getAccountAlias

public GetAccountAliasResult getAccountAlias(GetAccountAliasRequest request)

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

Specified by:

getAccountAlias in interface AWSSupportApp

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.

See Also:

AWS API Documentation

listSlackChannelConfigurations

public ListSlackChannelConfigurationsResult listSlackChannelConfigurations(ListSlackChannelConfigurationsRequest request)

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

Specified by:

listSlackChannelConfigurations in interface AWSSupportApp

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.

See Also:

AWS API Documentation

listSlackWorkspaceConfigurations

public ListSlackWorkspaceConfigurationsResult listSlackWorkspaceConfigurations(ListSlackWorkspaceConfigurationsRequest request)

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

Specified by:

listSlackWorkspaceConfigurations in interface AWSSupportApp

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.

See Also:

AWS API Documentation

putAccountAlias

public PutAccountAliasResult putAccountAlias(PutAccountAliasRequest request)

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

Specified by:

putAccountAlias in interface AWSSupportApp

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.

See Also:

AWS API Documentation

registerSlackWorkspaceForOrganization

public RegisterSlackWorkspaceForOrganizationResult registerSlackWorkspaceForOrganization(RegisterSlackWorkspaceForOrganizationRequest request)

Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.

If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:

1. Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.

2. Call the RegisterSlackWorkspaceForOrganization API to authorize each Slack workspace for the organization.

After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.

To use the Amazon Web Services Support App, each account must then complete the following tasks:

• Create an Identity and Access Management (IAM) role with the required permission. For more information, see Managing access to the Amazon Web Services Support App.

• Configure a Slack channel to use the Amazon Web Services Support App for support cases for that account. For more information, see Configuring a Slack channel.

Specified by:

registerSlackWorkspaceForOrganization in interface AWSSupportApp

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 RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

• Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException - The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException - You don't have sufficient permission to perform this action.

InternalServerException - We can’t process your request right now because of a server issue. Try again later.

ValidationException - Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

See Also:

AWS API Documentation

updateSlackChannelConfiguration

public UpdateSlackChannelConfigurationResult updateSlackChannelConfiguration(UpdateSlackChannelConfigurationRequest request)

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

Specified by:

updateSlackChannelConfiguration in interface AWSSupportApp

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 RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

• Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException - The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException - You don't have sufficient permission to perform this action.

InternalServerException - We can’t process your request right now because of a server issue. Try again later.

ValidationException - Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSSupportApp

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSSupportApp

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSupportApp

Overrides:

shutdown in class AmazonWebServiceClient