CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.

Parameter Syntax

$result = $client->createCluster([
    'clientToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'networking' => [ // REQUIRED
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'scheduler' => [ // REQUIRED
        'type' => 'SLURM', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'size' => 'SMALL|MEDIUM|LARGE', // REQUIRED
    'slurmConfiguration' => [
        'scaleDownIdleTimeInSeconds' => <integer>,
        'slurmCustomSettings' => [
            [
                'parameterName' => '<string>', // REQUIRED
                'parameterValue' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'endpoints' => [
            [
                'port' => '<string>',
                'privateIpAddress' => '<string>',
                'publicIpAddress' => '<string>',
                'type' => 'SLURMCTLD|SLURMDBD',
            ],
            // ...
        ],
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'networking' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'scheduler' => [
            'type' => 'SLURM',
            'version' => '<string>',
        ],
        'size' => 'SMALL|MEDIUM|LARGE',
        'slurmConfiguration' => [
            'authKey' => [
                'secretArn' => '<string>',
                'secretVersion' => '<string>',
            ],
            'scaleDownIdleTimeInSeconds' => <integer>,
            'slurmCustomSettings' => [
                [
                    'parameterName' => '<string>',
                    'parameterValue' => '<string>',
                ],
                // ...
            ],
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide

Examples

• The max number of clusters or queues has been reached for the account.

• The max number of compute node groups has been reached for the associated cluster.

• The total of maxInstances across all compute node groups has been reached for associated cluster.

ThrottlingException:

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

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.

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.

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

CreateComputeNodeGroup

$result = $client->createComputeNodeGroup([/* ... */]);
$promise = $client->createComputeNodeGroupAsync([/* ... */]);

Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

Parameter Syntax

$result = $client->createComputeNodeGroup([
    'amiId' => '<string>',
    'clientToken' => '<string>',
    'clusterIdentifier' => '<string>', // REQUIRED
    'computeNodeGroupName' => '<string>', // REQUIRED
    'customLaunchTemplate' => [ // REQUIRED
        'id' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'iamInstanceProfileArn' => '<string>', // REQUIRED
    'instanceConfigs' => [ // REQUIRED
        [
            'instanceType' => '<string>',
        ],
        // ...
    ],
    'purchaseOption' => 'ONDEMAND|SPOT',
    'scalingConfiguration' => [ // REQUIRED
        'maxInstanceCount' => <integer>, // REQUIRED
        'minInstanceCount' => <integer>, // REQUIRED
    ],
    'slurmConfiguration' => [
        'slurmCustomSettings' => [
            [
                'parameterName' => '<string>', // REQUIRED
                'parameterValue' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'spotOptions' => [
        'allocationStrategy' => 'lowest-price|capacity-optimized|price-capacity-optimized',
    ],
    'subnetIds' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'computeNodeGroup' => [
        'amiId' => '<string>',
        'arn' => '<string>',
        'clusterId' => '<string>',
        'createdAt' => <DateTime>,
        'customLaunchTemplate' => [
            'id' => '<string>',
            'version' => '<string>',
        ],
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'iamInstanceProfileArn' => '<string>',
        'id' => '<string>',
        'instanceConfigs' => [
            [
                'instanceType' => '<string>',
            ],
            // ...
        ],
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'purchaseOption' => 'ONDEMAND|SPOT',
        'scalingConfiguration' => [
            'maxInstanceCount' => <integer>,
            'minInstanceCount' => <integer>,
        ],
        'slurmConfiguration' => [
            'slurmCustomSettings' => [
                [
                    'parameterName' => '<string>',
                    'parameterValue' => '<string>',
                ],
                // ...
            ],
        ],
        'spotOptions' => [
            'allocationStrategy' => 'lowest-price|capacity-optimized|price-capacity-optimized',
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED|DELETED',
        'subnetIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide

Examples

• The max number of clusters or queues has been reached for the account.

• The max number of compute node groups has been reached for the associated cluster.

• The total of maxInstances across all compute node groups has been reached for associated cluster.

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

CreateQueue

$result = $client->createQueue([/* ... */]);
$promise = $client->createQueueAsync([/* ... */]);

Creates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.

Parameter Syntax

$result = $client->createQueue([
    'clientToken' => '<string>',
    'clusterIdentifier' => '<string>', // REQUIRED
    'computeNodeGroupConfigurations' => [
        [
            'computeNodeGroupId' => '<string>',
        ],
        // ...
    ],
    'queueName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'queue' => [
        'arn' => '<string>',
        'clusterId' => '<string>',
        'computeNodeGroupConfigurations' => [
            [
                'computeNodeGroupId' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide

Examples

• The max number of clusters or queues has been reached for the account.

• The max number of compute node groups has been reached for the associated cluster.

• The total of maxInstances across all compute node groups has been reached for associated cluster.

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Deletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.

Parameter Syntax

$result = $client->deleteCluster([
    'clientToken' => '<string>',
    'clusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

DeleteComputeNodeGroup

$result = $client->deleteComputeNodeGroup([/* ... */]);
$promise = $client->deleteComputeNodeGroupAsync([/* ... */]);

Deletes a compute node group. You must delete all queues associated with the compute node group first.

Parameter Syntax

$result = $client->deleteComputeNodeGroup([
    'clientToken' => '<string>',
    'clusterIdentifier' => '<string>', // REQUIRED
    'computeNodeGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

DeleteQueue

$result = $client->deleteQueue([/* ... */]);
$promise = $client->deleteQueueAsync([/* ... */]);

Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.

Parameter Syntax

$result = $client->deleteQueue([
    'clientToken' => '<string>',
    'clusterIdentifier' => '<string>', // REQUIRED
    'queueIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

GetCluster

$result = $client->getCluster([/* ... */]);
$promise = $client->getClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getCluster([
    'clusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'endpoints' => [
            [
                'port' => '<string>',
                'privateIpAddress' => '<string>',
                'publicIpAddress' => '<string>',
                'type' => 'SLURMCTLD|SLURMDBD',
            ],
            // ...
        ],
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'networking' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'scheduler' => [
            'type' => 'SLURM',
            'version' => '<string>',
        ],
        'size' => 'SMALL|MEDIUM|LARGE',
        'slurmConfiguration' => [
            'authKey' => [
                'secretArn' => '<string>',
                'secretVersion' => '<string>',
            ],
            'scaleDownIdleTimeInSeconds' => <integer>,
            'slurmCustomSettings' => [
                [
                    'parameterName' => '<string>',
                    'parameterValue' => '<string>',
                ],
                // ...
            ],
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
    ],
]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

GetComputeNodeGroup

$result = $client->getComputeNodeGroup([/* ... */]);
$promise = $client->getComputeNodeGroupAsync([/* ... */]);

Returns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler (such as Slurm) configuration.

Parameter Syntax

$result = $client->getComputeNodeGroup([
    'clusterIdentifier' => '<string>', // REQUIRED
    'computeNodeGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'computeNodeGroup' => [
        'amiId' => '<string>',
        'arn' => '<string>',
        'clusterId' => '<string>',
        'createdAt' => <DateTime>,
        'customLaunchTemplate' => [
            'id' => '<string>',
            'version' => '<string>',
        ],
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'iamInstanceProfileArn' => '<string>',
        'id' => '<string>',
        'instanceConfigs' => [
            [
                'instanceType' => '<string>',
            ],
            // ...
        ],
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'purchaseOption' => 'ONDEMAND|SPOT',
        'scalingConfiguration' => [
            'maxInstanceCount' => <integer>,
            'minInstanceCount' => <integer>,
        ],
        'slurmConfiguration' => [
            'slurmCustomSettings' => [
                [
                    'parameterName' => '<string>',
                    'parameterValue' => '<string>',
                ],
                // ...
            ],
        ],
        'spotOptions' => [
            'allocationStrategy' => 'lowest-price|capacity-optimized|price-capacity-optimized',
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED|DELETED',
        'subnetIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

GetQueue

$result = $client->getQueue([/* ... */]);
$promise = $client->getQueueAsync([/* ... */]);

Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.

Parameter Syntax

$result = $client->getQueue([
    'clusterIdentifier' => '<string>', // REQUIRED
    'queueIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'queue' => [
        'arn' => '<string>',
        'clusterId' => '<string>',
        'computeNodeGroupConfigurations' => [
            [
                'computeNodeGroupId' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
    ],
]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Returns a list of running clusters in your account.

Parameter Syntax

$result = $client->listClusters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'clusters' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

ListComputeNodeGroups

$result = $client->listComputeNodeGroups([/* ... */]);
$promise = $client->listComputeNodeGroupsAsync([/* ... */]);

Returns a list of all compute node groups associated with a cluster.

Parameter Syntax

$result = $client->listComputeNodeGroups([
    'clusterIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'computeNodeGroups' => [
        [
            'arn' => '<string>',
            'clusterId' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED|DELETED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

ListQueues

$result = $client->listQueues([/* ... */]);
$promise = $client->listQueuesAsync([/* ... */]);

Returns a list of all queues associated with a cluster.

Parameter Syntax

$result = $client->listQueues([
    'clusterIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'queues' => [
        [
            'arn' => '<string>',
            'clusterId' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of all tags on an Amazon Web Services PCS resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

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

RegisterComputeNodeGroupInstance

$result = $client->registerComputeNodeGroupInstance([/* ... */]);
$promise = $client->registerComputeNodeGroupInstanceAsync([/* ... */]);

This API action isn't intended for you to use.

Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.

Parameter Syntax

$result = $client->registerComputeNodeGroupInstance([
    'bootstrapId' => '<string>', // REQUIRED
    'clusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'endpoints' => [
        [
            'port' => '<string>',
            'privateIpAddress' => '<string>',
            'publicIpAddress' => '<string>',
            'type' => 'SLURMCTLD|SLURMDBD',
        ],
        // ...
    ],
    'nodeID' => '<string>',
    'sharedSecret' => '<string>',
]

Result Details

Errors

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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

UpdateComputeNodeGroup

$result = $client->updateComputeNodeGroup([/* ... */]);
$promise = $client->updateComputeNodeGroupAsync([/* ... */]);

Updates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler (such as Slurm).

Parameter Syntax

$result = $client->updateComputeNodeGroup([
    'amiId' => '<string>',
    'clientToken' => '<string>',
    'clusterIdentifier' => '<string>', // REQUIRED
    'computeNodeGroupIdentifier' => '<string>', // REQUIRED
    'customLaunchTemplate' => [
        'id' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'iamInstanceProfileArn' => '<string>',
    'purchaseOption' => 'ONDEMAND|SPOT',
    'scalingConfiguration' => [
        'maxInstanceCount' => <integer>, // REQUIRED
        'minInstanceCount' => <integer>, // REQUIRED
    ],
    'slurmConfiguration' => [
        'slurmCustomSettings' => [
            [
                'parameterName' => '<string>', // REQUIRED
                'parameterValue' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'spotOptions' => [
        'allocationStrategy' => 'lowest-price|capacity-optimized|price-capacity-optimized',
    ],
    'subnetIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'computeNodeGroup' => [
        'amiId' => '<string>',
        'arn' => '<string>',
        'clusterId' => '<string>',
        'createdAt' => <DateTime>,
        'customLaunchTemplate' => [
            'id' => '<string>',
            'version' => '<string>',
        ],
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'iamInstanceProfileArn' => '<string>',
        'id' => '<string>',
        'instanceConfigs' => [
            [
                'instanceType' => '<string>',
            ],
            // ...
        ],
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'purchaseOption' => 'ONDEMAND|SPOT',
        'scalingConfiguration' => [
            'maxInstanceCount' => <integer>,
            'minInstanceCount' => <integer>,
        ],
        'slurmConfiguration' => [
            'slurmCustomSettings' => [
                [
                    'parameterName' => '<string>',
                    'parameterValue' => '<string>',
                ],
                // ...
            ],
        ],
        'spotOptions' => [
            'allocationStrategy' => 'lowest-price|capacity-optimized|price-capacity-optimized',
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED|DELETED',
        'subnetIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide

Examples

• The max number of clusters or queues has been reached for the account.

• The max number of compute node groups has been reached for the associated cluster.

• The total of maxInstances across all compute node groups has been reached for associated cluster.

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.

UpdateQueue

$result = $client->updateQueue([/* ... */]);
$promise = $client->updateQueueAsync([/* ... */]);

Updates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.

Parameter Syntax

$result = $client->updateQueue([
    'clientToken' => '<string>',
    'clusterIdentifier' => '<string>', // REQUIRED
    'computeNodeGroupConfigurations' => [
        [
            'computeNodeGroupId' => '<string>',
        ],
        // ...
    ],
    'queueIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'queue' => [
        'arn' => '<string>',
        'clusterId' => '<string>',
        'computeNodeGroupConfigurations' => [
            [
                'computeNodeGroupId' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'errorInfo' => [
            [
                'code' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide

Examples

• The max number of clusters or queues has been reached for the account.

• The max number of compute node groups has been reached for the associated cluster.

• The total of maxInstances across all compute node groups has been reached for associated cluster.

ThrottlingException:

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

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.

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.

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

InternalServerException:

Amazon Web Services PCS can't process your request right now. Try again later.

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.