Cancel Steps

emr_cancel_steps

R Documentation

Cancels a pending step or steps in a running cluster¶

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 releases 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.

Usage¶

emr_cancel_steps(ClusterId, StepIds, StepCancellationOption)

Arguments¶

ClusterId

[required] The ClusterID for the specified steps that will be canceled. Use run_job_flow and list_clusters to get ClusterIDs.

StepIds

[required] The list of StepIDs to cancel. Use list_steps to get steps and their states for the specified cluster.

StepCancellationOption

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

Value¶

A list with the following syntax:

list(
  CancelStepsInfoList = list(
    list(
      StepId = "string",
      Status = "SUBMITTED"|"FAILED",
      Reason = "string"
    )
  )
)

Request syntax¶

svc$cancel_steps(
  ClusterId = "string",
  StepIds = list(
    "string"
  ),
  StepCancellationOption = "SEND_INTERRUPT"|"TERMINATE_PROCESS"
)