DevOpsAgentService / Client / update_goal

update_goal

DevOpsAgentService.Client.update_goal(**kwargs)

Update an existing goal

See also: AWS API Documentation

Request Syntax

response = client.update_goal(
    agentSpaceId='string',
    goalId='string',
    evaluationSchedule={
        'state': 'ENABLED'|'DISABLED'
    },
    clientToken='string'
)
Parameters:

  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier for the agent space containing the goal

  • goalId (string) –

    [REQUIRED]

    The unique identifier of the goal to update

  • evaluationSchedule (dict) –

    Update goal schedule state

    • state (string) – [REQUIRED]

      Whether the schedule is enabled or disabled

  • clientToken (string) –

    Client-provided token for idempotent operations

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'goal': {
        'agentSpaceArn': 'string',
        'goalId': 'string',
        'title': 'string',
        'content': {
            'description': 'string',
            'objectives': 'string'
        },
        'status': 'ACTIVE'|'PAUSED'|'COMPLETE',
        'goalType': 'CUSTOMER_DEFINED'|'ONCALL_REPORT',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'lastEvaluatedAt': datetime(2015, 1, 1),
        'lastTaskId': 'string',
        'lastSuccessfulTaskId': 'string',
        'version': 123,
        'evaluationSchedule': {
            'state': 'ENABLED'|'DISABLED',
            'expression': 'string'
        }
    }
}

Response Structure

  • (dict) –

    Response structure containing the updated goal

    • goal (dict) –

      The updated goal object

      • agentSpaceArn (string) –

        The unique identifier for the agent space containing this goal

      • goalId (string) –

        The unique identifier for this goal

      • title (string) –

        The title of the goal

      • content (dict) –

        Content of the goal

        • description (string) –

          A detailed description of the goal.

        • objectives (string) –

          The objectives to be achieved for this goal.

      • status (string) –

        Current status of the goal itself

      • goalType (string) –

        Type of goal based on its origin

      • createdAt (datetime) –

        Timestamp when this goal was created

      • updatedAt (datetime) –

        Timestamp when this goal was last updated

      • lastEvaluatedAt (datetime) –

        Timestamp when the goal was last evaluated

      • lastTaskId (string) –

        ID of the most recent task associated with this goal

      • lastSuccessfulTaskId (string) –

        ID of the most recent successful task associated with this goal

      • version (integer) –

        Version number for optimistic locking

      • evaluationSchedule (dict) –

        Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily

        • state (string) –

          Whether the schedule is enabled or disabled

        • expression (string) –

          Schedule expression (e.g., ‘rate(7 days)’)

Exceptions