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:
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 .
<note> <ul> <li> <p>You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API. </p> </li> <li> <p>For more information about the Amazon Web Services Support App endpoints, see the <a href="https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region">Amazon Web Services Support App in Slack endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> </ul> </note>
client = session.create_client('support-app')
These are the available methods:
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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.
Closes underlying endpoint connections.
Creates a Slack channel configuration for your Amazon Web Services account.
Note
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.
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'
)
channelId (string) –
[REQUIRED]
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) –
[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 .
notifyOnAddCorrespondenceToCase (boolean) – Whether you want to get notified when a support case has a new correspondence.
notifyOnCaseSeverity (string) –
[REQUIRED]
The case severity for a support case that you want to receive notifications.
<p>If you specify <code>high</code> or <code>all</code>, you must specify <code>true</code> for at least one of the following parameters:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <p>If you specify <code>none</code>, the following parameters must be null or <code>false</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <note> <p>If you don't specify these parameters in your request, they default to <code>false</code>.</p> </note>
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) –
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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()
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
channelId (string) –
[REQUIRED]
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
teamId (string) –
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
teamId (string) –
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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()
dict
Response Syntax
{
'accountAlias': 'string'
}
Response Structure
(dict) –
accountAlias (string) –
An alias or short name for an Amazon Web Services account.
Exceptions
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
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 (string) – If the results of a search are large, the API only returns a portion of the results and includes a 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.
dict
Response Syntax
{
'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
(dict) –
nextToken (string) –
The point where pagination should resume when the response returns only partial results.
slackChannelConfigurations (list) –
The configurations for a Slack channel.
(dict) –
The configuration for a Slack channel that you added to an Amazon Web Services account.
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 configured with 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.
Exceptions
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 (string) – If the results of a search are large, the API only returns a portion of the results and includes a 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.
dict
Response Syntax
{
'nextToken': 'string',
'slackWorkspaceConfigurations': [
{
'teamId': 'string'
},
]
}
Response Structure
(dict) –
nextToken (string) –
The point where pagination should resume when the response returns only partial results.
slackWorkspaceConfigurations (list) –
The configurations for a Slack workspace.
(dict) –
The configuration for a Slack workspace that you added to an Amazon Web Services account.
teamId (string) –
The team ID in Slack. This ID uniquely identifies a Slack workspace.
Exceptions
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'
)
accountAlias (string) –
[REQUIRED]
An alias or short name for an Amazon Web Services account.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
channelId (string) –
[REQUIRED]
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
channelName (string) – The Slack channel name that you want to update.
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.
<p>If you specify <code>high</code> or <code>all</code>, at least one of the following parameters must be <code>true</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <p>If you specify <code>none</code>, any of the following parameters that you specify in your request must be <code>false</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <note> <p>If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.</p> </note>
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) –
[REQUIRED]
The team ID in Slack. This ID uniquely identifies a Slack workspace.
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.
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
You don’t have sufficient permission to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
You don’t have sufficient permission to perform this action.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
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.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
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.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
We can’t process your request right now because of a server issue. Try again later.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
We can’t process your request right now because of a server issue. Try again later.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified resource is missing or doesn’t exist, such as an account alias or Slack channel configuration.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified resource is missing or doesn’t exist, such as an account alias or Slack channel configuration.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
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.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
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.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Your request input doesn’t meet the constraints that the Amazon Web Services Support App specifies.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Your request input doesn’t meet the constraints that the Amazon Web Services Support App specifies.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are: