Class: AWS.PCS

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  computeNodeGroupName: 'STRING_VALUE', /* required */
  customLaunchTemplate: { /* required */
    id: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  iamInstanceProfileArn: 'STRING_VALUE', /* required */
  instanceConfigs: [ /* required */
    {
      instanceType: 'STRING_VALUE'
    },
    /* more items */
  ],
  scalingConfiguration: { /* required */
    maxInstanceCount: 'NUMBER_VALUE', /* required */
    minInstanceCount: 'NUMBER_VALUE' /* required */
  },
  subnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  amiId: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  purchaseOption: ONDEMAND | SPOT,
  slurmConfiguration: {
    slurmCustomSettings: [
      {
        parameterName: 'STRING_VALUE', /* required */
        parameterValue: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  spotOptions: {
    allocationStrategy: lowest-price | capacity-optimized | price-capacity-optimized
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
pcs.createComputeNodeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster to create a compute node group in.

  • computeNodeGroupName — (String)

    A name to identify the cluster. Example: MyCluster

  • amiId — (String)

    The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

  • subnetIds — (Array<String>)

    The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.

  • purchaseOption — (String)

    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

    Possible values include:
    • "ONDEMAND"
    • "SPOT"
  • customLaunchTemplate — (map)

    An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

    • id — required — (String)

      The ID of the EC2 launch template to use to provision instances.

      Example: lt-xxxx

    • version — required — (String)

      The version of the EC2 launch template to use to provision instances.

  • iamInstanceProfileArn — (String)

    The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached in order to provision instances correctly. The resource identifier of the ARN must start with AWSPCS. For example, arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.

  • scalingConfiguration — (map)

    Specifies the boundaries of the compute node group auto scaling.

    • minInstanceCount — required — (Integer)

      The lower bound of the number of instances allowed in the compute fleet.

    • maxInstanceCount — required — (Integer)

      The upper bound of the number of instances allowed in the compute fleet.

  • instanceConfigs — (Array<map>)

    A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

    • instanceType — (String)

      The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.

      Example: t2.xlarge

  • spotOptions — (map)

    Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

    • allocationStrategy — (String)

      The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.

      Possible values include:
      • "lowest-price"
      • "capacity-optimized"
      • "price-capacity-optimized"
  • slurmConfiguration — (map)

    Additional options related to the Slurm scheduler.

    • slurmCustomSettings — (Array<map>)

      Additional Slurm-specific configuration that directly maps to Slurm settings.

      • parameterName — required — (String)

        Amazon Web Services PCS supports configuration of the following Slurm parameters: Prolog , Epilog , and SelectTypeParameters .

      • parameterValue — required — (String)

        The values for the configured Slurm settings.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (map<String>)

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • computeNodeGroup — (map)

      A compute node group associated with a cluster.

      • name — required — (String)

        The name that identifies the compute node group.

      • id — required — (String)

        The generated unique ID of the compute node group.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the compute node group.

      • clusterId — required — (String)

        The ID of the cluster of the compute node group.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the compute node group.

        Note: The provisioning status doesn't indicate the overall health of the compute node group.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
        • "DELETED"
      • amiId — (String)

        The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

      • subnetIds — required — (Array<String>)

        The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

      • purchaseOption — (String)

        Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

        Possible values include:
        • "ONDEMAND"
        • "SPOT"
      • customLaunchTemplate — required — (map)

        An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

        • id — required — (String)

          The ID of the EC2 launch template to use to provision instances.

          Example: lt-xxxx

        • version — required — (String)

          The version of the EC2 launch template to use to provision instances.

      • iamInstanceProfileArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.

      • scalingConfiguration — required — (map)

        Specifies the boundaries of the compute node group auto scaling.

        • minInstanceCount — required — (Integer)

          The lower bound of the number of instances allowed in the compute fleet.

        • maxInstanceCount — required — (Integer)

          The upper bound of the number of instances allowed in the compute fleet.

      • instanceConfigs — required — (Array<map>)

        A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

        • instanceType — (String)

          The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.

          Example: t2.xlarge

      • spotOptions — (map)

        Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

        • allocationStrategy — (String)

          The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.

          Possible values include:
          • "lowest-price"
          • "capacity-optimized"
          • "price-capacity-optimized"
      • slurmConfiguration — (map)

        Additional options related to the Slurm scheduler.

        • slurmCustomSettings — (Array<map>)

          Additional Slurm-specific configuration that directly maps to Slurm settings.

          • parameterName — required — (String)

            Amazon Web Services PCS supports configuration of the following Slurm parameters: Prolog , Epilog , and SelectTypeParameters .

          • parameterValue — required — (String)

            The values for the configured Slurm settings.

      • errorInfo — (Array<map>)

        The list of errors that occurred during compute node group provisioning.

        • code — (String)

          The short-form error code.

        • message — (String)

          The detailed error information.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  queueName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  computeNodeGroupConfigurations: [
    {
      computeNodeGroupId: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
pcs.createQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster for which to create a queue.

  • queueName — (String)

    A name to identify the queue.

  • computeNodeGroupConfigurations — (Array<map>)

    The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.

    • computeNodeGroupId — (String)

      The compute node group ID for the compute node group configuration.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (map<String>)

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • queue — (map)

      A queue resource.

      • name — required — (String)

        The name that identifies the queue.

      • id — required — (String)

        The generated unique ID of the queue.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the queue.

      • clusterId — required — (String)

        The ID of the cluster of the queue.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the queue.

        Note: The provisioning status doesn't indicate the overall health of the queue.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
      • computeNodeGroupConfigurations — required — (Array<map>)

        The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.

        • computeNodeGroupId — (String)

          The compute node group ID for the compute node group configuration.

      • errorInfo — (Array<map>)

        The list of errors that occurred during queue provisioning.

        • code — (String)

          The short-form error code.

        • message — (String)

          The detailed error information.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
pcs.deleteCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster to delete.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  computeNodeGroupIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
pcs.deleteComputeNodeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster of the compute node group.

  • computeNodeGroupIdentifier — (String)

    The name or ID of the compute node group to delete.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  queueIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
pcs.deleteQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster of the queue.

  • queueIdentifier — (String)

    The name or ID of the queue to delete.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE' /* required */
};
pcs.getCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster of the queue.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cluster — (map)

      The cluster resource.

      • name — required — (String)

        The name that identifies the cluster.

      • id — required — (String)

        The generated unique ID of the cluster.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the cluster.

      • status — required — (String)

        The provisioning status of the cluster.

        Note: The provisioning status doesn't indicate the overall health of the cluster.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • scheduler — required — (map)

        The cluster management and job scheduling software associated with the cluster.

        • type — required — (String)

          The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.

          Possible values include:
          • "SLURM"
        • version — required — (String)

          The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.

      • size — required — (String)

        The size of the cluster.

        • SMALL: 32 compute nodes and 256 jobs

        • MEDIUM: 512 compute nodes and 8192 jobs

        • LARGE: 2048 compute nodes and 16,384 jobs

        Possible values include:
        • "SMALL"
        • "MEDIUM"
        • "LARGE"
      • slurmConfiguration — (map)

        Additional options related to the Slurm scheduler.

        • scaleDownIdleTimeInSeconds — (Integer)

          The time before an idle node is scaled down.

        • slurmCustomSettings — (Array<map>)

          Additional Slurm-specific configuration that directly maps to Slurm settings.

          • parameterName — required — (String)

            Amazon Web Services PCS supports configuration of the following Slurm parameters: Prolog , Epilog , and SelectTypeParameters .

          • parameterValue — required — (String)

            The values for the configured Slurm settings.

        • authKey — (map)

          The shared Slurm key for authentication, also known as the cluster secret.

          • secretArn — required — (String)

            The Amazon Resource Name (ARN) of the the shared Slurm key.

          • secretVersion — required — (String)

            The version of the shared Slurm key.

      • networking — required — (map)

        The networking configuration for the cluster's control plane.

        • subnetIds — (Array<String>)

          The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone.

          Example: subnet-abcd1234

        • securityGroupIds — (Array<String>)

          The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.

          The following rules are required:

          • Inbound rule 1

            • Protocol: All

            • Ports: All

            • Source: Self

          • Outbound rule 1

            • Protocol: All

            • Ports: All

            • Destination: 0.0.0.0/0 (IPv4)

          • Outbound rule 2

            • Protocol: All

            • Ports: All

            • Destination: Self

      • endpoints — (Array<map>)

        The list of endpoints available for interaction with the scheduler.

        • type — required — (String)

          Indicates the type of endpoint running at the specific IP address.

          Possible values include:
          • "SLURMCTLD"
          • "SLURMDBD"
        • privateIpAddress — required — (String)

          The endpoint's private IP address.

          Example: 2.2.2.2

        • publicIpAddress — (String)

          The endpoint's public IP address.

          Example: 1.1.1.1

        • port — required — (String)

          The endpoint's connection port number.

          Example: 1234

      • errorInfo — (Array<map>)

        The list of errors that occurred during cluster provisioning.

        • code — (String)

          The short-form error code.

        • message — (String)

          The detailed error information.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  computeNodeGroupIdentifier: 'STRING_VALUE' /* required */
};
pcs.getComputeNodeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster.

  • computeNodeGroupIdentifier — (String)

    The name or ID of the compute node group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • computeNodeGroup — (map)

      A compute node group associated with a cluster.

      • name — required — (String)

        The name that identifies the compute node group.

      • id — required — (String)

        The generated unique ID of the compute node group.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the compute node group.

      • clusterId — required — (String)

        The ID of the cluster of the compute node group.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the compute node group.

        Note: The provisioning status doesn't indicate the overall health of the compute node group.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
        • "DELETED"
      • amiId — (String)

        The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

      • subnetIds — required — (Array<String>)

        The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

      • purchaseOption — (String)

        Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

        Possible values include:
        • "ONDEMAND"
        • "SPOT"
      • customLaunchTemplate — required — (map)

        An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

        • id — required — (String)

          The ID of the EC2 launch template to use to provision instances.

          Example: lt-xxxx

        • version — required — (String)

          The version of the EC2 launch template to use to provision instances.

      • iamInstanceProfileArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.

      • scalingConfiguration — required — (map)

        Specifies the boundaries of the compute node group auto scaling.

        • minInstanceCount — required — (Integer)

          The lower bound of the number of instances allowed in the compute fleet.

        • maxInstanceCount — required — (Integer)

          The upper bound of the number of instances allowed in the compute fleet.

      • instanceConfigs — required — (Array<map>)

        A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

        • instanceType — (String)

          The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.

          Example: t2.xlarge

      • spotOptions — (map)

        Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

        • allocationStrategy — (String)

          The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.

          Possible values include:
          • "lowest-price"
          • "capacity-optimized"
          • "price-capacity-optimized"
      • slurmConfiguration — (map)

        Additional options related to the Slurm scheduler.

        • slurmCustomSettings — (Array<map>)

          Additional Slurm-specific configuration that directly maps to Slurm settings.

          • parameterName — required — (String)

            Amazon Web Services PCS supports configuration of the following Slurm parameters: Prolog , Epilog , and SelectTypeParameters .

          • parameterValue — required — (String)

            The values for the configured Slurm settings.

      • errorInfo — (Array<map>)

        The list of errors that occurred during compute node group provisioning.

        • code — (String)

          The short-form error code.

        • message — (String)

          The detailed error information.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  queueIdentifier: 'STRING_VALUE' /* required */
};
pcs.getQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster of the queue.

  • queueIdentifier — (String)

    The name or ID of the queue.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • queue — (map)

      A queue resource.

      • name — required — (String)

        The name that identifies the queue.

      • id — required — (String)

        The generated unique ID of the queue.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the queue.

      • clusterId — required — (String)

        The ID of the cluster of the queue.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the queue.

        Note: The provisioning status doesn't indicate the overall health of the queue.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
      • computeNodeGroupConfigurations — required — (Array<map>)

        The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.

        • computeNodeGroupId — (String)

          The compute node group ID for the compute node group configuration.

      • errorInfo — (Array<map>)

        The list of errors that occurred during queue provisioning.

        • code — (String)

          The short-form error code.

        • message — (String)

          The detailed error information.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
pcs.listClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • clusters — (Array<map>)

      The list of clusters.

      • name — required — (String)

        The name that identifies the cluster.

      • id — required — (String)

        The generated unique ID of the cluster.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the cluster.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the cluster.

        Note: The provisioning status doesn't indicate the overall health of the cluster.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
    • nextToken — (String)

      The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
pcs.listComputeNodeGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster to list compute node groups for.

  • nextToken — (String)

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • computeNodeGroups — (Array<map>)

      The list of compute node groups for the cluster.

      • name — required — (String)

        The name that identifies the compute node group.

      • id — required — (String)

        The generated unique ID of the compute node group.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the compute node group.

      • clusterId — required — (String)

        The ID of the cluster of the compute node group.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the compute node group.

        Note: The provisioning status doesn't indicate the overall health of the compute node group.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
        • "DELETED"
    • nextToken — (String)

      The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
pcs.listQueues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster to list queues for.

  • nextToken — (String)

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • queues — (Array<map>)

      The list of queues associated with the cluster.

      • name — required — (String)

        The name that identifies the queue.

      • id — required — (String)

        The generated unique ID of the queue.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the queue.

      • clusterId — required — (String)

        The ID of the cluster of the queue.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the queue.

        Note: The provisioning status doesn't indicate the overall health of the queue.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
    • nextToken — (String)

      The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
pcs.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource for which to list tags.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  bootstrapId: 'STRING_VALUE', /* required */
  clusterIdentifier: 'STRING_VALUE' /* required */
};
pcs.registerComputeNodeGroupInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster to register the compute node group instance in.

  • bootstrapId — (String)

    The client-generated token to allow for retries.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nodeID — (String)

      The scheduler node ID for this instance.

    • sharedSecret — (String)

      For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.

    • endpoints — (Array<map>)

      The list of endpoints available for interaction with the scheduler.

      • type — required — (String)

        Indicates the type of endpoint running at the specific IP address.

        Possible values include:
        • "SLURMCTLD"
        • "SLURMDBD"
      • privateIpAddress — required — (String)

        The endpoint's private IP address.

        Example: 2.2.2.2

      • publicIpAddress — (String)

        The endpoint's public IP address.

        Example: 1.1.1.1

      • port — required — (String)

        The endpoint's connection port number.

        Example: 1234

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
pcs.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • tags — (map<String>)

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
pcs.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys — (Array<String>)

    1 or more tag keys to remove from the resource. Specify only tag keys and not tag values.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  computeNodeGroupIdentifier: 'STRING_VALUE', /* required */
  amiId: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  customLaunchTemplate: {
    id: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  iamInstanceProfileArn: 'STRING_VALUE',
  purchaseOption: ONDEMAND | SPOT,
  scalingConfiguration: {
    maxInstanceCount: 'NUMBER_VALUE', /* required */
    minInstanceCount: 'NUMBER_VALUE' /* required */
  },
  slurmConfiguration: {
    slurmCustomSettings: [
      {
        parameterName: 'STRING_VALUE', /* required */
        parameterValue: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  spotOptions: {
    allocationStrategy: lowest-price | capacity-optimized | price-capacity-optimized
  },
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
pcs.updateComputeNodeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster of the compute node group.

  • computeNodeGroupIdentifier — (String)

    The name or ID of the compute node group.

  • amiId — (String)

    The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

  • subnetIds — (Array<String>)

    The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.

  • customLaunchTemplate — (map)

    An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

    • id — required — (String)

      The ID of the EC2 launch template to use to provision instances.

      Example: lt-xxxx

    • version — required — (String)

      The version of the EC2 launch template to use to provision instances.

  • purchaseOption — (String)

    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

    Possible values include:
    • "ONDEMAND"
    • "SPOT"
  • spotOptions — (map)

    Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

    • allocationStrategy — (String)

      The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.

      Possible values include:
      • "lowest-price"
      • "capacity-optimized"
      • "price-capacity-optimized"
  • scalingConfiguration — (map)

    Specifies the boundaries of the compute node group auto scaling.

    • minInstanceCount — required — (Integer)

      The lower bound of the number of instances allowed in the compute fleet.

    • maxInstanceCount — required — (Integer)

      The upper bound of the number of instances allowed in the compute fleet.

  • iamInstanceProfileArn — (String)

    The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.

  • slurmConfiguration — (map)

    Additional options related to the Slurm scheduler.

    • slurmCustomSettings — (Array<map>)

      Additional Slurm-specific configuration that directly maps to Slurm settings.

      • parameterName — required — (String)

        Amazon Web Services PCS supports configuration of the following Slurm parameters: Prolog , Epilog , and SelectTypeParameters .

      • parameterValue — required — (String)

        The values for the configured Slurm settings.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • computeNodeGroup — (map)

      A compute node group associated with a cluster.

      • name — required — (String)

        The name that identifies the compute node group.

      • id — required — (String)

        The generated unique ID of the compute node group.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the compute node group.

      • clusterId — required — (String)

        The ID of the cluster of the compute node group.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the compute node group.

        Note: The provisioning status doesn't indicate the overall health of the compute node group.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
        • "DELETED"
      • amiId — (String)

        The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

      • subnetIds — required — (Array<String>)

        The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

      • purchaseOption — (String)

        Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

        Possible values include:
        • "ONDEMAND"
        • "SPOT"
      • customLaunchTemplate — required — (map)

        An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

        • id — required — (String)

          The ID of the EC2 launch template to use to provision instances.

          Example: lt-xxxx

        • version — required — (String)

          The version of the EC2 launch template to use to provision instances.

      • iamInstanceProfileArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.

      • scalingConfiguration — required — (map)

        Specifies the boundaries of the compute node group auto scaling.

        • minInstanceCount — required — (Integer)

          The lower bound of the number of instances allowed in the compute fleet.

        • maxInstanceCount — required — (Integer)

          The upper bound of the number of instances allowed in the compute fleet.

      • instanceConfigs — required — (Array<map>)

        A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

        • instanceType — (String)

          The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.

          Example: t2.xlarge

      • spotOptions — (map)

        Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

        • allocationStrategy — (String)

          The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.

          Possible values include:
          • "lowest-price"
          • "capacity-optimized"
          • "price-capacity-optimized"
      • slurmConfiguration — (map)

        Additional options related to the Slurm scheduler.

        • slurmCustomSettings — (Array<map>)

          Additional Slurm-specific configuration that directly maps to Slurm settings.

          • parameterName — required — (String)

            Amazon Web Services PCS supports configuration of the following Slurm parameters: Prolog , Epilog , and SelectTypeParameters .

          • parameterValue — required — (String)

            The values for the configured Slurm settings.

      • errorInfo — (Array<map>)

        The list of errors that occurred during compute node group provisioning.

        • code — (String)

          The short-form error code.

        • message — (String)

          The detailed error information.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterIdentifier: 'STRING_VALUE', /* required */
  queueIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  computeNodeGroupConfigurations: [
    {
      computeNodeGroupId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
pcs.updateQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterIdentifier — (String)

    The name or ID of the cluster of the queue.

  • queueIdentifier — (String)

    The name or ID of the queue.

  • computeNodeGroupConfigurations — (Array<map>)

    The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.

    • computeNodeGroupId — (String)

      The compute node group ID for the compute node group configuration.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • queue — (map)

      A queue resource.

      • name — required — (String)

        The name that identifies the queue.

      • id — required — (String)

        The generated unique ID of the queue.

      • arn — required — (String)

        The unique Amazon Resource Name (ARN) of the queue.

      • clusterId — required — (String)

        The ID of the cluster of the queue.

      • createdAt — required — (Date)

        The date and time the resource was created.

      • modifiedAt — required — (Date)

        The date and time the resource was modified.

      • status — required — (String)

        The provisioning status of the queue.

        Note: The provisioning status doesn't indicate the overall health of the queue.
        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
      • computeNodeGroupConfigurations — required — (Array<map>)

        The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.

        • computeNodeGroupId — (String)

          The compute node group ID for the compute node group configuration.

      • errorInfo — (Array<map>)

        The list of errors that occurred during queue provisioning.

        • code — (String)

          The short-form error code.

        • message — (String)

          The detailed error information.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.