| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- 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
Derived from API version 2018-11-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Timestream Query
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
- data CancelQuery = CancelQuery' Text
- newCancelQuery :: Text -> CancelQuery
- data CancelQueryResponse = CancelQueryResponse' (Maybe Text) Int
- newCancelQueryResponse :: Int -> CancelQueryResponse
- data CreateScheduledQuery = CreateScheduledQuery' (Maybe (Sensitive Text)) (Maybe Text) (Maybe [Tag]) (Maybe TargetConfiguration) Text (Sensitive Text) ScheduleConfiguration NotificationConfiguration Text ErrorReportConfiguration
- newCreateScheduledQuery :: Text -> Text -> ScheduleConfiguration -> NotificationConfiguration -> Text -> ErrorReportConfiguration -> CreateScheduledQuery
- data CreateScheduledQueryResponse = CreateScheduledQueryResponse' Int Text
- newCreateScheduledQueryResponse :: Int -> Text -> CreateScheduledQueryResponse
- data DeleteScheduledQuery = DeleteScheduledQuery' Text
- newDeleteScheduledQuery :: Text -> DeleteScheduledQuery
- data DeleteScheduledQueryResponse = DeleteScheduledQueryResponse' {
- newDeleteScheduledQueryResponse :: DeleteScheduledQueryResponse
- data DescribeEndpoints = DescribeEndpoints' {
- newDescribeEndpoints :: DescribeEndpoints
- data DescribeEndpointsResponse = DescribeEndpointsResponse' Int [Endpoint]
- newDescribeEndpointsResponse :: Int -> DescribeEndpointsResponse
- data DescribeScheduledQuery = DescribeScheduledQuery' Text
- newDescribeScheduledQuery :: Text -> DescribeScheduledQuery
- data DescribeScheduledQueryResponse = DescribeScheduledQueryResponse' Int ScheduledQueryDescription
- newDescribeScheduledQueryResponse :: Int -> ScheduledQueryDescription -> DescribeScheduledQueryResponse
- data ExecuteScheduledQuery = ExecuteScheduledQuery' (Maybe (Sensitive Text)) Text POSIX
- newExecuteScheduledQuery :: Text -> UTCTime -> ExecuteScheduledQuery
- data ExecuteScheduledQueryResponse = ExecuteScheduledQueryResponse' {
- newExecuteScheduledQueryResponse :: ExecuteScheduledQueryResponse
- data ListScheduledQueries = ListScheduledQueries' (Maybe Natural) (Maybe Text)
- newListScheduledQueries :: ListScheduledQueries
- data ListScheduledQueriesResponse = ListScheduledQueriesResponse' (Maybe Text) Int [ScheduledQuery]
- newListScheduledQueriesResponse :: Int -> ListScheduledQueriesResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) Int [Tag]
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PrepareQuery = PrepareQuery' (Maybe Bool) (Sensitive Text)
- newPrepareQuery :: Text -> PrepareQuery
- data PrepareQueryResponse = PrepareQueryResponse' Int (Sensitive Text) [SelectColumn] [ParameterMapping]
- newPrepareQueryResponse :: Int -> Text -> PrepareQueryResponse
- data Query = Query' (Maybe (Sensitive Text)) (Maybe Natural) (Maybe Text) (Sensitive Text)
- newQuery :: Text -> Query
- data QueryResponse = QueryResponse' (Maybe Text) (Maybe QueryStatus) Int Text [Row] [ColumnInfo]
- newQueryResponse :: Int -> Text -> QueryResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateScheduledQuery = UpdateScheduledQuery' Text ScheduledQueryState
- newUpdateScheduledQuery :: Text -> ScheduledQueryState -> UpdateScheduledQuery
- data UpdateScheduledQueryResponse = UpdateScheduledQueryResponse' {
- newUpdateScheduledQueryResponse :: UpdateScheduledQueryResponse
- 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' (Maybe Text) Type
- newColumnInfo :: Type -> ColumnInfo
- data Datum = Datum' (Maybe [Datum]) (Maybe Bool) (Maybe Row) (Maybe Text) (Maybe [TimeSeriesDataPoint])
- newDatum :: Datum
- data DimensionMapping = DimensionMapping' Text DimensionValueType
- newDimensionMapping :: Text -> DimensionValueType -> DimensionMapping
- data Endpoint = Endpoint' Text Integer
- newEndpoint :: Text -> Integer -> Endpoint
- data ErrorReportConfiguration = ErrorReportConfiguration' S3Configuration
- newErrorReportConfiguration :: S3Configuration -> ErrorReportConfiguration
- data ErrorReportLocation = ErrorReportLocation' (Maybe S3ReportLocation)
- newErrorReportLocation :: ErrorReportLocation
- data ExecutionStats = ExecutionStats' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newExecutionStats :: ExecutionStats
- data MixedMeasureMapping = MixedMeasureMapping' (Maybe Text) (Maybe (NonEmpty MultiMeasureAttributeMapping)) (Maybe Text) (Maybe Text) MeasureValueType
- newMixedMeasureMapping :: MeasureValueType -> MixedMeasureMapping
- data MultiMeasureAttributeMapping = MultiMeasureAttributeMapping' (Maybe Text) Text ScalarMeasureValueType
- newMultiMeasureAttributeMapping :: Text -> ScalarMeasureValueType -> MultiMeasureAttributeMapping
- data MultiMeasureMappings = MultiMeasureMappings' (Maybe Text) (NonEmpty MultiMeasureAttributeMapping)
- newMultiMeasureMappings :: NonEmpty MultiMeasureAttributeMapping -> MultiMeasureMappings
- data NotificationConfiguration = NotificationConfiguration' SnsConfiguration
- newNotificationConfiguration :: SnsConfiguration -> NotificationConfiguration
- data ParameterMapping = ParameterMapping' Text Type
- newParameterMapping :: Text -> Type -> ParameterMapping
- data QueryStatus = QueryStatus' (Maybe Integer) (Maybe Integer) (Maybe Double)
- newQueryStatus :: QueryStatus
- data Row = Row' [Datum]
- newRow :: Row
- data S3Configuration = S3Configuration' (Maybe S3EncryptionOption) (Maybe Text) Text
- newS3Configuration :: Text -> S3Configuration
- data S3ReportLocation = S3ReportLocation' (Maybe Text) (Maybe Text)
- newS3ReportLocation :: S3ReportLocation
- data ScheduleConfiguration = ScheduleConfiguration' Text
- newScheduleConfiguration :: Text -> ScheduleConfiguration
- data ScheduledQuery = ScheduledQuery' (Maybe POSIX) (Maybe ErrorReportConfiguration) (Maybe ScheduledQueryRunStatus) (Maybe POSIX) (Maybe POSIX) (Maybe TargetDestination) Text Text ScheduledQueryState
- newScheduledQuery :: Text -> Text -> ScheduledQueryState -> ScheduledQuery
- data ScheduledQueryDescription = ScheduledQueryDescription' (Maybe POSIX) (Maybe ErrorReportConfiguration) (Maybe Text) (Maybe ScheduledQueryRunSummary) (Maybe POSIX) (Maybe POSIX) (Maybe [ScheduledQueryRunSummary]) (Maybe Text) (Maybe TargetConfiguration) Text Text (Sensitive Text) ScheduledQueryState ScheduleConfiguration NotificationConfiguration
- newScheduledQueryDescription :: Text -> Text -> Text -> ScheduledQueryState -> ScheduleConfiguration -> NotificationConfiguration -> ScheduledQueryDescription
- data ScheduledQueryRunSummary = ScheduledQueryRunSummary' (Maybe ErrorReportLocation) (Maybe ExecutionStats) (Maybe Text) (Maybe POSIX) (Maybe ScheduledQueryRunStatus) (Maybe POSIX)
- newScheduledQueryRunSummary :: ScheduledQueryRunSummary
- data SelectColumn = SelectColumn' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Type)
- newSelectColumn :: SelectColumn
- data SnsConfiguration = SnsConfiguration' Text
- newSnsConfiguration :: Text -> SnsConfiguration
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TargetConfiguration = TargetConfiguration' TimestreamConfiguration
- newTargetConfiguration :: TimestreamConfiguration -> TargetConfiguration
- data TargetDestination = TargetDestination' (Maybe TimestreamDestination)
- newTargetDestination :: TargetDestination
- data TimeSeriesDataPoint = TimeSeriesDataPoint' Text Datum
- newTimeSeriesDataPoint :: Text -> Datum -> TimeSeriesDataPoint
- data TimestreamConfiguration = TimestreamConfiguration' (Maybe Text) (Maybe (NonEmpty MixedMeasureMapping)) (Maybe MultiMeasureMappings) Text Text Text [DimensionMapping]
- newTimestreamConfiguration :: Text -> Text -> Text -> TimestreamConfiguration
- data TimestreamDestination = TimestreamDestination' (Maybe Text) (Maybe Text)
- newTimestreamDestination :: TimestreamDestination
- data Type = Type' (Maybe ColumnInfo) (Maybe [ColumnInfo]) (Maybe ScalarType) (Maybe ColumnInfo)
- newType :: Type
Service Configuration
defaultService :: Service Source #
API version 2018-11-01 of the Amazon Timestream Query SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by TimeStreamQuery.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You are not authorized to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Unable to poll results for a cancelled query.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Timestream was unable to fully process this request because of an internal server error.
InvalidEndpointException
_InvalidEndpointException :: AsError a => Fold a ServiceError Source #
The requested endpoint was not valid.
QueryExecutionException
_QueryExecutionException :: AsError a => Fold a ServiceError Source #
Timestream was unable to run the query successfully.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource could not be found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
You have exceeded the service quota.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Invalid or malformed request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelQuery
data CancelQuery Source #
See: newCancelQuery smart constructor.
Constructors
| CancelQuery' Text |
Instances
Arguments
| :: Text | |
| -> CancelQuery |
Create a value of CancelQuery 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:queryId:CancelQuery', cancelQuery_queryId - The ID of the query that needs to be cancelled. QueryID is returned as
part of the query result.
data CancelQueryResponse Source #
See: newCancelQueryResponse smart constructor.
Constructors
| CancelQueryResponse' (Maybe Text) Int |
Instances
newCancelQueryResponse Source #
Arguments
| :: Int | |
| -> CancelQueryResponse |
Create a value of CancelQueryResponse 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:cancellationMessage:CancelQueryResponse', cancelQueryResponse_cancellationMessage - A CancellationMessage is returned when a CancelQuery request for the
query specified by QueryId has already been issued.
$sel:httpStatus:CancelQueryResponse', cancelQueryResponse_httpStatus - The response's http status code.
CreateScheduledQuery
data CreateScheduledQuery Source #
See: newCreateScheduledQuery smart constructor.
Constructors
Instances
newCreateScheduledQuery Source #
Arguments
| :: Text | |
| -> Text | |
| -> ScheduleConfiguration | |
| -> NotificationConfiguration | |
| -> Text | |
| -> ErrorReportConfiguration | |
| -> CreateScheduledQuery |
Create a value of CreateScheduledQuery 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:clientToken:CreateScheduledQuery', createScheduledQuery_clientToken - Using a ClientToken makes the call to CreateScheduledQuery idempotent,
in other words, making the same request repeatedly will produce the same
result. Making multiple identical CreateScheduledQuery requests has the
same effect as making a single request.
- If CreateScheduledQuery is called without a
ClientToken, the Query SDK generates aClientTokenon your behalf. - After 8 hours, any request with the same
ClientTokenis treated as a new request.
CreateScheduledQuery, createScheduledQuery_kmsKeyId - 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.
$sel:tags:CreateScheduledQuery', createScheduledQuery_tags - A list of key-value pairs to label the scheduled query.
CreateScheduledQuery, createScheduledQuery_targetConfiguration - Configuration used for writing the result of a query.
CreateScheduledQuery, createScheduledQuery_name - Name of the scheduled query.
CreateScheduledQuery, createScheduledQuery_queryString - 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.
CreateScheduledQuery, createScheduledQuery_scheduleConfiguration - The schedule configuration for the query.
CreateScheduledQuery, createScheduledQuery_notificationConfiguration - 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.
CreateScheduledQuery, createScheduledQuery_scheduledQueryExecutionRoleArn - The ARN for the IAM role that Timestream will assume when running the
scheduled query.
CreateScheduledQuery, createScheduledQuery_errorReportConfiguration - Configuration for error reporting. Error reports will be generated when
a problem is encountered when writing the query results.
data CreateScheduledQueryResponse Source #
See: newCreateScheduledQueryResponse smart constructor.
Constructors
| CreateScheduledQueryResponse' Int Text |
Instances
newCreateScheduledQueryResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateScheduledQueryResponse |
Create a value of CreateScheduledQueryResponse 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:httpStatus:CreateScheduledQueryResponse', createScheduledQueryResponse_httpStatus - The response's http status code.
CreateScheduledQueryResponse, createScheduledQueryResponse_arn - ARN for the created scheduled query.
DeleteScheduledQuery
data DeleteScheduledQuery Source #
See: newDeleteScheduledQuery smart constructor.
Constructors
| DeleteScheduledQuery' Text |
Instances
newDeleteScheduledQuery Source #
Create a value of DeleteScheduledQuery 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:scheduledQueryArn:DeleteScheduledQuery', deleteScheduledQuery_scheduledQueryArn - The ARN of the scheduled query.
data DeleteScheduledQueryResponse Source #
See: newDeleteScheduledQueryResponse smart constructor.
Constructors
| DeleteScheduledQueryResponse' | |
Instances
| Generic DeleteScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.DeleteScheduledQuery Associated Types type Rep DeleteScheduledQueryResponse :: Type -> Type # | |
| Read DeleteScheduledQueryResponse Source # | |
| Show DeleteScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.DeleteScheduledQuery Methods showsPrec :: Int -> DeleteScheduledQueryResponse -> ShowS # show :: DeleteScheduledQueryResponse -> String # showList :: [DeleteScheduledQueryResponse] -> ShowS # | |
| NFData DeleteScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.DeleteScheduledQuery Methods rnf :: DeleteScheduledQueryResponse -> () # | |
| Eq DeleteScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.DeleteScheduledQuery Methods (==) :: DeleteScheduledQueryResponse -> DeleteScheduledQueryResponse -> Bool # (/=) :: DeleteScheduledQueryResponse -> DeleteScheduledQueryResponse -> Bool # | |
| type Rep DeleteScheduledQueryResponse Source # | |
newDeleteScheduledQueryResponse :: DeleteScheduledQueryResponse Source #
Create a value of DeleteScheduledQueryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeEndpoints
data DescribeEndpoints Source #
See: newDescribeEndpoints smart constructor.
Constructors
| DescribeEndpoints' | |
Instances
newDescribeEndpoints :: DescribeEndpoints Source #
Create a value of DescribeEndpoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeEndpointsResponse Source #
See: newDescribeEndpointsResponse smart constructor.
Constructors
| DescribeEndpointsResponse' Int [Endpoint] |
Instances
newDescribeEndpointsResponse Source #
Create a value of DescribeEndpointsResponse 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:httpStatus:DescribeEndpointsResponse', describeEndpointsResponse_httpStatus - The response's http status code.
$sel:endpoints:DescribeEndpointsResponse', describeEndpointsResponse_endpoints - An Endpoints object is returned when a DescribeEndpoints request is
made.
DescribeScheduledQuery
data DescribeScheduledQuery Source #
See: newDescribeScheduledQuery smart constructor.
Constructors
| DescribeScheduledQuery' Text |
Instances
newDescribeScheduledQuery Source #
Create a value of DescribeScheduledQuery 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:scheduledQueryArn:DescribeScheduledQuery', describeScheduledQuery_scheduledQueryArn - The ARN of the scheduled query.
data DescribeScheduledQueryResponse Source #
See: newDescribeScheduledQueryResponse smart constructor.
Instances
newDescribeScheduledQueryResponse Source #
Arguments
| :: Int | |
| -> ScheduledQueryDescription | |
| -> DescribeScheduledQueryResponse |
Create a value of DescribeScheduledQueryResponse 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:httpStatus:DescribeScheduledQueryResponse', describeScheduledQueryResponse_httpStatus - The response's http status code.
$sel:scheduledQuery:DescribeScheduledQueryResponse', describeScheduledQueryResponse_scheduledQuery - The scheduled query.
ExecuteScheduledQuery
data ExecuteScheduledQuery Source #
See: newExecuteScheduledQuery smart constructor.
Instances
newExecuteScheduledQuery Source #
Arguments
| :: Text | |
| -> UTCTime | |
| -> ExecuteScheduledQuery |
Create a value of ExecuteScheduledQuery 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:clientToken:ExecuteScheduledQuery', executeScheduledQuery_clientToken - Not used.
$sel:scheduledQueryArn:ExecuteScheduledQuery', executeScheduledQuery_scheduledQueryArn - ARN of the scheduled query.
ExecuteScheduledQuery, executeScheduledQuery_invocationTime - The timestamp in UTC. Query will be run as if it was invoked at this
timestamp.
data ExecuteScheduledQueryResponse Source #
See: newExecuteScheduledQueryResponse smart constructor.
Constructors
| ExecuteScheduledQueryResponse' | |
Instances
| Generic ExecuteScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.ExecuteScheduledQuery Associated Types type Rep ExecuteScheduledQueryResponse :: Type -> Type # | |
| Read ExecuteScheduledQueryResponse Source # | |
| Show ExecuteScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.ExecuteScheduledQuery Methods showsPrec :: Int -> ExecuteScheduledQueryResponse -> ShowS # show :: ExecuteScheduledQueryResponse -> String # showList :: [ExecuteScheduledQueryResponse] -> ShowS # | |
| NFData ExecuteScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.ExecuteScheduledQuery Methods rnf :: ExecuteScheduledQueryResponse -> () # | |
| Eq ExecuteScheduledQueryResponse Source # | |
| type Rep ExecuteScheduledQueryResponse Source # | |
newExecuteScheduledQueryResponse :: ExecuteScheduledQueryResponse Source #
Create a value of ExecuteScheduledQueryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListScheduledQueries (Paginated)
data ListScheduledQueries Source #
See: newListScheduledQueries smart constructor.
Constructors
| ListScheduledQueries' (Maybe Natural) (Maybe Text) |
Instances
newListScheduledQueries :: ListScheduledQueries Source #
Create a value of ListScheduledQueries 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:maxResults:ListScheduledQueries', listScheduledQueries_maxResults - The maximum number of items to return in the output. If the total number
of items available is more than the value specified, a NextToken is
provided in the output. To resume pagination, provide the NextToken
value as the argument to the subsequent call to
ListScheduledQueriesRequest.
ListScheduledQueries, listScheduledQueries_nextToken - A pagination token to resume pagination.
data ListScheduledQueriesResponse Source #
See: newListScheduledQueriesResponse smart constructor.
Constructors
| ListScheduledQueriesResponse' (Maybe Text) Int [ScheduledQuery] |
Instances
newListScheduledQueriesResponse Source #
Create a value of ListScheduledQueriesResponse 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:
ListScheduledQueries, listScheduledQueriesResponse_nextToken - A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:httpStatus:ListScheduledQueriesResponse', listScheduledQueriesResponse_httpStatus - The response's http status code.
$sel:scheduledQueries:ListScheduledQueriesResponse', listScheduledQueriesResponse_scheduledQueries - A list of scheduled queries.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:maxResults:ListTagsForResource', listTagsForResource_maxResults - The maximum number of tags to return.
ListTagsForResource, listTagsForResource_nextToken - A pagination token to resume pagination.
$sel:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The Timestream resource with tags to be listed. This value is an Amazon
Resource Name (ARN).
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe Text) Int [Tag] |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResource, listTagsForResourceResponse_nextToken - A pagination token to resume pagination with a subsequent call to
ListTagsForResourceResponse.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags currently associated with the Timestream resource.
PrepareQuery
data PrepareQuery Source #
See: newPrepareQuery smart constructor.
Constructors
| PrepareQuery' (Maybe Bool) (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> PrepareQuery |
Create a value of PrepareQuery 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:validateOnly:PrepareQuery', prepareQuery_validateOnly - By setting this value to true, Timestream will only validate that the
query string is a valid Timestream query, and not store the prepared
query for later use.
PrepareQuery, prepareQuery_queryString - The Timestream query string that you want to use as a prepared
statement. Parameter names can be specified in the query string @
character followed by an identifier.
data PrepareQueryResponse Source #
See: newPrepareQueryResponse smart constructor.
Constructors
| PrepareQueryResponse' Int (Sensitive Text) [SelectColumn] [ParameterMapping] |
Instances
newPrepareQueryResponse Source #
Create a value of PrepareQueryResponse 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:httpStatus:PrepareQueryResponse', prepareQueryResponse_httpStatus - The response's http status code.
PrepareQuery, prepareQueryResponse_queryString - The query string that you want prepare.
$sel:columns:PrepareQueryResponse', prepareQueryResponse_columns - A list of SELECT clause columns of the submitted query string.
$sel:parameters:PrepareQueryResponse', prepareQueryResponse_parameters - A list of parameters used in the submitted query string.
Query (Paginated)
See: newQuery smart constructor.
Instances
Create a value of Query 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:clientToken:Query', query_clientToken - Unique, case-sensitive string of up to 64 ASCII characters specified
when a Query request is made. Providing a ClientToken makes the call
to Query idempotent. This means that running the same query
repeatedly will produce the same result. In other words, making multiple
identical Query requests has the same effect as making a single
request. When using ClientToken in a query, note the following:
- If the Query API is instantiated without a
ClientToken, the Query SDK generates aClientTokenon your behalf. - If the
Queryinvocation only contains theClientTokenbut does not include aNextToken, that invocation ofQueryis assumed to be a new query run. - If the invocation contains
NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned. - After 4 hours, any request with the same
ClientTokenis treated as a new request.
$sel:maxRows:Query', query_maxRows - The total number of rows to be returned in the Query output. The
initial run of Query with a MaxRows value specified will return the
result set of the query in two cases:
- The size of the result is less than
1MB. - The number of rows in the result set is less than the value of
maxRows.
Otherwise, the initial invocation of Query only returns a NextToken,
which can then be used in subsequent calls to fetch the result set. To
resume pagination, provide the NextToken value in the subsequent
command.
If the row size is large (e.g. a row has many columns), Timestream may
return fewer rows to keep the response size from exceeding the 1 MB
limit. If MaxRows is not provided, Timestream will send the necessary
number of rows to meet the 1 MB limit.
Query, query_nextToken - A pagination token used to return a set of results. When the Query API
is invoked using NextToken, that particular invocation is assumed to
be a subsequent invocation of a prior call to Query, and a result set
is returned. However, if the Query invocation only contains the
ClientToken, that invocation of Query is assumed to be a new query
run.
Note the following when using NextToken in a query:
- A pagination token can be used for up to five
Queryinvocations, OR for a duration of up to 1 hour – whichever comes first. - Using the same
NextTokenwill return the same set of records. To keep paginating through the result set, you must to use the most recentnextToken. - Suppose a
Queryinvocation returns twoNextTokenvalues,TokenAandTokenB. IfTokenBis used in a subsequentQueryinvocation, thenTokenAis invalidated and cannot be reused. - To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.
- The latest
NextTokenshould be used to paginate untilnullis returned, at which point a newNextTokenshould be used. - If the IAM principal of the query initiator and the result reader
are not the same and/or the query initiator and the result reader
do not have the same query string in the query requests, the query
will fail with an
Invalid pagination tokenerror.
Query, query_queryString - The query to be run by Timestream.
data QueryResponse Source #
See: newQueryResponse smart constructor.
Constructors
| QueryResponse' (Maybe Text) (Maybe QueryStatus) Int Text [Row] [ColumnInfo] |
Instances
Create a value of QueryResponse 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:
Query, queryResponse_nextToken - A pagination token that can be used again on a Query call to get the
next set of results.
$sel:queryStatus:QueryResponse', queryResponse_queryStatus - Information about the status of the query, including progress and bytes
scanned.
$sel:httpStatus:QueryResponse', queryResponse_httpStatus - The response's http status code.
$sel:queryId:QueryResponse', queryResponse_queryId - A unique ID for the given query.
$sel:rows:QueryResponse', queryResponse_rows - The result set rows returned by the query.
$sel:columnInfo:QueryResponse', queryResponse_columnInfo - The column data types of the returned result set.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceARN:TagResource', tagResource_resourceARN - Identifies the Timestream resource to which tags should be added. This
value is an Amazon Resource Name (ARN).
$sel:tags:TagResource', tagResource_tags - The tags to be assigned to the Timestream resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceARN:UntagResource', untagResource_resourceARN - The Timestream resource that the tags will be removed from. This value
is an Amazon Resource Name (ARN).
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of tags keys. Existing tags of the resource whose keys are
members of this list will be removed from the Timestream resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateScheduledQuery
data UpdateScheduledQuery Source #
See: newUpdateScheduledQuery smart constructor.
Constructors
| UpdateScheduledQuery' Text ScheduledQueryState |
Instances
newUpdateScheduledQuery Source #
Arguments
| :: Text | |
| -> ScheduledQueryState | |
| -> UpdateScheduledQuery |
Create a value of UpdateScheduledQuery 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:scheduledQueryArn:UpdateScheduledQuery', updateScheduledQuery_scheduledQueryArn - ARN of the scheuled query.
UpdateScheduledQuery, updateScheduledQuery_state - State of the scheduled query.
data UpdateScheduledQueryResponse Source #
See: newUpdateScheduledQueryResponse smart constructor.
Constructors
| UpdateScheduledQueryResponse' | |
Instances
| Generic UpdateScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.UpdateScheduledQuery Associated Types type Rep UpdateScheduledQueryResponse :: Type -> Type # | |
| Read UpdateScheduledQueryResponse Source # | |
| Show UpdateScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.UpdateScheduledQuery Methods showsPrec :: Int -> UpdateScheduledQueryResponse -> ShowS # show :: UpdateScheduledQueryResponse -> String # showList :: [UpdateScheduledQueryResponse] -> ShowS # | |
| NFData UpdateScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.UpdateScheduledQuery Methods rnf :: UpdateScheduledQueryResponse -> () # | |
| Eq UpdateScheduledQueryResponse Source # | |
Defined in Amazonka.TimeStreamQuery.UpdateScheduledQuery Methods (==) :: UpdateScheduledQueryResponse -> UpdateScheduledQueryResponse -> Bool # (/=) :: UpdateScheduledQueryResponse -> UpdateScheduledQueryResponse -> Bool # | |
| type Rep UpdateScheduledQueryResponse Source # | |
newUpdateScheduledQueryResponse :: UpdateScheduledQueryResponse Source #
Create a value of UpdateScheduledQueryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
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' (Maybe Text) Type |
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.
Datum
Datum represents a single data point in a query result.
See: newDatum smart constructor.
Constructors
| Datum' (Maybe [Datum]) (Maybe Bool) (Maybe Row) (Maybe Text) (Maybe [TimeSeriesDataPoint]) |
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.
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' Text DimensionValueType |
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.
Endpoint
Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.
See: newEndpoint smart constructor.
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.
ErrorReportConfiguration
data ErrorReportConfiguration Source #
Configuration required for error reporting.
See: newErrorReportConfiguration smart constructor.
Constructors
| ErrorReportConfiguration' S3Configuration |
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.
ErrorReportLocation
data ErrorReportLocation Source #
This contains the location of the error report for a single scheduled query call.
See: newErrorReportLocation smart constructor.
Constructors
| ErrorReportLocation' (Maybe S3ReportLocation) |
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.
ExecutionStats
data ExecutionStats Source #
Statistics for a single scheduled query run.
See: newExecutionStats smart constructor.
Constructors
| ExecutionStats' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) |
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.
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' (Maybe Text) (Maybe (NonEmpty MultiMeasureAttributeMapping)) (Maybe Text) (Maybe Text) MeasureValueType |
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.
MultiMeasureAttributeMapping
data MultiMeasureAttributeMapping Source #
Attribute mapping for MULTI value measures.
See: newMultiMeasureAttributeMapping smart constructor.
Constructors
| MultiMeasureAttributeMapping' (Maybe Text) Text ScalarMeasureValueType |
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.
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' (Maybe Text) (NonEmpty MultiMeasureAttributeMapping) |
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.
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' SnsConfiguration |
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.
ParameterMapping
data ParameterMapping Source #
Mapping for named parameters.
See: newParameterMapping smart constructor.
Constructors
| ParameterMapping' Text Type |
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.
QueryStatus
data QueryStatus Source #
Information about the status of the query, including progress and bytes scanned.
See: newQueryStatus smart constructor.
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.
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' (Maybe S3EncryptionOption) (Maybe Text) Text |
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.
S3ReportLocation
data S3ReportLocation Source #
S3 report location for the scheduled query run.
See: newS3ReportLocation smart constructor.
Constructors
| S3ReportLocation' (Maybe Text) (Maybe Text) |
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.
ScheduleConfiguration
data ScheduleConfiguration Source #
Configuration of the schedule of the query.
See: newScheduleConfiguration smart constructor.
Constructors
| ScheduleConfiguration' Text |
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.
ScheduledQuery
data ScheduledQuery Source #
Scheduled Query
See: newScheduledQuery smart constructor.
Constructors
| ScheduledQuery' (Maybe POSIX) (Maybe ErrorReportConfiguration) (Maybe ScheduledQueryRunStatus) (Maybe POSIX) (Maybe POSIX) (Maybe TargetDestination) Text Text ScheduledQueryState |
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.
ScheduledQueryDescription
data ScheduledQueryDescription Source #
Structure that describes scheduled query.
See: newScheduledQueryDescription smart constructor.
Constructors
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.
ScheduledQueryRunSummary
data ScheduledQueryRunSummary Source #
Run summary for the scheduled query
See: newScheduledQueryRunSummary smart constructor.
Constructors
| ScheduledQueryRunSummary' (Maybe ErrorReportLocation) (Maybe ExecutionStats) (Maybe Text) (Maybe POSIX) (Maybe ScheduledQueryRunStatus) (Maybe POSIX) |
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.
SelectColumn
data SelectColumn Source #
Details of the column that is returned by the query.
See: newSelectColumn smart constructor.
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.
SnsConfiguration
data SnsConfiguration Source #
Details on SNS that are required to send the notification.
See: newSnsConfiguration smart constructor.
Constructors
| SnsConfiguration' Text |
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.
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.
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.
TargetConfiguration
data TargetConfiguration Source #
Configuration used for writing the output of a query.
See: newTargetConfiguration smart constructor.
Constructors
| TargetConfiguration' TimestreamConfiguration |
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.
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' (Maybe TimestreamDestination) |
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.
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' Text Datum |
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.
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' (Maybe Text) (Maybe (NonEmpty MixedMeasureMapping)) (Maybe MultiMeasureMappings) Text Text Text [DimensionMapping] |
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.
TimestreamDestination
data TimestreamDestination Source #
Destination for scheduled query.
See: newTimestreamDestination smart constructor.
Constructors
| TimestreamDestination' (Maybe Text) (Maybe Text) |
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.
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' (Maybe ColumnInfo) (Maybe [ColumnInfo]) (Maybe ScalarType) (Maybe ColumnInfo) |
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.