domains
Creates, updates, deletes, gets or lists a domains resource.
Overview
| Name | domains |
| Type | Resource |
| Id | aws.controlcatalog.domains |
Fields
The following fields are returned by SELECT queries:
- list_domains
| Name | Datatype | Description |
|---|---|---|
arn | string | The Amazon Resource Name (ARN) that identifies the domain. (pattern: <code>arn:(aws(?:[-a-z]*)?):controlcatalog:::domain/[0-9a-z]+</code>) |
create_time | string (date-time) | The time when the domain was created. |
description | string | The description of the domain. |
last_update_time | string (date-time) | The time when the domain was most recently updated. |
name | string | The name of the domain. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_domains | select | region | maxResults, nextToken | Returns a paginated list of domains from the Control Catalog. |
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_domains
Returns a paginated list of domains from the Control Catalog.
SELECT
arn,
create_time,
description,
last_update_time,
name
FROM aws.controlcatalog.domains
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;