Amazonka.CloudTrail.CancelQuery

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

Creating a Request

data CancelQuery

See: newCancelQuery smart constructor.

Constructors

CancelQuery'

Fields

• eventDataStore :: Maybe Text

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

• queryId :: Text

  The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.

Instances

ToJSON CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

toJSON :: CancelQuery -> Value

toEncoding :: CancelQuery -> Encoding

toJSONList :: [CancelQuery] -> Value

toEncodingList :: [CancelQuery] -> Encoding

ToHeaders CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

toHeaders :: CancelQuery -> [Header]

ToPath CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

toPath :: CancelQuery -> ByteString

ToQuery CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

toQuery :: CancelQuery -> QueryString

AWSRequest CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Associated Types

type AWSResponse CancelQuery

Methods

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

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

Generic CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Associated Types

type Rep CancelQuery :: Type -> Type

Methods

from :: CancelQuery -> Rep CancelQuery x

to :: Rep CancelQuery x -> CancelQuery

Read CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

readsPrec :: Int -> ReadS CancelQuery

readList :: ReadS [CancelQuery]

readPrec :: ReadPrec CancelQuery

readListPrec :: ReadPrec [CancelQuery]

Show CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

showsPrec :: Int -> CancelQuery -> ShowS

show :: CancelQuery -> String

showList :: [CancelQuery] -> ShowS

NFData CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

rnf :: CancelQuery -> ()

Eq CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

(==) :: CancelQuery -> CancelQuery -> Bool

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

Hashable CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

Methods

hashWithSalt :: Int -> CancelQuery -> Int

hash :: CancelQuery -> Int

type AWSResponse CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

type AWSResponse CancelQuery = CancelQueryResponse

type Rep CancelQuery

Defined in Amazonka.CloudTrail.CancelQuery

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

newCancelQuery

Arguments

:: Text

CancelQuery

-> 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:eventDataStore:CancelQuery', cancelQuery_eventDataStore - The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.

CancelQuery, cancelQuery_queryId - The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.

Request Lenses

cancelQuery_eventDataStore :: Lens' CancelQuery (Maybe Text)

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

cancelQuery_queryId :: Lens' CancelQuery Text

The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.

Destructuring the Response

data CancelQueryResponse

See: newCancelQueryResponse smart constructor.

Constructors

CancelQueryResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• queryId :: Text

  The ID of the canceled query.

• queryStatus :: QueryStatus

  Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED.

Instances

Generic CancelQueryResponse

Defined in Amazonka.CloudTrail.CancelQuery

Associated Types

type Rep CancelQueryResponse :: Type -> Type

Methods

from :: CancelQueryResponse -> Rep CancelQueryResponse x

to :: Rep CancelQueryResponse x -> CancelQueryResponse

Read CancelQueryResponse

Defined in Amazonka.CloudTrail.CancelQuery

Methods

readsPrec :: Int -> ReadS CancelQueryResponse

readList :: ReadS [CancelQueryResponse]

readPrec :: ReadPrec CancelQueryResponse

readListPrec :: ReadPrec [CancelQueryResponse]

Show CancelQueryResponse

Defined in Amazonka.CloudTrail.CancelQuery

Methods

showsPrec :: Int -> CancelQueryResponse -> ShowS

show :: CancelQueryResponse -> String

showList :: [CancelQueryResponse] -> ShowS

NFData CancelQueryResponse

Defined in Amazonka.CloudTrail.CancelQuery

Methods

rnf :: CancelQueryResponse -> ()

Eq CancelQueryResponse

Defined in Amazonka.CloudTrail.CancelQuery

Methods

(==) :: CancelQueryResponse -> CancelQueryResponse -> Bool

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

type Rep CancelQueryResponse

Defined in Amazonka.CloudTrail.CancelQuery

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

newCancelQueryResponse

Arguments

:: Int

$sel:httpStatus:CancelQueryResponse'

-> Text

CancelQuery

-> QueryStatus

CancelQueryResponse

-> 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:httpStatus:CancelQueryResponse', cancelQueryResponse_httpStatus - The response's http status code.

CancelQuery, cancelQueryResponse_queryId - The ID of the canceled query.

CancelQueryResponse, cancelQueryResponse_queryStatus - Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED.

Response Lenses

cancelQueryResponse_httpStatus :: Lens' CancelQueryResponse Int

The response's http status code.

cancelQueryResponse_queryId :: Lens' CancelQueryResponse Text

The ID of the canceled query.

cancelQueryResponse_queryStatus :: Lens' CancelQueryResponse QueryStatus

Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED.