Amazonka.EMR.Types.Step

Documentation

data Step

This represents a step in a cluster.

See: newStep smart constructor.

Constructors

Step'

Fields

• actionOnFailure :: Maybe 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 :: Maybe HadoopStepConfig

  The Hadoop job configuration of the cluster step.

• executionRoleArn :: Maybe Text

  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 :: Maybe Text

  The identifier of the cluster step.

• name :: Maybe Text

  The name of the cluster step.

• status :: Maybe StepStatus

  The current execution status details of the cluster step.

Instances

FromJSON Step

Defined in Amazonka.EMR.Types.Step

Methods

parseJSON :: Value -> Parser Step

parseJSONList :: Value -> Parser [Step]

Generic Step

Defined in Amazonka.EMR.Types.Step

Associated Types

type Rep Step :: Type -> Type

Methods

from :: Step -> Rep Step x

to :: Rep Step x -> Step

Read Step

Defined in Amazonka.EMR.Types.Step

Methods

readsPrec :: Int -> ReadS Step

readList :: ReadS [Step]

readPrec :: ReadPrec Step

readListPrec :: ReadPrec [Step]

Show Step

Defined in Amazonka.EMR.Types.Step

Methods

showsPrec :: Int -> Step -> ShowS

show :: Step -> String

showList :: [Step] -> ShowS

NFData Step

Defined in Amazonka.EMR.Types.Step

Methods

rnf :: Step -> ()

Eq Step

Defined in Amazonka.EMR.Types.Step

Methods

(==) :: Step -> Step -> Bool

(/=) :: Step -> Step -> Bool

Hashable Step

Defined in Amazonka.EMR.Types.Step

Methods

hashWithSalt :: Int -> Step -> Int

hash :: Step -> Int

type Rep Step

Defined in Amazonka.EMR.Types.Step

type Rep Step = D1 ('MetaData "Step" "Amazonka.EMR.Types.Step" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "Step'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "actionOnFailure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionOnFailure)) :*: (S1 ('MetaSel ('Just "config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HadoopStepConfig)) :*: S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepStatus))))))

newStep :: Step

Create a value of Step with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:actionOnFailure:Step', step_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.

$sel:config:Step', step_config - The Hadoop job configuration of the cluster step.

$sel:executionRoleArn:Step', step_executionRoleArn - 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.

$sel:id:Step', step_id - The identifier of the cluster step.

$sel:name:Step', step_name - The name of the cluster step.

$sel:status:Step', step_status - The current execution status details of the cluster step.

step_actionOnFailure :: Lens' Step (Maybe 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.

step_config :: Lens' Step (Maybe HadoopStepConfig)

The Hadoop job configuration of the cluster step.

step_executionRoleArn :: Lens' Step (Maybe Text)

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.

step_id :: Lens' Step (Maybe Text)

The identifier of the cluster step.

step_name :: Lens' Step (Maybe Text)

The name of the cluster step.

step_status :: Lens' Step (Maybe StepStatus)

The current execution status details of the cluster step.