analysis_templates

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

Overview

Name	`analysis_templates`
Type	Resource
Id	`aws.cleanrooms.analysis_templates`

Fields

The following fields are returned by SELECT queries:

get_analysis_template
list_analysis_templates

Name	Datatype	Description
`id`	`string`	The identifier for the analysis template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`name`	`string`	The name of the analysis template. (pattern: <code>[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?</code>)
`analysis_parameters`	`array`	The parameters of the analysis template.
`arn`	`string`	The Amazon Resource Name (ARN) of the analysis template. (pattern: <code>arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+</code>)
`collaboration_arn`	`string`	The unique ARN for the analysis template’s associated collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
`collaboration_id`	`string`	The unique ID for the associated collaboration of the analysis template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`create_time`	`string (date-time)`	The time that the analysis template was created.
`description`	`string`	The description of the analysis template. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
`error_message_configuration`	`object`	A structure that defines the level of detail included in error messages returned by PySpark jobs. This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls.
`format_`	`string`	The format of the analysis template. (SQL, PYSPARK_1_0)
`membership_arn`	`string`	The Amazon Resource Name (ARN) of the member who created the analysis template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
`membership_id`	`string`	The identifier of a member who created the analysis template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`schema`	`object`	A relation within an analysis.
`source`	`object`	The structure that defines the body of the analysis template.
`source_metadata`	`object`	The source metadata for the analysis template.
`synthetic_data_parameters`	`object`	The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.
`update_time`	`string (date-time)`	The time that the analysis template was last updated.
`validations`	`array`	Information about the validations performed on the analysis template.

Name	Datatype	Description
`id`	`string`	The identifier of the analysis template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`name`	`string`	The name of the analysis template. (pattern: <code>[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?</code>)
`arn`	`string`	The Amazon Resource Name (ARN) of the analysis template. (pattern: <code>arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+</code>)
`collaboration_arn`	`string`	The unique ARN for the analysis template summary’s associated collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
`collaboration_id`	`string`	A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`create_time`	`string (date-time)`	The time that the analysis template summary was created.
`description`	`string`	The description of the analysis template. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
`is_synthetic_data`	`boolean`	Indicates if this analysis template summary generated synthetic data.
`membership_arn`	`string`	The Amazon Resource Name (ARN) of the member who created the analysis template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
`membership_id`	`string`	The identifier for a membership resource. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`update_time`	`string (date-time)`	The time that the analysis template summary was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_analysis_template`	`select`	`membership_identifier`, `analysis_template_identifier`, `region`		Retrieves an analysis template.
`list_analysis_templates`	`select`	`membership_identifier`, `region`	`nextToken`, `maxResults`	Lists analysis templates that the caller owns.
`create_analysis_template`	`insert`	`membership_identifier`, `region`, `name`, `format`, `source`		Creates a new analysis template.
`update_analysis_template`	`update`	`membership_identifier`, `analysis_template_identifier`, `region`		Updates the analysis template metadata.
`delete_analysis_template`	`delete`	`membership_identifier`, `analysis_template_identifier`, `region`		Deletes an analysis template.

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
`analysis_template_identifier`	`string`	The identifier for the analysis template resource.
`membership_identifier`	`string`	The identifier for a membership resource.
`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

get_analysis_template
list_analysis_templates

Retrieves an analysis template.

SELECT
id,
name,
analysis_parameters,
arn,
collaboration_arn,
collaboration_id,
create_time,
description,
error_message_configuration,
format_,
membership_arn,
membership_id,
schema,
source,
source_metadata,
synthetic_data_parameters,
update_time,
validations
FROM aws.cleanrooms.analysis_templates
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND analysis_template_identifier = '{{ analysis_template_identifier }}' -- required
AND region = '{{ region }}' -- required
;

Lists analysis templates that the caller owns.

SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
create_time,
description,
is_synthetic_data,
membership_arn,
membership_id,
update_time
FROM aws.cleanrooms.analysis_templates
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

`INSERT` examples

create_analysis_template
Manifest

Creates a new analysis template.

INSERT INTO aws.cleanrooms.analysis_templates (
description,
name,
format,
source,
tags,
analysisParameters,
schema,
errorMessageConfiguration,
syntheticDataParameters,
membership_identifier,
region
)
SELECT 
'{{ description }}',
'{{ name }}' /* required */,
'{{ format }}' /* required */,
'{{ source }}' /* required */,
'{{ tags }}',
'{{ analysisParameters }}',
'{{ schema }}',
'{{ errorMessageConfiguration }}',
'{{ syntheticDataParameters }}',
'{{ membership_identifier }}',
'{{ region }}'
RETURNING
analysis_template
;

# Description fields are for documentation purposes
- name: analysis_templates
props:
  - name: membership_identifier
    value: "{{ membership_identifier }}"
    description: Required parameter for the analysis_templates resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the analysis_templates resource.
  - name: description
    value: "{{ description }}"
  - name: name
    value: "{{ name }}"
  - name: format
    value: "{{ format }}"
    valid_values: ['SQL', 'PYSPARK_1_0']
  - name: source
    description: |
      The structure that defines the body of the analysis template.
    value:
      text: "{{ text }}"
      artifacts:
        entryPoint:
          location:
            bucket: "{{ bucket }}"
            key: "{{ key }}"
        additionalArtifacts:
          - location:
              bucket: "{{ bucket }}"
              key: "{{ key }}"
        roleArn: "{{ roleArn }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags assigned to a resource
  - name: analysisParameters
    value:
      - name: "{{ name }}"
        type_: "{{ type_ }}"
        defaultValue: "{{ defaultValue }}"
  - name: schema
    description: |
      A relation within an analysis.
    value:
      referencedTables:
        - "{{ referencedTables }}"
  - name: errorMessageConfiguration
    description: |
      A structure that defines the level of detail included in error messages returned by PySpark jobs. This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls.
    value:
      type_: "{{ type_ }}"
  - name: syntheticDataParameters
    description: |
      The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.
    value:
      mlSyntheticDataParameters:
        epsilon: {{ epsilon }}
        maxMembershipInferenceAttackScore: {{ maxMembershipInferenceAttackScore }}
        columnClassification:
          columnMapping:
            - columnName: "{{ columnName }}"
              columnType: "{{ columnType }}"
              isPredictiveValue: {{ isPredictiveValue }}

`UPDATE` examples

update_analysis_template

Updates the analysis template metadata.

UPDATE aws.cleanrooms.analysis_templates
SET 
description = '{{ description }}'
WHERE 
membership_identifier = '{{ membership_identifier }}' --required
AND analysis_template_identifier = '{{ analysis_template_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
analysis_template;

`DELETE` examples

delete_analysis_template

Deletes an analysis template.

DELETE FROM aws.cleanrooms.analysis_templates
WHERE membership_identifier = '{{ membership_identifier }}' --required
AND analysis_template_identifier = '{{ analysis_template_identifier }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​