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 . timestream-query ]

update-account-settings

Description

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.

Note

After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.

See also: AWS API Documentation

Synopsis

  update-account-settings
[--max-query-tcu <value>]
[--query-pricing-model <value>]
[--query-compute <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

--max-query-tcu (integer)

The maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas. This configuration is applicable only for on-demand usage of Timestream Compute Units (TCUs).

The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU , see Default quotas .

--query-pricing-model (string)

The pricing model for queries in an account.

Note

The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS .

Possible values:

  • BYTES_SCANNED
  • COMPUTE_UNITS

--query-compute (structure)

Modifies the query compute settings configured in your account, including the query pricing model and provisioned Timestream Compute Units (TCUs) in your account.

Note

This API is idempotent, meaning that making the same request multiple times will have the same effect as making the request once.

ComputeMode -> (string)

The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED .

ProvisionedCapacity -> (structure)

Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.

TargetQueryTCU -> (integer)

The target compute capacity for querying data, specified in Timestream Compute Units (TCUs).

NotificationConfiguration -> (structure)

Configuration settings for notifications related to the provisioned capacity update.

SnsConfiguration -> (structure)

Details on SNS that are required to send the notification.

TopicArn -> (string)

SNS topic ARN that the scheduled query status notifications will be sent to.

RoleArn -> (string)

An Amazon Resource Name (ARN) that grants Timestream permission to publish notifications. This field is only visible if SNS Topic is provided when updating the account settings.

JSON Syntax:

{
  "ComputeMode": "ON_DEMAND"|"PROVISIONED",
  "ProvisionedCapacity": {
    "TargetQueryTCU": integer,
    "NotificationConfiguration": {
      "SnsConfiguration": {
        "TopicArn": "string"
      },
      "RoleArn": "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

MaxQueryTCU -> (integer)

The configured maximum number of compute units the service will use at any point in time to serve your queries.

QueryPricingModel -> (string)

The pricing model for an account.

QueryCompute -> (structure)

Confirms the updated account settings for querying data in your account.

ComputeMode -> (string)

The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED .

ProvisionedCapacity -> (structure)

Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.

ActiveQueryTCU -> (integer)

The number of Timestream Compute Units (TCUs) provisioned in the account. This field is only visible when the compute mode is PROVISIONED .

NotificationConfiguration -> (structure)

An object that contains settings for notifications that are sent whenever the provisioned capacity settings are modified. This field is only visible when the compute mode is PROVISIONED .

SnsConfiguration -> (structure)

Details on SNS that are required to send the notification.

TopicArn -> (string)

SNS topic ARN that the scheduled query status notifications will be sent to.

RoleArn -> (string)

An Amazon Resource Name (ARN) that grants Timestream permission to publish notifications. This field is only visible if SNS Topic is provided when updating the account settings.

LastUpdate -> (structure)

Information about the last update to the provisioned capacity settings.

TargetQueryTCU -> (integer)

The number of TimeStream Compute Units (TCUs) requested in the last account settings update.

Status -> (string)

The status of the last update. Can be either PENDING , FAILED , or SUCCEEDED .

StatusMessage -> (string)

Error message describing the last account settings update status, visible only if an error occurred.