Amazonka.CloudTrail.StartQuery

Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket.

Creating a Request

data StartQuery

See: newStartQuery smart constructor.

Constructors

StartQuery'

Fields

• deliveryS3Uri :: Maybe Text

  The URI for the S3 bucket where CloudTrail delivers the query results.

• queryStatement :: Text

  The SQL code of your query.

Instances

ToJSON StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

toJSON :: StartQuery -> Value

toEncoding :: StartQuery -> Encoding

toJSONList :: [StartQuery] -> Value

toEncodingList :: [StartQuery] -> Encoding

ToHeaders StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

toHeaders :: StartQuery -> [Header]

ToPath StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

toPath :: StartQuery -> ByteString

ToQuery StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

toQuery :: StartQuery -> QueryString

AWSRequest StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Associated Types

type AWSResponse StartQuery

Methods

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

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

Generic StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Associated Types

type Rep StartQuery :: Type -> Type

Methods

from :: StartQuery -> Rep StartQuery x

to :: Rep StartQuery x -> StartQuery

Read StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

readsPrec :: Int -> ReadS StartQuery

readList :: ReadS [StartQuery]

readPrec :: ReadPrec StartQuery

readListPrec :: ReadPrec [StartQuery]

Show StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

showsPrec :: Int -> StartQuery -> ShowS

show :: StartQuery -> String

showList :: [StartQuery] -> ShowS

NFData StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

rnf :: StartQuery -> ()

Eq StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

(==) :: StartQuery -> StartQuery -> Bool

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

Hashable StartQuery

Defined in Amazonka.CloudTrail.StartQuery

Methods

hashWithSalt :: Int -> StartQuery -> Int

hash :: StartQuery -> Int

type AWSResponse StartQuery

Defined in Amazonka.CloudTrail.StartQuery

type AWSResponse StartQuery = StartQueryResponse

type Rep StartQuery

Defined in Amazonka.CloudTrail.StartQuery

type Rep StartQuery = D1 ('MetaData "StartQuery" "Amazonka.CloudTrail.StartQuery" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "StartQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deliveryS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartQuery

Arguments

:: Text

$sel:queryStatement:StartQuery'

-> StartQuery

Create a value of StartQuery 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:deliveryS3Uri:StartQuery', startQuery_deliveryS3Uri - The URI for the S3 bucket where CloudTrail delivers the query results.

$sel:queryStatement:StartQuery', startQuery_queryStatement - The SQL code of your query.

Request Lenses

startQuery_deliveryS3Uri :: Lens' StartQuery (Maybe Text)

The URI for the S3 bucket where CloudTrail delivers the query results.

startQuery_queryStatement :: Lens' StartQuery Text

The SQL code of your query.

Destructuring the Response

data StartQueryResponse

See: newStartQueryResponse smart constructor.

Constructors

StartQueryResponse'

Fields

• queryId :: Maybe Text

  The ID of the started query.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartQueryResponse

Defined in Amazonka.CloudTrail.StartQuery

Associated Types

type Rep StartQueryResponse :: Type -> Type

Methods

from :: StartQueryResponse -> Rep StartQueryResponse x

to :: Rep StartQueryResponse x -> StartQueryResponse

Read StartQueryResponse

Defined in Amazonka.CloudTrail.StartQuery

Methods

readsPrec :: Int -> ReadS StartQueryResponse

readList :: ReadS [StartQueryResponse]

readPrec :: ReadPrec StartQueryResponse

readListPrec :: ReadPrec [StartQueryResponse]

Show StartQueryResponse

Defined in Amazonka.CloudTrail.StartQuery

Methods

showsPrec :: Int -> StartQueryResponse -> ShowS

show :: StartQueryResponse -> String

showList :: [StartQueryResponse] -> ShowS

NFData StartQueryResponse

Defined in Amazonka.CloudTrail.StartQuery

Methods

rnf :: StartQueryResponse -> ()

Eq StartQueryResponse

Defined in Amazonka.CloudTrail.StartQuery

Methods

(==) :: StartQueryResponse -> StartQueryResponse -> Bool

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

type Rep StartQueryResponse

Defined in Amazonka.CloudTrail.StartQuery

type Rep StartQueryResponse = D1 ('MetaData "StartQueryResponse" "Amazonka.CloudTrail.StartQuery" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "StartQueryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartQueryResponse

Arguments

:: Int

$sel:httpStatus:StartQueryResponse'

-> StartQueryResponse

Create a value of StartQueryResponse 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:

StartQueryResponse, startQueryResponse_queryId - The ID of the started query.

$sel:httpStatus:StartQueryResponse', startQueryResponse_httpStatus - The response's http status code.

Response Lenses

startQueryResponse_queryId :: Lens' StartQueryResponse (Maybe Text)

The ID of the started query.

startQueryResponse_httpStatus :: Lens' StartQueryResponse Int

The response's http status code.