@pulumi/aws-native/timestream/getScheduledQuery.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
 */
export declare function getScheduledQuery(args: GetScheduledQueryArgs, opts?: pulumi.InvokeOptions): Promise<GetScheduledQueryResult>;
export interface GetScheduledQueryArgs {
    /**
     * The `ARN` of the scheduled query.
     */
    arn: string;
}
export interface GetScheduledQueryResult {
    /**
     * The `ARN` of the scheduled query.
     */
    readonly arn?: string;
    /**
     * Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
     */
    readonly sqErrorReportConfiguration?: 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.
     */
    readonly sqKmsKeyId?: string;
    /**
     * The name of the scheduled query. Scheduled query names must be unique within each Region.
     */
    readonly sqName?: 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.
     */
    readonly sqNotificationConfiguration?: 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.
     */
    readonly sqQueryString?: string;
    /**
     * Configuration for when the scheduled query is executed.
     */
    readonly sqScheduleConfiguration?: string;
    /**
     * The ARN for the IAM role that Timestream will assume when running the scheduled query.
     */
    readonly sqScheduledQueryExecutionRoleArn?: string;
    /**
     * Configuration of target store where scheduled query results are written to.
     */
    readonly sqTargetConfiguration?: string;
    /**
     * A list of key-value pairs to label the scheduled query.
     */
    readonly tags?: outputs.Tag[];
}
/**
 * The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
 */
export declare function getScheduledQueryOutput(args: GetScheduledQueryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetScheduledQueryResult>;
export interface GetScheduledQueryOutputArgs {
    /**
     * The `ARN` of the scheduled query.
     */
    arn: pulumi.Input<string>;
}