EMR / Client / add_job_flow_steps

add_job_flow_steps#

EMR.Client.add_job_flow_steps(**kwargs)#

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.

If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop.

A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.

Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.

You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.

Note

The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.

See also: AWS API Documentation

Request Syntax

response = client.add_job_flow_steps(
    JobFlowId='string',
    Steps=[
        {
            'Name': 'string',
            'ActionOnFailure': 'TERMINATE_JOB_FLOW'|'TERMINATE_CLUSTER'|'CANCEL_AND_WAIT'|'CONTINUE',
            'HadoopJarStep': {
                'Properties': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'Jar': 'string',
                'MainClass': 'string',
                'Args': [
                    'string',
                ]
            }
        },
    ],
    ExecutionRoleArn='string'
)
Parameters:

  • JobFlowId (string) –

    [REQUIRED]

    A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.

  • Steps (list) –

    [REQUIRED]

    A list of StepConfig to be executed by the job flow.

    • (dict) –

      Specification for a cluster (job flow) step.

      • Name (string) – [REQUIRED]

        The name of the step.

      • ActionOnFailure (string) –

        The action to take when the step fails. Use one of the following values:

        • TERMINATE_CLUSTER - Shuts down the cluster.

        • CANCEL_AND_WAIT - Cancels any pending steps and returns the cluster to the WAITING state.

        • CONTINUE - Continues to the next step in the queue.

        • TERMINATE_JOB_FLOW - Shuts down the cluster. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

        If a cluster’s StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

        If you change a cluster’s StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.

      • HadoopJarStep (dict) – [REQUIRED]

        The JAR file used for the step.

        • Properties (list) –

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

          • (dict) –

            A key-value pair.

            • Key (string) –

              The unique identifier of a key-value pair.

            • Value (string) –

              The value part of the identified key.

        • Jar (string) – [REQUIRED]

          A path to a JAR file run during the step.

        • 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) –

          A list of command line arguments passed to the JAR file’s main function when executed.

          • (string) –

  • ExecutionRoleArn (string) –

    The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.

    For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.

Return type:

dict

Returns:

Response Syntax

{
    'StepIds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    The output for the AddJobFlowSteps operation.

    • StepIds (list) –

      The identifiers of the list of steps added to the job flow.

      • (string) –

Exceptions