Skip to content

aws.emr.describe_cluster

Example SQL Queries

SELECT * FROM
aws.emr.describe_cluster
WHERE
"cluster_id" = 'VALUE';

Description

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.

Table Definition

Column NameColumn Data Type
cluster_id Required Input Column

The identifier of the cluster to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

cluster

This output contains the details for the requested cluster.

STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"status" STRUCT(
"state" VARCHAR,
"state_change_reason" STRUCT(
"code" VARCHAR,
"message" VARCHAR
),
"timeline" STRUCT(
"creation_date_time" TIMESTAMP_S,
"ready_date_time" TIMESTAMP_S,
"end_date_time" TIMESTAMP_S
),
"error_details" STRUCT(
"error_code" VARCHAR,
"error_data" MAP(VARCHAR, VARCHAR)[],
"error_message" VARCHAR
)[]
),
"ec2_instance_attributes" STRUCT(
"ec2_key_name" VARCHAR,
"ec2_subnet_id" VARCHAR,
"requested_ec2_subnet_ids" VARCHAR[],
"ec2_availability_zone" VARCHAR,
"requested_ec2_availability_zones" VARCHAR[],
"iam_instance_profile" VARCHAR,
"emr_managed_master_security_group" VARCHAR,
"emr_managed_slave_security_group" VARCHAR,
"service_access_security_group" VARCHAR,
"additional_master_security_groups" VARCHAR[],
"additional_slave_security_groups" VARCHAR[]
),
"instance_collection_type" VARCHAR,
"log_uri" VARCHAR,
"log_encryption_kms_key_id" VARCHAR,
"requested_ami_version" VARCHAR,
"running_ami_version" VARCHAR,
"release_label" VARCHAR,
"auto_terminate" BOOLEAN,
"termination_protected" BOOLEAN,
"unhealthy_node_replacement" BOOLEAN,
"visible_to_all_users" BOOLEAN,
"applications" STRUCT(
"name" VARCHAR,
"version" VARCHAR,
"args" VARCHAR[],
"additional_info" MAP(VARCHAR, VARCHAR)
)[],
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"service_role" VARCHAR,
"normalized_instance_hours" BIGINT,
"master_public_dns_name" VARCHAR,
"configurations" STRUCT(
"classification" VARCHAR,
"properties" MAP(VARCHAR, VARCHAR)
)[],
"security_configuration" VARCHAR,
"auto_scaling_role" VARCHAR,
"scale_down_behavior" VARCHAR,
"custom_ami_id" VARCHAR,
"ebs_root_volume_size" BIGINT,
"repo_upgrade_on_boot" VARCHAR,
"kerberos_attributes" STRUCT(
"realm" VARCHAR,
"kdc_admin_password" VARCHAR,
"cross_realm_trust_principal_password" VARCHAR,
"ad_domain_join_user" VARCHAR,
"ad_domain_join_password" VARCHAR
),
"cluster_arn" VARCHAR,
"outpost_arn" VARCHAR,
"step_concurrency_level" BIGINT,
"placement_groups" STRUCT(
"instance_role" VARCHAR,
"placement_strategy" VARCHAR
)[],
"os_release_label" VARCHAR,
"ebs_root_volume_iops" BIGINT,
"ebs_root_volume_throughput" BIGINT
)
Show child fields
cluster.applications[]
Show child fields
cluster.applications[].additional_info

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

cluster.applications[].args[]
cluster.applications[].name

The name of the application.

cluster.applications[].version

The version of the application.

cluster.auto_scaling_role

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.

cluster.auto_terminate

Specifies whether the cluster should terminate after completing all steps.

cluster.cluster_arn

The Amazon Resource Name of the cluster.

cluster.configurations[]
Show child fields
cluster.configurations[].classification

The classification within a configuration.

cluster.configurations[].properties

A set of properties specified within a configuration classification.

cluster.custom_ami_id

Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

cluster.ebs_root_volume_iops

The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

cluster.ebs_root_volume_size

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.

cluster.ebs_root_volume_throughput

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

cluster.ec2_instance_attributes

Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

Show child fields
cluster.ec2_instance_attributes.additional_master_security_groups[]
cluster.ec2_instance_attributes.additional_slave_security_groups[]
cluster.ec2_instance_attributes.ec2_availability_zone

The Availability Zone in which the cluster will run.

cluster.ec2_instance_attributes.ec2_key_name

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".

cluster.ec2_instance_attributes.ec2_subnet_id

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

cluster.ec2_instance_attributes.emr_managed_master_security_group

The identifier of the Amazon EC2 security group for the master node.

cluster.ec2_instance_attributes.emr_managed_slave_security_group

The identifier of the Amazon EC2 security group for the core and task nodes.

cluster.ec2_instance_attributes.iam_instance_profile

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

cluster.ec2_instance_attributes.requested_ec2_availability_zones[]
cluster.ec2_instance_attributes.requested_ec2_subnet_ids[]
cluster.ec2_instance_attributes.service_access_security_group

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

cluster.id

The unique identifier for the cluster.

cluster.instance_collection_type

The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

cluster.kerberos_attributes

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Show child fields
cluster.kerberos_attributes.ad_domain_join_password

The Active Directory password for ADDomainJoinUser.

cluster.kerberos_attributes.ad_domain_join_user

Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.

cluster.kerberos_attributes.cross_realm_trust_principal_password

Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.

cluster.kerberos_attributes.kdc_admin_password

The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.

cluster.kerberos_attributes.realm

The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.

cluster.log_encryption_kms_key_id

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

cluster.log_uri

The path to the Amazon S3 location where logs for this cluster are stored.

cluster.master_public_dns_name

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

cluster.name

The name of the cluster. This parameter can't contain the characters <, >, $, |, or ` (backtick).

cluster.normalized_instance_hours

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

cluster.os_release_label

The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.

cluster.outpost_arn

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

cluster.placement_groups[]
Show child fields
cluster.placement_groups[].instance_role

Role of the instance in the cluster.

Starting with Amazon EMR release 5.23.0, the only supported instance role is MASTER.

cluster.placement_groups[].placement_strategy

Amazon EC2 Placement Group strategy associated with instance role.

Starting with Amazon EMR release 5.23.0, the only supported placement strategy is SPREAD for the MASTER instance role.

cluster.release_label

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

cluster.repo_upgrade_on_boot

Applies only when CustomAmiID is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.

cluster.requested_ami_version

The AMI version requested for this cluster.

cluster.running_ami_version

The AMI version running on this cluster.

cluster.scale_down_behavior

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 is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

cluster.security_configuration

The name of the security configuration applied to the cluster.

cluster.service_role

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

cluster.status

The current status details about the cluster.

Show child fields
cluster.status.error_details[]
Show child fields
cluster.status.error_details[].error_code

The name or code associated with the error.

cluster.status.error_details[].error_data[]
cluster.status.error_details[].error_message

A message that describes the error.

cluster.status.state

The current state of the cluster.

cluster.status.state_change_reason

The reason for the cluster status change.

Show child fields
cluster.status.state_change_reason.code

The programmatic code for the state change reason.

cluster.status.state_change_reason.message

The descriptive message for the state change reason.

cluster.status.timeline

A timeline that represents the status of a cluster over the lifetime of the cluster.

Show child fields
cluster.status.timeline.creation_date_time

The creation date and time of the cluster.

cluster.status.timeline.end_date_time

The date and time when the cluster was terminated.

cluster.status.timeline.ready_date_time

The date and time when the cluster was ready to run steps.

cluster.step_concurrency_level

Specifies the number of steps that can be executed concurrently.

cluster.tags[]
Show child fields
cluster.tags[].key

A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag.

cluster.tags[].value

A user-defined value, which is optional in a tag. For more information, see Tag Clusters.

cluster.termination_protected

Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

cluster.unhealthy_node_replacement

Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.

cluster.visible_to_all_users

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 on the cluster 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.