paws.database (version 0.7.0)

timestreamquery: Amazon Timestream Query

Description

Amazon Timestream Query

Usage

timestreamquery(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Service syntax

svc <- timestreamquery(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

cancel_query	Cancels a query that has been issued
create_scheduled_query	Create a scheduled query that will be run on your behalf at the configured schedule
delete_scheduled_query	Deletes a given scheduled query
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
describe_endpoints	DescribeEndpoints returns a list of available endpoints to make Timestream API calls against
describe_scheduled_query	Provides detailed information about a scheduled query
execute_scheduled_query	You can use this API to run a scheduled query manually
list_scheduled_queries	Gets a list of all scheduled queries in the caller's Amazon account and Region
list_tags_for_resource	List all tags on a Timestream query resource
prepare_query	A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running
query	Query is a synchronous operation that enables you to run a query against your Amazon Timestream data
tag_resource	Associate a set of tags with a Timestream resource
untag_resource	Removes the association of tags from a Timestream query resource
update_account_settings	Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured
update_scheduled_query	Update a scheduled query

Examples

if (FALSE) {
svc <- timestreamquery()
svc$cancel_query(
  Foo = 123
)
}