[ aws . migrationhubstrategy ]

start-recommendation-report-generation

Description

Starts generating a recommendation report.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-recommendation-report-generation
[--group-id-filter <value>]
[--output-format <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--group-id-filter (list)

Groups the resources in the recommendation report with a unique name.

(structure)

The object containing information about distinct imports or groups for Strategy Recommendations.

name -> (string)

The key of the specific import group.

value -> (string)

The value of the specific import group.

Shorthand Syntax:

name=string,value=string ...

JSON Syntax:

[
  {
    "name": "ExternalId",
    "value": "string"
  }
  ...
]

--output-format (string)

The output format for the recommendation report file. The default format is Microsoft Excel.

Possible values:

  • Excel

  • Json

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

See ‘aws help’ for descriptions of global parameters.

Output

id -> (string)

The ID of the recommendation report generation task.