Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Step = Step' {}
- newStep :: Step
- step_actionOnFailure :: Lens' Step (Maybe ActionOnFailure)
- step_config :: Lens' Step (Maybe HadoopStepConfig)
- step_executionRoleArn :: Lens' Step (Maybe Text)
- step_id :: Lens' Step (Maybe Text)
- step_name :: Lens' Step (Maybe Text)
- step_status :: Lens' Step (Maybe StepStatus)
Documentation
This represents a step in a cluster.
See: newStep
smart constructor.
Step' | |
|
Instances
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) Source #
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) Source #
The Hadoop job configuration of the cluster step.
step_executionRoleArn :: Lens' Step (Maybe Text) Source #
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_status :: Lens' Step (Maybe StepStatus) Source #
The current execution status details of the cluster step.