WellArchitected / Client / create_agent_goal

create_agent_goal¶

WellArchitected.Client.create_agent_goal(**kwargs)¶

Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.

Request Syntax

response = client.create_agent_goal(
    clientToken='string',
    profileArn='string',
    pillars=[
        'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
    ],
    title='string',
    description='string'
)

Parameters:

clientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.
profileArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the profile to associate the goal with.
pillars (list) –
[REQUIRED]

The Well-Architected Tool Framework pillars to associate with this goal.
- (string) –
title (string) –
[REQUIRED]

The title of the goal.
description (string) – A description of the goal.

Return type:

dict

Returns:

Response Syntax

{
    'goal': {
        'id': 'string',
        'profileArn': 'string',
        'pillars': [
            'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
        ],
        'title': 'string',
        'description': 'string',
        'createdBy': 'string',
        'createdAt': datetime(2015, 1, 1),
        'lastModifiedBy': 'string',
        'lastModifiedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- goal (dict) –
  
  The created goal summary.
  - id (string) –
    
    The unique identifier of the goal.
  - profileArn (string) –
    
    The Amazon Resource Name (ARN) of the associated profile.
  - pillars (list) –
    
    The Well-Architected Tool Framework pillars associated with this goal.
    - (string) –
  - title (string) –
    
    The title of the goal.
  - description (string) –
    
    A description of the goal.
  - createdBy (string) –
    
    The identifier of the user or system that created this goal.
  - createdAt (datetime) –
    
    The timestamp when the goal was created.
  - lastModifiedBy (string) –
    
    The identifier of the user or system that last modified this goal.
  - lastModifiedAt (datetime) –
    
    The timestamp when the goal 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.ResourceNotFoundException
WellArchitected.Client.exceptions.ThrottlingException