WellArchitected / Client / list_agent_profiles

list_agent_profiles

WellArchitected.Client.list_agent_profiles(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_agent_profiles(
    maxResults=123,
    nextToken='string'
)

Parameters:

• 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.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            '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)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of profile summaries.

    • (dict) –

      Summary of an optimization profile, including its configuration, metadata, and audit information.

      • name (string) –

        The system name of the profile.

      • displayName (string) –

        The display name of the profile shown to users.

      • description (string) –

        A description of the profile.

      • businessOverview (string) –

        The business overview for this profile.

      • pillars (list) –

        The Well-Architected Tool Framework pillars associated with this profile.

        • (string) –

      • deletionProtection (boolean) –

        Indicates whether deletion protection is enabled for the profile.

      • executionRoleArn (string) –

        The ARN of the IAM execution role used for recommendation actions.

      • aggregationConfiguration (list) –

        The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

        • (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 optimization 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.

  • nextToken (string) –

    A pagination token to retrieve the next set of results, if available.

Exceptions

• WellArchitected.Client.exceptions.AccessDeniedException

• WellArchitected.Client.exceptions.ValidationException

• WellArchitected.Client.exceptions.InternalServerException

• WellArchitected.Client.exceptions.ThrottlingException