View a markdown version of this page

GoalSummary - AWS Well-Architected

GoalSummary

Summary of an optimization goal associated with a profile.

Contents

createdAt

The timestamp when the goal was created.

Type: Timestamp

Required: Yes

createdBy

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

Type: String

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

Required: Yes

id

The unique identifier of the goal.

Type: String

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

Required: Yes

pillars

The AWS Well-Architected Framework pillars associated with this goal.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

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

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

title

The title of the goal.

Type: String

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

Pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+

Required: Yes

description

A description of the goal.

Type: String

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

Pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+

Required: No

lastModifiedAt

The timestamp when the goal was last modified.

Type: Timestamp

Required: No

lastModifiedBy

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

Type: String

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: