EMR / Client / list_steps

list_steps#

EMR.Client.list_steps(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_steps(
    ClusterId='string',
    StepStates=[
        'PENDING'|'CANCEL_PENDING'|'RUNNING'|'COMPLETED'|'CANCELLED'|'FAILED'|'INTERRUPTED',
    ],
    StepIds=[
        'string',
    ],
    Marker='string'
)
Parameters:

  • ClusterId (string) –

    [REQUIRED]

    The identifier of the cluster for which to list the steps.

  • StepStates (list) –

    The filter to limit the step list based on certain states.

    • (string) –

  • StepIds (list) –

    The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.

    • (string) –

  • Marker (string) – The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

Return type:

dict

Returns:

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'|'CANCEL_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) –

          The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility.

        • 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 Amazon 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 maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

Exceptions