DescribeCluster - Amazon EMR
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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

Request Syntax

{ "ClusterId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The identifier of the cluster to describe.

Type: String

Required: Yes

Response Syntax

{ "Cluster": { "Applications": [ { "AdditionalInfo": { "string" : "string" }, "Args": [ "string" ], "Name": "string", "Version": "string" } ], "AutoScalingRole": "string", "AutoTerminate": boolean, "ClusterArn": "string", "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "CustomAmiId": "string", "EbsRootVolumeIops": number, "EbsRootVolumeSize": number, "EbsRootVolumeThroughput": number, "Ec2InstanceAttributes": { "AdditionalMasterSecurityGroups": [ "string" ], "AdditionalSlaveSecurityGroups": [ "string" ], "Ec2AvailabilityZone": "string", "Ec2KeyName": "string", "Ec2SubnetId": "string", "EmrManagedMasterSecurityGroup": "string", "EmrManagedSlaveSecurityGroup": "string", "IamInstanceProfile": "string", "RequestedEc2AvailabilityZones": [ "string" ], "RequestedEc2SubnetIds": [ "string" ], "ServiceAccessSecurityGroup": "string" }, "Id": "string", "InstanceCollectionType": "string", "KerberosAttributes": { "ADDomainJoinPassword": "string", "ADDomainJoinUser": "string", "CrossRealmTrustPrincipalPassword": "string", "KdcAdminPassword": "string", "Realm": "string" }, "LogEncryptionKmsKeyId": "string", "LogUri": "string", "MasterPublicDnsName": "string", "Name": "string", "NormalizedInstanceHours": number, "OSReleaseLabel": "string", "OutpostArn": "string", "PlacementGroups": [ { "InstanceRole": "string", "PlacementStrategy": "string" } ], "ReleaseLabel": "string", "RepoUpgradeOnBoot": "string", "RequestedAmiVersion": "string", "RunningAmiVersion": "string", "ScaleDownBehavior": "string", "SecurityConfiguration": "string", "ServiceRole": "string", "Status": { "ErrorDetails": [ { "ErrorCode": "string", "ErrorData": [ { "string" : "string" } ], "ErrorMessage": "string" } ], "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "ReadyDateTime": number } }, "StepConcurrencyLevel": number, "Tags": [ { "Key": "string", "Value": "string" } ], "TerminationProtected": boolean, "UnhealthyNodeReplacement": boolean, "VisibleToAllUsers": boolean } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


This output contains the details for the requested cluster.

Type: Cluster object


For information about the errors that are common to all actions, see Common Errors.


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

HTTP Status Code: 500


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: