collaboration_analysis_templates

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

Overview

Name	collaboration_analysis_templates
Type	Resource
Id	aws.cleanrooms.collaboration_analysis_templates

Fields

The following fields are returned by SELECT queries:

batch_get_collaboration_analysis_template

Name	Datatype	Description
collaboration_analysis_templates	array	The retrieved list of analysis templates within a collaboration.
errors	array	Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.

get_collaboration_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>)
analysis_parameters	array	The analysis parameters that have been specified in 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	A unique identifier for the collaboration that the analysis templates belong 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 within a collaboration was created.
creator_account_id	string	The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID. (pattern: <code>\d+</code>)
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	The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.
format_	string	The format of the analysis template in the collaboration. (SQL, PYSPARK_1_0)
schema	object	The entire schema object.
source	object	The source of the analysis template within a collaboration.
source_metadata	object	The source metadata for the collaboration analysis template.
synthetic_data_parameters	object	The synthetic data generation parameters configured for this collaboration analysis template.
update_time	string (date-time)	The time that the analysis template in the collaboration was last updated.
validations	array	The validations that were performed.

list_collaboration_analysis_templates

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’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 templates belong 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 summary of the analysis template in a collaboration was created.
creator_account_id	string	The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID. (pattern: <code>\d+</code>)
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 collaboration analysis template uses synthetic data generation.
update_time	string (date-time)	The time that the summary of the analysis template in the collaboration was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_collaboration_analysis_template	select	collaboration_identifier, region		Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
get_collaboration_analysis_template	select	collaboration_identifier, analysis_template_arn, region		Retrieves an analysis template within a collaboration.
list_collaboration_analysis_templates	select	collaboration_identifier, region	nextToken, maxResults	Lists analysis templates within a collaboration.

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_arn	string	The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
collaboration_identifier	string	A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
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

batch_get_collaboration_analysis_template

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

SELECT
collaboration_analysis_templates,
errors
FROM aws.cleanrooms.collaboration_analysis_templates
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
;

get_collaboration_analysis_template

Retrieves an analysis template within a collaboration.

SELECT
id,
name,
analysis_parameters,
arn,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
description,
error_message_configuration,
format_,
schema,
source,
source_metadata,
synthetic_data_parameters,
update_time,
validations
FROM aws.cleanrooms.collaboration_analysis_templates
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND analysis_template_arn = '{{ analysis_template_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_collaboration_analysis_templates

Lists analysis templates within a collaboration.

SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
description,
is_synthetic_data,
update_time
FROM aws.cleanrooms.collaboration_analysis_templates
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;