Skip to content

Step

Source code in docs_src/capo_emr/types/step.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class Step(TypedDict, closed=True):
    id: NotRequired["capo_emr.types.step_id.StepId"]
    """<p>The identifier of the cluster step.</p>"""
    name: NotRequired["capo_emr.types.string.String"]
    """<p>The name of the cluster step.</p>"""
    config: NotRequired["capo_emr.types.hadoop_step_config.HadoopStepConfig"]
    """<p>The Hadoop job configuration of the cluster step.</p>"""
    action_on_failure: NotRequired["capo_emr.types.action_on_failure.ActionOnFailure"]
    """<p>The action to take when the cluster step fails. Possible values are <code>TERMINATE_CLUSTER</code>, <code>CANCEL_AND_WAIT</code>, and <code>CONTINUE</code>. <code>TERMINATE_JOB_FLOW</code> is provided for backward compatibility. We recommend using <code>TERMINATE_CLUSTER</code> instead.</p> <p>If a cluster's <code>StepConcurrencyLevel</code> is greater than <code>1</code>, do not use <code>AddJobFlowSteps</code> to submit a step with this parameter set to <code>CANCEL_AND_WAIT</code> or <code>TERMINATE_CLUSTER</code>. The step is not submitted and the action fails with a message that the <code>ActionOnFailure</code> setting is not valid.</p> <p>If you change a cluster's <code>StepConcurrencyLevel</code> to be greater than 1 while a step is running, the <code>ActionOnFailure</code> parameter may not behave as you expect. In this case, for a step that fails with this parameter set to <code>CANCEL_AND_WAIT</code>, pending steps and the running step are not canceled; for a step that fails with this parameter set to <code>TERMINATE_CLUSTER</code>, the cluster does not terminate.</p>"""
    status: NotRequired["capo_emr.types.step_status.StepStatus"]
    """<p>The current execution status details of the cluster step.</p>"""
    execution_role_arn: NotRequired["capo_emr.types.optional_arn_type.OptionalArnType"]
    """<p>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: <code>arn:partition:service:region:account:resource</code>. </p> <p>For example, <code>arn:aws:IAM::1234567890:role/ReadOnly</code> is a correctly formatted runtime role ARN.</p>"""
    log_uri: NotRequired["capo_emr.types.string.String"]
    """<p>The Amazon S3 destination URI for log publishing.</p>"""
    encryption_key_arn: NotRequired["capo_emr.types.string.String"]
    """<p>The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.</p>"""

action_on_failure instance-attribute 

action_on_failure: NotRequired[ActionOnFailure]

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. 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.

config instance-attribute 

config: NotRequired[HadoopStepConfig]

The Hadoop job configuration of the cluster step.

encryption_key_arn instance-attribute 

encryption_key_arn: NotRequired[String]

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

execution_role_arn instance-attribute 

execution_role_arn: NotRequired[OptionalArnType]

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.

id instance-attribute 

id: NotRequired[StepId]

The identifier of the cluster step.

log_uri instance-attribute 

log_uri: NotRequired[String]

The Amazon S3 destination URI for log publishing.

name instance-attribute 

name: NotRequired[String]

The name of the cluster step.

status instance-attribute 

status: NotRequired[StepStatus]

The current execution status details of the cluster step.