[ aws . servicecatalog ]

create-service-action

Description

Creates a self-service action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-service-action
--name <value>
--definition-type <value>
--definition <value>
[--description <value>]
[--accept-language <value>]
[--idempotency-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

The self-service action name.

--definition-type (string)

The service action definition type. For example, SSM_AUTOMATION .

Possible values:

• SSM_AUTOMATION

--definition (map)

The self-service action definition. Can be one of the following:

Name

The name of the AWS Systems Manager document (SSM document). For example, AWS-RestartEC2Instance .

If you are using a shared SSM document, you must provide the ARN instead of the name.

Version

The AWS Systems Manager automation document version. For example, "Version": "1"

AssumeRole

The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole" .

To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE" .

Parameters

The list of parameters in JSON format.

For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}] .

key -> (string)

value -> (string)

Shorthand Syntax:

  KeyName1=string,KeyName2=string

Where valid key names are:
  Name
  Version
  AssumeRole
  Parameters

JSON Syntax:

{"Name"|"Version"|"AssumeRole"|"Parameters": "string"
  ...}

--description (string)

The self-service action description.

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--idempotency-token (string)

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ServiceActionDetail -> (structure)

An object containing information about the self-service action.

ServiceActionSummary -> (structure)

Summary information about the self-service action.

Id -> (string)

The self-service action identifier.

Name -> (string)

The self-service action name.

Description -> (string)

The self-service action description.

DefinitionType -> (string)

The self-service action definition type. For example, SSM_AUTOMATION .

Definition -> (map)

A map that defines the self-service action.

key -> (string)

value -> (string)