Skip to main content

common_controls

Creates, updates, deletes, gets or lists a common_controls resource.

Overview

Namecommon_controls
TypeResource
Idaws.controlcatalog.common_controls

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) that identifies the common control. (pattern: <code>arn:(aws(?:[-a-z]*)?):controlcatalog:::common-control/[0-9a-z]+</code>)
create_timestring (date-time)The time when the common control was created.
descriptionstringThe description of the common control.
domainobjectThe domain that the common control belongs to.
last_update_timestring (date-time)The time when the common control was most recently updated.
namestringThe name of the common control.
objectiveobjectThe objective that the common control belongs to.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_common_controlsselectregionmaxResults, nextTokenReturns a paginated list of common controls from the Amazon Web Services Control Catalog. You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
maxResultsintegerThe maximum number of results on a page or for an API request call.
nextTokenstringThe pagination token that's used to fetch the next set of results.

SELECT examples

Returns a paginated list of common controls from the Amazon Web Services Control Catalog. You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

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