start-agent-recommendation-generation¶

Description¶

Initiates a new recommendation generation process for the specified optimization profile. This asynchronous operation analyzes your Amazon Web Services resources and generates optimization recommendations based on the configured pillars and scope. Use GetAgentRecommendationGeneration to check status.

Synopsis¶

  start-agent-recommendation-generation
--profile-arn <value>
--types <value>
[--name <value>]
[--additional-context <value>]
--scope <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]
[--cli-error-format <value>]

Options¶

--profile-arn (string) [required]

The Amazon Resource Name (ARN) of the optimization profile to use for generating recommendations.

Constraints:

min: 0

max: 2048

pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)

--types (list) [required]

The types of recommendations to generate.

Constraints:

min: 1

max: 1

(string)

Possible values:

RESOURCE

ARCHITECTURE

APPLICATION

Syntax:

"string" "string" ...

--name (string)

An optional name for this generation process to help identify it in lists and logs.

Constraints:

min: 1

max: 128

pattern: [A-Za-z0-9_-]+

--additional-context (document)

Optional additional context to guide the recommendation generation, such as specific business requirements or constraints.

JSON Syntax:

{...}

--scope (structure) [required]

Scope configuration to focus the generation on specific pillars or goals.

pillars -> (list) [required]

The Well-Architected Tool Framework pillars to include in the generation scope.

Constraints:

min: 1

max: 5

(string)

Possible values:

COST_OPTIMIZATION

SECURITY

RESILIENCE

PERFORMANCE

OPERATIONAL_EXCELLENCE

goalIds -> (list)

Specific goal IDs to focus on during recommendation generation.

Constraints:

min: 1

max: 10

(string)

Constraints:

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

items -> (list)

Optional per-pillar item filtering configuration.

(structure)

Item configuration for a specific Well-Architected Tool Framework pillar.

pillar -> (string) [required]

The pillar this item configuration applies to.

Possible values:

COST_OPTIMIZATION

SECURITY

RESILIENCE

PERFORMANCE

OPERATIONAL_EXCELLENCE

ids -> (list) [required]

A list of item IDs to process for this pillar, such as best practice IDs, Amazon Web Services service names, or resource ARNs.

Constraints:

min: 1

(string)

Constraints:

min: 1

max: 2048

JSON Syntax:

{
  "pillars": ["COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE", ...],
  "goalIds": ["string", ...],
  "items": [
    {
      "pillar": "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE",
      "ids": ["string", ...]
    }
    ...
  ]
}

--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. 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
yaml
yaml-stream
off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

id -> (string)

The unique identifier of the recommendation generation.

Constraints:

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

profileArn -> (string)

The Amazon Resource Name (ARN) of the profile used for this generation.

Constraints:

min: 0

max: 2048

pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)

name -> (string)

The name of the recommendation generation.

status -> (string)

The current status of the recommendation generation.

Possible values:

QUEUED

IN_PROGRESS

COMPLETED

ERROR

estimatedCompletionTime -> (timestamp)

The estimated time for the generation to complete.

createdBy -> (string)

The identifier of the user or system that started this generation.

Constraints:

min: 1

max: 128

createdAt -> (timestamp)

The timestamp when the generation was started.

lastModifiedBy -> (string)

The identifier of the user or system that last modified this generation.

Constraints:

min: 1

max: 128

lastModifiedAt -> (timestamp)

The timestamp when the generation was last modified.

Table of Contents

Feedback

User Guide