[ aws . cleanrooms ]
create-collaboration
Description
Creates a new collaboration.
See also: AWS API Documentation
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>
[--job-log-status <value>]
[--tags <value>]
[--creator-payment-configuration <value>]
[--analytics-engine <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
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)
memberAbilities -> (list)
The abilities granted to the collaboration member.
(string)
mlMemberAbilities -> (structure)
The ML abilities granted to the collaboration member.
customMLMemberAbilities -> (list)
The custom ML member abilities for a collaboration member.
(string)
displayName -> (string)
paymentConfiguration -> (structure)
The collaboration member’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.
jobCompute -> (structure)
The compute configuration for the job.
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.
JSON Syntax:
[
{
"accountId": "string",
"memberAbilities": ["CAN_QUERY"|"CAN_RECEIVE_RESULTS"|"CAN_RUN_JOB", ...],
"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
}
},
"jobCompute": {
"isResponsible": true|false
}
}
}
...
]
--name (string)
--description (string)
--creator-member-abilities (list)
The abilities granted to the collaboration creator.
(string)
Syntax:
"string" "string" ...
Where valid values are:
CAN_QUERY
CAN_RECEIVE_RESULTS
CAN_RUN_JOB
--creator-ml-member-abilities (structure)
The ML abilities granted to the collaboration creator.
customMLMemberAbilities -> (list)
The custom ML member abilities for a collaboration member.
(string)
Shorthand Syntax:
customMLMemberAbilities=string,string
JSON Syntax:
{
"customMLMemberAbilities": ["CAN_RECEIVE_MODEL_OUTPUT"|"CAN_RECEIVE_INFERENCE_OUTPUT", ...]
}
--creator-display-name (string)
--data-encryption-metadata (structure)
The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
allowCleartext -> (boolean)
TRUE ) or are to cryptographically process every column (FALSE ).allowDuplicates -> (boolean)
TRUE ) or are to contain only non-repeated values (FALSE ).allowJoinsOnColumnsWithDifferentNames -> (boolean)
TRUE ) or can only be joined on Fingerprint columns of the same name (FALSE ).preserveNulls -> (boolean)
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.
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 .
Possible values:
ENABLEDDISABLED
--job-log-status (string)
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 .
Possible values:
ENABLEDDISABLED
--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.
jobCompute -> (structure)
The compute configuration for the job.
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.
Shorthand Syntax:
queryCompute={isResponsible=boolean},machineLearning={modelTraining={isResponsible=boolean},modelInference={isResponsible=boolean}},jobCompute={isResponsible=boolean}
JSON Syntax:
{
"queryCompute": {
"isResponsible": true|false
},
"machineLearning": {
"modelTraining": {
"isResponsible": true|false
},
"modelInference": {
"isResponsible": true|false
}
},
"jobCompute": {
"isResponsible": true|false
}
}
--analytics-engine (string)
The analytics engine.
Possible values:
SPARKCLEAN_ROOMS_SQL
--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
- yaml
- yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
collaboration -> (structure)
The collaboration.
id -> (string)
arn -> (string)
name -> (string)
description -> (string)
creatorAccountId -> (string)
creatorDisplayName -> (string)
createTime -> (timestamp)
updateTime -> (timestamp)
memberStatus -> (string)
membershipId -> (string)
membershipArn -> (string)
dataEncryptionMetadata -> (structure)
The settings for client-side encryption for cryptographic computing.
allowCleartext -> (boolean)
TRUE ) or are to cryptographically process every column (FALSE ).allowDuplicates -> (boolean)
TRUE ) or are to contain only non-repeated values (FALSE ).allowJoinsOnColumnsWithDifferentNames -> (boolean)
TRUE ) or can only be joined on Fingerprint columns of the same name (FALSE ).preserveNulls -> (boolean)
TRUE ) or cryptographically processed (FALSE ).queryLogStatus -> (string)
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 .
jobLogStatus -> (string)
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 .
analyticsEngine -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.