| 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.PrepareQuery
Description
A synchronous operation that allows you to submit a query with
parameters to be stored by Timestream for later running. Timestream only
supports using this operation with the
PrepareQueryRequest$ValidateOnly set to true.
Synopsis
- data PrepareQuery = PrepareQuery' {}
- newPrepareQuery :: Text -> PrepareQuery
- prepareQuery_validateOnly :: Lens' PrepareQuery (Maybe Bool)
- prepareQuery_queryString :: Lens' PrepareQuery Text
- data PrepareQueryResponse = PrepareQueryResponse' {
- httpStatus :: Int
- queryString :: Sensitive Text
- columns :: [SelectColumn]
- parameters :: [ParameterMapping]
- newPrepareQueryResponse :: Int -> Text -> PrepareQueryResponse
- prepareQueryResponse_httpStatus :: Lens' PrepareQueryResponse Int
- prepareQueryResponse_queryString :: Lens' PrepareQueryResponse Text
- prepareQueryResponse_columns :: Lens' PrepareQueryResponse [SelectColumn]
- prepareQueryResponse_parameters :: Lens' PrepareQueryResponse [ParameterMapping]
Creating a Request
data PrepareQuery Source #
See: newPrepareQuery smart constructor.
Constructors
| PrepareQuery' | |
Fields
| |
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.
Request Lenses
prepareQuery_validateOnly :: Lens' PrepareQuery (Maybe Bool) Source #
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_queryString :: Lens' PrepareQuery Text Source #
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.
Destructuring the Response
data PrepareQueryResponse Source #
See: newPrepareQueryResponse smart constructor.
Constructors
| PrepareQueryResponse' | |
Fields
| |
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.
Response Lenses
prepareQueryResponse_httpStatus :: Lens' PrepareQueryResponse Int Source #
The response's http status code.
prepareQueryResponse_queryString :: Lens' PrepareQueryResponse Text Source #
The query string that you want prepare.
prepareQueryResponse_columns :: Lens' PrepareQueryResponse [SelectColumn] Source #
A list of SELECT clause columns of the submitted query string.
prepareQueryResponse_parameters :: Lens' PrepareQueryResponse [ParameterMapping] Source #
A list of parameters used in the submitted query string.