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 CreateCollaboration API operation.

Syntax

New-CRSCollaboration
-DataEncryptionMetadata_AllowCleartext <Boolean>
-DataEncryptionMetadata_AllowDuplicate <Boolean>
-DataEncryptionMetadata_AllowJoinsOnColumnsWithDifferentName <Boolean>
-AnalyticsEngine <AnalyticsEngine>
-AutoApprovedChangeRequestType <String[]>
-CreatorDisplayName <String>
-CreatorMemberAbility <String[]>
-CreatorMLMemberAbilities_CustomMLMemberAbility <String[]>
-Description <String>
-JobCompute_IsResponsible <Boolean>
-ModelInference_IsResponsible <Boolean>
-ModelTraining_IsResponsible <Boolean>
-QueryCompute_IsResponsible <Boolean>
-JobLogStatus <CollaborationJobLogStatus>
-Member <MemberSpecification[]>
-Name <String>
-DataEncryptionMetadata_PreserveNull <Boolean>
-QueryLogStatus <CollaborationQueryLogStatus>
-Tag <Hashtable>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCleanRoomsConfig>

Description

Creates a new collaboration.

Parameters

-AnalyticsEngine <AnalyticsEngine>
The analytics engine.After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoApprovedChangeRequestType <String[]>
The types of change requests that are automatically approved for this collaboration. 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)
AliasesAutoApprovedChangeRequestTypes
-ClientConfig <AmazonCleanRoomsConfig>
Amazon.PowerShell.Cmdlets.CRS.AmazonCleanRoomsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreatorDisplayName <String>
The display name of the collaboration creator.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreatorMemberAbility <String[]>
The abilities granted to the collaboration creator. 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreatorMemberAbilities
-CreatorMLMemberAbilities_CustomMLMemberAbility <String[]>
The custom ML member abilities for a collaboration member. 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)
AliasesCreatorMLMemberAbilities_CustomMLMemberAbilities
-DataEncryptionMetadata_AllowCleartext <Boolean>
Indicates whether encrypted tables can contain cleartext data (TRUE) or are to cryptographically process every column (FALSE).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataEncryptionMetadata_AllowDuplicate <Boolean>
Indicates whether Fingerprint columns can contain duplicate entries (TRUE) or are to contain only non-repeated values (FALSE).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataEncryptionMetadata_AllowDuplicates
-DataEncryptionMetadata_AllowJoinsOnColumnsWithDifferentName <Boolean>
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (TRUE) or can only be joined on Fingerprint columns of the same name (FALSE).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataEncryptionMetadata_AllowJoinsOnColumnsWithDifferentNames
-DataEncryptionMetadata_PreserveNull <Boolean>
Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE) or cryptographically processed (FALSE).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataEncryptionMetadata_PreserveNulls
-Description <String>
A description of the collaboration provided by the collaboration owner.
Required?True
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)
-JobCompute_IsResponsible <Boolean>
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (TRUE) or has not configured the collaboration member to pay for query and job compute costs (FALSE).Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreatorPaymentConfiguration_JobCompute_IsResponsible
-JobLogStatus <CollaborationJobLogStatus>
Specifies whether job logs are enabled for this collaboration. When ENABLED, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Member <MemberSpecification[]>
A list of initial members, not including the creator. This list is immutable. 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMembers
-ModelInference_IsResponsible <Boolean>
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (TRUE) or has not configured the collaboration member to pay for model inference costs (FALSE).Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreatorPaymentConfiguration_MachineLearning_ModelInference_IsResponsible
-ModelTraining_IsResponsible <Boolean>
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (TRUE) or has not configured the collaboration member to pay for model training costs (FALSE).Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreatorPaymentConfiguration_MachineLearning_ModelTraining_IsResponsible
-Name <String>
The display name for a collaboration.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-QueryCompute_IsResponsible <Boolean>
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreatorPaymentConfiguration_QueryCompute_IsResponsible
-QueryLogStatus <CollaborationQueryLogStatus>
An indicator as to whether query logging has been enabled or disabled for the collaboration.When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Collaboration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRooms.Model.CreateCollaborationResponse). Specifying the name of a property of type Amazon.CleanRooms.Model.CreateCollaborationResponse 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)
-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.Collaboration or Amazon.CleanRooms.Model.CreateCollaborationResponse
This cmdlet returns an Amazon.CleanRooms.Model.Collaboration object. The service call response (type Amazon.CleanRooms.Model.CreateCollaborationResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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