Amazonka.TimeStreamQuery.PrepareQuery

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.

Creating a Request

data PrepareQuery

See: newPrepareQuery smart constructor.

Constructors

PrepareQuery'

Fields

• validateOnly :: Maybe Bool

  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.

• queryString :: Sensitive Text

  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.

Instances

ToJSON PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

toJSON :: PrepareQuery -> Value

toEncoding :: PrepareQuery -> Encoding

toJSONList :: [PrepareQuery] -> Value

toEncodingList :: [PrepareQuery] -> Encoding

ToHeaders PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

toHeaders :: PrepareQuery -> [Header]

ToPath PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

toPath :: PrepareQuery -> ByteString

ToQuery PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

toQuery :: PrepareQuery -> QueryString

AWSRequest PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Associated Types

type AWSResponse PrepareQuery

Methods

request :: (Service -> Service) -> PrepareQuery -> Request PrepareQuery

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PrepareQuery -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PrepareQuery)))

Generic PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Associated Types

type Rep PrepareQuery :: Type -> Type

Methods

from :: PrepareQuery -> Rep PrepareQuery x

to :: Rep PrepareQuery x -> PrepareQuery

Show PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

showsPrec :: Int -> PrepareQuery -> ShowS

show :: PrepareQuery -> String

showList :: [PrepareQuery] -> ShowS

NFData PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

rnf :: PrepareQuery -> ()

Eq PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

(==) :: PrepareQuery -> PrepareQuery -> Bool

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

Hashable PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

hashWithSalt :: Int -> PrepareQuery -> Int

hash :: PrepareQuery -> Int

type AWSResponse PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

type AWSResponse PrepareQuery = PrepareQueryResponse

type Rep PrepareQuery

Defined in Amazonka.TimeStreamQuery.PrepareQuery

type Rep PrepareQuery = D1 ('MetaData "PrepareQuery" "Amazonka.TimeStreamQuery.PrepareQuery" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "PrepareQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "validateOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newPrepareQuery

Arguments

:: Text

PrepareQuery

-> 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)

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

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

See: newPrepareQueryResponse smart constructor.

Constructors

PrepareQueryResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• queryString :: Sensitive Text

  The query string that you want prepare.

• columns :: [SelectColumn]

  A list of SELECT clause columns of the submitted query string.

• parameters :: [ParameterMapping]

  A list of parameters used in the submitted query string.

Instances

Generic PrepareQueryResponse

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Associated Types

type Rep PrepareQueryResponse :: Type -> Type

Methods

from :: PrepareQueryResponse -> Rep PrepareQueryResponse x

to :: Rep PrepareQueryResponse x -> PrepareQueryResponse

Show PrepareQueryResponse

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

showsPrec :: Int -> PrepareQueryResponse -> ShowS

show :: PrepareQueryResponse -> String

showList :: [PrepareQueryResponse] -> ShowS

NFData PrepareQueryResponse

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

rnf :: PrepareQueryResponse -> ()

Eq PrepareQueryResponse

Defined in Amazonka.TimeStreamQuery.PrepareQuery

Methods

(==) :: PrepareQueryResponse -> PrepareQueryResponse -> Bool

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

type Rep PrepareQueryResponse

Defined in Amazonka.TimeStreamQuery.PrepareQuery

type Rep PrepareQueryResponse = D1 ('MetaData "PrepareQueryResponse" "Amazonka.TimeStreamQuery.PrepareQuery" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "PrepareQueryResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :*: (S1 ('MetaSel ('Just "columns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SelectColumn]) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ParameterMapping]))))

newPrepareQueryResponse

Arguments

:: Int

$sel:httpStatus:PrepareQueryResponse'

-> Text

PrepareQuery

-> PrepareQueryResponse

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

The response's http status code.

prepareQueryResponse_queryString :: Lens' PrepareQueryResponse Text

The query string that you want prepare.

prepareQueryResponse_columns :: Lens' PrepareQueryResponse [SelectColumn]

A list of SELECT clause columns of the submitted query string.

prepareQueryResponse_parameters :: Lens' PrepareQueryResponse [ParameterMapping]

A list of parameters used in the submitted query string.