Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cleanrooms ]

create-membership

Description

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

See also: AWS API Documentation

Synopsis

  create-membership
--collaboration-identifier <value>
--query-log-status <value>
[--tags <value>]
[--default-result-configuration <value>]
[--payment-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--collaboration-identifier (string)

The unique ID for the associated collaboration.

--query-log-status (string)

An indicator as to whether query logging has been enabled or disabled for the membership.

Possible values:

• ENABLED
• DISABLED

--tags (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--default-result-configuration (structure)

The default protected query result configuration as specified by the member who can receive results.

outputConfiguration -> (tagged union structure)

Configuration for protected query results.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

Contains the configuration to write the query results to S3.

resultFormat -> (string)

Intended file format of the result.

bucket -> (string)

The S3 bucket to unload the protected query results.

keyPrefix -> (string)

The S3 prefix to unload the protected query results.

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.

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.

Shorthand Syntax:

outputConfiguration={s3={resultFormat=string,bucket=string,keyPrefix=string,singleFileOutput=boolean}},roleArn=string

JSON Syntax:

{
  "outputConfiguration": {
    "s3": {
      "resultFormat": "CSV"|"PARQUET",
      "bucket": "string",
      "keyPrefix": "string",
      "singleFileOutput": true|false
    }
  },
  "roleArn": "string"
}

--payment-configuration (structure)

The payment responsibilities accepted by the collaboration member.

Not required if the collaboration member has the member ability to run queries.

Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.

queryCompute -> (structure)

The payment responsibilities accepted by the collaboration member for query compute costs.

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.

machineLearning -> (structure)

The payment responsibilities accepted by the collaboration member for machine learning costs.

modelTraining -> (structure)

The payment responsibilities accepted by the member for model training.

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.

modelInference -> (structure)

The payment responsibilities accepted by the member for model inference.

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.

Shorthand Syntax:

queryCompute={isResponsible=boolean},machineLearning={modelTraining={isResponsible=boolean},modelInference={isResponsible=boolean}}

JSON Syntax:

{
  "queryCompute": {
    "isResponsible": true|false
  },
  "machineLearning": {
    "modelTraining": {
      "isResponsible": true|false
    },
    "modelInference": {
      "isResponsible": true|false
    }
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

membership -> (structure)

The membership that was created.

id -> (string)

The unique ID of the membership.

arn -> (string)

The unique ARN for the membership.

collaborationArn -> (string)

The unique ARN for the membership's associated collaboration.

collaborationId -> (string)

The unique ID for the membership's collaboration.

collaborationCreatorAccountId -> (string)

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

collaborationCreatorDisplayName -> (string)

The display name of the collaboration creator.

collaborationName -> (string)

The name of the membership's collaboration.

createTime -> (timestamp)

The time when the membership was created.

updateTime -> (timestamp)

The time the membership metadata was last updated.

status -> (string)

The status of the membership.

memberAbilities -> (list)

The abilities granted to the collaboration member.

(string)

mlMemberAbilities -> (structure)

Specifies the ML member abilities that are granted to a collaboration member.

Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms .

customMLMemberAbilities -> (list)

The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.

Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms .

(string)

queryLogStatus -> (string)

An indicator as to whether query logging has been enabled or disabled for the membership.

defaultResultConfiguration -> (structure)

The default protected query result configuration as specified by the member who can receive results.

outputConfiguration -> (tagged union structure)

Configuration for protected query results.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

Contains the configuration to write the query results to S3.

resultFormat -> (string)

Intended file format of the result.

bucket -> (string)

The S3 bucket to unload the protected query results.

keyPrefix -> (string)

The S3 prefix to unload the protected query results.

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.

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.

paymentConfiguration -> (structure)

The payment responsibilities accepted by the collaboration member.

queryCompute -> (structure)

The payment responsibilities accepted by the collaboration member for query compute costs.

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.

machineLearning -> (structure)

The payment responsibilities accepted by the collaboration member for machine learning costs.

modelTraining -> (structure)

The payment responsibilities accepted by the member for model training.

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.

modelInference -> (structure)

The payment responsibilities accepted by the member for model inference.

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.