AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Clean Rooms Service CreateAnalysisTemplate API operation.

Syntax

New-CRSAnalysisTemplate
-Artifacts_AdditionalArtifact <AnalysisTemplateArtifact[]>
-AnalysisParameter <AnalysisParameter[]>
-Location_Bucket <String>
-ColumnClassification_ColumnMapping <SyntheticDataColumnProperties[]>
-Description <String>
-MlSyntheticDataParameters_Epsilon <Double>
-Format <AnalysisFormat>
-Location_Key <String>
-MlSyntheticDataParameters_MaxMembershipInferenceAttackScore <Double>
-MembershipIdentifier <String>
-Name <String>
-Schema_ReferencedTable <String[]>
-Artifacts_RoleArn <String>
-Tag <Hashtable>
-Source_Text <String>
-ErrorMessageConfiguration_Type <ErrorMessageType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCleanRoomsConfig>

Description

Creates a new analysis template.

Parameters

-AnalysisParameter <AnalysisParameter[]>
The parameters of the analysis template. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisParameters
-Artifacts_AdditionalArtifact <AnalysisTemplateArtifact[]>
Additional artifacts for the analysis template. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_Artifacts_AdditionalArtifacts
-Artifacts_RoleArn <String>
The role ARN for the analysis template artifacts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_Artifacts_RoleArn
-ClientConfig <AmazonCleanRoomsConfig>
Amazon.PowerShell.Cmdlets.CRS.AmazonCleanRoomsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ColumnClassification_ColumnMapping <SyntheticDataColumnProperties[]>
A mapping that defines the classification of data columns for synthetic data generation and specifies how each column should be handled during the privacy-preserving data synthesis process. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyntheticDataParameters_MlSyntheticDataParameters_ColumnClassification_ColumnMapping
-Description <String>
The description of the analysis template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ErrorMessageConfiguration_Type <ErrorMessageType>
The level of detail for error messages returned by the PySpark job. When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job.Because this setting may expose sensitive data, it is recommended for development and testing environments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Format <AnalysisFormat>
The format of the analysis template.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Location_Bucket <String>
The bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_Artifacts_EntryPoint_Location_Bucket
-Location_Key <String>
The object key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_Artifacts_EntryPoint_Location_Key
-MembershipIdentifier <String>
The identifier for a membership resource.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MlSyntheticDataParameters_Epsilon <Double>
The epsilon value for differential privacy when generating synthetic data. Lower values provide stronger privacy guarantees but may reduce data utility.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyntheticDataParameters_MlSyntheticDataParameters_Epsilon
-MlSyntheticDataParameters_MaxMembershipInferenceAttackScore <Double>
The maximum acceptable score for membership inference attack vulnerability. Synthetic data generation fails if the score for the resulting data exceeds this threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyntheticDataParameters_MlSyntheticDataParameters_MaxMembershipInferenceAttackScore
-Name <String>
The name of the analysis template.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schema_ReferencedTable <String[]>
The tables referenced in the analysis schema. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchema_ReferencedTables
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'AnalysisTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRooms.Model.CreateAnalysisTemplateResponse). Specifying the name of a property of type Amazon.CleanRooms.Model.CreateAnalysisTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_Text <String>
The query text.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CleanRooms.Model.AnalysisTemplate or Amazon.CleanRooms.Model.CreateAnalysisTemplateResponse
This cmdlet returns an Amazon.CleanRooms.Model.AnalysisTemplate object. The service call response (type Amazon.CleanRooms.Model.CreateAnalysisTemplateResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z