WellArchitected / Client / create_agent_profile

create_agent_profile

WellArchitected.Client.create_agent_profile(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_agent_profile(
    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'
        },
    ],
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

• name (string) –

  [REQUIRED]

  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) –

  [REQUIRED]

  The Well-Architected Tool Framework pillars to associate with this profile.

  • (string) –

• deletionProtection (boolean) – Indicates whether deletion protection is enabled for the profile.

• executionRoleArn (string) –

  [REQUIRED]

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

• aggregationConfiguration (list) –

  [REQUIRED]

  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) – [REQUIRED]

      The Amazon Web Services account ID to analyze.

    • regions (list) – [REQUIRED]

      A list of Amazon Web Services Regions to include in the analysis.

      • (string) –

    • accessRoleArn (string) – [REQUIRED]

      The ARN of an IAM role to assume for resource analysis in this account.

• clientToken (string) –

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  This field is autopopulated if not provided.

• tags (list) –

  The tags to associate with the profile.

  • (dict) –

    A key-value pair associated with a resource for cost allocation and access control.

    • key (string) – [REQUIRED]

      The key of the tag.

    • value (string) – [REQUIRED]

      The value of the tag.

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 created profile.

  • displayName (string) –

    The display name of the created profile.

  • description (string) –

    A description of the created profile.

  • businessOverview (string) –

    The business overview of the created profile.

  • pillars (list) –

    The Well-Architected Tool Framework pillars associated with the created 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 created 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 created 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.ConflictException

• WellArchitected.Client.exceptions.ServiceQuotaExceededException

• WellArchitected.Client.exceptions.ThrottlingException