Skip to content

Creates an optimization profile that defines the scope and configuration for generating recommendations

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.

Usage

wellarchitected_create_agent_profile(name, displayName, description,
  businessOverview, pillars, deletionProtection, executionRoleArn,
  aggregationConfiguration, clientToken, tags)

Arguments

  • name

    [required] The system name of the profile.

  • displayName

    The display name of the profile shown to users.

  • description

    A description of the profile.

  • businessOverview

    The business overview for this profile.

  • pillars

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

  • deletionProtection

    Indicates whether deletion protection is enabled for the profile.

  • executionRoleArn

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

  • aggregationConfiguration

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

  • clientToken

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

  • tags

    The tags to associate with the profile.

Value

A list with the following syntax:

list(
  name = "string",
  displayName = "string",
  description = "string",
  businessOverview = "string",
  pillars = list(
    "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE"
  ),
  deletionProtection = TRUE|FALSE,
  executionRoleArn = "string",
  aggregationConfiguration = list(
    list(
      accountId = "string",
      regions = list(
        "string"
      ),
      accessRoleArn = "string"
    )
  ),
  arn = "string",
  eligibleForScheduledGeneration = TRUE|FALSE,
  eligibleForArchitectureGeneration = TRUE|FALSE,
  fieldErrors = list(
    "string"
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  createdBy = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  lastModifiedBy = "string",
  lastModifiedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_agent_profile(
  name = "string",
  displayName = "string",
  description = "string",
  businessOverview = "string",
  pillars = list(
    "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE"
  ),
  deletionProtection = TRUE|FALSE,
  executionRoleArn = "string",
  aggregationConfiguration = list(
    list(
      accountId = "string",
      regions = list(
        "string"
      ),
      accessRoleArn = "string"
    )
  ),
  clientToken = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)