Skip to content

JobFlowDetail

Source code in docs_src/capo_emr/types/job_flow_detail.py
class JobFlowDetail(TypedDict, closed=True):
    job_flow_id: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The job flow identifier.</p>"""
    name: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The name of the job flow.</p>"""
    log_uri: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The location in Amazon S3 where log files for the job are stored.</p>"""
    log_encryption_kms_key_id: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.</p>"""
    ami_version: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, <code>ReleaseLabel</code> is used. To specify a custom AMI, use <code>CustomAmiID</code>.</p>"""
    execution_status_detail: NotRequired[
        "capo_emr.types.job_flow_execution_status_detail.JobFlowExecutionStatusDetail"
    ]
    """<p>Describes the execution status of the job flow.</p>"""
    instances: NotRequired[
        "capo_emr.types.job_flow_instances_detail.JobFlowInstancesDetail"
    ]
    """<p>Describes the Amazon EC2 instances of the job flow.</p>"""
    steps: NotRequired["capo_emr.types.step_detail_list.StepDetailList"]
    """<p>A list of steps run by the job flow.</p>"""
    bootstrap_actions: NotRequired[
        "capo_emr.types.bootstrap_action_detail_list.BootstrapActionDetailList"
    ]
    """<p>A list of the bootstrap actions run by the job flow.</p>"""
    supported_products: NotRequired[
        "capo_emr.types.supported_products_list.SupportedProductsList"
    ]
    """<p>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.</p>"""
    visible_to_all_users: NotRequired["capo_emr.types.boolean.Boolean"]
    """<p>Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When <code>true</code>, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.</p> <p>The default value is <code>true</code> if a value is not provided when creating a cluster using the Amazon EMR API <a>RunJobFlow</a> command, the CLI <a href="https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html">create-cluster</a> command, or the Amazon Web Services Management Console.</p>"""
    job_flow_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.</p>"""
    service_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.</p>"""
    auto_scaling_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>An IAM role for automatic scaling policies. The default role is <code>EMR_AutoScaling_DefaultRole</code>. 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.</p>"""
    scale_down_behavior: NotRequired[
        "capo_emr.types.scale_down_behavior.ScaleDownBehavior"
    ]
    """<p>The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. <code>TERMINATE_AT_INSTANCE_HOUR</code> 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. <code>TERMINATE_AT_TASK_COMPLETION</code> 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. <code>TERMINATE_AT_TASK_COMPLETION</code> 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.</p>"""

ami_version instance-attribute

ami_version: NotRequired[XmlStringMaxLen256]

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, use CustomAmiID.

auto_scaling_role instance-attribute

auto_scaling_role: NotRequired[XmlString]

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.

bootstrap_actions instance-attribute

bootstrap_actions: NotRequired[BootstrapActionDetailList]

A list of the bootstrap actions run by the job flow.

execution_status_detail instance-attribute

execution_status_detail: NotRequired[JobFlowExecutionStatusDetail]

Describes the execution status of the job flow.

instances instance-attribute

instances: NotRequired[JobFlowInstancesDetail]

Describes the Amazon EC2 instances of the job flow.

job_flow_id instance-attribute

job_flow_id: NotRequired[XmlStringMaxLen256]

The job flow identifier.

job_flow_role instance-attribute

job_flow_role: NotRequired[XmlString]

The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.

log_encryption_kms_key_id instance-attribute

log_encryption_kms_key_id: NotRequired[XmlString]

The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.

log_uri instance-attribute

log_uri: NotRequired[XmlString]

The location in Amazon S3 where log files for the job are stored.

name instance-attribute

name: NotRequired[XmlStringMaxLen256]

The name of the job flow.

scale_down_behavior instance-attribute

scale_down_behavior: NotRequired[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.

service_role instance-attribute

service_role: NotRequired[XmlString]

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

steps instance-attribute

steps: NotRequired[StepDetailList]

A list of steps run by the job flow.

supported_products instance-attribute

supported_products: NotRequired[SupportedProductsList]

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.

visible_to_all_users instance-attribute

visible_to_all_users: NotRequired[Boolean]

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services 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 CLI create-cluster command, or the Amazon Web Services Management Console.