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 . chatbot ]

create-custom-action

Description

Creates a custom action that can be invoked as an alias or as a button on a notification.

See also: AWS API Documentation

Synopsis

  create-custom-action
--definition <value>
[--alias-name <value>]
[--attachments <value>]
[--tags <value>]
[--client-token <value>]
--action-name <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

--definition (structure)

The definition of the command to run when invoked as an alias or as an action button.

CommandText -> (string)

The command string to run which may include variables by prefixing with a dollar sign ($).

Shorthand Syntax:

CommandText=string

JSON Syntax:

{
  "CommandText": "string"
}

--alias-name (string)

The name used to invoke this action in a chat channel. For example, @aws run my-alias .

--attachments (list)

Defines when this custom action button should be attached to a notification.

(structure)

Defines when a custom action button should be attached to a notification.

NotificationType -> (string)

The type of notification that the custom action should be attached to.

ButtonText -> (string)

The text of the button that appears on the notification.

Criteria -> (list)

The criteria for when a button should be shown based on values in the notification.

(structure)

A criteria for when a button should be shown based on values in the notification

Operator -> (string)

The operation to perform on the named variable.

VariableName -> (string)

The name of the variable to operate on.

Value -> (string)

A value that is compared with the actual value of the variable based on the behavior of the operator.

Variables -> (map)

The variables to extract from the notification.

key -> (string)

value -> (string)

Shorthand Syntax:

NotificationType=string,ButtonText=string,Criteria=[{Operator=string,VariableName=string,Value=string},{Operator=string,VariableName=string,Value=string}],Variables={KeyName1=string,KeyName2=string} ...

JSON Syntax:

[
  {
    "NotificationType": "string",
    "ButtonText": "string",
    "Criteria": [
      {
        "Operator": "HAS_VALUE"|"EQUALS",
        "VariableName": "string",
        "Value": "string"
      }
      ...
    ],
    "Variables": {"string": "string"
      ...}
  }
  ...
]

--tags (list)

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

(structure)

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

Warning

Do not include confidential or sensitive information in this field.

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .

TagKey -> (string)

The key of the tag.

TagValue -> (string)

The value of the tag.

Shorthand Syntax:

TagKey=string,TagValue=string ...

JSON Syntax:

[
  {
    "TagKey": "string",
    "TagValue": "string"
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the SDK.

--action-name (string)

The name of the custom action. This name is included in the Amazon Resource Name (ARN).

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

CustomActionArn -> (string)

The fully defined ARN of the custom action.