AWS CLI Command Reference

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 ]

batch-get-collaboration-analysis-template

Description

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

See also: AWS API Documentation

Synopsis

  batch-get-collaboration-analysis-template
--collaboration-identifier <value>
--analysis-template-arns <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)

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

--analysis-template-arns (list)

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

(string)

Syntax:

"string" "string" ...

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

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

collaborationAnalysisTemplates -> (list)

The retrieved list of analysis templates within a collaboration.

(structure)

The analysis template within a collaboration.

id -> (string)

The identifier of the analysis template.

arn -> (string)

The Amazon Resource Name (ARN) of the analysis template.

collaborationId -> (string)

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

collaborationArn -> (string)

The unique ARN for the analysis template’s associated collaboration.

description -> (string)

The description of the analysis template.

creatorAccountId -> (string)

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

name -> (string)

The name of the analysis template.

createTime -> (timestamp)

The time that the analysis template within a collaboration was created.

updateTime -> (timestamp)

The time that the analysis template in the collaboration was last updated.

schema -> (structure)

The entire schema object.

referencedTables -> (list)

The tables referenced in the analysis schema.

(string)

format -> (string)

The format of the analysis template in the collaboration.

source -> (tagged union structure)

The source of the analysis template within a collaboration.

Note

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

text -> (string)

The query text.

analysisParameters -> (list)

The analysis parameters that have been specified in the analysis template.

(structure)

Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.

name -> (string)

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

type -> (string)

The type of parameter.

defaultValue -> (string)

Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

validations -> (list)

The validations that were performed.

(structure)

The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.

For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy .

type -> (string)

The type of validation that was performed.

status -> (string)

The status of the validation.

reasons -> (list)

The reasons for the validation results.

(structure)

The reasons for the validation results.

message -> (string)

The validation message.

errors -> (list)

Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.

(structure)

Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

arn -> (string)

The Amazon Resource Name (ARN) of the analysis template.

code -> (string)

An error code for the error.

message -> (string)

A description of why the call failed.