intermediate_table_versions
Creates, updates, deletes, gets or lists an intermediate_table_versions resource.
Overview
| Name | intermediate_table_versions |
| Type | Resource |
| Id | aws.cleanrooms.intermediate_table_versions |
Fields
The following fields are returned by SELECT queries:
- list_intermediate_table_versions
| Name | Datatype | Description |
|---|---|---|
analysis_id | string | The identifier of the protected query that created this version. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>) |
analysis_type | string | The type of analysis that created this version. (QUERY) |
create_time | string (date-time) | The time the version was created. |
expiration_time | string (date-time) | The time when this version expires based on the retention period. |
kms_key_arn | string | The Amazon Resource Name (ARN) of the KMS key used to encrypt this version's data. (pattern: <code>arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+</code>) |
status | string | The status of the version. (POPULATE_STARTED, POPULATE_SUCCESS, POPULATE_FAILED, RETENTION_PERIOD_EXPIRED) |
table_id | string | The unique identifier of the intermediate table that this version belongs to. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>) |
version_id | string | The unique identifier of the version. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_intermediate_table_versions | select | membership_identifier, intermediate_table_identifier, region | nextToken, maxResults | Lists the version history of an intermediate table. Each call to PopulateIntermediateTable creates a new version. We recommend using pagination to ensure that the operation returns quickly and successfully. |
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 |
|---|---|---|
intermediate_table_identifier | string | The unique identifier of the intermediate table for which to list versions. |
membership_identifier | string | The unique identifier of the membership that contains the intermediate table. |
region | string | AWS region (default: us-east-1) |
maxResults | integer | The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met. |
nextToken | string | The pagination token that's used to fetch the next set of results. |
SELECT examples
- list_intermediate_table_versions
Lists the version history of an intermediate table. Each call to PopulateIntermediateTable creates a new version. We recommend using pagination to ensure that the operation returns quickly and successfully.
SELECT
analysis_id,
analysis_type,
create_time,
expiration_time,
kms_key_arn,
status,
table_id,
version_id
FROM aws.cleanrooms.intermediate_table_versions
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND intermediate_table_identifier = '{{ intermediate_table_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;