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 ]

update-configured-table-association-analysis-rule

Description

Updates the analysis rule for a configured table association.

See also: AWS API Documentation

Synopsis

  update-configured-table-association-analysis-rule
--membership-identifier <value>
--configured-table-association-identifier <value>
--analysis-rule-type <value>
--analysis-rule-policy <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

--membership-identifier (string)

A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

--configured-table-association-identifier (string)

The identifier for the configured table association to update.

--analysis-rule-type (string)

The analysis rule type that you want to update.

Possible values:

  • AGGREGATION
  • LIST
  • CUSTOM

--analysis-rule-policy (tagged union structure)

The updated analysis rule policy for the configured table association.

Note

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

v1 -> (tagged union structure)

The policy for the configured table association analysis rule.

Note

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

list -> (structure)

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

allowedResultReceivers -> (list)

The list of collaboration members who are allowed to receive results of queries run with this configured table.

(string)

allowedAdditionalAnalyses -> (list)

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

(string)

aggregation -> (structure)

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

allowedResultReceivers -> (list)

The list of collaboration members who are allowed to receive results of queries run with this configured table.

(string)

allowedAdditionalAnalyses -> (list)

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

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

(string)

custom -> (structure)

Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

allowedResultReceivers -> (list)

The list of collaboration members who are allowed to receive results of queries run with this configured table.

(string)

allowedAdditionalAnalyses -> (list)

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

(string)

JSON Syntax:

{
  "v1": {
    "list": {
      "allowedResultReceivers": ["string", ...],
      "allowedAdditionalAnalyses": ["string", ...]
    },
    "aggregation": {
      "allowedResultReceivers": ["string", ...],
      "allowedAdditionalAnalyses": ["string", ...]
    },
    "custom": {
      "allowedResultReceivers": ["string", ...],
      "allowedAdditionalAnalyses": ["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. 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)

The updated analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule .

membershipIdentifier -> (string)

The membership identifier for the configured table association analysis rule.

configuredTableAssociationId -> (string)

The unique identifier for the configured table association.

configuredTableAssociationArn -> (string)

The Amazon Resource Name (ARN) of the configured table association.

policy -> (tagged union structure)

The policy of the configured table association analysis rule.

Note

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

v1 -> (tagged union structure)

The policy for the configured table association analysis rule.

Note

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

list -> (structure)

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

allowedResultReceivers -> (list)

The list of collaboration members who are allowed to receive results of queries run with this configured table.

(string)

allowedAdditionalAnalyses -> (list)

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

(string)

aggregation -> (structure)

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

allowedResultReceivers -> (list)

The list of collaboration members who are allowed to receive results of queries run with this configured table.

(string)

allowedAdditionalAnalyses -> (list)

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

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

(string)

custom -> (structure)

Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

allowedResultReceivers -> (list)

The list of collaboration members who are allowed to receive results of queries run with this configured table.

(string)

allowedAdditionalAnalyses -> (list)

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

(string)

type -> (string)

The type of the configured table association analysis rule.

createTime -> (timestamp)

The creation time of the configured table association analysis rule.

updateTime -> (timestamp)

The update time of the configured table association analysis rule.