| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.TimeStreamQuery.Types
Contents
- Service Configuration
- Errors
- DimensionValueType
- MeasureValueType
- S3EncryptionOption
- ScalarMeasureValueType
- ScalarType
- ScheduledQueryRunStatus
- ScheduledQueryState
- ColumnInfo
- Datum
- DimensionMapping
- Endpoint
- ErrorReportConfiguration
- ErrorReportLocation
- ExecutionStats
- MixedMeasureMapping
- MultiMeasureAttributeMapping
- MultiMeasureMappings
- NotificationConfiguration
- ParameterMapping
- QueryStatus
- Row
- S3Configuration
- S3ReportLocation
- ScheduleConfiguration
- ScheduledQuery
- ScheduledQueryDescription
- ScheduledQueryRunSummary
- SelectColumn
- SnsConfiguration
- Tag
- TargetConfiguration
- TargetDestination
- TimeSeriesDataPoint
- TimestreamConfiguration
- TimestreamDestination
- Type
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidEndpointException :: AsError a => Fold a ServiceError
- _QueryExecutionException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype DimensionValueType where
- newtype MeasureValueType where
- MeasureValueType' { }
- pattern MeasureValueType_BIGINT :: MeasureValueType
- pattern MeasureValueType_BOOLEAN :: MeasureValueType
- pattern MeasureValueType_DOUBLE :: MeasureValueType
- pattern MeasureValueType_MULTI :: MeasureValueType
- pattern MeasureValueType_VARCHAR :: MeasureValueType
- newtype S3EncryptionOption where
- S3EncryptionOption' { }
- pattern S3EncryptionOption_SSE_KMS :: S3EncryptionOption
- pattern S3EncryptionOption_SSE_S3 :: S3EncryptionOption
- newtype ScalarMeasureValueType where
- ScalarMeasureValueType' { }
- pattern ScalarMeasureValueType_BIGINT :: ScalarMeasureValueType
- pattern ScalarMeasureValueType_BOOLEAN :: ScalarMeasureValueType
- pattern ScalarMeasureValueType_DOUBLE :: ScalarMeasureValueType
- pattern ScalarMeasureValueType_TIMESTAMP :: ScalarMeasureValueType
- pattern ScalarMeasureValueType_VARCHAR :: ScalarMeasureValueType
- newtype ScalarType where
- ScalarType' { }
- pattern ScalarType_BIGINT :: ScalarType
- pattern ScalarType_BOOLEAN :: ScalarType
- pattern ScalarType_DATE :: ScalarType
- pattern ScalarType_DOUBLE :: ScalarType
- pattern ScalarType_INTEGER :: ScalarType
- pattern ScalarType_INTERVAL_DAY_TO_SECOND :: ScalarType
- pattern ScalarType_INTERVAL_YEAR_TO_MONTH :: ScalarType
- pattern ScalarType_TIME :: ScalarType
- pattern ScalarType_TIMESTAMP :: ScalarType
- pattern ScalarType_UNKNOWN :: ScalarType
- pattern ScalarType_VARCHAR :: ScalarType
- newtype ScheduledQueryRunStatus where
- ScheduledQueryRunStatus' { }
- pattern ScheduledQueryRunStatus_AUTO_TRIGGER_FAILURE :: ScheduledQueryRunStatus
- pattern ScheduledQueryRunStatus_AUTO_TRIGGER_SUCCESS :: ScheduledQueryRunStatus
- pattern ScheduledQueryRunStatus_MANUAL_TRIGGER_FAILURE :: ScheduledQueryRunStatus
- pattern ScheduledQueryRunStatus_MANUAL_TRIGGER_SUCCESS :: ScheduledQueryRunStatus
- newtype ScheduledQueryState where
- data ColumnInfo = ColumnInfo' {}
- newColumnInfo :: Type -> ColumnInfo
- columnInfo_name :: Lens' ColumnInfo (Maybe Text)
- columnInfo_type :: Lens' ColumnInfo Type
- data Datum = Datum' {
- arrayValue :: Maybe [Datum]
- nullValue :: Maybe Bool
- rowValue :: Maybe Row
- scalarValue :: Maybe Text
- timeSeriesValue :: Maybe [TimeSeriesDataPoint]
- newDatum :: Datum
- datum_arrayValue :: Lens' Datum (Maybe [Datum])
- datum_nullValue :: Lens' Datum (Maybe Bool)
- datum_rowValue :: Lens' Datum (Maybe Row)
- datum_scalarValue :: Lens' Datum (Maybe Text)
- datum_timeSeriesValue :: Lens' Datum (Maybe [TimeSeriesDataPoint])
- data DimensionMapping = DimensionMapping' {}
- newDimensionMapping :: Text -> DimensionValueType -> DimensionMapping
- dimensionMapping_name :: Lens' DimensionMapping Text
- dimensionMapping_dimensionValueType :: Lens' DimensionMapping DimensionValueType
- data Endpoint = Endpoint' {}
- newEndpoint :: Text -> Integer -> Endpoint
- endpoint_address :: Lens' Endpoint Text
- endpoint_cachePeriodInMinutes :: Lens' Endpoint Integer
- data ErrorReportConfiguration = ErrorReportConfiguration' {}
- newErrorReportConfiguration :: S3Configuration -> ErrorReportConfiguration
- errorReportConfiguration_s3Configuration :: Lens' ErrorReportConfiguration S3Configuration
- data ErrorReportLocation = ErrorReportLocation' {}
- newErrorReportLocation :: ErrorReportLocation
- errorReportLocation_s3ReportLocation :: Lens' ErrorReportLocation (Maybe S3ReportLocation)
- data ExecutionStats = ExecutionStats' {}
- newExecutionStats :: ExecutionStats
- executionStats_bytesMetered :: Lens' ExecutionStats (Maybe Integer)
- executionStats_dataWrites :: Lens' ExecutionStats (Maybe Integer)
- executionStats_executionTimeInMillis :: Lens' ExecutionStats (Maybe Integer)
- executionStats_queryResultRows :: Lens' ExecutionStats (Maybe Integer)
- executionStats_recordsIngested :: Lens' ExecutionStats (Maybe Integer)
- data MixedMeasureMapping = MixedMeasureMapping' {}
- newMixedMeasureMapping :: MeasureValueType -> MixedMeasureMapping
- mixedMeasureMapping_measureName :: Lens' MixedMeasureMapping (Maybe Text)
- mixedMeasureMapping_multiMeasureAttributeMappings :: Lens' MixedMeasureMapping (Maybe (NonEmpty MultiMeasureAttributeMapping))
- mixedMeasureMapping_sourceColumn :: Lens' MixedMeasureMapping (Maybe Text)
- mixedMeasureMapping_targetMeasureName :: Lens' MixedMeasureMapping (Maybe Text)
- mixedMeasureMapping_measureValueType :: Lens' MixedMeasureMapping MeasureValueType
- data MultiMeasureAttributeMapping = MultiMeasureAttributeMapping' {}
- newMultiMeasureAttributeMapping :: Text -> ScalarMeasureValueType -> MultiMeasureAttributeMapping
- multiMeasureAttributeMapping_targetMultiMeasureAttributeName :: Lens' MultiMeasureAttributeMapping (Maybe Text)
- multiMeasureAttributeMapping_sourceColumn :: Lens' MultiMeasureAttributeMapping Text
- multiMeasureAttributeMapping_measureValueType :: Lens' MultiMeasureAttributeMapping ScalarMeasureValueType
- data MultiMeasureMappings = MultiMeasureMappings' {}
- newMultiMeasureMappings :: NonEmpty MultiMeasureAttributeMapping -> MultiMeasureMappings
- multiMeasureMappings_targetMultiMeasureName :: Lens' MultiMeasureMappings (Maybe Text)
- multiMeasureMappings_multiMeasureAttributeMappings :: Lens' MultiMeasureMappings (NonEmpty MultiMeasureAttributeMapping)
- data NotificationConfiguration = NotificationConfiguration' {}
- newNotificationConfiguration :: SnsConfiguration -> NotificationConfiguration
- notificationConfiguration_snsConfiguration :: Lens' NotificationConfiguration SnsConfiguration
- data ParameterMapping = ParameterMapping' {}
- newParameterMapping :: Text -> Type -> ParameterMapping
- parameterMapping_name :: Lens' ParameterMapping Text
- parameterMapping_type :: Lens' ParameterMapping Type
- data QueryStatus = QueryStatus' {}
- newQueryStatus :: QueryStatus
- queryStatus_cumulativeBytesMetered :: Lens' QueryStatus (Maybe Integer)
- queryStatus_cumulativeBytesScanned :: Lens' QueryStatus (Maybe Integer)
- queryStatus_progressPercentage :: Lens' QueryStatus (Maybe Double)
- data Row = Row' {}
- newRow :: Row
- row_data :: Lens' Row [Datum]
- data S3Configuration = S3Configuration' {}
- newS3Configuration :: Text -> S3Configuration
- s3Configuration_encryptionOption :: Lens' S3Configuration (Maybe S3EncryptionOption)
- s3Configuration_objectKeyPrefix :: Lens' S3Configuration (Maybe Text)
- s3Configuration_bucketName :: Lens' S3Configuration Text
- data S3ReportLocation = S3ReportLocation' {}
- newS3ReportLocation :: S3ReportLocation
- s3ReportLocation_bucketName :: Lens' S3ReportLocation (Maybe Text)
- s3ReportLocation_objectKey :: Lens' S3ReportLocation (Maybe Text)
- data ScheduleConfiguration = ScheduleConfiguration' {}
- newScheduleConfiguration :: Text -> ScheduleConfiguration
- scheduleConfiguration_scheduleExpression :: Lens' ScheduleConfiguration Text
- data ScheduledQuery = ScheduledQuery' {}
- newScheduledQuery :: Text -> Text -> ScheduledQueryState -> ScheduledQuery
- scheduledQuery_creationTime :: Lens' ScheduledQuery (Maybe UTCTime)
- scheduledQuery_errorReportConfiguration :: Lens' ScheduledQuery (Maybe ErrorReportConfiguration)
- scheduledQuery_lastRunStatus :: Lens' ScheduledQuery (Maybe ScheduledQueryRunStatus)
- scheduledQuery_nextInvocationTime :: Lens' ScheduledQuery (Maybe UTCTime)
- scheduledQuery_previousInvocationTime :: Lens' ScheduledQuery (Maybe UTCTime)
- scheduledQuery_targetDestination :: Lens' ScheduledQuery (Maybe TargetDestination)
- scheduledQuery_arn :: Lens' ScheduledQuery Text
- scheduledQuery_name :: Lens' ScheduledQuery Text
- scheduledQuery_state :: Lens' ScheduledQuery ScheduledQueryState
- data ScheduledQueryDescription = ScheduledQueryDescription' {
- creationTime :: Maybe POSIX
- errorReportConfiguration :: Maybe ErrorReportConfiguration
- kmsKeyId :: Maybe Text
- lastRunSummary :: Maybe ScheduledQueryRunSummary
- nextInvocationTime :: Maybe POSIX
- previousInvocationTime :: Maybe POSIX
- recentlyFailedRuns :: Maybe [ScheduledQueryRunSummary]
- scheduledQueryExecutionRoleArn :: Maybe Text
- targetConfiguration :: Maybe TargetConfiguration
- arn :: Text
- name :: Text
- queryString :: Sensitive Text
- state :: ScheduledQueryState
- scheduleConfiguration :: ScheduleConfiguration
- notificationConfiguration :: NotificationConfiguration
- newScheduledQueryDescription :: Text -> Text -> Text -> ScheduledQueryState -> ScheduleConfiguration -> NotificationConfiguration -> ScheduledQueryDescription
- scheduledQueryDescription_creationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime)
- scheduledQueryDescription_errorReportConfiguration :: Lens' ScheduledQueryDescription (Maybe ErrorReportConfiguration)
- scheduledQueryDescription_kmsKeyId :: Lens' ScheduledQueryDescription (Maybe Text)
- scheduledQueryDescription_lastRunSummary :: Lens' ScheduledQueryDescription (Maybe ScheduledQueryRunSummary)
- scheduledQueryDescription_nextInvocationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime)
- scheduledQueryDescription_previousInvocationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime)
- scheduledQueryDescription_recentlyFailedRuns :: Lens' ScheduledQueryDescription (Maybe [ScheduledQueryRunSummary])
- scheduledQueryDescription_scheduledQueryExecutionRoleArn :: Lens' ScheduledQueryDescription (Maybe Text)
- scheduledQueryDescription_targetConfiguration :: Lens' ScheduledQueryDescription (Maybe TargetConfiguration)
- scheduledQueryDescription_arn :: Lens' ScheduledQueryDescription Text
- scheduledQueryDescription_name :: Lens' ScheduledQueryDescription Text
- scheduledQueryDescription_queryString :: Lens' ScheduledQueryDescription Text
- scheduledQueryDescription_state :: Lens' ScheduledQueryDescription ScheduledQueryState
- scheduledQueryDescription_scheduleConfiguration :: Lens' ScheduledQueryDescription ScheduleConfiguration
- scheduledQueryDescription_notificationConfiguration :: Lens' ScheduledQueryDescription NotificationConfiguration
- data ScheduledQueryRunSummary = ScheduledQueryRunSummary' {}
- newScheduledQueryRunSummary :: ScheduledQueryRunSummary
- scheduledQueryRunSummary_errorReportLocation :: Lens' ScheduledQueryRunSummary (Maybe ErrorReportLocation)
- scheduledQueryRunSummary_executionStats :: Lens' ScheduledQueryRunSummary (Maybe ExecutionStats)
- scheduledQueryRunSummary_failureReason :: Lens' ScheduledQueryRunSummary (Maybe Text)
- scheduledQueryRunSummary_invocationTime :: Lens' ScheduledQueryRunSummary (Maybe UTCTime)
- scheduledQueryRunSummary_runStatus :: Lens' ScheduledQueryRunSummary (Maybe ScheduledQueryRunStatus)
- scheduledQueryRunSummary_triggerTime :: Lens' ScheduledQueryRunSummary (Maybe UTCTime)
- data SelectColumn = SelectColumn' {}
- newSelectColumn :: SelectColumn
- selectColumn_aliased :: Lens' SelectColumn (Maybe Bool)
- selectColumn_databaseName :: Lens' SelectColumn (Maybe Text)
- selectColumn_name :: Lens' SelectColumn (Maybe Text)
- selectColumn_tableName :: Lens' SelectColumn (Maybe Text)
- selectColumn_type :: Lens' SelectColumn (Maybe Type)
- data SnsConfiguration = SnsConfiguration' {}
- newSnsConfiguration :: Text -> SnsConfiguration
- snsConfiguration_topicArn :: Lens' SnsConfiguration Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TargetConfiguration = TargetConfiguration' {}
- newTargetConfiguration :: TimestreamConfiguration -> TargetConfiguration
- targetConfiguration_timestreamConfiguration :: Lens' TargetConfiguration TimestreamConfiguration
- data TargetDestination = TargetDestination' {}
- newTargetDestination :: TargetDestination
- targetDestination_timestreamDestination :: Lens' TargetDestination (Maybe TimestreamDestination)
- data TimeSeriesDataPoint = TimeSeriesDataPoint' {}
- newTimeSeriesDataPoint :: Text -> Datum -> TimeSeriesDataPoint
- timeSeriesDataPoint_time :: Lens' TimeSeriesDataPoint Text
- timeSeriesDataPoint_value :: Lens' TimeSeriesDataPoint Datum
- data TimestreamConfiguration = TimestreamConfiguration' {}
- newTimestreamConfiguration :: Text -> Text -> Text -> TimestreamConfiguration
- timestreamConfiguration_measureNameColumn :: Lens' TimestreamConfiguration (Maybe Text)
- timestreamConfiguration_mixedMeasureMappings :: Lens' TimestreamConfiguration (Maybe (NonEmpty MixedMeasureMapping))
- timestreamConfiguration_multiMeasureMappings :: Lens' TimestreamConfiguration (Maybe MultiMeasureMappings)
- timestreamConfiguration_databaseName :: Lens' TimestreamConfiguration Text
- timestreamConfiguration_tableName :: Lens' TimestreamConfiguration Text
- timestreamConfiguration_timeColumn :: Lens' TimestreamConfiguration Text
- timestreamConfiguration_dimensionMappings :: Lens' TimestreamConfiguration [DimensionMapping]
- data TimestreamDestination = TimestreamDestination' {}
- newTimestreamDestination :: TimestreamDestination
- timestreamDestination_databaseName :: Lens' TimestreamDestination (Maybe Text)
- timestreamDestination_tableName :: Lens' TimestreamDestination (Maybe Text)
- data Type = Type' {}
- newType :: Type
- type_arrayColumnInfo :: Lens' Type (Maybe ColumnInfo)
- type_rowColumnInfo :: Lens' Type (Maybe [ColumnInfo])
- type_scalarType :: Lens' Type (Maybe ScalarType)
- type_timeSeriesMeasureValueColumnInfo :: Lens' Type (Maybe ColumnInfo)
Service Configuration
defaultService :: Service Source #
API version 2018-11-01 of the Amazon Timestream Query SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You are not authorized to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
Unable to poll results for a cancelled query.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Timestream was unable to fully process this request because of an internal server error.
_InvalidEndpointException :: AsError a => Fold a ServiceError Source #
The requested endpoint was not valid.
_QueryExecutionException :: AsError a => Fold a ServiceError Source #
Timestream was unable to run the query successfully.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource could not be found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
You have exceeded the service quota.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
Invalid or malformed request.
DimensionValueType
newtype DimensionValueType Source #
Constructors
| DimensionValueType' | |
Fields | |
Bundled Patterns
| pattern DimensionValueType_VARCHAR :: DimensionValueType |
Instances
MeasureValueType
newtype MeasureValueType Source #
Constructors
| MeasureValueType' | |
Fields | |
Bundled Patterns
| pattern MeasureValueType_BIGINT :: MeasureValueType | |
| pattern MeasureValueType_BOOLEAN :: MeasureValueType | |
| pattern MeasureValueType_DOUBLE :: MeasureValueType | |
| pattern MeasureValueType_MULTI :: MeasureValueType | |
| pattern MeasureValueType_VARCHAR :: MeasureValueType |
Instances
S3EncryptionOption
newtype S3EncryptionOption Source #
Constructors
| S3EncryptionOption' | |
Fields | |
Bundled Patterns
| pattern S3EncryptionOption_SSE_KMS :: S3EncryptionOption | |
| pattern S3EncryptionOption_SSE_S3 :: S3EncryptionOption |
Instances
ScalarMeasureValueType
newtype ScalarMeasureValueType Source #
Constructors
| ScalarMeasureValueType' | |
Fields | |
Bundled Patterns
Instances
ScalarType
newtype ScalarType Source #
Constructors
| ScalarType' | |
Fields | |
Bundled Patterns
| pattern ScalarType_BIGINT :: ScalarType | |
| pattern ScalarType_BOOLEAN :: ScalarType | |
| pattern ScalarType_DATE :: ScalarType | |
| pattern ScalarType_DOUBLE :: ScalarType | |
| pattern ScalarType_INTEGER :: ScalarType | |
| pattern ScalarType_INTERVAL_DAY_TO_SECOND :: ScalarType | |
| pattern ScalarType_INTERVAL_YEAR_TO_MONTH :: ScalarType | |
| pattern ScalarType_TIME :: ScalarType | |
| pattern ScalarType_TIMESTAMP :: ScalarType | |
| pattern ScalarType_UNKNOWN :: ScalarType | |
| pattern ScalarType_VARCHAR :: ScalarType |
Instances
ScheduledQueryRunStatus
newtype ScheduledQueryRunStatus Source #
Constructors
| ScheduledQueryRunStatus' | |
Fields | |
Bundled Patterns
Instances
ScheduledQueryState
newtype ScheduledQueryState Source #
Constructors
| ScheduledQueryState' | |
Fields | |
Bundled Patterns
| pattern ScheduledQueryState_DISABLED :: ScheduledQueryState | |
| pattern ScheduledQueryState_ENABLED :: ScheduledQueryState |
Instances
ColumnInfo
data ColumnInfo Source #
Contains the metadata for query results such as the column names, data types, and other attributes.
See: newColumnInfo smart constructor.
Constructors
| ColumnInfo' | |
Fields
| |
Instances
Arguments
| :: Type | |
| -> ColumnInfo |
Create a value of ColumnInfo 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:name:ColumnInfo', columnInfo_name - The name of the result set column. The name of the result set is
available for columns of all data types except for arrays.
$sel:type':ColumnInfo', columnInfo_type - The data type of the result set column. The data type can be a scalar or
complex. Scalar data types are integers, strings, doubles, Booleans, and
others. Complex data types are types such as arrays, rows, and others.
columnInfo_name :: Lens' ColumnInfo (Maybe Text) Source #
The name of the result set column. The name of the result set is available for columns of all data types except for arrays.
columnInfo_type :: Lens' ColumnInfo Type Source #
The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.
Datum
Datum represents a single data point in a query result.
See: newDatum smart constructor.
Constructors
| Datum' | |
Fields
| |
Instances
Create a value of Datum 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:arrayValue:Datum', datum_arrayValue - Indicates if the data point is an array.
$sel:nullValue:Datum', datum_nullValue - Indicates if the data point is null.
$sel:rowValue:Datum', datum_rowValue - Indicates if the data point is a row.
$sel:scalarValue:Datum', datum_scalarValue - Indicates if the data point is a scalar value such as integer, string,
double, or Boolean.
$sel:timeSeriesValue:Datum', datum_timeSeriesValue - Indicates if the data point is a timeseries data type.
datum_scalarValue :: Lens' Datum (Maybe Text) Source #
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
datum_timeSeriesValue :: Lens' Datum (Maybe [TimeSeriesDataPoint]) Source #
Indicates if the data point is a timeseries data type.
DimensionMapping
data DimensionMapping Source #
This type is used to map column(s) from the query result to a dimension in the destination table.
See: newDimensionMapping smart constructor.
Constructors
| DimensionMapping' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DimensionValueType | |
| -> DimensionMapping |
Create a value of DimensionMapping 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:name:DimensionMapping', dimensionMapping_name - Column name from query result.
$sel:dimensionValueType:DimensionMapping', dimensionMapping_dimensionValueType - Type for the dimension.
dimensionMapping_name :: Lens' DimensionMapping Text Source #
Column name from query result.
dimensionMapping_dimensionValueType :: Lens' DimensionMapping DimensionValueType Source #
Type for the dimension.
Endpoint
Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.
See: newEndpoint smart constructor.
Constructors
| Endpoint' | |
Fields
| |
Instances
| FromJSON Endpoint Source # | |
| Generic Endpoint Source # | |
| Read Endpoint Source # | |
| Show Endpoint Source # | |
| NFData Endpoint Source # | |
Defined in Amazonka.TimeStreamQuery.Types.Endpoint | |
| Eq Endpoint Source # | |
| Hashable Endpoint Source # | |
Defined in Amazonka.TimeStreamQuery.Types.Endpoint | |
| type Rep Endpoint Source # | |
Defined in Amazonka.TimeStreamQuery.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.TimeStreamQuery.Types.Endpoint" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cachePeriodInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) | |
Create a value of Endpoint 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:address:Endpoint', endpoint_address - An endpoint address.
$sel:cachePeriodInMinutes:Endpoint', endpoint_cachePeriodInMinutes - The TTL for the endpoint, in minutes.
endpoint_cachePeriodInMinutes :: Lens' Endpoint Integer Source #
The TTL for the endpoint, in minutes.
ErrorReportConfiguration
data ErrorReportConfiguration Source #
Configuration required for error reporting.
See: newErrorReportConfiguration smart constructor.
Constructors
| ErrorReportConfiguration' | |
Fields
| |
Instances
newErrorReportConfiguration Source #
Arguments
| :: S3Configuration | |
| -> ErrorReportConfiguration |
Create a value of ErrorReportConfiguration 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:s3Configuration:ErrorReportConfiguration', errorReportConfiguration_s3Configuration - The S3 configuration for the error reports.
errorReportConfiguration_s3Configuration :: Lens' ErrorReportConfiguration S3Configuration Source #
The S3 configuration for the error reports.
ErrorReportLocation
data ErrorReportLocation Source #
This contains the location of the error report for a single scheduled query call.
See: newErrorReportLocation smart constructor.
Constructors
| ErrorReportLocation' | |
Fields
| |
Instances
newErrorReportLocation :: ErrorReportLocation Source #
Create a value of ErrorReportLocation 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:s3ReportLocation:ErrorReportLocation', errorReportLocation_s3ReportLocation - The S3 location where error reports are written.
errorReportLocation_s3ReportLocation :: Lens' ErrorReportLocation (Maybe S3ReportLocation) Source #
The S3 location where error reports are written.
ExecutionStats
data ExecutionStats Source #
Statistics for a single scheduled query run.
See: newExecutionStats smart constructor.
Constructors
| ExecutionStats' | |
Fields
| |
Instances
newExecutionStats :: ExecutionStats Source #
Create a value of ExecutionStats 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:bytesMetered:ExecutionStats', executionStats_bytesMetered - Bytes metered for a single scheduled query run.
$sel:dataWrites:ExecutionStats', executionStats_dataWrites - Data writes metered for records ingested in a single scheduled query
run.
$sel:executionTimeInMillis:ExecutionStats', executionStats_executionTimeInMillis - Total time, measured in milliseconds, that was needed for the scheduled
query run to complete.
$sel:queryResultRows:ExecutionStats', executionStats_queryResultRows - Number of rows present in the output from running a query before
ingestion to destination data source.
$sel:recordsIngested:ExecutionStats', executionStats_recordsIngested - The number of records ingested for a single scheduled query run.
executionStats_bytesMetered :: Lens' ExecutionStats (Maybe Integer) Source #
Bytes metered for a single scheduled query run.
executionStats_dataWrites :: Lens' ExecutionStats (Maybe Integer) Source #
Data writes metered for records ingested in a single scheduled query run.
executionStats_executionTimeInMillis :: Lens' ExecutionStats (Maybe Integer) Source #
Total time, measured in milliseconds, that was needed for the scheduled query run to complete.
executionStats_queryResultRows :: Lens' ExecutionStats (Maybe Integer) Source #
Number of rows present in the output from running a query before ingestion to destination data source.
executionStats_recordsIngested :: Lens' ExecutionStats (Maybe Integer) Source #
The number of records ingested for a single scheduled query run.
MixedMeasureMapping
data MixedMeasureMapping Source #
MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.
See: newMixedMeasureMapping smart constructor.
Constructors
| MixedMeasureMapping' | |
Fields
| |
Instances
newMixedMeasureMapping Source #
Arguments
| :: MeasureValueType | |
| -> MixedMeasureMapping |
Create a value of MixedMeasureMapping 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:measureName:MixedMeasureMapping', mixedMeasureMapping_measureName - Refers to the value of measure_name in a result row. This field is
required if MeasureNameColumn is provided.
$sel:multiMeasureAttributeMappings:MixedMeasureMapping', mixedMeasureMapping_multiMeasureAttributeMappings - Required when measureValueType is MULTI. Attribute mappings for MULTI
value measures.
MixedMeasureMapping, mixedMeasureMapping_sourceColumn - This field refers to the source column from which measure-value is to be
read for result materialization.
$sel:targetMeasureName:MixedMeasureMapping', mixedMeasureMapping_targetMeasureName - Target measure name to be used. If not provided, the target measure name
by default would be measure-name if provided, or sourceColumn otherwise.
MixedMeasureMapping, mixedMeasureMapping_measureValueType - Type of the value that is to be read from sourceColumn. If the mapping
is for MULTI, use MeasureValueType.MULTI.
mixedMeasureMapping_measureName :: Lens' MixedMeasureMapping (Maybe Text) Source #
Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.
mixedMeasureMapping_multiMeasureAttributeMappings :: Lens' MixedMeasureMapping (Maybe (NonEmpty MultiMeasureAttributeMapping)) Source #
Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.
mixedMeasureMapping_sourceColumn :: Lens' MixedMeasureMapping (Maybe Text) Source #
This field refers to the source column from which measure-value is to be read for result materialization.
mixedMeasureMapping_targetMeasureName :: Lens' MixedMeasureMapping (Maybe Text) Source #
Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.
mixedMeasureMapping_measureValueType :: Lens' MixedMeasureMapping MeasureValueType Source #
Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
MultiMeasureAttributeMapping
data MultiMeasureAttributeMapping Source #
Attribute mapping for MULTI value measures.
See: newMultiMeasureAttributeMapping smart constructor.
Constructors
| MultiMeasureAttributeMapping' | |
Fields
| |
Instances
newMultiMeasureAttributeMapping Source #
Arguments
| :: Text | |
| -> ScalarMeasureValueType | |
| -> MultiMeasureAttributeMapping |
Create a value of MultiMeasureAttributeMapping 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:targetMultiMeasureAttributeName:MultiMeasureAttributeMapping', multiMeasureAttributeMapping_targetMultiMeasureAttributeName - Custom name to be used for attribute name in derived table. If not
provided, source column name would be used.
$sel:sourceColumn:MultiMeasureAttributeMapping', multiMeasureAttributeMapping_sourceColumn - Source column from where the attribute value is to be read.
$sel:measureValueType:MultiMeasureAttributeMapping', multiMeasureAttributeMapping_measureValueType - Type of the attribute to be read from the source column.
multiMeasureAttributeMapping_targetMultiMeasureAttributeName :: Lens' MultiMeasureAttributeMapping (Maybe Text) Source #
Custom name to be used for attribute name in derived table. If not provided, source column name would be used.
multiMeasureAttributeMapping_sourceColumn :: Lens' MultiMeasureAttributeMapping Text Source #
Source column from where the attribute value is to be read.
multiMeasureAttributeMapping_measureValueType :: Lens' MultiMeasureAttributeMapping ScalarMeasureValueType Source #
Type of the attribute to be read from the source column.
MultiMeasureMappings
data MultiMeasureMappings Source #
Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.
See: newMultiMeasureMappings smart constructor.
Constructors
| MultiMeasureMappings' | |
Fields
| |
Instances
newMultiMeasureMappings Source #
Arguments
| :: NonEmpty MultiMeasureAttributeMapping | |
| -> MultiMeasureMappings |
Create a value of MultiMeasureMappings 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:targetMultiMeasureName:MultiMeasureMappings', multiMeasureMappings_targetMultiMeasureName - The name of the target multi-measure name in the derived table. This
input is required when measureNameColumn is not provided. If
MeasureNameColumn is provided, then value from that column will be used
as multi-measure name.
$sel:multiMeasureAttributeMappings:MultiMeasureMappings', multiMeasureMappings_multiMeasureAttributeMappings - Required. Attribute mappings to be used for mapping query results to
ingest data for multi-measure attributes.
multiMeasureMappings_targetMultiMeasureName :: Lens' MultiMeasureMappings (Maybe Text) Source #
The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
multiMeasureMappings_multiMeasureAttributeMappings :: Lens' MultiMeasureMappings (NonEmpty MultiMeasureAttributeMapping) Source #
Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
NotificationConfiguration
data NotificationConfiguration Source #
Notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated or when it is deleted.
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' | |
Fields
| |
Instances
newNotificationConfiguration Source #
Arguments
| :: SnsConfiguration | |
| -> NotificationConfiguration |
Create a value of NotificationConfiguration 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:snsConfiguration:NotificationConfiguration', notificationConfiguration_snsConfiguration - Details on SNS configuration.
notificationConfiguration_snsConfiguration :: Lens' NotificationConfiguration SnsConfiguration Source #
Details on SNS configuration.
ParameterMapping
data ParameterMapping Source #
Mapping for named parameters.
See: newParameterMapping smart constructor.
Constructors
| ParameterMapping' | |
Instances
Create a value of ParameterMapping 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:name:ParameterMapping', parameterMapping_name - Parameter name.
$sel:type':ParameterMapping', parameterMapping_type - Undocumented member.
parameterMapping_name :: Lens' ParameterMapping Text Source #
Parameter name.
parameterMapping_type :: Lens' ParameterMapping Type Source #
Undocumented member.
QueryStatus
data QueryStatus Source #
Information about the status of the query, including progress and bytes scanned.
See: newQueryStatus smart constructor.
Constructors
| QueryStatus' | |
Fields
| |
Instances
newQueryStatus :: QueryStatus Source #
Create a value of QueryStatus 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:cumulativeBytesMetered:QueryStatus', queryStatus_cumulativeBytesMetered - The amount of data scanned by the query in bytes that you will be
charged for. This is a cumulative sum and represents the total amount of
data that you will be charged for since the query was started. The
charge is applied only once and is either applied when the query
completes running or when the query is cancelled.
$sel:cumulativeBytesScanned:QueryStatus', queryStatus_cumulativeBytesScanned - The amount of data scanned by the query in bytes. This is a cumulative
sum and represents the total amount of bytes scanned since the query was
started.
$sel:progressPercentage:QueryStatus', queryStatus_progressPercentage - The progress of the query, expressed as a percentage.
queryStatus_cumulativeBytesMetered :: Lens' QueryStatus (Maybe Integer) Source #
The amount of data scanned by the query in bytes that you will be charged for. This is a cumulative sum and represents the total amount of data that you will be charged for since the query was started. The charge is applied only once and is either applied when the query completes running or when the query is cancelled.
queryStatus_cumulativeBytesScanned :: Lens' QueryStatus (Maybe Integer) Source #
The amount of data scanned by the query in bytes. This is a cumulative sum and represents the total amount of bytes scanned since the query was started.
queryStatus_progressPercentage :: Lens' QueryStatus (Maybe Double) Source #
The progress of the query, expressed as a percentage.
Row
Represents a single row in the query results.
See: newRow smart constructor.
Instances
Create a value of Row 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:data':Row', row_data - List of data points in a single row of the result set.
S3Configuration
data S3Configuration Source #
Details on S3 location for error reports that result from running a query.
See: newS3Configuration smart constructor.
Constructors
| S3Configuration' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> S3Configuration |
Create a value of S3Configuration 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:encryptionOption:S3Configuration', s3Configuration_encryptionOption - Encryption at rest options for the error reports. If no encryption
option is specified, Timestream will choose SSE_S3 as default.
$sel:objectKeyPrefix:S3Configuration', s3Configuration_objectKeyPrefix - Prefix for the error report key. Timestream by default adds the
following prefix to the error report path.
$sel:bucketName:S3Configuration', s3Configuration_bucketName - Name of the S3 bucket under which error reports will be created.
s3Configuration_encryptionOption :: Lens' S3Configuration (Maybe S3EncryptionOption) Source #
Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
s3Configuration_objectKeyPrefix :: Lens' S3Configuration (Maybe Text) Source #
Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
s3Configuration_bucketName :: Lens' S3Configuration Text Source #
Name of the S3 bucket under which error reports will be created.
S3ReportLocation
data S3ReportLocation Source #
S3 report location for the scheduled query run.
See: newS3ReportLocation smart constructor.
Constructors
| S3ReportLocation' | |
Instances
newS3ReportLocation :: S3ReportLocation Source #
Create a value of S3ReportLocation 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:bucketName:S3ReportLocation', s3ReportLocation_bucketName - S3 bucket name.
$sel:objectKey:S3ReportLocation', s3ReportLocation_objectKey - S3 key.
s3ReportLocation_bucketName :: Lens' S3ReportLocation (Maybe Text) Source #
S3 bucket name.
s3ReportLocation_objectKey :: Lens' S3ReportLocation (Maybe Text) Source #
S3 key.
ScheduleConfiguration
data ScheduleConfiguration Source #
Configuration of the schedule of the query.
See: newScheduleConfiguration smart constructor.
Constructors
| ScheduleConfiguration' | |
Fields
| |
Instances
newScheduleConfiguration Source #
Create a value of ScheduleConfiguration 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:scheduleExpression:ScheduleConfiguration', scheduleConfiguration_scheduleExpression - An expression that denotes when to trigger the scheduled query run. This
can be a cron expression or a rate expression.
scheduleConfiguration_scheduleExpression :: Lens' ScheduleConfiguration Text Source #
An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
ScheduledQuery
data ScheduledQuery Source #
Scheduled Query
See: newScheduledQuery smart constructor.
Constructors
| ScheduledQuery' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ScheduledQueryState | |
| -> ScheduledQuery |
Create a value of ScheduledQuery 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:ScheduledQuery', scheduledQuery_creationTime - The creation time of the scheduled query.
$sel:errorReportConfiguration:ScheduledQuery', scheduledQuery_errorReportConfiguration - Configuration for scheduled query error reporting.
$sel:lastRunStatus:ScheduledQuery', scheduledQuery_lastRunStatus - Status of the last scheduled query run.
$sel:nextInvocationTime:ScheduledQuery', scheduledQuery_nextInvocationTime - The next time the scheduled query is to be run.
$sel:previousInvocationTime:ScheduledQuery', scheduledQuery_previousInvocationTime - The last time the scheduled query was run.
$sel:targetDestination:ScheduledQuery', scheduledQuery_targetDestination - Target data source where final scheduled query result will be written.
$sel:arn:ScheduledQuery', scheduledQuery_arn - The Amazon Resource Name.
$sel:name:ScheduledQuery', scheduledQuery_name - The name of the scheduled query.
$sel:state:ScheduledQuery', scheduledQuery_state - State of scheduled query.
scheduledQuery_creationTime :: Lens' ScheduledQuery (Maybe UTCTime) Source #
The creation time of the scheduled query.
scheduledQuery_errorReportConfiguration :: Lens' ScheduledQuery (Maybe ErrorReportConfiguration) Source #
Configuration for scheduled query error reporting.
scheduledQuery_lastRunStatus :: Lens' ScheduledQuery (Maybe ScheduledQueryRunStatus) Source #
Status of the last scheduled query run.
scheduledQuery_nextInvocationTime :: Lens' ScheduledQuery (Maybe UTCTime) Source #
The next time the scheduled query is to be run.
scheduledQuery_previousInvocationTime :: Lens' ScheduledQuery (Maybe UTCTime) Source #
The last time the scheduled query was run.
scheduledQuery_targetDestination :: Lens' ScheduledQuery (Maybe TargetDestination) Source #
Target data source where final scheduled query result will be written.
scheduledQuery_arn :: Lens' ScheduledQuery Text Source #
The Amazon Resource Name.
scheduledQuery_name :: Lens' ScheduledQuery Text Source #
The name of the scheduled query.
scheduledQuery_state :: Lens' ScheduledQuery ScheduledQueryState Source #
State of scheduled query.
ScheduledQueryDescription
data ScheduledQueryDescription Source #
Structure that describes scheduled query.
See: newScheduledQueryDescription smart constructor.
Constructors
| ScheduledQueryDescription' | |
Fields
| |
Instances
newScheduledQueryDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ScheduledQueryState | |
| -> ScheduleConfiguration | |
| -> NotificationConfiguration | |
| -> 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) Source #
Creation time of the scheduled query.
scheduledQueryDescription_errorReportConfiguration :: Lens' ScheduledQueryDescription (Maybe ErrorReportConfiguration) Source #
Error-reporting configuration for the scheduled query.
scheduledQueryDescription_kmsKeyId :: Lens' ScheduledQueryDescription (Maybe Text) Source #
A customer provided KMS key used to encrypt the scheduled query resource.
scheduledQueryDescription_lastRunSummary :: Lens' ScheduledQueryDescription (Maybe ScheduledQueryRunSummary) Source #
Runtime summary for the last scheduled query run.
scheduledQueryDescription_nextInvocationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime) Source #
The next time the scheduled query is scheduled to run.
scheduledQueryDescription_previousInvocationTime :: Lens' ScheduledQueryDescription (Maybe UTCTime) Source #
Last time the query was run.
scheduledQueryDescription_recentlyFailedRuns :: Lens' ScheduledQueryDescription (Maybe [ScheduledQueryRunSummary]) Source #
Runtime summary for the last five failed scheduled query runs.
scheduledQueryDescription_scheduledQueryExecutionRoleArn :: Lens' ScheduledQueryDescription (Maybe Text) Source #
IAM role that Timestream uses to run the schedule query.
scheduledQueryDescription_targetConfiguration :: Lens' ScheduledQueryDescription (Maybe TargetConfiguration) Source #
Scheduled query target store configuration.
scheduledQueryDescription_arn :: Lens' ScheduledQueryDescription Text Source #
Scheduled query ARN.
scheduledQueryDescription_name :: Lens' ScheduledQueryDescription Text Source #
Name of the scheduled query.
scheduledQueryDescription_queryString :: Lens' ScheduledQueryDescription Text Source #
The query to be run.
scheduledQueryDescription_state :: Lens' ScheduledQueryDescription ScheduledQueryState Source #
State of the scheduled query.
scheduledQueryDescription_scheduleConfiguration :: Lens' ScheduledQueryDescription ScheduleConfiguration Source #
Schedule configuration.
scheduledQueryDescription_notificationConfiguration :: Lens' ScheduledQueryDescription NotificationConfiguration Source #
Notification configuration.
ScheduledQueryRunSummary
data ScheduledQueryRunSummary Source #
Run summary for the scheduled query
See: newScheduledQueryRunSummary smart constructor.
Constructors
| ScheduledQueryRunSummary' | |
Fields
| |
Instances
newScheduledQueryRunSummary :: ScheduledQueryRunSummary Source #
Create a value of ScheduledQueryRunSummary 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:errorReportLocation:ScheduledQueryRunSummary', scheduledQueryRunSummary_errorReportLocation - S3 location for error report.
$sel:executionStats:ScheduledQueryRunSummary', scheduledQueryRunSummary_executionStats - Runtime statistics for a scheduled run.
$sel:failureReason:ScheduledQueryRunSummary', scheduledQueryRunSummary_failureReason - Error message for the scheduled query in case of failure. You might have
to look at the error report to get more detailed error reasons.
$sel:invocationTime:ScheduledQueryRunSummary', scheduledQueryRunSummary_invocationTime - InvocationTime for this run. This is the time at which the query is
scheduled to run. Parameter @scheduled_runtime can be used in the
query to get the value.
$sel:runStatus:ScheduledQueryRunSummary', scheduledQueryRunSummary_runStatus - The status of a scheduled query run.
$sel:triggerTime:ScheduledQueryRunSummary', scheduledQueryRunSummary_triggerTime - The actual time when the query was run.
scheduledQueryRunSummary_errorReportLocation :: Lens' ScheduledQueryRunSummary (Maybe ErrorReportLocation) Source #
S3 location for error report.
scheduledQueryRunSummary_executionStats :: Lens' ScheduledQueryRunSummary (Maybe ExecutionStats) Source #
Runtime statistics for a scheduled run.
scheduledQueryRunSummary_failureReason :: Lens' ScheduledQueryRunSummary (Maybe Text) Source #
Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.
scheduledQueryRunSummary_invocationTime :: Lens' ScheduledQueryRunSummary (Maybe UTCTime) Source #
InvocationTime for this run. This is the time at which the query is
scheduled to run. Parameter @scheduled_runtime can be used in the
query to get the value.
scheduledQueryRunSummary_runStatus :: Lens' ScheduledQueryRunSummary (Maybe ScheduledQueryRunStatus) Source #
The status of a scheduled query run.
scheduledQueryRunSummary_triggerTime :: Lens' ScheduledQueryRunSummary (Maybe UTCTime) Source #
The actual time when the query was run.
SelectColumn
data SelectColumn Source #
Details of the column that is returned by the query.
See: newSelectColumn smart constructor.
Constructors
| SelectColumn' | |
Instances
newSelectColumn :: SelectColumn Source #
Create a value of SelectColumn 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:aliased:SelectColumn', selectColumn_aliased - True, if the column name was aliased by the query. False otherwise.
$sel:databaseName:SelectColumn', selectColumn_databaseName - Database that has this column.
$sel:name:SelectColumn', selectColumn_name - Name of the column.
$sel:tableName:SelectColumn', selectColumn_tableName - Table within the database that has this column.
$sel:type':SelectColumn', selectColumn_type - Undocumented member.
selectColumn_aliased :: Lens' SelectColumn (Maybe Bool) Source #
True, if the column name was aliased by the query. False otherwise.
selectColumn_databaseName :: Lens' SelectColumn (Maybe Text) Source #
Database that has this column.
selectColumn_name :: Lens' SelectColumn (Maybe Text) Source #
Name of the column.
selectColumn_tableName :: Lens' SelectColumn (Maybe Text) Source #
Table within the database that has this column.
selectColumn_type :: Lens' SelectColumn (Maybe Type) Source #
Undocumented member.
SnsConfiguration
data SnsConfiguration Source #
Details on SNS that are required to send the notification.
See: newSnsConfiguration smart constructor.
Constructors
| SnsConfiguration' | |
Instances
Arguments
| :: Text | |
| -> SnsConfiguration |
Create a value of SnsConfiguration 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:topicArn:SnsConfiguration', snsConfiguration_topicArn - SNS topic ARN that the scheduled query status notifications will be sent
to.
snsConfiguration_topicArn :: Lens' SnsConfiguration Text Source #
SNS topic ARN that the scheduled query status notifications will be sent to.
Tag
A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.TimeStreamQuery.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.TimeStreamQuery.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.TimeStreamQuery.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.TimeStreamQuery.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.TimeStreamQuery.Types.Tag" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - The key of the tag. Tag keys are case sensitive.
$sel:value:Tag', tag_value - The value of the tag. Tag values are case sensitive and can be null.
tag_value :: Lens' Tag Text Source #
The value of the tag. Tag values are case sensitive and can be null.
TargetConfiguration
data TargetConfiguration Source #
Configuration used for writing the output of a query.
See: newTargetConfiguration smart constructor.
Constructors
| TargetConfiguration' | |
Fields
| |
Instances
newTargetConfiguration Source #
Arguments
| :: TimestreamConfiguration | |
| -> TargetConfiguration |
Create a value of TargetConfiguration 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:timestreamConfiguration:TargetConfiguration', targetConfiguration_timestreamConfiguration - Configuration needed to write data into the Timestream database and
table.
targetConfiguration_timestreamConfiguration :: Lens' TargetConfiguration TimestreamConfiguration Source #
Configuration needed to write data into the Timestream database and table.
TargetDestination
data TargetDestination Source #
Destination details to write data for a target data source. Current supported data source is Timestream.
See: newTargetDestination smart constructor.
Constructors
| TargetDestination' | |
Fields
| |
Instances
newTargetDestination :: TargetDestination Source #
Create a value of TargetDestination 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:timestreamDestination:TargetDestination', targetDestination_timestreamDestination - Query result destination details for Timestream data source.
targetDestination_timestreamDestination :: Lens' TargetDestination (Maybe TimestreamDestination) Source #
Query result destination details for Timestream data source.
TimeSeriesDataPoint
data TimeSeriesDataPoint Source #
The timeseries data type represents the values of a measure over time. A time series is an array of rows of timestamps and measure values, with rows sorted in ascending order of time. A TimeSeriesDataPoint is a single data point in the time series. It represents a tuple of (time, measure value) in a time series.
See: newTimeSeriesDataPoint smart constructor.
Constructors
| TimeSeriesDataPoint' | |
Instances
newTimeSeriesDataPoint Source #
Arguments
| :: Text | |
| -> Datum | |
| -> TimeSeriesDataPoint |
Create a value of TimeSeriesDataPoint 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:time:TimeSeriesDataPoint', timeSeriesDataPoint_time - The timestamp when the measure value was collected.
$sel:value:TimeSeriesDataPoint', timeSeriesDataPoint_value - The measure value for the data point.
timeSeriesDataPoint_time :: Lens' TimeSeriesDataPoint Text Source #
The timestamp when the measure value was collected.
timeSeriesDataPoint_value :: Lens' TimeSeriesDataPoint Datum Source #
The measure value for the data point.
TimestreamConfiguration
data TimestreamConfiguration Source #
Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns.
See: newTimestreamConfiguration smart constructor.
Constructors
| TimestreamConfiguration' | |
Fields
| |
Instances
newTimestreamConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TimestreamConfiguration |
Create a value of TimestreamConfiguration 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:measureNameColumn:TimestreamConfiguration', timestreamConfiguration_measureNameColumn - Name of the measure column.
$sel:mixedMeasureMappings:TimestreamConfiguration', timestreamConfiguration_mixedMeasureMappings - Specifies how to map measures to multi-measure records.
$sel:multiMeasureMappings:TimestreamConfiguration', timestreamConfiguration_multiMeasureMappings - Multi-measure mappings.
$sel:databaseName:TimestreamConfiguration', timestreamConfiguration_databaseName - Name of Timestream database to which the query result will be written.
$sel:tableName:TimestreamConfiguration', timestreamConfiguration_tableName - Name of Timestream table that the query result will be written to. The
table should be within the same database that is provided in Timestream
configuration.
$sel:timeColumn:TimestreamConfiguration', timestreamConfiguration_timeColumn - Column from query result that should be used as the time column in
destination table. Column type for this should be TIMESTAMP.
$sel:dimensionMappings:TimestreamConfiguration', timestreamConfiguration_dimensionMappings - This is to allow mapping column(s) from the query result to the
dimension in the destination table.
timestreamConfiguration_measureNameColumn :: Lens' TimestreamConfiguration (Maybe Text) Source #
Name of the measure column.
timestreamConfiguration_mixedMeasureMappings :: Lens' TimestreamConfiguration (Maybe (NonEmpty MixedMeasureMapping)) Source #
Specifies how to map measures to multi-measure records.
timestreamConfiguration_multiMeasureMappings :: Lens' TimestreamConfiguration (Maybe MultiMeasureMappings) Source #
Multi-measure mappings.
timestreamConfiguration_databaseName :: Lens' TimestreamConfiguration Text Source #
Name of Timestream database to which the query result will be written.
timestreamConfiguration_tableName :: Lens' TimestreamConfiguration Text Source #
Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
timestreamConfiguration_timeColumn :: Lens' TimestreamConfiguration Text Source #
Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
timestreamConfiguration_dimensionMappings :: Lens' TimestreamConfiguration [DimensionMapping] Source #
This is to allow mapping column(s) from the query result to the dimension in the destination table.
TimestreamDestination
data TimestreamDestination Source #
Destination for scheduled query.
See: newTimestreamDestination smart constructor.
Constructors
| TimestreamDestination' | |
Instances
newTimestreamDestination :: TimestreamDestination Source #
Create a value of TimestreamDestination 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:databaseName:TimestreamDestination', timestreamDestination_databaseName - Timestream database name.
$sel:tableName:TimestreamDestination', timestreamDestination_tableName - Timestream table name.
timestreamDestination_databaseName :: Lens' TimestreamDestination (Maybe Text) Source #
Timestream database name.
timestreamDestination_tableName :: Lens' TimestreamDestination (Maybe Text) Source #
Timestream table name.
Type
Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.
See: newType smart constructor.
Constructors
| Type' | |
Fields
| |
Instances
Create a value of Type 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:arrayColumnInfo:Type', type_arrayColumnInfo - Indicates if the column is an array.
$sel:rowColumnInfo:Type', type_rowColumnInfo - Indicates if the column is a row.
$sel:scalarType:Type', type_scalarType - Indicates if the column is of type string, integer, Boolean, double,
timestamp, date, time.
$sel:timeSeriesMeasureValueColumnInfo:Type', type_timeSeriesMeasureValueColumnInfo - Indicates if the column is a timeseries data type.
type_arrayColumnInfo :: Lens' Type (Maybe ColumnInfo) Source #
Indicates if the column is an array.
type_rowColumnInfo :: Lens' Type (Maybe [ColumnInfo]) Source #
Indicates if the column is a row.
type_scalarType :: Lens' Type (Maybe ScalarType) Source #
Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time.
type_timeSeriesMeasureValueColumnInfo :: Lens' Type (Maybe ColumnInfo) Source #
Indicates if the column is a timeseries data type.