Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . support-app ]
update-slack-channel-configuration¶
Description¶
Updates the configuration for a Slack channel, such as case update notifications.
See also: AWS API Documentation
Synopsis¶
update-slack-channel-configuration
--channel-id <value>
[--channel-name <value>]
[--channel-role-arn <value>]
[--notify-on-add-correspondence-to-case | --no-notify-on-add-correspondence-to-case]
[--notify-on-case-severity <value>]
[--notify-on-create-or-reopen-case | --no-notify-on-create-or-reopen-case]
[--notify-on-resolve-case | --no-notify-on-resolve-case]
--team-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--channel-id (string)
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
--channel-name (string)
The Slack channel name that you want to update.
--channel-role-arn (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 .
--notify-on-add-correspondence-to-case | --no-notify-on-add-correspondence-to-case (boolean)
Whether you want to get notified when a support case has a new correspondence.
--notify-on-case-severity (string)
The case severity for a support case that you want to receive notifications.
If you specify
highorall, at least one of the following parameters must betrue:
notifyOnAddCorrespondenceToCasenotifyOnCreateOrReopenCasenotifyOnResolveCaseIf you specify
none, any of the following parameters that you specify in your request must befalse:
notifyOnAddCorrespondenceToCasenotifyOnCreateOrReopenCasenotifyOnResolveCaseNote
If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.Possible values:
noneallhigh
--notify-on-create-or-reopen-case | --no-notify-on-create-or-reopen-case (boolean)
Whether you want to get notified when a support case is created or reopened.
--notify-on-resolve-case | --no-notify-on-resolve-case (boolean)
Whether you want to get notified when a support case is resolved.
--team-id (string)
The team ID in Slack. This ID uniquely identifies a Slack workspace, such asT012ABCDEFG.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
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 asT012ABCDEFG.