Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCluster

Returns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication with the scheduler, and provisioning status.

Request Syntax


{
   "clusterIdentifier": "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.

clusterIdentifier

The name or ID of the cluster of the queue.

Type: String

Pattern: (pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,40})

Required: Yes

Response Syntax


{
   "cluster": { 
      "arn": "string",
      "createdAt": "string",
      "endpoints": [ 
         { 
            "port": "string",
            "privateIpAddress": "string",
            "publicIpAddress": "string",
            "type": "string"
         }
      ],
      "errorInfo": [ 
         { 
            "code": "string",
            "message": "string"
         }
      ],
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "networking": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ]
      },
      "scheduler": { 
         "type": "string",
         "version": "string"
      },
      "size": "string",
      "slurmConfiguration": { 
         "authKey": { 
            "secretArn": "string",
            "secretVersion": "string"
         },
         "scaleDownIdleTimeInSeconds": number,
         "slurmCustomSettings": [ 
            { 
               "parameterName": "string",
               "parameterValue": "string"
            }
         ]
      },
      "status": "string"
   }
}

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.

cluster

The cluster resource.

Type: Cluster object

Errors

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

AccessDeniedException

You don't have permission to perform the action.

Examples

The launch template instance profile doesn't pass iam:PassRole verification.
There is a mismatch between the account ID and cluster ID.
The cluster ID doesn't exist.
The EC2 instance isn't present.

HTTP Status Code: 400

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.

Examples

A cluster with the same name already exists.
A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has ACTIVE node groups or queues.
A queue already exists in a cluster.

HTTP Status Code: 400

InternalServerException

AWS PCS can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.

Examples

HTTP Status Code: 400

ThrottlingException

Your request exceeded a request rate quota. Check the resource's request rate quota and try again.

HTTP Status Code: 400

ValidationException

The request isn't valid.

Examples

Your request contains malformed JSON or unsupported characters.
The scheduler version isn't supported.
There are networking related errors, such as network validation failure.
AMI type is CUSTOM and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.

HTTP Status Code: 400