1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. wellarchitected
  6. getAgentProfile

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi

    Resource Type definition for AWS::WellArchitected::AgentProfile. An Agent Profile defines the execution role, account/region scope (via aggregation configuration access roles), and Well-Architected pillar focus used to generate Well-Architected Agent recommendations.

    Using getAgentProfile

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAgentProfile(args: GetAgentProfileArgs, opts?: InvokeOptions): Promise<GetAgentProfileResult>
    function getAgentProfileOutput(args: GetAgentProfileOutputArgs, opts?: InvokeOutputOptions): Output<GetAgentProfileResult>
    def get_agent_profile(arn: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAgentProfileResult
    def get_agent_profile_output(arn: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetAgentProfileResult]
    func LookupAgentProfile(ctx *Context, args *LookupAgentProfileArgs, opts ...InvokeOption) (*LookupAgentProfileResult, error)
    func LookupAgentProfileOutput(ctx *Context, args *LookupAgentProfileOutputArgs, opts ...InvokeOption) LookupAgentProfileResultOutput

    > Note: This function is named LookupAgentProfile in the Go SDK.

    public static class GetAgentProfile 
    {
        public static Task<GetAgentProfileResult> InvokeAsync(GetAgentProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentProfileResult> Invoke(GetAgentProfileInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentProfileResult> Invoke(GetAgentProfileInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetAgentProfileResult> getAgentProfile(GetAgentProfileArgs args, InvokeOptions options)
    public static Output<GetAgentProfileResult> getAgentProfile(GetAgentProfileArgs args, InvokeOptions options)
    public static Output<GetAgentProfileResult> getAgentProfile(GetAgentProfileArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:wellarchitected:getAgentProfile
      arguments:
        # arguments dictionary
    data "aws-native_wellarchitected_get_agent_profile" "name" {
        # arguments
    }

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    Arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    arn String
    The Amazon Resource Name (ARN) of the Agent Profile.
    arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    arn str
    The Amazon Resource Name (ARN) of the Agent Profile.
    arn String
    The Amazon Resource Name (ARN) of the Agent Profile.

    getAgentProfile Result

    The following output properties are available:

    AggregationConfiguration List<Pulumi.AwsNative.WellArchitected.Outputs.AgentProfileAggregationConfiguration>
    The aggregation configuration entries (account, regions, access role) associated with this profile.
    Arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    BusinessOverview string
    A business overview for the profile used to improve recommendation quality.
    CreatedAt string
    The timestamp when the profile was created.
    CreatedBy string
    The identifier of the system or user that created this profile.
    DeletionProtection bool
    Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.
    Description string
    A description of the profile.
    DisplayName string
    The human-readable display name of the profile.
    ExecutionRoleArn string
    The ARN of the IAM role assumed to execute recommendation actions.
    LastModifiedAt string
    The timestamp when the profile was last modified.
    LastModifiedBy string
    The identifier of the system or user that last modified this profile.
    Pillars List<Pulumi.AwsNative.WellArchitected.AgentProfilePillar>
    The list of Well-Architected pillars to focus on.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Key-value pairs to associate with the Agent Profile.
    AggregationConfiguration []AgentProfileAggregationConfiguration
    The aggregation configuration entries (account, regions, access role) associated with this profile.
    Arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    BusinessOverview string
    A business overview for the profile used to improve recommendation quality.
    CreatedAt string
    The timestamp when the profile was created.
    CreatedBy string
    The identifier of the system or user that created this profile.
    DeletionProtection bool
    Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.
    Description string
    A description of the profile.
    DisplayName string
    The human-readable display name of the profile.
    ExecutionRoleArn string
    The ARN of the IAM role assumed to execute recommendation actions.
    LastModifiedAt string
    The timestamp when the profile was last modified.
    LastModifiedBy string
    The identifier of the system or user that last modified this profile.
    Pillars []AgentProfilePillar
    The list of Well-Architected pillars to focus on.
    Tags Tag
    Key-value pairs to associate with the Agent Profile.
    aggregation_configuration list(object)
    The aggregation configuration entries (account, regions, access role) associated with this profile.
    arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    business_overview string
    A business overview for the profile used to improve recommendation quality.
    created_at string
    The timestamp when the profile was created.
    created_by string
    The identifier of the system or user that created this profile.
    deletion_protection bool
    Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.
    description string
    A description of the profile.
    display_name string
    The human-readable display name of the profile.
    execution_role_arn string
    The ARN of the IAM role assumed to execute recommendation actions.
    last_modified_at string
    The timestamp when the profile was last modified.
    last_modified_by string
    The identifier of the system or user that last modified this profile.
    pillars list("COST_OPTIMIZATION" | "SECURITY" | "RESILIENCE" | "PERFORMANCE")
    The list of Well-Architected pillars to focus on.
    tags list(object)
    Key-value pairs to associate with the Agent Profile.
    aggregationConfiguration List<AgentProfileAggregationConfiguration>
    The aggregation configuration entries (account, regions, access role) associated with this profile.
    arn String
    The Amazon Resource Name (ARN) of the Agent Profile.
    businessOverview String
    A business overview for the profile used to improve recommendation quality.
    createdAt String
    The timestamp when the profile was created.
    createdBy String
    The identifier of the system or user that created this profile.
    deletionProtection Boolean
    Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.
    description String
    A description of the profile.
    displayName String
    The human-readable display name of the profile.
    executionRoleArn String
    The ARN of the IAM role assumed to execute recommendation actions.
    lastModifiedAt String
    The timestamp when the profile was last modified.
    lastModifiedBy String
    The identifier of the system or user that last modified this profile.
    pillars List<AgentProfilePillar>
    The list of Well-Architected pillars to focus on.
    tags List<Tag>
    Key-value pairs to associate with the Agent Profile.
    aggregationConfiguration AgentProfileAggregationConfiguration[]
    The aggregation configuration entries (account, regions, access role) associated with this profile.
    arn string
    The Amazon Resource Name (ARN) of the Agent Profile.
    businessOverview string
    A business overview for the profile used to improve recommendation quality.
    createdAt string
    The timestamp when the profile was created.
    createdBy string
    The identifier of the system or user that created this profile.
    deletionProtection boolean
    Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.
    description string
    A description of the profile.
    displayName string
    The human-readable display name of the profile.
    executionRoleArn string
    The ARN of the IAM role assumed to execute recommendation actions.
    lastModifiedAt string
    The timestamp when the profile was last modified.
    lastModifiedBy string
    The identifier of the system or user that last modified this profile.
    pillars AgentProfilePillar[]
    The list of Well-Architected pillars to focus on.
    tags Tag[]
    Key-value pairs to associate with the Agent Profile.
    aggregation_configuration Sequence[AgentProfileAggregationConfiguration]
    The aggregation configuration entries (account, regions, access role) associated with this profile.
    arn str
    The Amazon Resource Name (ARN) of the Agent Profile.
    business_overview str
    A business overview for the profile used to improve recommendation quality.
    created_at str
    The timestamp when the profile was created.
    created_by str
    The identifier of the system or user that created this profile.
    deletion_protection bool
    Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.
    description str
    A description of the profile.
    display_name str
    The human-readable display name of the profile.
    execution_role_arn str
    The ARN of the IAM role assumed to execute recommendation actions.
    last_modified_at str
    The timestamp when the profile was last modified.
    last_modified_by str
    The identifier of the system or user that last modified this profile.
    pillars Sequence[AgentProfilePillar]
    The list of Well-Architected pillars to focus on.
    tags Sequence[root_Tag]
    Key-value pairs to associate with the Agent Profile.
    aggregationConfiguration List<Property Map>
    The aggregation configuration entries (account, regions, access role) associated with this profile.
    arn String
    The Amazon Resource Name (ARN) of the Agent Profile.
    businessOverview String
    A business overview for the profile used to improve recommendation quality.
    createdAt String
    The timestamp when the profile was created.
    createdBy String
    The identifier of the system or user that created this profile.
    deletionProtection Boolean
    Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.
    description String
    A description of the profile.
    displayName String
    The human-readable display name of the profile.
    executionRoleArn String
    The ARN of the IAM role assumed to execute recommendation actions.
    lastModifiedAt String
    The timestamp when the profile was last modified.
    lastModifiedBy String
    The identifier of the system or user that last modified this profile.
    pillars List<"COST_OPTIMIZATION" | "SECURITY" | "RESILIENCE" | "PERFORMANCE">
    The list of Well-Architected pillars to focus on.
    tags List<Property Map>
    Key-value pairs to associate with the Agent Profile.

    Supporting Types

    AgentProfileAggregationConfiguration

    AccessRoleArn string
    The ARN of the IAM role used to access resources in this account.
    AccountId string
    The target AWS account ID.
    Regions List<string>
    The target regions in the account.
    AccessRoleArn string
    The ARN of the IAM role used to access resources in this account.
    AccountId string
    The target AWS account ID.
    Regions []string
    The target regions in the account.
    access_role_arn string
    The ARN of the IAM role used to access resources in this account.
    account_id string
    The target AWS account ID.
    regions list(string)
    The target regions in the account.
    accessRoleArn String
    The ARN of the IAM role used to access resources in this account.
    accountId String
    The target AWS account ID.
    regions List<String>
    The target regions in the account.
    accessRoleArn string
    The ARN of the IAM role used to access resources in this account.
    accountId string
    The target AWS account ID.
    regions string[]
    The target regions in the account.
    access_role_arn str
    The ARN of the IAM role used to access resources in this account.
    account_id str
    The target AWS account ID.
    regions Sequence[str]
    The target regions in the account.
    accessRoleArn String
    The ARN of the IAM role used to access resources in this account.
    accountId String
    The target AWS account ID.
    regions List<String>
    The target regions in the account.

    AgentProfilePillar

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial