AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cleanrooms ]

populate-intermediate-table

Description

Executes the stored query of an intermediate table to materialize data into managed storage. With this operation, you can perform initial population and subsequent refreshes. Each call creates a new version. The returned analysis ID can be tracked using GetProtectedQuery . Only the intermediate table owner can call this operation.

See also: AWS API Documentation

Synopsis

  populate-intermediate-table
--intermediate-table-identifier <value>
--membership-identifier <value>
[--parameters <value>]
[--compute-configuration <value>]
[--analysis-payer-account-id <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>]
[--v2-debug]

Options

--intermediate-table-identifier (string)

The unique identifier of the intermediate table to populate.

--membership-identifier (string)

The unique identifier of the membership that contains the intermediate table.

--parameters (map)

The runtime parameter values that override the defaults in the stored query.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--compute-configuration (tagged union structure)

The compute configuration for the population query execution.

Note

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

queryComputeConfiguration -> (structure)

The configuration of the compute resources for workers running an analysis with the Clean Rooms SQL analytics engine.

type -> (string)

The worker compute configuration type.

number -> (integer)

The number of workers.

SQL queries support a minimum value of 2 and a maximum value of 400.

PySpark jobs support a minimum value of 4 and a maximum value of 128.

properties -> (tagged union structure)

The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.

Note

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

spark -> (map)

The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.

key -> (string)

value -> (string)

JSON Syntax:

{
  "queryComputeConfiguration": {
    "type": "CR.1X"|"CR.4X",
    "number": integer,
    "properties": {
      "spark": {"string": "string"
        ...}
    }
  }
}

--analysis-payer-account-id (string)

The account ID of the member that pays for the analysis compute costs.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

analysisId -> (string)

The identifier for the protected query execution. Use this value with GetProtectedQuery to track the population progress.

analysisType -> (string)

The type of analysis performed to populate the intermediate table.

versionId -> (string)

The unique identifier of the version created by this population operation.