Skip to content

Lists active optimization recommendations for a specified profile with optional filtering by state

Description

Lists active optimization recommendations for a specified profile with optional filtering by state.

Usage

wellarchitected_list_agent_recommendations(profileArn, maxResults,
  nextToken, state, pillar)

Arguments

  • profileArn

    [required] The Amazon Resource Name (ARN) of the optimization profile to list recommendations for.

  • maxResults

    The maximum number of recommendations to return in a single response.

  • nextToken

    A pagination token returned from a previous call to continue retrieving results.

  • state

    Optional filter to return only recommendations with the specified state (OPEN or CLOSED).

  • pillar

    Optional filter to return only recommendations for the specified pillar.

Value

A list with the following syntax:

list(
  items = list(
    list(
      recommendationArn = "string",
      profileArn = "string",
      generationId = "string",
      title = "string",
      description = "string",
      type = "RESOURCE"|"ARCHITECTURE"|"APPLICATION",
      pillar = "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE",
      priority = "HIGH"|"MEDIUM"|"LOW",
      effort = "LARGE"|"MEDIUM"|"SMALL",
      status = "ACTIVE"|"SUPPRESSED"|"COMPLETED",
      state = "OPEN"|"CLOSED",
      updateReason = "string",
      impact = "HIGH"|"MEDIUM"|"LOW",
      roi = list(
        estimate = "string",
        detail = "string"
      ),
      numberOfResources = 123,
      awsServices = list(
        "string"
      ),
      businessUnits = list(
        "string"
      ),
      applications = list(
        "string"
      ),
      createdBy = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      lastModifiedBy = "string",
      lastModifiedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_agent_recommendations(
  profileArn = "string",
  maxResults = 123,
  nextToken = "string",
  state = "OPEN"|"CLOSED",
  pillar = "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE"
)