AgentRecommendationSummary

Summary of an agent optimization recommendation returned by list operations.

createdAt

The timestamp when the recommendation was created.

Type: Timestamp

Required: Yes

createdBy

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

description

A description of the recommendation.

Type: String

Length Constraints: Minimum length of 80. Maximum length of 500.

Required: Yes

effort

The effort required to implement the recommendation.

Type: String

Valid Values: LARGE | MEDIUM | SMALL

Required: Yes

impact

The severity of the recommendation's impact.

Type: String

Valid Values: HIGH | MEDIUM | LOW

Required: Yes

pillar

The AWS Well-Architected Framework pillar that the recommendation addresses.

Type: String

Valid Values: COST_OPTIMIZATION | SECURITY | RESILIENCE | PERFORMANCE | OPERATIONAL_EXCELLENCE

Required: Yes

priority

The priority of the recommendation.

Type: String

Valid Values: HIGH | MEDIUM | LOW

Required: Yes

profileArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

Required: Yes

recommendationArn

The Amazon Resource Name (ARN) of the recommendation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

roi

The return on investment estimate for the recommendation.

Type: Roi object

Required: Yes

state

The current state of the recommendation.

Type: String

Valid Values: OPEN | CLOSED

Required: Yes

status

The current status of the recommendation.

Type: String

Valid Values: ACTIVE | SUPPRESSED | COMPLETED

Required: Yes

title

The title of the recommendation.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 120.

Required: Yes

type

The type of the recommendation.

Type: String

Valid Values: RESOURCE | ARCHITECTURE | APPLICATION

Required: Yes

applications

The applications that the recommendation targets.

Type: Array of strings

Required: No

awsServices

The AWS services that the recommendation applies to.

Type: Array of strings

Required: No

businessUnits

The business units that own the affected resources.

Type: Array of strings

Required: No

generationId

The identifier of the generation that produced this recommendation.

Type: String

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

Required: No

lastModifiedAt

The timestamp when the recommendation was last modified.

Type: Timestamp

Required: No

lastModifiedBy

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

numberOfResources

The number of AWS resources this recommendation affects.

Type: Integer

Required: No

updateReason

The free-text reason associated with the recommendation's most recent status update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

AgentRecommendationSummary

Contents

See Also