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-collaboration¶

Description¶

Creates a new collaboration.

Synopsis¶

  create-collaboration
--members <value>
--name <value>
--description <value>
--creator-member-abilities <value>
[--creator-ml-member-abilities <value>]
--creator-display-name <value>
[--data-encryption-metadata <value>]
--query-log-status <value>
[--tags <value>]
[--creator-payment-configuration <value>]
[--analytics-engine <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¶

--members (list)

A list of initial members, not including the creator. This list is immutable.

(structure)

Basic metadata used to construct a new member.

accountId -> (string)

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

memberAbilities -> (list)

The abilities granted to the collaboration member.

(string)

mlMemberAbilities -> (structure)

The ML abilities granted to the 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)

displayName -> (string)

The member's display name.

paymentConfiguration -> (structure)

The collaboration member's payment responsibilities set by the collaboration creator.

If the collaboration creator hasn't speciﬁed anyone as the member paying for query compute costs, then the member who can query is the default payer.

queryCompute -> (structure)

The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.

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.

machineLearning -> (structure)

An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.

modelTraining -> (structure)

The payment responsibilities accepted by the member for model training.

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.

modelInference -> (structure)

The payment responsibilities accepted by the member for model inference.

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.

JSON Syntax:

[
  {
    "accountId": "string",
    "memberAbilities": ["CAN_QUERY"|"CAN_RECEIVE_RESULTS", ...],
    "mlMemberAbilities": {
      "customMLMemberAbilities": ["CAN_RECEIVE_MODEL_OUTPUT"|"CAN_RECEIVE_INFERENCE_OUTPUT", ...]
    },
    "displayName": "string",
    "paymentConfiguration": {
      "queryCompute": {
        "isResponsible": true|false
      },
      "machineLearning": {
        "modelTraining": {
          "isResponsible": true|false
        },
        "modelInference": {
          "isResponsible": true|false
        }
      }
    }
  }
  ...
]

--name (string)

The display name for a collaboration.

--description (string)

A description of the collaboration provided by the collaboration owner.

--creator-member-abilities (list)

The abilities granted to the collaboration creator.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  CAN_QUERY
  CAN_RECEIVE_RESULTS

--creator-ml-member-abilities (structure)

The ML abilities granted to the collaboration creator.

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)

Shorthand Syntax:

customMLMemberAbilities=string,string

JSON Syntax:

{
  "customMLMemberAbilities": ["CAN_RECEIVE_MODEL_OUTPUT"|"CAN_RECEIVE_INFERENCE_OUTPUT", ...]
}

--creator-display-name (string)

The display name of the collaboration creator.

--data-encryption-metadata (structure)

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

allowCleartext -> (boolean)

Indicates whether encrypted tables can contain cleartext data (TRUE ) or are to cryptographically process every column (FALSE ).

allowDuplicates -> (boolean)

Indicates whether Fingerprint columns can contain duplicate entries (TRUE ) or are to contain only non-repeated values (FALSE ).

allowJoinsOnColumnsWithDifferentNames -> (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 ).

preserveNulls -> (boolean)

Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE ) or cryptographically processed (FALSE ).

Shorthand Syntax:

allowCleartext=boolean,allowDuplicates=boolean,allowJoinsOnColumnsWithDifferentNames=boolean,preserveNulls=boolean

JSON Syntax:

{
  "allowCleartext": true|false,
  "allowDuplicates": true|false,
  "allowJoinsOnColumnsWithDifferentNames": true|false,
  "preserveNulls": true|false
}

--query-log-status (string)

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

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"
  ...}

--creator-payment-configuration (structure)

The collaboration creator's payment responsibilities set by the collaboration creator.

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.

queryCompute -> (structure)

The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.

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.

machineLearning -> (structure)

An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.

modelTraining -> (structure)

The payment responsibilities accepted by the member for model training.

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.

modelInference -> (structure)

The payment responsibilities accepted by the member for model inference.

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.

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
    }
  }
}

--analytics-engine (string)

The analytics engine.

Possible values:

SPARK

CLEAN_ROOMS_SQL

--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¶

collaboration -> (structure)

The collaboration.

id -> (string)

The unique ID for the collaboration.

arn -> (string)

The unique ARN for the collaboration.

name -> (string)

A human-readable identifier provided by the collaboration owner. Display names are not unique.

description -> (string)

A description of the collaboration provided by the collaboration owner.

creatorAccountId -> (string)

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

creatorDisplayName -> (string)

A display name of the collaboration creator.

createTime -> (timestamp)

The time when the collaboration was created.

updateTime -> (timestamp)

The time the collaboration metadata was last updated.

memberStatus -> (string)

The status of a member in a collaboration.

membershipId -> (string)

The unique ID for your membership within the collaboration.

membershipArn -> (string)

The unique ARN for your membership within the collaboration.

dataEncryptionMetadata -> (structure)

The settings for client-side encryption for cryptographic computing.

allowCleartext -> (boolean)

Indicates whether encrypted tables can contain cleartext data (TRUE ) or are to cryptographically process every column (FALSE ).

allowDuplicates -> (boolean)

Indicates whether Fingerprint columns can contain duplicate entries (TRUE ) or are to contain only non-repeated values (FALSE ).

allowJoinsOnColumnsWithDifferentNames -> (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 ).

preserveNulls -> (boolean)

Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE ) or cryptographically processed (FALSE ).

queryLogStatus -> (string)

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

analyticsEngine -> (string)

The analytics engine for the collaboration.

Table Of Contents

Feedback

User Guide

Note:

create-collaboration¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶