Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class ListStepsCommandProtected

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve.

Example

Use a bare-bones client and the command you need to make an API call.

import { EMRClient, ListStepsCommand } from "@aws-sdk/client-emr"; // ES Modules import
// const { EMRClient, ListStepsCommand } = require("@aws-sdk/client-emr"); // CommonJS import
const client = new EMRClient(config);
const input = { // ListStepsInput
ClusterId: "STRING_VALUE", // required
StepStates: [ // StepStateList
"PENDING" || "CANCEL_PENDING" || "RUNNING" || "COMPLETED" || "CANCELLED" || "FAILED" || "INTERRUPTED",
],
StepIds: [ // XmlStringList
"STRING_VALUE",
],
Marker: "STRING_VALUE",
};
const command = new ListStepsCommand(input);
const response = await client.send(command);
// { // ListStepsOutput
// Steps: [ // StepSummaryList
// { // StepSummary
// Id: "STRING_VALUE",
// Name: "STRING_VALUE",
// Config: { // HadoopStepConfig
// Jar: "STRING_VALUE",
// Properties: { // StringMap
// "<keys>": "STRING_VALUE",
// },
// MainClass: "STRING_VALUE",
// Args: [ // StringList
// "STRING_VALUE",
// ],
// },
// ActionOnFailure: "TERMINATE_JOB_FLOW" || "TERMINATE_CLUSTER" || "CANCEL_AND_WAIT" || "CONTINUE",
// Status: { // StepStatus
// State: "PENDING" || "CANCEL_PENDING" || "RUNNING" || "COMPLETED" || "CANCELLED" || "FAILED" || "INTERRUPTED",
// StateChangeReason: { // StepStateChangeReason
// Code: "NONE",
// Message: "STRING_VALUE",
// },
// FailureDetails: { // FailureDetails
// Reason: "STRING_VALUE",
// Message: "STRING_VALUE",
// LogFile: "STRING_VALUE",
// },
// Timeline: { // StepTimeline
// CreationDateTime: new Date("TIMESTAMP"),
// StartDateTime: new Date("TIMESTAMP"),
// EndDateTime: new Date("TIMESTAMP"),
// },
// },
// },
// ],
// Marker: "STRING_VALUE",
// };

Param

ListStepsCommandInput

Returns

ListStepsCommandOutput

See

Throws

InternalServerException (server fault)

This exception occurs when there is an internal failure in the Amazon EMR service.

Throws

InvalidRequestException (client fault)

This exception occurs when there is something wrong with user input.

Throws

EMRServiceException

Base exception class for all service exceptions from EMR service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods