objectives

Creates, updates, deletes, gets or lists an objectives resource.

Overview

Name	objectives
Type	Resource
Id	aws.controlcatalog.objectives

Fields

The following fields are returned by SELECT queries:

list_objectives

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) that identifies the objective. (pattern: <code>arn:(aws(?:[-a-z]*)?):controlcatalog:::objective/[0-9a-z]+</code>)
create_time	string (date-time)	The time when the objective was created.
description	string	The description of the objective.
domain	object	The domain that the objective belongs to.
last_update_time	string (date-time)	The time when the objective was most recently updated.
name	string	The name of the objective.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_objectives	select	region	maxResults, nextToken	Returns a paginated list of objectives from the Control Catalog. You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results on a page or for an API request call.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

list_objectives

Returns a paginated list of objectives from the Control Catalog. You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

SELECT
arn,
create_time,
description,
domain,
last_update_time,
name
FROM aws.controlcatalog.objectives
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;