AWS CLI Command Reference

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

create-workflow-step

Description

Create a step in the migration workflow.

See also: AWS API Documentation

Synopsis

  create-workflow-step
--name <value>
--step-group-id <value>
--workflow-id <value>
--step-action-type <value>
[--description <value>]
[--workflow-step-automation-configuration <value>]
[--step-target <value>]
[--outputs <value>]
[--previous <value>]
[--next <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

--name (string)

The name of the step.

--step-group-id (string)

The ID of the step group.

--workflow-id (string)

The ID of the migration workflow.

--step-action-type (string)

The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

Possible values:

  • MANUAL
  • AUTOMATED

--description (string)

The description of the step.

--workflow-step-automation-configuration (structure)

The custom script to run tests on source or target environments.

scriptLocationS3Bucket -> (string)

The Amazon S3 bucket where the script is located.

scriptLocationS3Key -> (structure)

The Amazon S3 key for the script location.

linux -> (string)

The script location for Linux.

windows -> (string)

The script location for Windows.

command -> (structure)

The command required to run the script.

linux -> (string)

Command for Linux.

windows -> (string)

Command for Windows.

runEnvironment -> (string)

The source or target environment.

targetType -> (string)

The servers on which to run the script.

Shorthand Syntax:

scriptLocationS3Bucket=string,scriptLocationS3Key={linux=string,windows=string},command={linux=string,windows=string},runEnvironment=string,targetType=string

JSON Syntax:

{
  "scriptLocationS3Bucket": "string",
  "scriptLocationS3Key": {
    "linux": "string",
    "windows": "string"
  },
  "command": {
    "linux": "string",
    "windows": "string"
  },
  "runEnvironment": "AWS"|"ONPREMISE",
  "targetType": "SINGLE"|"ALL"|"NONE"
}

--step-target (list)

The servers on which a step will be run.

(string)

Syntax:

"string" "string" ...

--outputs (list)

The key value pairs added for the expected output.

(structure)

The output of a step.

name -> (string)

The name of the step.

dataType -> (string)

The data type of the output.

required -> (boolean)

Determine if an output is required from a step.

value -> (tagged union structure)

The value of the output.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: integerValue, stringValue, listOfStringValue.

integerValue -> (integer)

The integer value.

stringValue -> (string)

The string value.

listOfStringValue -> (list)

The list of string value.

(string)

Shorthand Syntax:

name=string,dataType=string,required=boolean,value={integerValue=integer,stringValue=string,listOfStringValue=[string,string]} ...

JSON Syntax:

[
  {
    "name": "string",
    "dataType": "STRING"|"INTEGER"|"STRINGLIST"|"STRINGMAP",
    "required": true|false,
    "value": {
      "integerValue": integer,
      "stringValue": "string",
      "listOfStringValue": ["string", ...]
    }
  }
  ...
]

--previous (list)

The previous step.

(string)

Syntax:

"string" "string" ...

--next (list)

The next step.

(string)

Syntax:

"string" "string" ...

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

id -> (string)

The ID of the step.

stepGroupId -> (string)

The ID of the step group.

workflowId -> (string)

The ID of the migration workflow.

name -> (string)

The name of the step.