Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. timestream
  5. getScheduledQuery

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.timestream.getScheduledQuery

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    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
    The ARN of the scheduled query.
    Arn string
    The ARN of the scheduled query.
    arn String
    The ARN of the scheduled query.
    arn string
    The ARN of the scheduled query.
    arn str
    The ARN of the scheduled query.
    arn String
    The ARN of the scheduled query.

    getScheduledQuery Result

    The following output properties are available:

    Arn string
    The ARN of the scheduled query.
    SqErrorReportConfiguration string
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    SqKmsKeyId 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.
    SqName string
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    SqNotificationConfiguration 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.
    SqQueryString 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.
    SqScheduleConfiguration string
    Configuration for when the scheduled query is executed.
    SqScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    SqTargetConfiguration string
    Configuration of target store where scheduled query results are written to.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs to label the scheduled query.
    Arn string
    The ARN of the scheduled query.
    SqErrorReportConfiguration string
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    SqKmsKeyId 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.
    SqName string
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    SqNotificationConfiguration 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.
    SqQueryString 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.
    SqScheduleConfiguration string
    Configuration for when the scheduled query is executed.
    SqScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    SqTargetConfiguration string
    Configuration of target store where scheduled query results are written to.
    Tags Tag
    A list of key-value pairs to label the scheduled query.
    arn String
    The ARN of the scheduled query.
    sqErrorReportConfiguration String
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sqKmsKeyId 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.
    sqName String
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sqNotificationConfiguration 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.
    sqQueryString 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.
    sqScheduleConfiguration String
    Configuration for when the scheduled query is executed.
    sqScheduledQueryExecutionRoleArn String
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sqTargetConfiguration String
    Configuration of target store where scheduled query results are written to.
    tags List<Tag>
    A list of key-value pairs to label the scheduled query.
    arn string
    The ARN of the scheduled query.
    sqErrorReportConfiguration string
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sqKmsKeyId 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.
    sqName string
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sqNotificationConfiguration 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.
    sqQueryString 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.
    sqScheduleConfiguration string
    Configuration for when the scheduled query is executed.
    sqScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sqTargetConfiguration string
    Configuration of target store where scheduled query results are written to.
    tags Tag[]
    A list of key-value pairs to label the scheduled query.
    arn str
    The ARN of the scheduled query.
    sq_error_report_configuration str
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sq_kms_key_id 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.
    sq_name str
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sq_notification_configuration str
    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.
    sq_query_string 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.
    sq_schedule_configuration str
    Configuration for when the scheduled query is executed.
    sq_scheduled_query_execution_role_arn str
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sq_target_configuration str
    Configuration of target store where scheduled query results are written to.
    tags Sequence[root_Tag]
    A list of key-value pairs to label the scheduled query.
    arn String
    The ARN of the scheduled query.
    sqErrorReportConfiguration String
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sqKmsKeyId 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.
    sqName String
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sqNotificationConfiguration 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.
    sqQueryString 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.
    sqScheduleConfiguration String
    Configuration for when the scheduled query is executed.
    sqScheduledQueryExecutionRoleArn String
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sqTargetConfiguration String
    Configuration of target store where scheduled query results are written to.
    tags List<Property Map>
    A list of key-value pairs to label the scheduled query.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native