Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

Documentation

data ScheduledQueryDescription

Structure that describes scheduled query.

See: newScheduledQueryDescription smart constructor.

Constructors

ScheduledQueryDescription'

Fields

• creationTime :: Maybe POSIX

  Creation time of the scheduled query.

• errorReportConfiguration :: Maybe ErrorReportConfiguration

  Error-reporting configuration for the scheduled query.

• kmsKeyId :: Maybe Text

  A customer provided KMS key used to encrypt the scheduled query resource.

• lastRunSummary :: Maybe ScheduledQueryRunSummary

  Runtime summary for the last scheduled query run.

• nextInvocationTime :: Maybe POSIX

  The next time the scheduled query is scheduled to run.

• previousInvocationTime :: Maybe POSIX

  Last time the query was run.

• recentlyFailedRuns :: Maybe [ScheduledQueryRunSummary]

  Runtime summary for the last five failed scheduled query runs.

• scheduledQueryExecutionRoleArn :: Maybe Text

  IAM role that Timestream uses to run the schedule query.

• targetConfiguration :: Maybe TargetConfiguration

  Scheduled query target store configuration.

• arn :: Text

  Scheduled query ARN.

• name :: Text

  Name of the scheduled query.

• queryString :: Sensitive Text

  The query to be run.

• state :: ScheduledQueryState

  State of the scheduled query.

• scheduleConfiguration :: ScheduleConfiguration

  Schedule configuration.

• notificationConfiguration :: NotificationConfiguration

  Notification configuration.

Instances

FromJSON ScheduledQueryDescription

Defined in Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

Methods

parseJSON :: Value -> Parser ScheduledQueryDescription

parseJSONList :: Value -> Parser [ScheduledQueryDescription]

Generic ScheduledQueryDescription

Defined in Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

Associated Types

type Rep ScheduledQueryDescription :: Type -> Type

Methods

from :: ScheduledQueryDescription -> Rep ScheduledQueryDescription x

to :: Rep ScheduledQueryDescription x -> ScheduledQueryDescription

Show ScheduledQueryDescription

Defined in Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

Methods

showsPrec :: Int -> ScheduledQueryDescription -> ShowS

show :: ScheduledQueryDescription -> String

showList :: [ScheduledQueryDescription] -> ShowS

NFData ScheduledQueryDescription

Defined in Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

Methods

rnf :: ScheduledQueryDescription -> ()

Eq ScheduledQueryDescription

Defined in Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

Methods

(==) :: ScheduledQueryDescription -> ScheduledQueryDescription -> Bool

(/=) :: ScheduledQueryDescription -> ScheduledQueryDescription -> Bool

Hashable ScheduledQueryDescription

Defined in Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

Methods

hashWithSalt :: Int -> ScheduledQueryDescription -> Int

hash :: ScheduledQueryDescription -> Int

type Rep ScheduledQueryDescription

Defined in Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription

type Rep ScheduledQueryDescription = D1 ('MetaData "ScheduledQueryDescription" "Amazonka.TimeStreamQuery.Types.ScheduledQueryDescription" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "ScheduledQueryDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "errorReportConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorReportConfiguration)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "lastRunSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledQueryRunSummary)) :*: S1 ('MetaSel ('Just "nextInvocationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "previousInvocationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "recentlyFailedRuns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduledQueryRunSummary]))))) :*: (((S1 ('MetaSel ('Just "scheduledQueryExecutionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetConfiguration))) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduledQueryState)) :*: (S1 ('MetaSel ('Just "scheduleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduleConfiguration) :*: S1 ('MetaSel ('Just "notificationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NotificationConfiguration))))))

newScheduledQueryDescription

Arguments

:: Text

$sel:arn:ScheduledQueryDescription'

-> Text

$sel:name:ScheduledQueryDescription'

-> Text

$sel:queryString:ScheduledQueryDescription'

-> ScheduledQueryState

$sel:state:ScheduledQueryDescription'

-> ScheduleConfiguration

$sel:scheduleConfiguration:ScheduledQueryDescription'

-> NotificationConfiguration

$sel:notificationConfiguration:ScheduledQueryDescription'

-> ScheduledQueryDescription

Create a value of ScheduledQueryDescription 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:creationTime:ScheduledQueryDescription', scheduledQueryDescription_creationTime - Creation time of the scheduled query.

$sel:errorReportConfiguration:ScheduledQueryDescription', scheduledQueryDescription_errorReportConfiguration - Error-reporting configuration for the scheduled query.

$sel:kmsKeyId:ScheduledQueryDescription', scheduledQueryDescription_kmsKeyId - A customer provided KMS key used to encrypt the scheduled query resource.

$sel:lastRunSummary:ScheduledQueryDescription', scheduledQueryDescription_lastRunSummary - Runtime summary for the last scheduled query run.

$sel:nextInvocationTime:ScheduledQueryDescription', scheduledQueryDescription_nextInvocationTime - The next time the scheduled query is scheduled to run.

$sel:previousInvocationTime:ScheduledQueryDescription', scheduledQueryDescription_previousInvocationTime - Last time the query was run.

$sel:recentlyFailedRuns:ScheduledQueryDescription', scheduledQueryDescription_recentlyFailedRuns - Runtime summary for the last five failed scheduled query runs.

$sel:scheduledQueryExecutionRoleArn:ScheduledQueryDescription', scheduledQueryDescription_scheduledQueryExecutionRoleArn - IAM role that Timestream uses to run the schedule query.

$sel:targetConfiguration:ScheduledQueryDescription', scheduledQueryDescription_targetConfiguration - Scheduled query target store configuration.

$sel:arn:ScheduledQueryDescription', scheduledQueryDescription_arn - Scheduled query ARN.

$sel:name:ScheduledQueryDescription', scheduledQueryDescription_name - Name of the scheduled query.

$sel:queryString:ScheduledQueryDescription', scheduledQueryDescription_queryString - The query to be run.

$sel:state:ScheduledQueryDescription', scheduledQueryDescription_state - State of the scheduled query.

$sel:scheduleConfiguration:ScheduledQueryDescription', scheduledQueryDescription_scheduleConfiguration - Schedule configuration.

$sel:notificationConfiguration:ScheduledQueryDescription', scheduledQueryDescription_notificationConfiguration - Notification configuration.

scheduledQueryDescription_creationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime)

Creation time of the scheduled query.

scheduledQueryDescription_errorReportConfiguration :: Lens' ScheduledQueryDescription (Maybe ErrorReportConfiguration)

Error-reporting configuration for the scheduled query.

scheduledQueryDescription_kmsKeyId :: Lens' ScheduledQueryDescription (Maybe Text)

A customer provided KMS key used to encrypt the scheduled query resource.

scheduledQueryDescription_lastRunSummary :: Lens' ScheduledQueryDescription (Maybe ScheduledQueryRunSummary)

Runtime summary for the last scheduled query run.

scheduledQueryDescription_nextInvocationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime)

The next time the scheduled query is scheduled to run.

scheduledQueryDescription_previousInvocationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime)

Last time the query was run.

scheduledQueryDescription_recentlyFailedRuns :: Lens' ScheduledQueryDescription (Maybe [ScheduledQueryRunSummary])

Runtime summary for the last five failed scheduled query runs.

scheduledQueryDescription_scheduledQueryExecutionRoleArn :: Lens' ScheduledQueryDescription (Maybe Text)

IAM role that Timestream uses to run the schedule query.

scheduledQueryDescription_targetConfiguration :: Lens' ScheduledQueryDescription (Maybe TargetConfiguration)

Scheduled query target store configuration.

scheduledQueryDescription_arn :: Lens' ScheduledQueryDescription Text

Scheduled query ARN.

scheduledQueryDescription_name :: Lens' ScheduledQueryDescription Text

Name of the scheduled query.

scheduledQueryDescription_queryString :: Lens' ScheduledQueryDescription Text

The query to be run.

scheduledQueryDescription_state :: Lens' ScheduledQueryDescription ScheduledQueryState

State of the scheduled query.

scheduledQueryDescription_scheduleConfiguration :: Lens' ScheduledQueryDescription ScheduleConfiguration

Schedule configuration.

scheduledQueryDescription_notificationConfiguration :: Lens' ScheduledQueryDescription NotificationConfiguration

Notification configuration.