Table of Contents
SupportApp.
Client
¶A low-level client representing AWS Support App (SupportApp)
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:
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 .
Note
import boto3
client = boto3.client('support-app')
These are the available methods:
can_paginate()
close()
create_slack_channel_configuration()
delete_account_alias()
delete_slack_channel_configuration()
delete_slack_workspace_configuration()
get_account_alias()
get_paginator()
get_waiter()
list_slack_channel_configurations()
list_slack_workspace_configurations()
put_account_alias()
register_slack_workspace_for_organization()
update_slack_channel_configuration()
can_paginate
(operation_name)¶Check if an operation can be paginated.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.True
if the operation can be paginated,
False
otherwise.close
()¶Closes underlying endpoint connections.
create_slack_channel_configuration
(**kwargs)¶Creates a Slack channel configuration for your Amazon Web Services account.
Note
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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.create_slack_channel_configuration(
channelId='string',
channelName='string',
channelRoleArn='string',
notifyOnAddCorrespondenceToCase=True|False,
notifyOnCaseSeverity='none'|'all'|'high',
notifyOnCreateOrReopenCase=True|False,
notifyOnResolveCase=True|False,
teamId='string'
)
[REQUIRED]
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide .
[REQUIRED]
The case severity for a support case that you want to receive notifications.
If you specify high
or all
, you must specify true
for at least one of the following parameters:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
If you specify none
, the following parameters must be null or false
:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
Note
If you don't specify these parameters in your request, they default to false
.
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
dict
Response Syntax
{}
Response Structure
Exceptions
SupportApp.Client.exceptions.ServiceQuotaExceededException
SupportApp.Client.exceptions.ConflictException
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
SupportApp.Client.exceptions.ValidationException
delete_account_alias
()¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_account_alias()
{}
Response Structure
Exceptions
SupportApp.Client.exceptions.ResourceNotFoundException
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
delete_slack_channel_configuration
(**kwargs)¶Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_slack_channel_configuration(
channelId='string',
teamId='string'
)
[REQUIRED]
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
dict
Response Syntax
{}
Response Structure
Exceptions
SupportApp.Client.exceptions.ConflictException
SupportApp.Client.exceptions.ResourceNotFoundException
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
SupportApp.Client.exceptions.ValidationException
delete_slack_workspace_configuration
(**kwargs)¶Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.
See also: AWS API Documentation
Request Syntax
response = client.delete_slack_workspace_configuration(
teamId='string'
)
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
{}
Response Structure
Exceptions
SupportApp.Client.exceptions.ConflictException
SupportApp.Client.exceptions.ResourceNotFoundException
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
SupportApp.Client.exceptions.ValidationException
get_account_alias
()¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_account_alias()
{
'accountAlias': 'string'
}
Response Structure
An alias or short name for an Amazon Web Services account.
Exceptions
SupportApp.Client.exceptions.InternalServerException
get_paginator
(operation_name)¶Create a paginator for an operation.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.client.can_paginate
method to
check if an operation is pageable.get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
list_slack_channel_configurations
(**kwargs)¶Lists the Slack channel configurations for an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_slack_channel_configurations(
nextToken='string'
)
nextToken
pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.{
'nextToken': 'string',
'slackChannelConfigurations': [
{
'channelId': 'string',
'channelName': 'string',
'channelRoleArn': 'string',
'notifyOnAddCorrespondenceToCase': True|False,
'notifyOnCaseSeverity': 'none'|'all'|'high',
'notifyOnCreateOrReopenCase': True|False,
'notifyOnResolveCase': True|False,
'teamId': 'string'
},
]
}
Response Structure
The point where pagination should resume when the response returns only partial results.
The configurations for a Slack channel.
The configuration for a Slack channel that you added for your Amazon Web Services account.
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
The name of the Slack channel that you configured with the Amazon Web Services Support App for your Amazon Web Services account.
The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide .
Whether you want to get notified when a support case has a new correspondence.
The case severity for a support case that you want to receive notifications.
Whether you want to get notified when a support case is created or reopened.
Whether you want to get notified when a support case is resolved.
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
Exceptions
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
list_slack_workspace_configurations
(**kwargs)¶Lists the Slack workspace configurations for an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_slack_workspace_configurations(
nextToken='string'
)
nextToken
pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.{
'nextToken': 'string',
'slackWorkspaceConfigurations': [
{
'allowOrganizationMemberAccount': True|False,
'teamId': 'string',
'teamName': 'string'
},
]
}
Response Structure
The point where pagination should resume when the response returns only partial results.
The configurations for a Slack workspace.
The configuration for a Slack workspace that you added to an Amazon Web Services account.
Whether to allow member accounts to authorize Slack workspaces. Member accounts must be part of an organization in Organizations.
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
The name of the Slack workspace.
Exceptions
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
put_account_alias
(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.put_account_alias(
accountAlias='string'
)
[REQUIRED]
An alias or short name for an Amazon Web Services account.
{}
Response Structure
Exceptions
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
SupportApp.Client.exceptions.ValidationException
register_slack_workspace_for_organization
(**kwargs)¶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:
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:
See also: AWS API Documentation
Request Syntax
response = client.register_slack_workspace_for_organization(
teamId='string'
)
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
. Specify the Slack workspace that you want to use for your organization.
{
'accountType': 'management'|'member',
'teamId': 'string',
'teamName': 'string'
}
Response Structure
Whether the Amazon Web Services account is a management or member account that's part of an organization in Organizations.
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
The name of the Slack workspace.
Exceptions
SupportApp.Client.exceptions.ConflictException
SupportApp.Client.exceptions.ResourceNotFoundException
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
SupportApp.Client.exceptions.ValidationException
update_slack_channel_configuration
(**kwargs)¶Updates the configuration for a Slack channel, such as case update notifications.
See also: AWS API Documentation
Request Syntax
response = client.update_slack_channel_configuration(
channelId='string',
channelName='string',
channelRoleArn='string',
notifyOnAddCorrespondenceToCase=True|False,
notifyOnCaseSeverity='none'|'all'|'high',
notifyOnCreateOrReopenCase=True|False,
notifyOnResolveCase=True|False,
teamId='string'
)
[REQUIRED]
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
The case severity for a support case that you want to receive notifications.
If you specify high
or all
, at least one of the following parameters must be true
:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
If you specify none
, any of the following parameters that you specify in your request must be false
:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
Note
If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
dict
Response Syntax
{
'channelId': 'string',
'channelName': 'string',
'channelRoleArn': 'string',
'notifyOnAddCorrespondenceToCase': True|False,
'notifyOnCaseSeverity': 'none'|'all'|'high',
'notifyOnCreateOrReopenCase': True|False,
'notifyOnResolveCase': True|False,
'teamId': 'string'
}
Response Structure
(dict) --
channelId (string) --
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
channelName (string) --
The name of the Slack channel that you configure for the Amazon Web Services Support App.
channelRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide .
notifyOnAddCorrespondenceToCase (boolean) --
Whether you want to get notified when a support case has a new correspondence.
notifyOnCaseSeverity (string) --
The case severity for a support case that you want to receive notifications.
notifyOnCreateOrReopenCase (boolean) --
Whether you want to get notified when a support case is created or reopened.
notifyOnResolveCase (boolean) --
Whether you want to get notified when a support case is resolved.
teamId (string) --
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG
.
Exceptions
SupportApp.Client.exceptions.ConflictException
SupportApp.Client.exceptions.ResourceNotFoundException
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
SupportApp.Client.exceptions.ValidationException
The available paginators are: