amazonka-timestream-query-2.0: Amazon Timestream Query SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.TimeStreamQuery.CreateScheduledQuery

Description

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

Synopsis

Creating a Request

data CreateScheduledQuery Source #

See: newCreateScheduledQuery smart constructor.

Constructors

CreateScheduledQuery' 

Fields

  • clientToken :: Maybe (Sensitive Text)

    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
  • kmsKeyId :: Maybe Text

    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

    If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

  • tags :: Maybe [Tag]

    A list of key-value pairs to label the scheduled query.

  • targetConfiguration :: Maybe TargetConfiguration

    Configuration used for writing the result of a query.

  • name :: Text

    Name of the scheduled query.

  • queryString :: Sensitive Text

    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

    The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

  • scheduleConfiguration :: ScheduleConfiguration

    The schedule configuration for the query.

  • notificationConfiguration :: NotificationConfiguration

    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

  • scheduledQueryExecutionRoleArn :: Text

    The ARN for the IAM role that Timestream will assume when running the scheduled query.

  • errorReportConfiguration :: ErrorReportConfiguration

    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Instances

Instances details
ToJSON CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

ToHeaders CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

ToPath CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

ToQuery CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

AWSRequest CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

Associated Types

type AWSResponse CreateScheduledQuery #

Generic CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

Associated Types

type Rep CreateScheduledQuery :: Type -> Type #

Show CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

NFData CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

Methods

rnf :: CreateScheduledQuery -> () #

Eq CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

Hashable CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

type AWSResponse CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

type Rep CreateScheduledQuery Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

type Rep CreateScheduledQuery = D1 ('MetaData "CreateScheduledQuery" "Amazonka.TimeStreamQuery.CreateScheduledQuery" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "CreateScheduledQuery'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "targetConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetConfiguration)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "scheduleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduleConfiguration)) :*: (S1 ('MetaSel ('Just "notificationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NotificationConfiguration) :*: (S1 ('MetaSel ('Just "scheduledQueryExecutionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "errorReportConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ErrorReportConfiguration))))))

newCreateScheduledQuery Source #

Create a value of CreateScheduledQuery with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateScheduledQuery', createScheduledQuery_clientToken - Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

  • If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.
  • After 8 hours, any request with the same ClientToken is treated as a new request.

CreateScheduledQuery, createScheduledQuery_kmsKeyId - The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

$sel:tags:CreateScheduledQuery', createScheduledQuery_tags - A list of key-value pairs to label the scheduled query.

CreateScheduledQuery, createScheduledQuery_targetConfiguration - Configuration used for writing the result of a query.

CreateScheduledQuery, createScheduledQuery_name - Name of the scheduled query.

CreateScheduledQuery, createScheduledQuery_queryString - The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

CreateScheduledQuery, createScheduledQuery_scheduleConfiguration - The schedule configuration for the query.

CreateScheduledQuery, createScheduledQuery_notificationConfiguration - Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

CreateScheduledQuery, createScheduledQuery_scheduledQueryExecutionRoleArn - The ARN for the IAM role that Timestream will assume when running the scheduled query.

CreateScheduledQuery, createScheduledQuery_errorReportConfiguration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Request Lenses

createScheduledQuery_clientToken :: Lens' CreateScheduledQuery (Maybe Text) Source #

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

  • If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.
  • After 8 hours, any request with the same ClientToken is treated as a new request.

createScheduledQuery_kmsKeyId :: Lens' CreateScheduledQuery (Maybe Text) Source #

The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

createScheduledQuery_tags :: Lens' CreateScheduledQuery (Maybe [Tag]) Source #

A list of key-value pairs to label the scheduled query.

createScheduledQuery_targetConfiguration :: Lens' CreateScheduledQuery (Maybe TargetConfiguration) Source #

Configuration used for writing the result of a query.

createScheduledQuery_queryString :: Lens' CreateScheduledQuery Text Source #

The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

createScheduledQuery_notificationConfiguration :: Lens' CreateScheduledQuery NotificationConfiguration Source #

Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

createScheduledQuery_scheduledQueryExecutionRoleArn :: Lens' CreateScheduledQuery Text Source #

The ARN for the IAM role that Timestream will assume when running the scheduled query.

createScheduledQuery_errorReportConfiguration :: Lens' CreateScheduledQuery ErrorReportConfiguration Source #

Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Destructuring the Response

data CreateScheduledQueryResponse Source #

See: newCreateScheduledQueryResponse smart constructor.

Constructors

CreateScheduledQueryResponse' 

Fields

Instances

Instances details
Generic CreateScheduledQueryResponse Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

Associated Types

type Rep CreateScheduledQueryResponse :: Type -> Type #

Read CreateScheduledQueryResponse Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

Show CreateScheduledQueryResponse Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

NFData CreateScheduledQueryResponse Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

Eq CreateScheduledQueryResponse Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

type Rep CreateScheduledQueryResponse Source # 
Instance details

Defined in Amazonka.TimeStreamQuery.CreateScheduledQuery

type Rep CreateScheduledQueryResponse = D1 ('MetaData "CreateScheduledQueryResponse" "Amazonka.TimeStreamQuery.CreateScheduledQuery" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "CreateScheduledQueryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateScheduledQueryResponse Source #

Create a value of CreateScheduledQueryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateScheduledQueryResponse', createScheduledQueryResponse_httpStatus - The response's http status code.

CreateScheduledQueryResponse, createScheduledQueryResponse_arn - ARN for the created scheduled query.

Response Lenses