AgentProfileSummary
Summary of an optimization profile, including its configuration, metadata, and audit information.
Contents
- arn
-
The Amazon Resource Name (ARN) of the optimization 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
- createdAt
-
The timestamp when the profile was created.
Type: Timestamp
Required: Yes
- createdBy
-
The identifier of the user or system that created this profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- name
-
The system name of the profile.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- aggregationConfiguration
-
The aggregation configuration that defines which AWS accounts and Regions to analyze. Not present for basic profiles.
Type: Array of AggregationConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
- businessOverview
-
The business overview for this profile.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*Required: No
- deletionProtection
-
Indicates whether deletion protection is enabled for the profile.
Type: Boolean
Required: No
- description
-
A description of the profile.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*Required: No
- displayName
-
The display name of the profile shown to users.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+Required: No
- eligibleForArchitectureGeneration
-
Indicates whether the profile is valid for manual architecture generation.
Type: Boolean
Required: No
- eligibleForScheduledGeneration
-
Indicates whether the profile is valid for scheduled recommendation generation.
Type: Boolean
Required: No
- executionRoleArn
-
The ARN of the IAM execution role used for recommendation actions. Not present for basic profiles.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+Required: No
- fieldErrors
-
A map of field paths to error messages for invalid or missing input fields.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 100 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Value Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- lastModifiedAt
-
The timestamp when the profile was last modified.
Type: Timestamp
Required: No
- lastModifiedBy
-
The identifier of the user or system that last modified this profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- organizationalAggregationConfiguration
-
Important
This is not available during the preview release.
The organizational monitoring boundary. Present only for organizational profiles.
Type: OrganizationalAggregationConfiguration object
Required: No
- pillars
-
The AWS Well-Architected Framework pillars associated with this profile. Not present for basic profiles.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Valid Values:
COST_OPTIMIZATION | SECURITY | RESILIENCE | PERFORMANCE | OPERATIONAL_EXCELLENCERequired: No
- profileType
-
The type of the profile.
ORGANIZATIONALis not available during the preview release.Type: String
Valid Values:
STANDARD | BASIC | ORGANIZATIONALRequired: No
-
The tags associated with the profile.
Type: Array of Tag objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
