[ aws . wellarchitected ]

create-agent-profile

Description

Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon Web Services resources.

See also: AWS API Documentation

Synopsis

  create-agent-profile
--name <value>
[--display-name <value>]
[--description <value>]
[--business-overview <value>]
--pillars <value>
[--deletion-protection | --no-deletion-protection]
--execution-role-arn <value>
--aggregation-configuration <value>
[--client-token <value>]
[--tags <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

--name (string) [required]

The system name of the profile.

Constraints:

• min: 3
• max: 128
• pattern: [a-zA-Z0-9_-]+

--display-name (string)

The display name of the profile shown to users.

Constraints:

• min: 3
• max: 128
• pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+

--description (string)

A description of the profile.

Constraints:

• min: 0
• max: 512
• pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])*

--business-overview (string)

The business overview for this profile.

Constraints:

• min: 0
• max: 512
• pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])*

--pillars (list) [required]

The Well-Architected Tool Framework pillars to associate with this profile.

Constraints:

• min: 1
• max: 5

(string)

Possible values:

• COST_OPTIMIZATION
• SECURITY
• RESILIENCE
• PERFORMANCE
• OPERATIONAL_EXCELLENCE

Syntax:

"string" "string" ...

--deletion-protection | --no-deletion-protection (boolean)

Indicates whether deletion protection is enabled for the profile.

--execution-role-arn (string) [required]

The ARN of the IAM execution role used for recommendation actions.

Constraints:

• min: 0
• max: 2048
• pattern: arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+

--aggregation-configuration (list) [required]

The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

Constraints:

• min: 0
• max: 100

(structure)

Configuration settings that define the scope of Amazon Web Services resources to analyze for optimization recommendations.

accountId -> (string) [required]

The Amazon Web Services account ID to analyze.

Constraints:

• pattern: \d{12}

regions -> (list) [required]

A list of Amazon Web Services Regions to include in the analysis.

Constraints:

• min: 0
• max: 25

(string)

Constraints:

• min: 0
• max: 64
• pattern: [a-z]{2}-[a-z]+-\d{1}

accessRoleArn -> (string) [required]

The ARN of an IAM role to assume for resource analysis in this account.

Constraints:

• min: 0
• max: 2048
• pattern: arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+

Shorthand Syntax:

accountId=string,regions=string,string,accessRoleArn=string ...

JSON Syntax:

[
  {
    "accountId": "string",
    "regions": ["string", ...],
    "accessRoleArn": "string"
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:

• min: 1
• max: 128
• pattern: [\x21-\x7E]+

--tags (list)

The tags to associate with the profile.

(structure)

A key-value pair associated with a resource for cost allocation and access control.

key -> (string) [required]

The key of the tag.

Constraints:

• min: 1
• max: 128
• pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

value -> (string) [required]

The value of the tag.

Constraints:

• min: 1
• max: 256
• pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "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

name -> (string)

The system name of the created profile.

Constraints:

• min: 3
• max: 128
• pattern: [a-zA-Z0-9_-]+

displayName -> (string)

The display name of the created profile.

Constraints:

• min: 3
• max: 128
• pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+

description -> (string)

A description of the created profile.

Constraints:

• min: 0
• max: 512
• pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])*

businessOverview -> (string)

The business overview of the created profile.

Constraints:

• min: 0
• max: 512
• pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])*

pillars -> (list)

The Well-Architected Tool Framework pillars associated with the created profile.

Constraints:

• min: 1
• max: 5

(string)

Possible values:

• COST_OPTIMIZATION
• SECURITY
• RESILIENCE
• PERFORMANCE
• OPERATIONAL_EXCELLENCE

deletionProtection -> (boolean)

Indicates whether deletion protection is enabled.

executionRoleArn -> (string)

The ARN of the IAM execution role.

Constraints:

• min: 0
• max: 2048
• pattern: arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+

aggregationConfiguration -> (list)

The aggregation configuration.

Constraints:

• min: 0
• max: 100

(structure)

Configuration settings that define the scope of Amazon Web Services resources to analyze for optimization recommendations.

accountId -> (string) [required]

The Amazon Web Services account ID to analyze.

Constraints:

• pattern: \d{12}

regions -> (list) [required]

A list of Amazon Web Services Regions to include in the analysis.

Constraints:

• min: 0
• max: 25

(string)

Constraints:

• min: 0
• max: 64
• pattern: [a-z]{2}-[a-z]+-\d{1}

accessRoleArn -> (string) [required]

The ARN of an IAM role to assume for resource analysis in this account.

Constraints:

• min: 0
• max: 2048
• pattern: arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+

arn -> (string)

The Amazon Resource Name (ARN) of the created profile.

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_-]+)

eligibleForScheduledGeneration -> (boolean)

Indicates whether the profile is valid for scheduled recommendation generation.

eligibleForArchitectureGeneration -> (boolean)

Indicates whether the profile is valid for manual architecture generation.

fieldErrors -> (map)

A map of field paths to error messages for invalid or missing input fields.

Constraints:

• min: 0
• max: 100

key -> (string)

Constraints:

• min: 1
• max: 256

value -> (string)

Constraints:

• min: 1
• max: 1024

tags -> (list)

The tags associated with the created profile.

(structure)

A key-value pair associated with a resource for cost allocation and access control.

key -> (string) [required]

The key of the tag.

Constraints:

• min: 1
• max: 128
• pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

value -> (string) [required]

The value of the tag.

Constraints:

• min: 1
• max: 256
• pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

createdBy -> (string)

The identifier of the user or system that created this profile.

Constraints:

• min: 1
• max: 128

createdAt -> (timestamp)

The timestamp when the profile was created.

lastModifiedBy -> (string)

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

Constraints:

• min: 1
• max: 128

lastModifiedAt -> (timestamp)

The timestamp when the profile was last modified.