TimestreamQuery / Client / describe_account_settings

describe_account_settings#

TimestreamQuery.Client.describe_account_settings()#

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

You’re charged only for the duration of compute units used for your workloads.

Request Syntax

response = client.describe_account_settings()

Return type:

dict

Returns:

Response Syntax

{
    'MaxQueryTCU': 123,
    'QueryPricingModel': 'BYTES_SCANNED'|'COMPUTE_UNITS',
    'QueryCompute': {
        'ComputeMode': 'ON_DEMAND'|'PROVISIONED',
        'ProvisionedCapacity': {
            'ActiveQueryTCU': 123,
            'NotificationConfiguration': {
                'SnsConfiguration': {
                    'TopicArn': 'string'
                },
                'RoleArn': 'string'
            },
            'LastUpdate': {
                'TargetQueryTCU': 123,
                'Status': 'PENDING'|'FAILED'|'SUCCEEDED',
                'StatusMessage': 'string'
            }
        }
    }
}

Response Structure

(dict) –
- MaxQueryTCU (integer) –
  
  The maximum number of Timestream compute units (TCUs) 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. This configuration is applicable only for on-demand usage of (TCUs).
- QueryPricingModel (string) –
  
  The pricing model for queries in your 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.
- QueryCompute (dict) –
  
  An object that contains the usage settings for Timestream Compute Units (TCUs) in your account for the query workload.
  - 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 (dict) –
    
    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 (dict) –
      
      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 (dict) –
        
        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 (dict) –
      
      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.

Exceptions

TimestreamQuery.Client.exceptions.AccessDeniedException
TimestreamQuery.Client.exceptions.InternalServerException
TimestreamQuery.Client.exceptions.ThrottlingException
TimestreamQuery.Client.exceptions.InvalidEndpointException