Class DescribeClusterCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { EMRClient, DescribeClusterCommand } from "@aws-sdk/client-emr"; // ES Modules import
// const { EMRClient, DescribeClusterCommand } = require("@aws-sdk/client-emr"); // CommonJS import
const client = new EMRClient(config);
const input = { // DescribeClusterInput
  ClusterId: "STRING_VALUE", // required
};
const command = new DescribeClusterCommand(input);
const response = await client.send(command);
// { // DescribeClusterOutput
//   Cluster: { // Cluster
//     Id: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Status: { // ClusterStatus
//       State: "STARTING" || "BOOTSTRAPPING" || "RUNNING" || "WAITING" || "TERMINATING" || "TERMINATED" || "TERMINATED_WITH_ERRORS",
//       StateChangeReason: { // ClusterStateChangeReason
//         Code: "INTERNAL_ERROR" || "VALIDATION_ERROR" || "INSTANCE_FAILURE" || "INSTANCE_FLEET_TIMEOUT" || "BOOTSTRAP_FAILURE" || "USER_REQUEST" || "STEP_FAILURE" || "ALL_STEPS_COMPLETED",
//         Message: "STRING_VALUE",
//       },
//       Timeline: { // ClusterTimeline
//         CreationDateTime: new Date("TIMESTAMP"),
//         ReadyDateTime: new Date("TIMESTAMP"),
//         EndDateTime: new Date("TIMESTAMP"),
//       },
//       ErrorDetails: [ // ErrorDetailList
//         { // ErrorDetail
//           ErrorCode: "STRING_VALUE",
//           ErrorData: [ // ErrorData
//             { // StringMap
//               "<keys>": "STRING_VALUE",
//             },
//           ],
//           ErrorMessage: "STRING_VALUE",
//         },
//       ],
//     },
//     Ec2InstanceAttributes: { // Ec2InstanceAttributes
//       Ec2KeyName: "STRING_VALUE",
//       Ec2SubnetId: "STRING_VALUE",
//       RequestedEc2SubnetIds: [ // XmlStringMaxLen256List
//         "STRING_VALUE",
//       ],
//       Ec2AvailabilityZone: "STRING_VALUE",
//       RequestedEc2AvailabilityZones: [
//         "STRING_VALUE",
//       ],
//       IamInstanceProfile: "STRING_VALUE",
//       EmrManagedMasterSecurityGroup: "STRING_VALUE",
//       EmrManagedSlaveSecurityGroup: "STRING_VALUE",
//       ServiceAccessSecurityGroup: "STRING_VALUE",
//       AdditionalMasterSecurityGroups: [ // StringList
//         "STRING_VALUE",
//       ],
//       AdditionalSlaveSecurityGroups: [
//         "STRING_VALUE",
//       ],
//     },
//     InstanceCollectionType: "INSTANCE_FLEET" || "INSTANCE_GROUP",
//     LogUri: "STRING_VALUE",
//     LogEncryptionKmsKeyId: "STRING_VALUE",
//     RequestedAmiVersion: "STRING_VALUE",
//     RunningAmiVersion: "STRING_VALUE",
//     ReleaseLabel: "STRING_VALUE",
//     AutoTerminate: true || false,
//     TerminationProtected: true || false,
//     VisibleToAllUsers: true || false,
//     Applications: [ // ApplicationList
//       { // Application
//         Name: "STRING_VALUE",
//         Version: "STRING_VALUE",
//         Args: [
//           "STRING_VALUE",
//         ],
//         AdditionalInfo: {
//           "<keys>": "STRING_VALUE",
//         },
//       },
//     ],
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     ServiceRole: "STRING_VALUE",
//     NormalizedInstanceHours: Number("int"),
//     MasterPublicDnsName: "STRING_VALUE",
//     Configurations: [ // ConfigurationList
//       { // Configuration
//         Classification: "STRING_VALUE",
//         Configurations: [
//           {
//             Classification: "STRING_VALUE",
//             Configurations: "<ConfigurationList>",
//             Properties: {
//               "<keys>": "STRING_VALUE",
//             },
//           },
//         ],
//         Properties: {
//           "<keys>": "STRING_VALUE",
//         },
//       },
//     ],
//     SecurityConfiguration: "STRING_VALUE",
//     AutoScalingRole: "STRING_VALUE",
//     ScaleDownBehavior: "TERMINATE_AT_INSTANCE_HOUR" || "TERMINATE_AT_TASK_COMPLETION",
//     CustomAmiId: "STRING_VALUE",
//     EbsRootVolumeSize: Number("int"),
//     RepoUpgradeOnBoot: "SECURITY" || "NONE",
//     KerberosAttributes: { // KerberosAttributes
//       Realm: "STRING_VALUE", // required
//       KdcAdminPassword: "STRING_VALUE", // required
//       CrossRealmTrustPrincipalPassword: "STRING_VALUE",
//       ADDomainJoinUser: "STRING_VALUE",
//       ADDomainJoinPassword: "STRING_VALUE",
//     },
//     ClusterArn: "STRING_VALUE",
//     OutpostArn: "STRING_VALUE",
//     StepConcurrencyLevel: Number("int"),
//     PlacementGroups: [ // PlacementGroupConfigList
//       { // PlacementGroupConfig
//         InstanceRole: "MASTER" || "CORE" || "TASK", // required
//         PlacementStrategy: "SPREAD" || "PARTITION" || "CLUSTER" || "NONE",
//       },
//     ],
//     OSReleaseLabel: "STRING_VALUE",
//   },
// };

Param

DescribeClusterCommandInput

Returns

DescribeClusterCommandOutput

See

• DescribeClusterCommandInput for command's input shape.
• DescribeClusterCommandOutput for command's response shape.
• config for EMRClient's config shape.

Throws

InternalServerException (server fault)

This exception occurs when there is an internal failure in the Amazon EMR service.

Throws

InvalidRequestException (client fault)

This exception occurs when there is something wrong with user input.

Throws

EMRServiceException

Base exception class for all service exceptions from EMR service.