AWS API Changes

2022/08/22 - AWS Support App - 9 new api methods

Changes This is the initial SDK release for the AWS Support App in Slack.

DeleteSlackWorkspaceConfiguration (new)

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

client.delete_slack_workspace_configuration(
    teamId='string'
)

type teamId

string

param teamId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeleteAccountAlias (new)

Link ¶

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

client.delete_account_alias()

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListSlackChannelConfigurations (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_slack_channel_configurations(
    nextToken='string'
)

type nextToken

string

param nextToken

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.

rtype

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.

GetAccountAlias (new)

Link ¶

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

client.get_account_alias()

rtype

dict

returns

Response Syntax

{
    'accountAlias': 'string'
}

Response Structure

(dict) --
- accountAlias (string) --
  
  An alias or short name for an Amazon Web Services account.

DeleteSlackChannelConfiguration (new)

Link ¶

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

client.delete_slack_channel_configuration(
    channelId='string',
    teamId='string'
)

type channelId

string

param channelId

[REQUIRED]

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

type teamId

string

param teamId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

PutAccountAlias (new)

Link ¶

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

client.put_account_alias(
    accountAlias='string'
)

type accountAlias

string

param accountAlias

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListSlackWorkspaceConfigurations (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_slack_workspace_configurations(
    nextToken='string'
)

type nextToken

string

param nextToken

rtype

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.

UpdateSlackChannelConfiguration (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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

type channelId

string

param channelId

[REQUIRED]

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

type channelName

string

param channelName

The Slack channel name that you want to update.

type channelRoleArn

string

param channelRoleArn

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 .

type notifyOnAddCorrespondenceToCase

boolean

param notifyOnAddCorrespondenceToCase

Whether you want to get notified when a support case has a new correspondence.

type notifyOnCaseSeverity

string

param notifyOnCaseSeverity

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>

type notifyOnCreateOrReopenCase

boolean

param notifyOnCreateOrReopenCase

Whether you want to get notified when a support case is created or reopened.

type notifyOnResolveCase

boolean

param notifyOnResolveCase

Whether you want to get notified when a support case is resolved.

type teamId

string

param teamId

[REQUIRED]

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

rtype

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.

CreateSlackChannelConfiguration (new)

Link ¶

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

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

type channelId

string

param channelId

[REQUIRED]

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

type channelName

string

param channelName

The name of the Slack channel that you configure for the Amazon Web Services Support App.

type channelRoleArn

string

param channelRoleArn

[REQUIRED]

type notifyOnAddCorrespondenceToCase

boolean

param notifyOnAddCorrespondenceToCase

Whether you want to get notified when a support case has a new correspondence.

type notifyOnCaseSeverity

string

param notifyOnCaseSeverity

[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>

type notifyOnCreateOrReopenCase

boolean

param notifyOnCreateOrReopenCase

Whether you want to get notified when a support case is created or reopened.

type notifyOnResolveCase

boolean

param notifyOnResolveCase

Whether you want to get notified when a support case is resolved.

type teamId

string

param teamId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --