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

Syntax

New-CRSMembership
-CollaborationIdentifier <String>
-DefaultJobResultConfiguration_OutputConfiguration_S3_Bucket <String>
-S3_Bucket <String>
-JobCompute_IsResponsible <Boolean>
-ModelInference_IsResponsible <Boolean>
-ModelTraining_IsResponsible <Boolean>
-QueryCompute_IsResponsible <Boolean>
-JobLogStatus <MembershipJobLogStatus>
-DefaultJobResultConfiguration_OutputConfiguration_S3_KeyPrefix <String>
-S3_KeyPrefix <String>
-QueryLogStatus <MembershipQueryLogStatus>
-S3_ResultFormat <ResultFormat>
-DefaultJobResultConfiguration_RoleArn <String>
-DefaultResultConfiguration_RoleArn <String>
-S3_SingleFileOutput <Boolean>
-Tag <Hashtable>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCleanRoomsConfig>

Description

Creates a membership for a specific collaboration identifier and joins the collaboration.

Parameters

-ClientConfig <AmazonCleanRoomsConfig>
Amazon.PowerShell.Cmdlets.CRS.AmazonCleanRoomsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CollaborationIdentifier <String>
The unique ID for the associated collaboration.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DefaultJobResultConfiguration_OutputConfiguration_S3_Bucket <String>
The S3 bucket for job output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefault_Job_S3_Bucket
-DefaultJobResultConfiguration_OutputConfiguration_S3_KeyPrefix <String>
The S3 prefix to unload the protected job results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefault_Job_S3_KeyPrefix
-DefaultJobResultConfiguration_RoleArn <String>
The unique ARN for an IAM role that is used by Clean Rooms to write protected job results to the result location, given by the member who can receive results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultResultConfiguration_RoleArn <String>
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
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)
-JobCompute_IsResponsible <Boolean>
Indicates whether the collaboration member has accepted to pay for job compute costs (TRUE) or has not accepted to pay for query and job compute costs (FALSE).There is only one member who pays for queries and jobs. An error message is returned for the following reasons:
  • If you set the value to FALSE but you are responsible to pay for query and job compute costs.
  • If you set the value to TRUE but you are not responsible to pay for query and job compute costs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPaymentConfiguration_JobCompute_IsResponsible
-JobLogStatus <MembershipJobLogStatus>
An indicator as to whether job logging has been enabled or disabled for the collaboration.When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelInference_IsResponsible <Boolean>
Indicates whether the collaboration member has accepted to pay for model inference costs (TRUE) or has not accepted to pay for model inference costs (FALSE).If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. An error message is returned for the following reasons:
  • If you set the value to FALSE but you are responsible to pay for model inference costs.
  • If you set the value to TRUE but you are not responsible to pay for model inference costs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPaymentConfiguration_MachineLearning_ModelInference_IsResponsible
-ModelTraining_IsResponsible <Boolean>
Indicates whether the collaboration member has accepted to pay for model training costs (TRUE) or has not accepted to pay for model training costs (FALSE).If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. An error message is returned for the following reasons:
  • If you set the value to FALSE but you are responsible to pay for model training costs.
  • If you set the value to TRUE but you are not responsible to pay for model training costs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPaymentConfiguration_MachineLearning_ModelTraining_IsResponsible
-QueryCompute_IsResponsible <Boolean>
Indicates whether the collaboration member has accepted to pay for query compute costs (TRUE) or has not accepted to pay for query compute costs (FALSE).If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. An error message is returned for the following reasons:
  • If you set the value to FALSE but you are responsible to pay for query compute costs.
  • If you set the value to TRUE but you are not responsible to pay for query compute costs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPaymentConfiguration_QueryCompute_IsResponsible
-QueryLogStatus <MembershipQueryLogStatus>
An indicator as to whether query logging has been enabled or disabled for the membership.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)
-S3_Bucket <String>
The S3 bucket to unload the protected query results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultResultConfiguration_OutputConfiguration_S3_Bucket
-S3_KeyPrefix <String>
The S3 prefix to unload the protected query results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultResultConfiguration_OutputConfiguration_S3_KeyPrefix
-S3_ResultFormat <ResultFormat>
Intended file format of the result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultResultConfiguration_OutputConfiguration_S3_ResultFormat
-S3_SingleFileOutput <Boolean>
Indicates whether files should be output as a single file (TRUE) or output as multiple files (FALSE). This parameter is only supported for analyses with the Spark analytics engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultResultConfiguration_OutputConfiguration_S3_SingleFileOutput
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Membership'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRooms.Model.CreateMembershipResponse). Specifying the name of a property of type Amazon.CleanRooms.Model.CreateMembershipResponse 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.Membership or Amazon.CleanRooms.Model.CreateMembershipResponse
This cmdlet returns an Amazon.CleanRooms.Model.Membership object. The service call response (type Amazon.CleanRooms.Model.CreateMembershipResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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