JobFlowDetail
A description of a cluster (job flow).
Contents
- ExecutionStatusDetail
-
Describes the execution status of the job flow.
Type: JobFlowExecutionStatusDetail object
Required: Yes
- Instances
-
Describes the Amazon EC2 instances of the job flow.
Type: JobFlowInstancesDetail object
Required: Yes
- JobFlowId
-
The job flow identifier.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- Name
-
The name of the job flow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- AmiVersion
-
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,
ReleaseLabel
is used. To specify a custom AMI, useCustomAmiID
.Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- AutoScalingRole
-
An IAM role for automatic scaling policies. The default role is
EMR_AutoScaling_DefaultRole
. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate Amazon EC2 instances in an instance group.Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- BootstrapActions
-
A list of the bootstrap actions run by the job flow.
Type: Array of BootstrapActionDetail objects
Required: No
- JobFlowRole
-
The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- LogEncryptionKmsKeyId
-
The AWS KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- LogUri
-
The location in Amazon S3 where log files for the job are stored.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- ScaleDownBehavior
-
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption.TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.Type: String
Valid Values:
TERMINATE_AT_INSTANCE_HOUR | TERMINATE_AT_TASK_COMPLETION
Required: No
- ServiceRole
-
The IAM role that is assumed by the Amazon EMR service to access AWS resources on your behalf.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- Steps
-
A list of steps run by the job flow.
Type: Array of StepDetail objects
Required: No
- SupportedProducts
-
A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- VisibleToAllUsers
-
Indicates whether the cluster is visible to IAM principals in the AWS account associated with the cluster. When
true
, IAM principals in the AWS account can perform Amazon EMR cluster actions that their IAM policies allow. Whenfalse
, only the IAM principal that created the cluster and the AWS account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.The default value is
true
if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the AWS CLI create-cluster command, or the AWS Management Console.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: