supportapp/aws.sdk.kotlin.services.supportapp/SupportAppClient

SupportAppClient

interface SupportAppClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: SupportAppClient.Config

SupportAppClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createSlackChannelConfiguration(input: CreateSlackChannelConfigurationRequest): CreateSlackChannelConfigurationResponse

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

Link copied to clipboard
abstract suspend fun deleteAccountAlias(input: DeleteAccountAliasRequest = DeleteAccountAliasRequest { }): DeleteAccountAliasResponse

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.

Link copied to clipboard
abstract suspend fun deleteSlackChannelConfiguration(input: DeleteSlackChannelConfigurationRequest): DeleteSlackChannelConfigurationResponse

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

Link copied to clipboard
abstract suspend fun deleteSlackWorkspaceConfiguration(input: DeleteSlackWorkspaceConfigurationRequest): DeleteSlackWorkspaceConfigurationResponse

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

Link copied to clipboard
abstract suspend fun getAccountAlias(input: GetAccountAliasRequest = GetAccountAliasRequest { }): GetAccountAliasResponse

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.

Link copied to clipboard
abstract suspend fun listSlackChannelConfigurations(input: ListSlackChannelConfigurationsRequest = ListSlackChannelConfigurationsRequest { }): ListSlackChannelConfigurationsResponse

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

Link copied to clipboard
abstract suspend fun listSlackWorkspaceConfigurations(input: ListSlackWorkspaceConfigurationsRequest = ListSlackWorkspaceConfigurationsRequest { }): ListSlackWorkspaceConfigurationsResponse

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

Link copied to clipboard
abstract suspend fun putAccountAlias(input: PutAccountAliasRequest): PutAccountAliasResponse

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.

Link copied to clipboard
abstract suspend fun registerSlackWorkspaceForOrganization(input: RegisterSlackWorkspaceForOrganizationRequest): RegisterSlackWorkspaceForOrganizationResponse

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

Link copied to clipboard
abstract suspend fun updateSlackChannelConfiguration(input: UpdateSlackChannelConfigurationRequest): UpdateSlackChannelConfigurationResponse

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

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun SupportAppClient.createSlackChannelConfiguration(crossinline block: CreateSlackChannelConfigurationRequest.Builder.() -> Unit): CreateSlackChannelConfigurationResponse

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

Link copied to clipboard
inline suspend fun SupportAppClient.deleteAccountAlias(crossinline block: DeleteAccountAliasRequest.Builder.() -> Unit): DeleteAccountAliasResponse

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.

Link copied to clipboard
inline suspend fun SupportAppClient.deleteSlackChannelConfiguration(crossinline block: DeleteSlackChannelConfigurationRequest.Builder.() -> Unit): DeleteSlackChannelConfigurationResponse

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

Link copied to clipboard
inline suspend fun SupportAppClient.deleteSlackWorkspaceConfiguration(crossinline block: DeleteSlackWorkspaceConfigurationRequest.Builder.() -> Unit): DeleteSlackWorkspaceConfigurationResponse

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

Link copied to clipboard
inline suspend fun SupportAppClient.getAccountAlias(crossinline block: GetAccountAliasRequest.Builder.() -> Unit): GetAccountAliasResponse

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.

Link copied to clipboard
inline suspend fun SupportAppClient.listSlackChannelConfigurations(crossinline block: ListSlackChannelConfigurationsRequest.Builder.() -> Unit): ListSlackChannelConfigurationsResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun SupportAppClient.listSlackWorkspaceConfigurations(crossinline block: ListSlackWorkspaceConfigurationsRequest.Builder.() -> Unit): ListSlackWorkspaceConfigurationsResponse

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

Link copied to clipboard
inline suspend fun SupportAppClient.putAccountAlias(crossinline block: PutAccountAliasRequest.Builder.() -> Unit): PutAccountAliasResponse

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.

Link copied to clipboard
inline suspend fun SupportAppClient.registerSlackWorkspaceForOrganization(crossinline block: RegisterSlackWorkspaceForOrganizationRequest.Builder.() -> Unit): RegisterSlackWorkspaceForOrganizationResponse

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

Link copied to clipboard
inline suspend fun SupportAppClient.updateSlackChannelConfiguration(crossinline block: UpdateSlackChannelConfigurationRequest.Builder.() -> Unit): UpdateSlackChannelConfigurationResponse

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

Link copied to clipboard
fun SupportAppClient.withConfig(block: SupportAppClient.Config.Builder.() -> Unit): SupportAppClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.