Goal
Represents a goal with all its properties and metadata
Contents
- agentSpaceArn
-
The unique identifier for the agent space containing this goal
Type: String
Required: Yes
- content
-
Content of the goal
Type: GoalContent object
Required: Yes
- createdAt
-
Timestamp when this goal was created
Type: Timestamp
Required: Yes
- goalId
-
The unique identifier for this goal
Type: String
Required: Yes
- goalType
-
Type of goal based on its origin
Type: String
Valid Values:
CUSTOMER_DEFINED | ONCALL_REPORTRequired: Yes
- status
-
Current status of the goal itself
Type: String
Valid Values:
ACTIVE | PAUSED | COMPLETERequired: Yes
- title
-
The title of the goal
Type: String
Required: Yes
- updatedAt
-
Timestamp when this goal was last updated
Type: Timestamp
Required: Yes
- version
-
Version number for optimistic locking
Type: Integer
Required: Yes
- evaluationSchedule
-
Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily
Type: GoalSchedule object
Required: No
- lastEvaluatedAt
-
Timestamp when the goal was last evaluated
Type: Timestamp
Required: No
- lastSuccessfulTaskId
-
ID of the most recent successful task associated with this goal
Type: String
Required: No
- lastTaskId
-
ID of the most recent task associated with this goal
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
