Skip to content

Creates a context associated with an optimization profile

Description

Creates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation.

Usage

wellarchitected_create_agent_context(clientToken, profileArn, title,
  contextType, content)

Arguments

  • clientToken

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

  • profileArn

    [required] The Amazon Resource Name (ARN) of the profile to associate the context with.

  • title

    [required] The title of the context.

  • contextType

    [required] The type of the context.

  • content

    [required] The typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.

Value

A list with the following syntax:

list(
  context = list(
    id = "string",
    profileArn = "string",
    title = "string",
    contextType = "APPLICATION",
    content = list(
      accountIds = list(
        "string"
      ),
      regions = list(
        "string"
      ),
      awsServices = list(
        "string"
      ),
      resourceTypes = list(
        "string"
      ),
      resourceTags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      applicationOverview = "string",
      industry = "string",
      applicationType = "SAS"|"DESKTOP_APPLICATION"|"OTHER",
      criticality = "MISSION_CRITICAL"|"BUSINESS_CRITICAL"|"NON_CRITICAL"|"TEST_DEVELOPMENT",
      architectureOverview = "string",
      additionalContext = "string"
    ),
    applicationType = "SAS"|"DESKTOP_APPLICATION"|"OTHER",
    criticality = "MISSION_CRITICAL"|"BUSINESS_CRITICAL"|"NON_CRITICAL"|"TEST_DEVELOPMENT",
    createdBy = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    lastModifiedBy = "string",
    lastModifiedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$create_agent_context(
  clientToken = "string",
  profileArn = "string",
  title = "string",
  contextType = "APPLICATION",
  content = list(
    accountIds = list(
      "string"
    ),
    regions = list(
      "string"
    ),
    awsServices = list(
      "string"
    ),
    resourceTypes = list(
      "string"
    ),
    resourceTags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    applicationOverview = "string",
    industry = "string",
    applicationType = "SAS"|"DESKTOP_APPLICATION"|"OTHER",
    criticality = "MISSION_CRITICAL"|"BUSINESS_CRITICAL"|"NON_CRITICAL"|"TEST_DEVELOPMENT",
    architectureOverview = "string",
    additionalContext = "string"
  )
)