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 ]

get-schema-analysis-rule

Description

Retrieves a schema analysis rule.

See also: AWS API Documentation

Synopsis

  get-schema-analysis-rule
--collaboration-identifier <value>
--name <value>
--type <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 schema belongs to. Currently accepts a collaboration ID.

--name (string)

The name of the schema to retrieve the analysis rule for.

--type (string)

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

Possible values:

  • AGGREGATION
  • LIST
  • CUSTOM
  • ID_MAPPING_TABLE

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

analysisRule -> (structure)

A specification about how data from the configured table can be used.

collaborationId -> (string)

The unique ID for the associated collaboration.

type -> (string)

The type of analysis rule.

name -> (string)

The name for the analysis rule.

createTime -> (timestamp)

The time the analysis rule was created.

updateTime -> (timestamp)

The time the analysis rule was last updated.

policy -> (tagged union structure)

A policy that describes the associated data usage limitations.

Note

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

v1 -> (tagged union structure)

Controls on the query specifications that can be run on configured table.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: list, aggregation, custom, idMappingTable.

list -> (structure)

Analysis rule type that enables only list queries on a configured table.

joinColumns -> (list)

Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.

(string)

allowedJoinOperators -> (list)

The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND .

(string)

listColumns -> (list)

Columns that can be listed in the output.

(string)

additionalAnalyses -> (string)

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

aggregation -> (structure)

Analysis rule type that enables only aggregation queries on a configured table.

aggregateColumns -> (list)

The columns that query runners are allowed to use in aggregation queries.

(structure)

Column in configured table that can be used in aggregate function in query.

columnNames -> (list)

Column names in configured table of aggregate columns.

(string)

function -> (string)

Aggregation function that can be applied to aggregate column in query.

joinColumns -> (list)

Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

(string)

joinRequired -> (string)

Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

allowedJoinOperators -> (list)

Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND .

(string)

dimensionColumns -> (list)

The columns that query runners are allowed to select, group by, or filter by.

(string)

scalarFunctions -> (list)

Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

(string)

outputConstraints -> (list)

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

(structure)

Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.

columnName -> (string)

Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

minimum -> (integer)

The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

type -> (string)

The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.

additionalAnalyses -> (string)

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

The additionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList ) and the custom analysis rule (AnalysisRuleCustom ).

custom -> (structure)

Analysis rule type that enables custom SQL queries on a configured table.

allowedAnalyses -> (list)

The ARN of the analysis templates that are allowed by the custom analysis rule.

(string)

allowedAnalysisProviders -> (list)

The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY .

(string)

additionalAnalyses -> (string)

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

disallowedOutputColumns -> (list)

A list of columns that aren't allowed to be shown in the query output.

(string)

differentialPrivacy -> (structure)

The differential privacy configuration.

columns -> (list)

The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.

(structure)

Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.

name -> (string)

The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.

idMappingTable -> (structure)

The ID mapping table.

joinColumns -> (list)

The columns that query runners are allowed to use in an INNER JOIN statement.

(string)

queryConstraints -> (list)

The query constraints of the analysis rule ID mapping table.

(tagged union structure)

Provides any necessary query constraint information.

Note

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

requireOverlap -> (structure)

An array of column names that specifies which columns are required in the JOIN statement.

columns -> (list)

The columns that are required to overlap.

(string)

dimensionColumns -> (list)

The columns that query runners are allowed to select, group by, or filter by.

(string)