[ aws . cleanrooms ]

create-collaboration-change-request

Description

Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.

See also: AWS API Documentation

Synopsis

  create-collaboration-change-request
--collaboration-identifier <value>
--changes <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

--collaboration-identifier (string)

The identifier of the collaboration that the change request is made against.

--changes (list)

The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.

(structure)

Specifies a change to apply to a collaboration.

specificationType -> (string)

The type of specification for the change. Currently supports MEMBER for member-related changes.

specification -> (tagged union structure)

The specification details for the change. The structure depends on the specification type.

Note

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

member -> (structure)

The member change specification when the change type is MEMBER .

accountId -> (string)

The Amazon Web Services account ID of the member to add to the collaboration.

memberAbilities -> (list)

The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

Note

The following values are currently not supported: CAN_QUERY , CAN_RECEIVE_RESULTS, and CAN_RUN_JOB .

Set the value of memberAbilities to [] to allow a member to contribute data.

(string)

displayName -> (string)

Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

JSON Syntax:

[
  {
    "specificationType": "MEMBER",
    "specification": {
      "member": {
        "accountId": "string",
        "memberAbilities": ["CAN_QUERY"|"CAN_RECEIVE_RESULTS"|"CAN_RUN_JOB", ...],
        "displayName": "string"
      }
    }
  }
  ...
]

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

collaborationChangeRequest -> (structure)

Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.

id -> (string)

The unique identifier for the change request.

collaborationId -> (string)

The unique identifier for the collaboration being modified.

createTime -> (timestamp)

The time when the change request was created.

updateTime -> (timestamp)

The time when the change request was last updated.

status -> (string)

The current status of the change request. Valid values are PENDING , APPROVED , DENIED , COMMITTED , and CANCELLED .

isAutoApproved -> (boolean)

Whether the change request was automatically approved based on the collaboration’s auto-approval settings.

changes -> (list)

The list of changes specified in this change request.

(structure)

Represents a single change within a collaboration change request, containing the change identifier and specification.

specificationType -> (string)

The type of specification for this change.

specification -> (tagged union structure)

The specification details for this change.

Note

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

member -> (structure)

The member change specification when the change type is MEMBER .

accountId -> (string)

The Amazon Web Services account ID of the member to add to the collaboration.

memberAbilities -> (list)

The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

Note

The following values are currently not supported: CAN_QUERY , CAN_RECEIVE_RESULTS, and CAN_RUN_JOB .

Set the value of memberAbilities to [] to allow a member to contribute data.

(string)

displayName -> (string)

Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

types -> (list)

The list of change types that were applied.

(string)