We are excited to announce our new API Documentation.
Protected
Provides more detail about the cluster step.
Use a bare-bones client and the command you need to make an API call.
import { EMRClient, DescribeStepCommand } from "@aws-sdk/client-emr"; // ES Modules import// const { EMRClient, DescribeStepCommand } = require("@aws-sdk/client-emr"); // CommonJS importconst client = new EMRClient(config);const input = { // DescribeStepInput ClusterId: "STRING_VALUE", // required StepId: "STRING_VALUE", // required};const command = new DescribeStepCommand(input);const response = await client.send(command);// { // DescribeStepOutput// Step: { // Step// 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"),// },// },// ExecutionRoleArn: "STRING_VALUE",// },// };
DescribeStepCommandInput
DescribeStepCommandOutput
input
response
config
InternalServerException (server fault)
This exception occurs when there is an internal failure in the Amazon EMR service.
InvalidRequestException (client fault)
This exception occurs when there is something wrong with user input.
EMRServiceException
Base exception class for all service exceptions from EMR service.
Readonly
Static
Provides more detail about the cluster step.
Example
Use a bare-bones client and the command you need to make an API call.
Param
DescribeStepCommandInput
Returns
DescribeStepCommandOutput
See
input
shape.response
shape.config
shape.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.