[ aws . migrationhuborchestrator ]
get-workflow¶
Synopsis¶
get-workflow
--id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--id (string)
The ID of the migration workflow.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
yaml
yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
id -> (string)
The ID of the migration workflow.
arn -> (string)
The Amazon Resource Name (ARN) of the migration workflow.
name -> (string)
The name of the migration workflow.
description -> (string)
The description of the migration workflow.
templateId -> (string)
The ID of the template.
adsApplicationConfigurationId -> (string)
The configuration ID of the application configured in Application Discovery Service.
adsApplicationName -> (string)
The name of the application configured in Application Discovery Service.
status -> (string)
The status of the migration workflow.
statusMessage -> (string)
The status message of the migration workflow.
creationTime -> (timestamp)
The time at which the migration workflow was created.
lastStartTime -> (timestamp)
The time at which the migration workflow was last started.
lastStopTime -> (timestamp)
The time at which the migration workflow was last stopped.
lastModifiedTime -> (timestamp)
The time at which the migration workflow was last modified.
endTime -> (timestamp)
The time at which the migration workflow ended.
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.
totalSteps -> (integer)
The total number of steps in the migration workflow.
completedSteps -> (integer)
Get a list of completed steps in the migration workflow.
workflowInputs -> (map)
The inputs required for creating the migration workflow.
key -> (string)
value -> (tagged union structure)
A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
integerValue,stringValue,listOfStringsValue,mapOfStringValue.integerValue -> (integer)
The value of the integer.
stringValue -> (string)
String value.
listOfStringsValue -> (list)
List of string values.
(string)
mapOfStringValue -> (map)
Map of string values.
key -> (string)
value -> (string)
tags -> (map)
The tags added to the migration workflow.
key -> (string)
value -> (string)
workflowBucket -> (string)
The Amazon S3 bucket where the migration logs are stored.