WellArchitected / Client / get_agent_profile

get_agent_profile¶

WellArchitected.Client.get_agent_profile(**kwargs)¶

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

Request Syntax

response = client.get_agent_profile(
    profileArn='string'
)

Parameters:

profileArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the optimization profile to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'displayName': 'string',
    'description': 'string',
    'businessOverview': 'string',
    'pillars': [
        'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
    ],
    'deletionProtection': True|False,
    'executionRoleArn': 'string',
    'aggregationConfiguration': [
        {
            'accountId': 'string',
            'regions': [
                'string',
            ],
            'accessRoleArn': 'string'
        },
    ],
    'arn': 'string',
    'eligibleForScheduledGeneration': True|False,
    'eligibleForArchitectureGeneration': True|False,
    'fieldErrors': {
        'string': 'string'
    },
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'createdBy': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastModifiedBy': 'string',
    'lastModifiedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- name (string) –
  
  The system name of the profile.
- displayName (string) –
  
  The display name of the profile.
- description (string) –
  
  A description of the profile.
- businessOverview (string) –
  
  The business overview of the profile.
- pillars (list) –
  
  The Well-Architected Tool Framework pillars associated with the profile.
  - (string) –
- deletionProtection (boolean) –
  
  Indicates whether deletion protection is enabled.
- executionRoleArn (string) –
  
  The ARN of the IAM execution role.
- aggregationConfiguration (list) –
  
  The aggregation configuration.
  - (dict) –
    
    Configuration settings that define the scope of Amazon Web Services resources to analyze for optimization recommendations.
    - accountId (string) –
      
      The Amazon Web Services account ID to analyze.
    - regions (list) –
      
      A list of Amazon Web Services Regions to include in the analysis.
      - (string) –
    - accessRoleArn (string) –
      
      The ARN of an IAM role to assume for resource analysis in this account.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the profile.
- eligibleForScheduledGeneration (boolean) –
  
  Indicates whether the profile is valid for scheduled recommendation generation.
- eligibleForArchitectureGeneration (boolean) –
  
  Indicates whether the profile is valid for manual architecture generation.
- fieldErrors (dict) –
  
  A map of field paths to error messages for invalid or missing input fields.
  - (string) –
    - (string) –
- tags (list) –
  
  The tags associated with the profile.
  - (dict) –
    
    A key-value pair associated with a resource for cost allocation and access control.
    - key (string) –
      
      The key of the tag.
    - value (string) –
      
      The value of the tag.
- createdBy (string) –
  
  The identifier of the user or system that created this profile.
- createdAt (datetime) –
  
  The timestamp when the profile was created.
- lastModifiedBy (string) –
  
  The identifier of the user or system that last modified this profile.
- lastModifiedAt (datetime) –
  
  The timestamp when the profile was last modified.

Exceptions

WellArchitected.Client.exceptions.AccessDeniedException
WellArchitected.Client.exceptions.ValidationException
WellArchitected.Client.exceptions.InternalServerException
WellArchitected.Client.exceptions.ResourceNotFoundException
WellArchitected.Client.exceptions.ThrottlingException