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 ]

get-template

Description

Get the template you want to use for creating a migration workflow.

See also: AWS API Documentation

Synopsis

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

--id (string)

The ID of the template.

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

id -> (string)

The ID of the template.

templateArn -> (string)

>The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234 . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .

name -> (string)

The name of the template.

description -> (string)

The time at which the template was last created.

inputs -> (list)

The inputs provided for the creation of the migration workflow.

(structure)

The input parameters of a template.

inputName -> (string)

The name of the template.

dataType -> (string)

The data type of the template input.

required -> (boolean)

Determine if an input is required from the template.

tools -> (list)

List of AWS services utilized in a migration workflow.

(structure)

List of AWS services utilized in a migration workflow.

name -> (string)

The name of an AWS service.

url -> (string)

The URL of an AWS service.

creationTime -> (timestamp)

The time at which the template was last created.

owner -> (string)

The owner of the migration workflow template.

status -> (string)

The status of the template.

statusMessage -> (string)

The status message of retrieving migration workflow templates.

templateClass -> (string)

The class of the migration workflow template. The available template classes are:

  • A2C
  • MGN
  • SAP_MULTI
  • SQL_EC2
  • SQL_RDS
  • VMIE

tags -> (map)

The tags added to the migration workflow template.

key -> (string)

value -> (string)