analysis_templates

Creates, updates, deletes or gets an analysis_template resource or lists analysis_templates in a region

Overview

Name	analysis_templates
Type	Resource
Description	Represents a stored analysis within a collaboration
Id	aws.cleanrooms.analysis_templates

Fields

Name	Datatype	Description
arn	string
collaboration_arn	string
collaboration_identifier	string
tags	array	An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
analysis_parameters	array	The member who can query can provide this placeholder for a literal data value in an analysis template
analysis_template_identifier	string
description	string
membership_arn	string
membership_identifier	string
name	string
schema	object
source	object
format	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Source, Format, Name, MembershipIdentifier, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all analysis_templates in a region.

SELECT
region,
arn,
collaboration_arn,
collaboration_identifier,
tags,
analysis_parameters,
analysis_template_identifier,
description,
membership_arn,
membership_identifier,
name,
schema,
source,
format
FROM aws.cleanrooms.analysis_templates
WHERE region = 'us-east-1';

Gets all properties from an individual analysis_template.

SELECT
region,
arn,
collaboration_arn,
collaboration_identifier,
tags,
analysis_parameters,
analysis_template_identifier,
description,
membership_arn,
membership_identifier,
name,
schema,
source,
format
FROM aws.cleanrooms.analysis_templates
WHERE region = 'us-east-1' AND data__Identifier = '<AnalysisTemplateIdentifier>|<MembershipIdentifier>';

INSERT example

Use the following StackQL query and manifest file to create a new analysis_template resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cleanrooms.analysis_templates (
 MembershipIdentifier,
 Name,
 Source,
 Format,
 region
)
SELECT 
'{{ MembershipIdentifier }}',
 '{{ Name }}',
 '{{ Source }}',
 '{{ Format }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cleanrooms.analysis_templates (
 Tags,
 AnalysisParameters,
 Description,
 MembershipIdentifier,
 Name,
 Source,
 Format,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ AnalysisParameters }}',
 '{{ Description }}',
 '{{ MembershipIdentifier }}',
 '{{ Name }}',
 '{{ Source }}',
 '{{ Format }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: analysis_template
    props:
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: AnalysisParameters
        value:
          - DefaultValue: '{{ DefaultValue }}'
            Name: '{{ Name }}'
            Type: '{{ Type }}'
      - name: Description
        value: '{{ Description }}'
      - name: MembershipIdentifier
        value: '{{ MembershipIdentifier }}'
      - name: Name
        value: '{{ Name }}'
      - name: Source
        value:
          Text: '{{ Text }}'
      - name: Format
        value: '{{ Format }}'

DELETE example

/*+ delete */
DELETE FROM aws.cleanrooms.analysis_templates
WHERE data__Identifier = '<AnalysisTemplateIdentifier|MembershipIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the analysis_templates resource, the following permissions are required:

Create

cleanrooms:CreateAnalysisTemplate,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:GetAnalysisTemplate,
cleanrooms:ListAnalysisTemplates

Read

cleanrooms:GetAnalysisTemplate,
cleanrooms:ListTagsForResource

Update

cleanrooms:UpdateAnalysisTemplate,
cleanrooms:GetAnalysisTemplate,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource

Delete

cleanrooms:DeleteAnalysisTemplate,
cleanrooms:GetAnalysisTemplate,
cleanrooms:ListAnalysisTemplates,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource

List

cleanrooms:ListAnalysisTemplates