agent_profiles

Creates, updates, deletes, gets or lists an agent_profiles resource.

Overview

Name	agent_profiles
Type	Resource
Id	aws.wellarchitected.agent_profiles

Fields

The following fields are returned by SELECT queries:

get_agent_profile

Name	Datatype	Description
name	string	The system name of the profile. (pattern: <code>[a-zA-Z0-9_-]+</code>)
aggregation_configuration	array	The aggregation configuration.
arn	string	The Amazon Resource Name (ARN) of the profile. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
business_overview	string	The business overview of the profile. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])*</code>)
created_at	string (date-time)	The timestamp when the profile was created.
created_by	string	The identifier of the user or system that created this profile.
deletion_protection	boolean	Indicates whether deletion protection is enabled.
description	string	A description of the profile. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])*</code>)
display_name	string	The display name of the profile. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])+</code>)
eligible_for_architecture_generation	boolean	Indicates whether the profile is valid for manual architecture generation.
eligible_for_scheduled_generation	boolean	Indicates whether the profile is valid for scheduled recommendation generation.
execution_role_arn	string	The ARN of the IAM execution role. (pattern: <code>arn:([a-z-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@-_]+</code>)
field_errors	object	A map of field paths to error messages for invalid or missing input fields.
last_modified_at	string (date-time)	The timestamp when the profile was last modified.
last_modified_by	string	The identifier of the user or system that last modified this profile.
pillars	array	The Well-Architected Tool Framework pillars associated with the profile.
tags	array	The tags associated with the profile.

list_agent_profiles

Name	Datatype	Description
name	string	The system name of the profile. (pattern: <code>[a-zA-Z0-9_-]+</code>)
aggregation_configuration	array	The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.
arn	string	The Amazon Resource Name (ARN) of the optimization profile. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
business_overview	string	The business overview for this profile. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])*</code>)
created_at	string (date-time)	The timestamp when the profile was created.
created_by	string	The identifier of the user or system that created this profile.
deletion_protection	boolean	Indicates whether deletion protection is enabled for the profile.
description	string	A description of the profile. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])*</code>)
display_name	string	The display name of the profile shown to users. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])+</code>)
eligible_for_architecture_generation	boolean	Indicates whether the profile is valid for manual architecture generation.
eligible_for_scheduled_generation	boolean	Indicates whether the profile is valid for scheduled recommendation generation.
execution_role_arn	string	The ARN of the IAM execution role used for recommendation actions. (pattern: <code>arn:([a-z-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@-_]+</code>)
field_errors	object	A map of field paths to error messages for invalid or missing input fields.
last_modified_at	string (date-time)	The timestamp when the profile was last modified.
last_modified_by	string	The identifier of the user or system that last modified this profile.
pillars	array	The Well-Architected Tool Framework pillars associated with this profile.
tags	array	The tags associated with the profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_profile	select	profile_arn, region		Retrieves detailed information about an optimization profile, including its configuration and metadata.
list_agent_profiles	select	region	maxResults, nextToken	Lists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations.
create_agent_profile	insert	region, name, pillars, executionRoleArn, aggregationConfiguration		Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon Web Services resources.
update_agent_profile	update	profile_arn, region		Updates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings.
delete_agent_profile	delete	profile_arn, region		Deletes an optimization profile and its associated configuration. This action cannot be undone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
profile_arn	string	The Amazon Resource Name (ARN) of the profile to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of profiles to return in a single call. Default is 100.
nextToken	string	A pagination token returned from a previous call to continue retrieving results.

SELECT examples

get_agent_profile

Retrieves detailed information about an optimization profile, including its configuration and metadata.

SELECT
name,
aggregation_configuration,
arn,
business_overview,
created_at,
created_by,
deletion_protection,
description,
display_name,
eligible_for_architecture_generation,
eligible_for_scheduled_generation,
execution_role_arn,
field_errors,
last_modified_at,
last_modified_by,
pillars,
tags
FROM aws.wellarchitected.agent_profiles
WHERE profile_arn = '{{ profile_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_agent_profiles

Lists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations.

SELECT
name,
aggregation_configuration,
arn,
business_overview,
created_at,
created_by,
deletion_protection,
description,
display_name,
eligible_for_architecture_generation,
eligible_for_scheduled_generation,
execution_role_arn,
field_errors,
last_modified_at,
last_modified_by,
pillars,
tags
FROM aws.wellarchitected.agent_profiles
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_agent_profile

Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon Web Services resources.

INSERT INTO aws.wellarchitected.agent_profiles (
name,
displayName,
description,
businessOverview,
pillars,
deletionProtection,
executionRoleArn,
aggregationConfiguration,
clientToken,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ displayName }}',
'{{ description }}',
'{{ businessOverview }}',
'{{ pillars }}' /* required */,
{{ deletionProtection }},
'{{ executionRoleArn }}' /* required */,
'{{ aggregationConfiguration }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
aggregation_configuration,
arn,
business_overview,
created_at,
created_by,
deletion_protection,
description,
display_name,
eligible_for_architecture_generation,
eligible_for_scheduled_generation,
execution_role_arn,
field_errors,
last_modified_at,
last_modified_by,
pillars,
tags
;

Manifest

# Description fields are for documentation purposes
- name: agent_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agent_profiles resource.
  - name: name
    value: "{{ name }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: businessOverview
    value: "{{ businessOverview }}"
  - name: pillars
    value:
      - "{{ pillars }}"
  - name: deletionProtection
    value: {{ deletionProtection }}
  - name: executionRoleArn
    value: "{{ executionRoleArn }}"
  - name: aggregationConfiguration
    value:
      - accountId: "{{ accountId }}"
        regions: "{{ regions }}"
        accessRoleArn: "{{ accessRoleArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_agent_profile

Updates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings.

UPDATE aws.wellarchitected.agent_profiles
SET 
clientToken = '{{ clientToken }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
executionRoleArn = '{{ executionRoleArn }}',
aggregationConfiguration = '{{ aggregationConfiguration }}',
businessOverview = '{{ businessOverview }}',
pillars = '{{ pillars }}',
deletionProtection = {{ deletionProtection }}
WHERE 
profile_arn = '{{ profile_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
aggregation_configuration,
arn,
business_overview,
created_at,
created_by,
deletion_protection,
description,
display_name,
eligible_for_architecture_generation,
eligible_for_scheduled_generation,
execution_role_arn,
field_errors,
last_modified_at,
last_modified_by,
pillars,
tags;

DELETE examples

delete_agent_profile

Deletes an optimization profile and its associated configuration. This action cannot be undone.

DELETE FROM aws.wellarchitected.agent_profiles
WHERE profile_arn = '{{ profile_arn }}' --required
AND region = '{{ region }}' --required
;