Struct aws_sdk_timestreamquery::operation::create_scheduled_query::CreateScheduledQueryInput

#[non_exhaustive]
pub struct CreateScheduledQueryInput {
    pub name: Option<String>,
    pub query_string: Option<String>,
    pub schedule_configuration: Option<ScheduleConfiguration>,
    pub notification_configuration: Option<NotificationConfiguration>,
    pub target_configuration: Option<TargetConfiguration>,
    pub client_token: Option<String>,
    pub scheduled_query_execution_role_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub kms_key_id: Option<String>,
    pub error_report_configuration: Option<ErrorReportConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

Name of the scheduled query.

query_string: Option<String>

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.

schedule_configuration: Option<ScheduleConfiguration>

The schedule configuration for the query.

notification_configuration: Option<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.

target_configuration: Option<TargetConfiguration>

Configuration used for writing the result of a query.

client_token: Option<String>

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.

scheduled_query_execution_role_arn: Option<String>

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

tags: Option<Vec<Tag>>

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

kms_key_id: Option<String>

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.

error_report_configuration: Option<ErrorReportConfiguration>

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

Implementations

impl CreateScheduledQueryInput

pub fn name(&self) -> Option<&str>

Name of the scheduled query.

pub fn query_string(&self) -> Option<&str>

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.

pub fn schedule_configuration(&self) -> Option<&ScheduleConfiguration>

The schedule configuration for the query.

pub fn notification_configuration(&self) -> Option<&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.

pub fn target_configuration(&self) -> Option<&TargetConfiguration>

Configuration used for writing the result of a query.

pub fn client_token(&self) -> Option<&str>

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.

pub fn scheduled_query_execution_role_arn(&self) -> Option<&str>

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

pub fn tags(&self) -> Option<&[Tag]>

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

pub fn kms_key_id(&self) -> Option<&str>

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.

pub fn error_report_configuration(&self) -> Option<&ErrorReportConfiguration>

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

impl CreateScheduledQueryInput

pub fn builder() -> CreateScheduledQueryInputBuilder

Creates a new builder-style object to manufacture CreateScheduledQueryInput.

Trait Implementations

impl Clone for CreateScheduledQueryInput

fn clone(&self) -> CreateScheduledQueryInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateScheduledQueryInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateScheduledQueryInput

fn eq(&self, other: &CreateScheduledQueryInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateScheduledQueryInput