2016/08/02 - Amazon Elastic MapReduce - 2 updated api methods
{'Step': {'Status': {'FailureDetails': {'LogFile': 'string',
'Message': 'string',
'Reason': 'string'}}}}
Provides more detail about the cluster step.
Request Syntax
client.describe_step(
ClusterId='string',
StepId='string'
)
string
[REQUIRED]
The identifier of the cluster with steps to describe.
string
[REQUIRED]
The identifier of the step to describe.
dict
Response Syntax
{
'Step': {
'Id': 'string',
'Name': 'string',
'Config': {
'Jar': 'string',
'Properties': {
'string': 'string'
},
'MainClass': 'string',
'Args': [
'string',
]
},
'ActionOnFailure': 'TERMINATE_JOB_FLOW'|'TERMINATE_CLUSTER'|'CANCEL_AND_WAIT'|'CONTINUE',
'Status': {
'State': 'PENDING'|'RUNNING'|'COMPLETED'|'CANCELLED'|'FAILED'|'INTERRUPTED',
'StateChangeReason': {
'Code': 'NONE',
'Message': 'string'
},
'FailureDetails': {
'Reason': 'string',
'Message': 'string',
'LogFile': 'string'
},
'Timeline': {
'CreationDateTime': datetime(2015, 1, 1),
'StartDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1)
}
}
}
}
Response Structure
(dict) --
This output contains the description of the cluster step.
Step (dict) --
The step details for the requested step identifier.
Id (string) --
The identifier of the cluster step.
Name (string) --
The name of the cluster step.
Config (dict) --
The Hadoop job configuration of the cluster step.
Jar (string) --
The path to the JAR file that runs during the step.
Properties (dict) --
The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
(string) --
(string) --
MainClass (string) --
The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
Args (list) --
The list of command line arguments to pass to the JAR file's main function for execution.
(string) --
ActionOnFailure (string) --
This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
Status (dict) --
The current execution status details of the cluster step.
State (string) --
The execution state of the cluster step.
StateChangeReason (dict) --
The reason for the step execution status change.
Code (string) --
The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.
Message (string) --
The descriptive message for the state change reason.
FailureDetails (dict) --
The details for the step failure including reason, message, and log file path where the root cause was identified.
Reason (string) --
The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
Message (string) --
The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
LogFile (string) --
The path to the log file where the step failure root cause was originally recorded.
Timeline (dict) --
The timeline of the cluster step status over time.
CreationDateTime (datetime) --
The date and time when the cluster step was created.
StartDateTime (datetime) --
The date and time when the cluster step execution started.
EndDateTime (datetime) --
The date and time when the cluster step execution completed or failed.
{'Steps': {'Status': {'FailureDetails': {'LogFile': 'string',
'Message': 'string',
'Reason': 'string'}}}}
Provides a list of steps for the cluster.
Request Syntax
client.list_steps(
ClusterId='string',
StepStates=[
'PENDING'|'RUNNING'|'COMPLETED'|'CANCELLED'|'FAILED'|'INTERRUPTED',
],
StepIds=[
'string',
],
Marker='string'
)
string
[REQUIRED]
The identifier of the cluster for which to list the steps.
list
The filter to limit the step list based on certain states.
(string) --
list
The filter to limit the step list based on the identifier of the steps.
(string) --
string
The pagination token that indicates the next set of results to retrieve.
dict
Response Syntax
{
'Steps': [
{
'Id': 'string',
'Name': 'string',
'Config': {
'Jar': 'string',
'Properties': {
'string': 'string'
},
'MainClass': 'string',
'Args': [
'string',
]
},
'ActionOnFailure': 'TERMINATE_JOB_FLOW'|'TERMINATE_CLUSTER'|'CANCEL_AND_WAIT'|'CONTINUE',
'Status': {
'State': 'PENDING'|'RUNNING'|'COMPLETED'|'CANCELLED'|'FAILED'|'INTERRUPTED',
'StateChangeReason': {
'Code': 'NONE',
'Message': 'string'
},
'FailureDetails': {
'Reason': 'string',
'Message': 'string',
'LogFile': 'string'
},
'Timeline': {
'CreationDateTime': datetime(2015, 1, 1),
'StartDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1)
}
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.
Steps (list) --
The filtered list of steps for the cluster.
(dict) --
The summary of the cluster step.
Id (string) --
The identifier of the cluster step.
Name (string) --
The name of the cluster step.
Config (dict) --
The Hadoop job configuration of the cluster step.
Jar (string) --
The path to the JAR file that runs during the step.
Properties (dict) --
The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
(string) --
(string) --
MainClass (string) --
The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
Args (list) --
The list of command line arguments to pass to the JAR file's main function for execution.
(string) --
ActionOnFailure (string) --
This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
Status (dict) --
The current execution status details of the cluster step.
State (string) --
The execution state of the cluster step.
StateChangeReason (dict) --
The reason for the step execution status change.
Code (string) --
The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.
Message (string) --
The descriptive message for the state change reason.
FailureDetails (dict) --
The details for the step failure including reason, message, and log file path where the root cause was identified.
Reason (string) --
The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
Message (string) --
The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
LogFile (string) --
The path to the log file where the step failure root cause was originally recorded.
Timeline (dict) --
The timeline of the cluster step status over time.
CreationDateTime (datetime) --
The date and time when the cluster step was created.
StartDateTime (datetime) --
The date and time when the cluster step execution started.
EndDateTime (datetime) --
The date and time when the cluster step execution completed or failed.
Marker (string) --
The pagination token that indicates the next set of results to retrieve.