SupportApp ¶

Table of Contents

SupportApp
- Client
- Paginators

Client ¶

class 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:

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> You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API. </li> <li> 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 Amazon Web Services General Reference. </li> </ul> </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()
update_slack_channel_configuration()

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: 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").
Returns: 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

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'
)

Parameters

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.

If you specify <code>high</code> or <code>all</code>, you must specify <code>true</code> for at least one of the following parameters: <ul> <li> <code>notifyOnAddCorrespondenceToCase</code> </li> <li> <code>notifyOnCreateOrReopenCase</code> </li> <li> <code>notifyOnResolveCase</code> </li> </ul> If you specify <code>none</code>, the following parameters must be null or <code>false</code>: <ul> <li> <code>notifyOnAddCorrespondenceToCase</code> </li> <li> <code>notifyOnCreateOrReopenCase</code> </li> <li> <code>notifyOnResolveCase</code> </li> </ul> <note> If you don't specify these parameters in your request, they default to <code>false</code>. </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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

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()

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

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'
)

Parameters

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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

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'
)

Parameters

teamId (string) --

[REQUIRED]

The team ID in Slack. This ID uniquely identifies a Slack workspace.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

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()

Return type

dict

Returns

Response Syntax

{
    'accountAlias': 'string'
}

Response Structure

(dict) --
- accountAlias (string) --
  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.

Parameters: 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").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

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'
)

Parameters

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.

Return type

dict

Returns

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

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'
)

Parameters

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.

Return type

dict

Returns

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

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'
)

Parameters

accountAlias (string) --

[REQUIRED]

An alias or short name for an Amazon Web Services account.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

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'
)

Parameters

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.

If you specify <code>high</code> or <code>all</code>, at least one of the following parameters must be <code>true</code>: <ul> <li> <code>notifyOnAddCorrespondenceToCase</code> </li> <li> <code>notifyOnCreateOrReopenCase</code> </li> <li> <code>notifyOnResolveCase</code> </li> </ul> If you specify <code>none</code>, any of the following parameters that you specify in your request must be <code>false</code>: <ul> <li> <code>notifyOnAddCorrespondenceToCase</code> </li> <li> <code>notifyOnCreateOrReopenCase</code> </li> <li> <code>notifyOnResolveCase</code> </li> </ul> <note> If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default. </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.

Return type

dict

Returns

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

SupportApp.Client.exceptions.ConflictException
SupportApp.Client.exceptions.ResourceNotFoundException
SupportApp.Client.exceptions.AccessDeniedException
SupportApp.Client.exceptions.InternalServerException
SupportApp.Client.exceptions.ValidationException

Paginators ¶

The available paginators are:

Table Of Contents

SupportApp¶

Client¶

Paginators¶

SupportApp ¶

Client ¶

Paginators ¶