AWS Native
getScheduledQuery
The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Using getScheduledQuery
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getScheduledQuery(args: GetScheduledQueryArgs, opts?: InvokeOptions): Promise<GetScheduledQueryResult>
function getScheduledQueryOutput(args: GetScheduledQueryOutputArgs, opts?: InvokeOptions): Output<GetScheduledQueryResult>
def get_scheduled_query(arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetScheduledQueryResult
def get_scheduled_query_output(arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetScheduledQueryResult]
func LookupScheduledQuery(ctx *Context, args *LookupScheduledQueryArgs, opts ...InvokeOption) (*LookupScheduledQueryResult, error)
func LookupScheduledQueryOutput(ctx *Context, args *LookupScheduledQueryOutputArgs, opts ...InvokeOption) LookupScheduledQueryResultOutput
> Note: This function is named LookupScheduledQuery
in the Go SDK.
public static class GetScheduledQuery
{
public static Task<GetScheduledQueryResult> InvokeAsync(GetScheduledQueryArgs args, InvokeOptions? opts = null)
public static Output<GetScheduledQueryResult> Invoke(GetScheduledQueryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetScheduledQueryResult> getScheduledQuery(GetScheduledQueryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws-native:timestream:getScheduledQuery
Arguments:
# Arguments dictionary
The following arguments are supported:
- Arn string
- Arn string
- arn String
- arn string
- arn str
- arn String
getScheduledQuery Result
The following output properties are available:
- Arn string
- SQError
Report stringConfiguration Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- SQKms
Key stringId 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.
- SQName string
The name of the scheduled query. Scheduled query names must be unique within each Region.
- SQNotification
Configuration string 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.
- SQQuery
String 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.
- SQSchedule
Configuration string Configuration for when the scheduled query is executed.
- SQScheduled
Query stringExecution Role Arn The ARN for the IAM role that Timestream will assume when running the scheduled query.
- SQTarget
Configuration string Configuration of target store where scheduled query results are written to.
- List<Pulumi.
Aws Native. Timestream. Outputs. Scheduled Query Tag>
- Arn string
- SQError
Report stringConfiguration Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- SQKms
Key stringId 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.
- SQName string
The name of the scheduled query. Scheduled query names must be unique within each Region.
- SQNotification
Configuration string 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.
- SQQuery
String 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.
- SQSchedule
Configuration string Configuration for when the scheduled query is executed.
- SQScheduled
Query stringExecution Role Arn The ARN for the IAM role that Timestream will assume when running the scheduled query.
- SQTarget
Configuration string Configuration of target store where scheduled query results are written to.
- []Scheduled
Query Tag
- arn String
- s
QError StringReport Configuration Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- s
QKms StringKey Id 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.
- s
QName String The name of the scheduled query. Scheduled query names must be unique within each Region.
- s
QNotification StringConfiguration 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.
- s
QQuery StringString 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.
- s
QSchedule StringConfiguration Configuration for when the scheduled query is executed.
- s
QScheduled StringQuery Execution Role Arn The ARN for the IAM role that Timestream will assume when running the scheduled query.
- s
QTarget StringConfiguration Configuration of target store where scheduled query results are written to.
- List<Scheduled
Query Tag>
- arn string
- s
QError stringReport Configuration Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- s
QKms stringKey Id 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.
- s
QName string The name of the scheduled query. Scheduled query names must be unique within each Region.
- s
QNotification stringConfiguration 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.
- s
QQuery stringString 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.
- s
QSchedule stringConfiguration Configuration for when the scheduled query is executed.
- s
QScheduled stringQuery Execution Role Arn The ARN for the IAM role that Timestream will assume when running the scheduled query.
- s
QTarget stringConfiguration Configuration of target store where scheduled query results are written to.
- Scheduled
Query Tag[]
- arn str
- s_
q_ strerror_ report_ configuration Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- s_
q_ strkms_ key_ id 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.
- s_
q_ strname The name of the scheduled query. Scheduled query names must be unique within each Region.
- s_
q_ strnotification_ configuration 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.
- s_
q_ strquery_ 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.
- s_
q_ strschedule_ configuration Configuration for when the scheduled query is executed.
- s_
q_ strscheduled_ query_ execution_ role_ arn The ARN for the IAM role that Timestream will assume when running the scheduled query.
- s_
q_ strtarget_ configuration Configuration of target store where scheduled query results are written to.
- Sequence[Scheduled
Query Tag]
- arn String
- s
QError StringReport Configuration Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- s
QKms StringKey Id 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.
- s
QName String The name of the scheduled query. Scheduled query names must be unique within each Region.
- s
QNotification StringConfiguration 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.
- s
QQuery StringString 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.
- s
QSchedule StringConfiguration Configuration for when the scheduled query is executed.
- s
QScheduled StringQuery Execution Role Arn The ARN for the IAM role that Timestream will assume when running the scheduled query.
- s
QTarget StringConfiguration Configuration of target store where scheduled query results are written to.
- List<Property Map>
Supporting Types
ScheduledQueryTag
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0