Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.EMR.CancelSteps

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.

Creating a Request

data CancelSteps Source #

The input argument to the CancelSteps operation.

See: newCancelSteps smart constructor.

Constructors

CancelSteps'

Fields

stepCancellationOption :: Maybe StepCancellationOption
The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.
clusterId :: Text
The ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.
stepIds :: [Text]
The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

Instances

Instances details

Eq CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods (==) :: CancelSteps -> CancelSteps -> Bool # (/=) :: CancelSteps -> CancelSteps -> Bool #
Read CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods readsPrec :: Int -> ReadS CancelSteps # readList :: ReadS [CancelSteps] # readPrec :: ReadPrec CancelSteps # readListPrec :: ReadPrec [CancelSteps] #
Show CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods showsPrec :: Int -> CancelSteps -> ShowS # show :: CancelSteps -> String # showList :: [CancelSteps] -> ShowS #
Generic CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Associated Types type Rep CancelSteps :: Type -> Type # Methods from :: CancelSteps -> Rep CancelSteps x # to :: Rep CancelSteps x -> CancelSteps #
NFData CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods rnf :: CancelSteps -> () #
Hashable CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods hashWithSalt :: Int -> CancelSteps -> Int # hash :: CancelSteps -> Int #
ToJSON CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods toJSON :: CancelSteps -> Value # toEncoding :: CancelSteps -> Encoding # toJSONList :: [CancelSteps] -> Value # toEncodingList :: [CancelSteps] -> Encoding #
AWSRequest CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Associated Types type AWSResponse CancelSteps # Methods request :: CancelSteps -> Request CancelSteps # response :: MonadResource m => Logger -> Service -> Proxy CancelSteps -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelSteps))) #
ToHeaders CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods toHeaders :: CancelSteps -> [Header] #
ToPath CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods toPath :: CancelSteps -> ByteString #
ToQuery CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods toQuery :: CancelSteps -> QueryString #
type Rep CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps type Rep CancelSteps = D1 ('MetaData "CancelSteps" "Amazonka.EMR.CancelSteps" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "CancelSteps'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stepCancellationOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepCancellationOption)) :: (S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "stepIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))
type AWSResponse CancelSteps Source #
Instance details Defined in Amazonka.EMR.CancelSteps type AWSResponse CancelSteps = CancelStepsResponse

newCancelSteps Source #

Arguments

:: Text	`$sel:clusterId:CancelSteps'`
-> CancelSteps

Create a value of CancelSteps 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:stepCancellationOption:CancelSteps', cancelSteps_stepCancellationOption - The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.

$sel:clusterId:CancelSteps', cancelSteps_clusterId - The ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

$sel:stepIds:CancelSteps', cancelSteps_stepIds - The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

Request Lenses

cancelSteps_stepCancellationOption :: Lens' CancelSteps (Maybe StepCancellationOption) Source #

The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.

cancelSteps_clusterId :: Lens' CancelSteps Text Source #

The ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

cancelSteps_stepIds :: Lens' CancelSteps [Text] Source #

The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

Destructuring the Response

data CancelStepsResponse Source #

The output for the CancelSteps operation.

See: newCancelStepsResponse smart constructor.

Constructors

CancelStepsResponse'
Fields cancelStepsInfoList :: Maybe [CancelStepsInfo] A list of CancelStepsInfo, which shows the status of specified cancel requests for each `StepID` specified. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CancelStepsResponse Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods (==) :: CancelStepsResponse -> CancelStepsResponse -> Bool # (/=) :: CancelStepsResponse -> CancelStepsResponse -> Bool #
Read CancelStepsResponse Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods readsPrec :: Int -> ReadS CancelStepsResponse # readList :: ReadS [CancelStepsResponse] # readPrec :: ReadPrec CancelStepsResponse # readListPrec :: ReadPrec [CancelStepsResponse] #
Show CancelStepsResponse Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods showsPrec :: Int -> CancelStepsResponse -> ShowS # show :: CancelStepsResponse -> String # showList :: [CancelStepsResponse] -> ShowS #
Generic CancelStepsResponse Source #
Instance details Defined in Amazonka.EMR.CancelSteps Associated Types type Rep CancelStepsResponse :: Type -> Type # Methods from :: CancelStepsResponse -> Rep CancelStepsResponse x # to :: Rep CancelStepsResponse x -> CancelStepsResponse #
NFData CancelStepsResponse Source #
Instance details Defined in Amazonka.EMR.CancelSteps Methods rnf :: CancelStepsResponse -> () #
type Rep CancelStepsResponse Source #
Instance details Defined in Amazonka.EMR.CancelSteps type Rep CancelStepsResponse = D1 ('MetaData "CancelStepsResponse" "Amazonka.EMR.CancelSteps" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "CancelStepsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cancelStepsInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CancelStepsInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelStepsResponse Source #

Arguments

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

Create a value of CancelStepsResponse 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:cancelStepsInfoList:CancelStepsResponse', cancelStepsResponse_cancelStepsInfoList - A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.

$sel:httpStatus:CancelStepsResponse', cancelStepsResponse_httpStatus - The response's http status code.

Response Lenses

cancelStepsResponse_cancelStepsInfoList :: Lens' CancelStepsResponse (Maybe [CancelStepsInfo]) Source #

A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.

cancelStepsResponse_httpStatus :: Lens' CancelStepsResponse Int Source #

The response's http status code.