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

Description

Updates the processing of a currently running query.

See also: AWS API Documentation

Synopsis

  update-protected-query
--membership-identifier <value>
--protected-query-identifier <value>
--target-status <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)

The identifier for a member of a protected query instance.

--protected-query-identifier (string)

The identifier for a protected query instance.

--target-status (string)

The target status of a query. Used to update the execution status of a currently running query.

Possible values:

  • CANCELLED

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

protectedQuery -> (structure)

The protected query output.

id -> (string)

The identifier for a protected query instance.

membershipId -> (string)

The identifier for the membership.

membershipArn -> (string)

The ARN of the membership.

createTime -> (timestamp)

The time at which the protected query was created.

sqlParameters -> (structure)

The protected query SQL parameters.

queryString -> (string)

The query string to be submitted.

analysisTemplateArn -> (string)

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

parameters -> (map)

The protected query SQL parameters.

key -> (string)

value -> (string)

status -> (string)

The status of the query.

resultConfiguration -> (structure)

Contains any details needed to write the query results.

outputConfiguration -> (tagged union structure)

Configuration for protected query results.

Note

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

s3 -> (structure)

Required configuration for a protected query with an S3 output type.

resultFormat -> (string)

Intended file format of the result.

bucket -> (string)

The S3 bucket to unload the protected query results.

keyPrefix -> (string)

The S3 prefix to unload the protected query results.

statistics -> (structure)

Statistics about protected query execution.

totalDurationInMillis -> (long)

The duration of the Protected Query, from creation until query completion.

result -> (structure)

The result of the protected query.

output -> (tagged union structure)

The output of the protected query.

Note

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

s3 -> (structure)

If present, the output for a protected query with an S3 output type.

location -> (string)

The S3 location of the result.

memberList -> (list)

The list of member Amazon Web Services account(s) that received the results of the query.

(structure)

Details about the member who received the query result.

accountId -> (string)

The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.

error -> (structure)

An error thrown by the protected query.

message -> (string)

A description of why the query failed.

code -> (string)

An error code for the error.