SupportApp / Client / update_slack_channel_configuration

update_slack_channel_configuration#

SupportApp.Client.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 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.

  • 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, such as T012ABCDEFG.

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, such as T012ABCDEFG.

Exceptions

  • SupportApp.Client.exceptions.ConflictException

  • SupportApp.Client.exceptions.ResourceNotFoundException

  • SupportApp.Client.exceptions.AccessDeniedException

  • SupportApp.Client.exceptions.InternalServerException

  • SupportApp.Client.exceptions.ValidationException