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.CloudTrail.DescribeQuery

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for EventDataStore, and a value for QueryID.

Synopsis

data DescribeQuery = DescribeQuery' {
- eventDataStore :: Maybe Text
- queryId :: Text
}
newDescribeQuery :: Text -> DescribeQuery
describeQuery_eventDataStore :: Lens' DescribeQuery (Maybe Text)
describeQuery_queryId :: Lens' DescribeQuery Text
data DescribeQueryResponse = DescribeQueryResponse' {
- deliveryS3Uri :: Maybe Text
- deliveryStatus :: Maybe DeliveryStatus
- errorMessage :: Maybe Text
- queryId :: Maybe Text
- queryStatistics :: Maybe QueryStatisticsForDescribeQuery
- queryStatus :: Maybe QueryStatus
- queryString :: Maybe Text
- httpStatus :: Int
}
newDescribeQueryResponse :: Int -> DescribeQueryResponse
describeQueryResponse_deliveryS3Uri :: Lens' DescribeQueryResponse (Maybe Text)
describeQueryResponse_deliveryStatus :: Lens' DescribeQueryResponse (Maybe DeliveryStatus)
describeQueryResponse_errorMessage :: Lens' DescribeQueryResponse (Maybe Text)
describeQueryResponse_queryId :: Lens' DescribeQueryResponse (Maybe Text)
describeQueryResponse_queryStatistics :: Lens' DescribeQueryResponse (Maybe QueryStatisticsForDescribeQuery)
describeQueryResponse_queryStatus :: Lens' DescribeQueryResponse (Maybe QueryStatus)
describeQueryResponse_queryString :: Lens' DescribeQueryResponse (Maybe Text)
describeQueryResponse_httpStatus :: Lens' DescribeQueryResponse Int

Creating a Request

data DescribeQuery Source #

See: newDescribeQuery smart constructor.

Constructors

DescribeQuery'
Fields eventDataStore :: Maybe Text The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run. queryId :: Text The query ID.

Instances

Instances details

ToJSON DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods toJSON :: DescribeQuery -> Value # toEncoding :: DescribeQuery -> Encoding # toJSONList :: [DescribeQuery] -> Value # toEncodingList :: [DescribeQuery] -> Encoding #
ToHeaders DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods toHeaders :: DescribeQuery -> [Header] #
ToPath DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods toPath :: DescribeQuery -> ByteString #
ToQuery DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods toQuery :: DescribeQuery -> QueryString #
AWSRequest DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Associated Types type AWSResponse DescribeQuery # Methods request :: (Service -> Service) -> DescribeQuery -> Request DescribeQuery # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeQuery -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeQuery))) #
Generic DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Associated Types type Rep DescribeQuery :: Type -> Type # Methods from :: DescribeQuery -> Rep DescribeQuery x # to :: Rep DescribeQuery x -> DescribeQuery #
Read DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods readsPrec :: Int -> ReadS DescribeQuery # readList :: ReadS [DescribeQuery] # readPrec :: ReadPrec DescribeQuery # readListPrec :: ReadPrec [DescribeQuery] #
Show DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods showsPrec :: Int -> DescribeQuery -> ShowS # show :: DescribeQuery -> String # showList :: [DescribeQuery] -> ShowS #
NFData DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods rnf :: DescribeQuery -> () #
Eq DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods (==) :: DescribeQuery -> DescribeQuery -> Bool # (/=) :: DescribeQuery -> DescribeQuery -> Bool #
Hashable DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods hashWithSalt :: Int -> DescribeQuery -> Int # hash :: DescribeQuery -> Int #
type AWSResponse DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery type AWSResponse DescribeQuery = DescribeQueryResponse
type Rep DescribeQuery Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery type Rep DescribeQuery = D1 ('MetaData "DescribeQuery" "Amazonka.CloudTrail.DescribeQuery" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "DescribeQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventDataStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeQuery Source #

Arguments

:: Text	`DescribeQuery`
-> DescribeQuery

Create a value of DescribeQuery 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:eventDataStore:DescribeQuery', describeQuery_eventDataStore - The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.

DescribeQuery, describeQuery_queryId - The query ID.

Request Lenses

describeQuery_eventDataStore :: Lens' DescribeQuery (Maybe Text) Source #

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.

describeQuery_queryId :: Lens' DescribeQuery Text Source #

The query ID.

Destructuring the Response

data DescribeQueryResponse Source #

See: newDescribeQueryResponse smart constructor.

Constructors

DescribeQueryResponse'

Fields

deliveryS3Uri :: Maybe Text
The URI for the S3 bucket where CloudTrail delivered query results, if applicable.
deliveryStatus :: Maybe DeliveryStatus
The delivery status.
errorMessage :: Maybe Text
The error message returned if a query failed.
queryId :: Maybe Text
The ID of the query.
queryStatistics :: Maybe QueryStatisticsForDescribeQuery
Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.
queryStatus :: Maybe QueryStatus
The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED
queryString :: Maybe Text
The SQL code of a query.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeQueryResponse Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Associated Types type Rep DescribeQueryResponse :: Type -> Type # Methods from :: DescribeQueryResponse -> Rep DescribeQueryResponse x # to :: Rep DescribeQueryResponse x -> DescribeQueryResponse #
Read DescribeQueryResponse Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods readsPrec :: Int -> ReadS DescribeQueryResponse # readList :: ReadS [DescribeQueryResponse] # readPrec :: ReadPrec DescribeQueryResponse # readListPrec :: ReadPrec [DescribeQueryResponse] #
Show DescribeQueryResponse Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods showsPrec :: Int -> DescribeQueryResponse -> ShowS # show :: DescribeQueryResponse -> String # showList :: [DescribeQueryResponse] -> ShowS #
NFData DescribeQueryResponse Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods rnf :: DescribeQueryResponse -> () #
Eq DescribeQueryResponse Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery Methods (==) :: DescribeQueryResponse -> DescribeQueryResponse -> Bool # (/=) :: DescribeQueryResponse -> DescribeQueryResponse -> Bool #
type Rep DescribeQueryResponse Source #
Instance details Defined in Amazonka.CloudTrail.DescribeQuery type Rep DescribeQueryResponse = D1 ('MetaData "DescribeQueryResponse" "Amazonka.CloudTrail.DescribeQuery" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "DescribeQueryResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deliveryS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deliveryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStatus))) :: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "queryStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatisticsForDescribeQuery)) :: S1 ('MetaSel ('Just "queryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatus))) :: (S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeQueryResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeQueryResponse'`
-> DescribeQueryResponse

Create a value of DescribeQueryResponse 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:DescribeQueryResponse', describeQueryResponse_deliveryS3Uri - The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

$sel:deliveryStatus:DescribeQueryResponse', describeQueryResponse_deliveryStatus - The delivery status.

DescribeQueryResponse, describeQueryResponse_errorMessage - The error message returned if a query failed.

DescribeQuery, describeQueryResponse_queryId - The ID of the query.

$sel:queryStatistics:DescribeQueryResponse', describeQueryResponse_queryStatistics - Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

DescribeQueryResponse, describeQueryResponse_queryStatus - The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

$sel:queryString:DescribeQueryResponse', describeQueryResponse_queryString - The SQL code of a query.

$sel:httpStatus:DescribeQueryResponse', describeQueryResponse_httpStatus - The response's http status code.

Response Lenses

describeQueryResponse_deliveryS3Uri :: Lens' DescribeQueryResponse (Maybe Text) Source #

The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

describeQueryResponse_deliveryStatus :: Lens' DescribeQueryResponse (Maybe DeliveryStatus) Source #

The delivery status.

describeQueryResponse_errorMessage :: Lens' DescribeQueryResponse (Maybe Text) Source #

The error message returned if a query failed.

describeQueryResponse_queryId :: Lens' DescribeQueryResponse (Maybe Text) Source #

The ID of the query.

describeQueryResponse_queryStatistics :: Lens' DescribeQueryResponse (Maybe QueryStatisticsForDescribeQuery) Source #

Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

describeQueryResponse_queryStatus :: Lens' DescribeQueryResponse (Maybe QueryStatus) Source #

The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

describeQueryResponse_queryString :: Lens' DescribeQueryResponse (Maybe Text) Source #

The SQL code of a query.

describeQueryResponse_httpStatus :: Lens' DescribeQueryResponse Int Source #

The response's http status code.