Class: AWS.Deadline

var params = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  identityStoreId: 'STRING_VALUE', /* required */
  membershipLevel: VIEWER | CONTRIBUTOR | OWNER | MANAGER, /* required */
  principalId: 'STRING_VALUE', /* required */
  principalType: USER | GROUP /* required */
};
deadline.associateMemberToFleet(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: {}) —
  • farmId — (String)

    The farm ID of the fleet to associate with the member.

  • fleetId — (String)

    The ID of the fleet to associate with a member.

  • principalId — (String)

    The member's principal ID to associate with a fleet.

  • principalType — (String)

    The member's principal type to associate with the fleet.

    Possible values include:
    • "USER"
    • "GROUP"
  • identityStoreId — (String)

    The member's identity store ID to associate with the fleet.

  • membershipLevel — (String)

    The principal's membership level for the associated fleet.

    Possible values include:
    • "VIEWER"
    • "CONTRIBUTOR"
    • "OWNER"
    • "MANAGER"

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 = {
  farmId: 'STRING_VALUE', /* required */
  identityStoreId: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  membershipLevel: VIEWER | CONTRIBUTOR | OWNER | MANAGER, /* required */
  principalId: 'STRING_VALUE', /* required */
  principalType: USER | GROUP, /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.associateMemberToJob(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: {}) —
  • farmId — (String)

    The farm ID of the job to associate with the member.

  • queueId — (String)

    The queue ID to associate to the member.

  • jobId — (String)

    The job ID to associate with the member.

  • principalId — (String)

    The member's principal ID to associate with the job.

  • principalType — (String)

    The member's principal type to associate with the job.

    Possible values include:
    • "USER"
    • "GROUP"
  • identityStoreId — (String)

    The member's identity store ID to associate with the job.

  • membershipLevel — (String)

    The principal's membership level for the associated job.

    Possible values include:
    • "VIEWER"
    • "CONTRIBUTOR"
    • "OWNER"
    • "MANAGER"

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 = {
  farmId: 'STRING_VALUE', /* required */
  identityStoreId: 'STRING_VALUE', /* required */
  membershipLevel: VIEWER | CONTRIBUTOR | OWNER | MANAGER, /* required */
  principalId: 'STRING_VALUE', /* required */
  principalType: USER | GROUP, /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.associateMemberToQueue(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: {}) —
  • farmId — (String)

    The farm ID of the queue to associate with the member.

  • queueId — (String)

    The ID of the queue to associate to the member.

  • principalId — (String)

    The member's principal ID to associate with the queue.

  • principalType — (String)

    The member's principal type to associate with the queue.

    Possible values include:
    • "USER"
    • "GROUP"
  • identityStoreId — (String)

    The member's identity store ID to associate with the queue.

  • membershipLevel — (String)

    The principal's membership level for the associated queue.

    Possible values include:
    • "VIEWER"
    • "CONTRIBUTOR"
    • "OWNER"
    • "MANAGER"

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 = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE' /* required */
};
deadline.assumeFleetRoleForRead(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: {}) —
  • farmId — (String)

    The farm ID for the fleet's farm.

  • fleetId — (String)

    The fleet ID.

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:

    • credentials — (map)

      The credentials for the fleet role.

      • accessKeyId — required — (String)

        The IAM access key ID.

      • secretAccessKey — required — (String)

        The IAM secret access key.

      • sessionToken — required — (String)

        The IAM session token

      • expiration — required — (Date)

        The expiration date and time of the IAM credentials.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  workerId: 'STRING_VALUE' /* required */
};
deadline.assumeFleetRoleForWorker(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: {}) —
  • farmId — (String)

    The farm ID for the fleet's farm.

  • fleetId — (String)

    The fleet ID that contains the worker.

  • workerId — (String)

    The ID of the worker assuming the fleet role.

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:

    • credentials — (map)

      The credentials for the worker.

      • accessKeyId — required — (String)

        The IAM access key ID.

      • secretAccessKey — required — (String)

        The IAM secret access key.

      • sessionToken — required — (String)

        The IAM session token

      • expiration — required — (Date)

        The expiration date and time of the IAM credentials.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.assumeQueueRoleForRead(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: {}) —
  • farmId — (String)

    The farm ID of the farm containing the queue.

  • queueId — (String)

    The queue ID.

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:

    • credentials — (map)

      The credentials for the queue role.

      • accessKeyId — required — (String)

        The IAM access key ID.

      • secretAccessKey — required — (String)

        The IAM secret access key.

      • sessionToken — required — (String)

        The IAM session token

      • expiration — required — (Date)

        The expiration date and time of the IAM credentials.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.assumeQueueRoleForUser(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: {}) —
  • farmId — (String)

    The farm ID of the queue that the user assumes the role for.

  • queueId — (String)

    The queue ID of the queue that the user assumes the role for.

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:

    • credentials — (map)

      The credentials for the queue role that a user has access to.

      • accessKeyId — required — (String)

        The IAM access key ID.

      • secretAccessKey — required — (String)

        The IAM secret access key.

      • sessionToken — required — (String)

        The IAM session token

      • expiration — required — (Date)

        The expiration date and time of the IAM credentials.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE', /* required */
  workerId: 'STRING_VALUE' /* required */
};
deadline.assumeQueueRoleForWorker(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: {}) —
  • farmId — (String)

    The farm ID of the worker assuming the queue role.

  • fleetId — (String)

    The fleet ID of the worker assuming the queue role.

  • workerId — (String)

    The worker ID of the worker assuming the queue role.

  • queueId — (String)

    The queue ID of the worker assuming the queue role.

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:

    • credentials — (map)

      The Amazon Web Services credentials for the role that the worker is assuming.

      • accessKeyId — required — (String)

        The IAM access key ID.

      • secretAccessKey — required — (String)

        The IAM secret access key.

      • sessionToken — required — (String)

        The IAM session token

      • expiration — required — (Date)

        The expiration date and time of the IAM credentials.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  identifiers: [ /* required */
    {
      environmentDetails: {
        environmentId: 'STRING_VALUE', /* required */
        jobId: 'STRING_VALUE' /* required */
      },
      jobAttachmentDetails: {
        jobId: 'STRING_VALUE' /* required */
      },
      jobDetails: {
        jobId: 'STRING_VALUE' /* required */
      },
      stepDetails: {
        jobId: 'STRING_VALUE', /* required */
        stepId: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  workerId: 'STRING_VALUE' /* required */
};
deadline.batchGetJobEntity(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: {}) —
  • farmId — (String)

    The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

  • fleetId — (String)

    The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

  • workerId — (String)

    The worker ID of the worker containing the job details to get.

  • identifiers — (Array<map>)

    The job identifiers to include within the job entity batch details.

    • jobDetails — (map)

      The job details.

      • jobId — required — (String)

        The job ID.

    • jobAttachmentDetails — (map)

      The job attachment details.

      • jobId — required — (String)

        The job ID.

    • stepDetails — (map)

      The step details.

      • jobId — required — (String)

        The job ID.

      • stepId — required — (String)

        The step ID.

    • environmentDetails — (map)

      The environment details.

      • jobId — required — (String)

        The job ID.

      • environmentId — required — (String)

        The environment ID.

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:

    • entities — (Array<map>)

      A list of the job entities, or details, in the batch.

      • jobDetails — (map)

        The job details.

        • jobId — required — (String)

          The job ID.

        • jobAttachmentSettings — (map)

          The job attachment settings.

          • s3BucketName — required — (String)

            The Amazon S3 bucket name.

          • rootPrefix — required — (String)

            The root prefix.

        • jobRunAsUser — (map)

          The user name and group that the job uses when run.

          • posix — (map)

            The user and group that the jobs in the queue run as.

            • user — required — (String)

              The name of the POSIX user.

            • group — required — (String)

              The name of the POSIX user's group.

          • windows — (map)

            Identifies a Microsoft Windows user.

            • user — required — (String)

              The user.

            • passwordArn — required — (String)

              The password ARN for the Windows user.

          • runAs — required — (String)

            Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.

            Possible values include:
            • "QUEUE_CONFIGURED_USER"
            • "WORKER_AGENT_USER"
        • logGroupName — required — (String)

          The log group name.

        • queueRoleArn — (String)

          The queue role ARN.

        • parameters — (map<map>)

          The parameters.

          • int — (String)

            A signed integer represented as a string.

          • float — (String)

            A double precision IEEE-754 floating point number represented as a string.

          • string — (String)

            A UTF-8 string.

          • path — (String)

            A file system path represented as a string.

        • schemaVersion — required — (String)

          The schema version.

        • pathMappingRules — (Array<map>)

          The path mapping rules.

          • sourcePathFormat — required — (String)

            The source path format.

            Possible values include:
            • "windows"
            • "posix"
          • sourcePath — required — (String)

            The source path.

          • destinationPath — required — (String)

            The destination path.

      • jobAttachmentDetails — (map)

        The job attachment details.

        • jobId — required — (String)

          The job ID.

        • attachments — required — (map)

          The job attachments.

          • manifests — required — (Array<map>)

            A list of manifests which describe job attachment configurations.

            • fileSystemLocationName — (String)

              The file system location name.

            • rootPath — required — (String)

              The file's root path.

            • rootPathFormat — required — (String)

              The format of the root path.

              Possible values include:
              • "windows"
              • "posix"
            • outputRelativeDirectories — (Array<String>)

              The file path relative to the directory.

            • inputManifestPath — (String)

              The file path.

            • inputManifestHash — (String)

              The has value of the file.

          • fileSystem — (String)

            The file system.

            Possible values include:
            • "COPIED"
            • "VIRTUAL"
      • stepDetails — (map)

        The step details.

        • jobId — required — (String)

          The job ID.

        • stepId — required — (String)

          The step ID.

        • schemaVersion — required — (String)

          The schema version for a step template.

        • template — required — (map)

          The template for a step.

        • dependencies — required — (Array<String>)

          The dependencies for a step.

      • environmentDetails — (map)

        The environment details for the job entity.

        • jobId — required — (String)

          The job ID.

        • environmentId — required — (String)

          The environment ID.

        • schemaVersion — required — (String)

          The schema version in the environment.

        • template — required — (map)

          The template used for the environment.

    • errors — (Array<map>)

      A list of errors from the job error logs for the batch.

      • jobDetails — (map)

        The job details for the failed job entity.

        • jobId — required — (String)

          The job ID.

        • code — required — (String)

          The error code.

          Possible values include:
          • "AccessDeniedException"
          • "InternalServerException"
          • "ValidationException"
          • "ResourceNotFoundException"
          • "MaxPayloadSizeExceeded"
          • "ConflictException"
        • message — required — (String)

          The error message detailing the error's cause.

      • jobAttachmentDetails — (map)

        The job attachment details for the failed job entity.

        • jobId — required — (String)

          The job ID.

        • code — required — (String)

          The error code.

          Possible values include:
          • "AccessDeniedException"
          • "InternalServerException"
          • "ValidationException"
          • "ResourceNotFoundException"
          • "MaxPayloadSizeExceeded"
          • "ConflictException"
        • message — required — (String)

          The error message detailing the error's cause.

      • stepDetails — (map)

        The step details for the failed job entity.

        • jobId — required — (String)

          The job ID.

        • stepId — required — (String)

          The step ID.

        • code — required — (String)

          The error code.

          Possible values include:
          • "AccessDeniedException"
          • "InternalServerException"
          • "ValidationException"
          • "ResourceNotFoundException"
          • "MaxPayloadSizeExceeded"
          • "ConflictException"
        • message — required — (String)

          The error message detailing the error's cause.

      • environmentDetails — (map)

        The environment details for the failed job entity.

        • jobId — required — (String)

          The job ID.

        • environmentId — required — (String)

          The environment ID.

        • code — required — (String)

          The error code.

          Possible values include:
          • "AccessDeniedException"
          • "InternalServerException"
          • "ValidationException"
          • "ResourceNotFoundException"
          • "MaxPayloadSizeExceeded"
          • "ConflictException"
        • message — required — (String)

          The error message detailing the error's cause.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE', /* required */
  targetS3Location: { /* required */
    bucketName: 'STRING_VALUE', /* required */
    key: 'STRING_VALUE' /* required */
  }
};
deadline.copyJobTemplate(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: {}) —
  • farmId — (String)

    The farm ID to copy.

  • jobId — (String)

    The job ID to copy.

  • queueId — (String)

    The queue ID to copy.

  • targetS3Location — (map)

    The Amazon S3 bucket name and key where you would like to add a copy of the job template.

    • bucketName — required — (String)

      The name of the Amazon S3 bucket.

    • key — required — (String)

      The Amazon S3 object key that uniquely identifies the Amazon S3 bucket.

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:

    • templateType — (String)

      The format of the job template, either JSON or YAML.

      Possible values include:
      • "JSON"
      • "YAML"

Returns:

• (AWS.Request) —

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

var params = {
  actions: [ /* required */
    {
      thresholdPercentage: 'NUMBER_VALUE', /* required */
      type: STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS, /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  approximateDollarLimit: 'NUMBER_VALUE', /* required */
  displayName: 'STRING_VALUE', /* required */
  farmId: 'STRING_VALUE', /* required */
  schedule: { /* required */
    fixed: {
      endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
    }
  },
  usageTrackingResource: { /* required */
    queueId: 'STRING_VALUE'
  },
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
deadline.createBudget(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The farm ID to include in this budget.

  • usageTrackingResource — (map)

    The queue ID provided to this budget to track usage.

    • queueId — (String)

      The queue ID.

  • displayName — (String)

    The display name of the budget.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description — (String)

    The description of the budget.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • approximateDollarLimit — (Float)

    The dollar limit based on consumed usage.

  • actions — (Array<map>)

    The budget actions to specify what happens when the budget runs out.

    • type — required — (String)

      The type of budget action to add.

      Possible values include:
      • "STOP_SCHEDULING_AND_COMPLETE_TASKS"
      • "STOP_SCHEDULING_AND_CANCEL_TASKS"
    • thresholdPercentage — required — (Float)

      The percentage threshold for the budget action to add.

    • description — (String)

      A description for the budget action to add.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • schedule — (map)

    The schedule to associate with this budget.

    • fixed — (map)

      The fixed start and end time of the budget's schedule.

      • startTime — required — (Date)

        When the budget starts.

      • endTime — required — (Date)

        When the budget ends.

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:

    • budgetId — (String)

      The budget ID.

Returns:

• (AWS.Request) —

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

var params = {
  displayName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  kmsKeyArn: 'STRING_VALUE',
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
deadline.createFarm(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The display name of the farm.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description — (String)

    The description of the farm.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • kmsKeyArn — (String)

    The ARN of the KMS key to use on the farm.

  • tags — (map<String>)

    The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

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:

    • farmId — (String)

      The farm ID.

Returns:

• (AWS.Request) —

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

var params = {
  configuration: { /* required */
    customerManaged: {
      mode: NO_SCALING | EVENT_BASED_AUTO_SCALING, /* required */
      workerCapabilities: { /* required */
        cpuArchitectureType: x86_64 | arm64, /* required */
        memoryMiB: { /* required */
          min: 'NUMBER_VALUE', /* required */
          max: 'NUMBER_VALUE'
        },
        osFamily: WINDOWS | LINUX | MACOS, /* required */
        vCpuCount: { /* required */
          min: 'NUMBER_VALUE', /* required */
          max: 'NUMBER_VALUE'
        },
        acceleratorCount: {
          min: 'NUMBER_VALUE', /* required */
          max: 'NUMBER_VALUE'
        },
        acceleratorTotalMemoryMiB: {
          min: 'NUMBER_VALUE', /* required */
          max: 'NUMBER_VALUE'
        },
        acceleratorTypes: [
          gpu,
          /* more items */
        ],
        customAmounts: [
          {
            min: 'NUMBER_VALUE', /* required */
            name: 'STRING_VALUE', /* required */
            max: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        customAttributes: [
          {
            name: 'STRING_VALUE', /* required */
            values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ]
      },
      storageProfileId: 'STRING_VALUE'
    },
    serviceManagedEc2: {
      instanceCapabilities: { /* required */
        cpuArchitectureType: x86_64 | arm64, /* required */
        memoryMiB: { /* required */
          min: 'NUMBER_VALUE', /* required */
          max: 'NUMBER_VALUE'
        },
        osFamily: WINDOWS | LINUX, /* required */
        vCpuCount: { /* required */
          min: 'NUMBER_VALUE', /* required */
          max: 'NUMBER_VALUE'
        },
        allowedInstanceTypes: [
          'STRING_VALUE',
          /* more items */
        ],
        customAmounts: [
          {
            min: 'NUMBER_VALUE', /* required */
            name: 'STRING_VALUE', /* required */
            max: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        customAttributes: [
          {
            name: 'STRING_VALUE', /* required */
            values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ],
        excludedInstanceTypes: [
          'STRING_VALUE',
          /* more items */
        ],
        rootEbsVolume: {
          iops: 'NUMBER_VALUE',
          sizeGiB: 'NUMBER_VALUE',
          throughputMiB: 'NUMBER_VALUE'
        }
      },
      instanceMarketOptions: { /* required */
        type: on-demand | spot /* required */
      }
    }
  },
  displayName: 'STRING_VALUE', /* required */
  farmId: 'STRING_VALUE', /* required */
  maxWorkerCount: 'NUMBER_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  minWorkerCount: 'NUMBER_VALUE',
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
deadline.createFleet(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The farm ID of the farm to connect to the fleet.

  • displayName — (String)

    The display name of the fleet.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description — (String)

    The description of the fleet.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • roleArn — (String)

    The IAM role ARN for the role that the fleet's workers will use.

  • minWorkerCount — (Integer)

    The minimum number of workers for the fleet.

  • maxWorkerCount — (Integer)

    The maximum number of workers for the fleet.

  • configuration — (map)

    The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

    • customerManaged — (map)

      The customer managed fleets within a fleet configuration.

      • mode — required — (String)

        The Auto Scaling mode for the customer managed fleet configuration.

        Possible values include:
        • "NO_SCALING"
        • "EVENT_BASED_AUTO_SCALING"
      • workerCapabilities — required — (map)

        The worker capabilities for a customer managed fleet configuration.

        • vCpuCount — required — (map)

          The vCPU count for the customer manged worker capabilities.

          • min — required — (Integer)

            The minimum amount of vCPU.

          • max — (Integer)

            The maximum amount of vCPU.

        • memoryMiB — required — (map)

          The memory (MiB).

          • min — required — (Integer)

            The minimum amount of memory (in MiB).

          • max — (Integer)

            The maximum amount of memory (in MiB).

        • acceleratorTypes — (Array<String>)

          The accelerator types for the customer managed worker capabilities.

        • acceleratorCount — (map)

          The range of the accelerator.

          • min — required — (Integer)

            The minimum GPU for the accelerator.

          • max — (Integer)

            The maximum GPU for the accelerator.

        • acceleratorTotalMemoryMiB — (map)

          The total memory (MiB) for the customer managed worker capabilities.

          • min — required — (Integer)

            The minimum amount of memory to use for the accelerator, measured in MiB.

          • max — (Integer)

            The maximum amount of memory to use for the accelerator, measured in MiB.

        • osFamily — required — (String)

          The operating system (OS) family.

          Possible values include:
          • "WINDOWS"
          • "LINUX"
          • "MACOS"
        • cpuArchitectureType — required — (String)

          The CPU architecture type for the customer managed worker capabilities.

          Possible values include:
          • "x86_64"
          • "arm64"
        • customAmounts — (Array<map>)

          Custom requirement ranges for customer managed worker capabilities.

          • name — required — (String)

            The name of the fleet capability.

          • min — required — (Float)

            The minimum amount of fleet worker capability.

          • max — (Float)

            The maximum amount of the fleet worker capability.

        • customAttributes — (Array<map>)

          Custom attributes for the customer manged worker capabilities.

          • name — required — (String)

            The name of the fleet attribute capability for the worker.

          • values — required — (Array<String>)

            The number of fleet attribute capabilities.

      • storageProfileId — (String)

        The storage profile ID.

    • serviceManagedEc2 — (map)

      The service managed Amazon EC2 instances for a fleet configuration.

      • instanceCapabilities — required — (map)

        The Amazon EC2 instance capabilities.

        • vCpuCount — required — (map)

          The amount of vCPU to require for instances in this fleet.

          • min — required — (Integer)

            The minimum amount of vCPU.

          • max — (Integer)

            The maximum amount of vCPU.

        • memoryMiB — required — (map)

          The memory, as MiB, for the Amazon EC2 instance type.

          • min — required — (Integer)

            The minimum amount of memory (in MiB).

          • max — (Integer)

            The maximum amount of memory (in MiB).

        • osFamily — required — (String)

          The operating system (OS) family.

          Possible values include:
          • "WINDOWS"
          • "LINUX"
        • cpuArchitectureType — required — (String)

          The CPU architecture type.

          Possible values include:
          • "x86_64"
          • "arm64"
        • rootEbsVolume — (map)

          The root EBS volume.

          • sizeGiB — (Integer)

            The EBS volume size in GiB.

          • iops — (Integer)

            The IOPS per volume.

          • throughputMiB — (Integer)

            The throughput per volume in MiB.

        • allowedInstanceTypes — (Array<String>)

          The allowable Amazon EC2 instance types.

        • excludedInstanceTypes — (Array<String>)

          The instance types to exclude from the fleet.

        • customAmounts — (Array<map>)

          The custom capability amounts to require for instances in this fleet.

          • name — required — (String)

            The name of the fleet capability.

          • min — required — (Float)

            The minimum amount of fleet worker capability.

          • max — (Float)

            The maximum amount of the fleet worker capability.

        • customAttributes — (Array<map>)

          The custom capability attributes to require for instances in this fleet.

          • name — required — (String)

            The name of the fleet attribute capability for the worker.

          • values — required — (Array<String>)

            The number of fleet attribute capabilities.

      • instanceMarketOptions — required — (map)

        The Amazon EC2 market type.

        • type — required — (String)

          The Amazon EC2 instance type.

          Possible values include:
          • "on-demand"
          • "spot"
  • tags — (map<String>)

    Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

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:

    • fleetId — (String)

      The fleet ID.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  priority: 'NUMBER_VALUE', /* required */
  queueId: 'STRING_VALUE', /* required */
  template: 'STRING_VALUE', /* required */
  templateType: JSON | YAML, /* required */
  attachments: {
    manifests: [ /* required */
      {
        rootPath: 'STRING_VALUE', /* required */
        rootPathFormat: windows | posix, /* required */
        fileSystemLocationName: 'STRING_VALUE',
        inputManifestHash: 'STRING_VALUE',
        inputManifestPath: 'STRING_VALUE',
        outputRelativeDirectories: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    fileSystem: COPIED | VIRTUAL
  },
  clientToken: 'STRING_VALUE',
  maxFailedTasksCount: 'NUMBER_VALUE',
  maxRetriesPerTask: 'NUMBER_VALUE',
  parameters: {
    '<String>': {
      float: 'STRING_VALUE',
      int: 'STRING_VALUE',
      path: 'STRING_VALUE',
      string: 'STRING_VALUE'
    },
    /* '<String>': ... */
  },
  storageProfileId: 'STRING_VALUE',
  targetTaskRunStatus: READY | SUSPENDED
};
deadline.createJob(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: {}) —
  • farmId — (String)

    The farm ID of the farm to connect to the job.

  • queueId — (String)

    The ID of the queue that the job is submitted to.

  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The job template to use for this job.

  • templateType — (String)

    The file type for the job template.

    Possible values include:
    • "JSON"
    • "YAML"
  • priority — (Integer)

    The priority of the job on a scale of 0 to 100. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

  • parameters — (map<map>)

    The parameters for the job.

    • int — (String)

      A signed integer represented as a string.

    • float — (String)

      A double precision IEEE-754 floating point number represented as a string.

    • string — (String)

      A UTF-8 string.

    • path — (String)

      A file system path represented as a string.

  • attachments — (map)

    The attachments for the job. Attach files required for the job to run to a render job.

    • manifests — required — (Array<map>)

      A list of manifests which describe job attachment configurations.

      • fileSystemLocationName — (String)

        The file system location name.

      • rootPath — required — (String)

        The file's root path.

      • rootPathFormat — required — (String)

        The format of the root path.

        Possible values include:
        • "windows"
        • "posix"
      • outputRelativeDirectories — (Array<String>)

        The file path relative to the directory.

      • inputManifestPath — (String)

        The file path.

      • inputManifestHash — (String)

        The has value of the file.

    • fileSystem — (String)

      The file system.

      Possible values include:
      • "COPIED"
      • "VIRTUAL"
  • storageProfileId — (String)

    The storage profile ID for the storage profile to connect to the job.

  • targetTaskRunStatus — (String)

    The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

    Possible values include:
    • "READY"
    • "SUSPENDED"
  • maxFailedTasksCount — (Integer)

    The number of task failures before the job stops running and is marked as FAILED.

  • maxRetriesPerTask — (Integer)

    The maximum number of retries for each task.

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:

    • jobId — (String)

      The job ID.

Returns:

• (AWS.Request) —

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

var params = {
  securityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  subnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  vpcId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
deadline.createLicenseEndpoint(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The VPC (virtual private cloud) ID to use with the license endpoint.

  • subnetIds — (Array<String>)

    The subnet IDs.

  • securityGroupIds — (Array<String>)

    The security group IDs.

  • tags — (map<String>)

    Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

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:

    • licenseEndpointId — (String)

      The license endpoint ID.

Returns:

• (AWS.Request) —

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

var params = {
  displayName: 'STRING_VALUE', /* required */
  identityCenterInstanceArn: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  subdomain: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
deadline.createMonitor(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The name that you give the monitor that is displayed in the Deadline Cloud console.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • identityCenterInstanceArn — (String)

    The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.

  • subdomain — (String)

    The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

  • roleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.

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:

    • monitorId — (String)

      The unique identifier of the monitor.

    • identityCenterApplicationArn — (String)

      The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.

Returns:

• (AWS.Request) —

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

var params = {
  displayName: 'STRING_VALUE', /* required */
  farmId: 'STRING_VALUE', /* required */
  allowedStorageProfileIds: [
    'STRING_VALUE',
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  defaultBudgetAction: NONE | STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS,
  description: 'STRING_VALUE',
  jobAttachmentSettings: {
    rootPrefix: 'STRING_VALUE', /* required */
    s3BucketName: 'STRING_VALUE' /* required */
  },
  jobRunAsUser: {
    runAs: QUEUE_CONFIGURED_USER | WORKER_AGENT_USER, /* required */
    posix: {
      group: 'STRING_VALUE', /* required */
      user: 'STRING_VALUE' /* required */
    },
    windows: {
      passwordArn: 'STRING_VALUE', /* required */
      user: 'STRING_VALUE' /* required */
    }
  },
  requiredFileSystemLocationNames: [
    'STRING_VALUE',
    /* more items */
  ],
  roleArn: 'STRING_VALUE',
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
deadline.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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The farm ID of the farm to connect to the queue.

  • displayName — (String)

    The display name of the queue.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description — (String)

    The description of the queue.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • defaultBudgetAction — (String)

    The default action to take on a queue if a budget isn't configured.

    Possible values include:
    • "NONE"
    • "STOP_SCHEDULING_AND_COMPLETE_TASKS"
    • "STOP_SCHEDULING_AND_CANCEL_TASKS"
  • jobAttachmentSettings — (map)

    The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

    • s3BucketName — required — (String)

      The Amazon S3 bucket name.

    • rootPrefix — required — (String)

      The root prefix.

  • roleArn — (String)

    The IAM role ARN that workers will use while running jobs for this queue.

  • jobRunAsUser — (map)

    The jobs in the queue run as the specified POSIX user.

    • posix — (map)

      The user and group that the jobs in the queue run as.

      • user — required — (String)

        The name of the POSIX user.

      • group — required — (String)

        The name of the POSIX user's group.

    • windows — (map)

      Identifies a Microsoft Windows user.

      • user — required — (String)

        The user.

      • passwordArn — required — (String)

        The password ARN for the Windows user.

    • runAs — required — (String)

      Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.

      Possible values include:
      • "QUEUE_CONFIGURED_USER"
      • "WORKER_AGENT_USER"
  • requiredFileSystemLocationNames — (Array<String>)

    The file system location name to include in the queue.

  • allowedStorageProfileIds — (Array<String>)

    The storage profile IDs to include in the queue.

  • tags — (map<String>)

    Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

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:

    • queueId — (String)

      The queue ID.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  priority: 'NUMBER_VALUE', /* required */
  queueId: 'STRING_VALUE', /* required */
  template: 'STRING_VALUE', /* required */
  templateType: JSON | YAML, /* required */
  clientToken: 'STRING_VALUE'
};
deadline.createQueueEnvironment(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The farm ID of the farm to connect to the environment.

  • queueId — (String)

    The queue ID to connect the queue and environment.

  • priority — (Integer)

    Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.

  • templateType — (String)

    The template's file type, JSON or YAML.

    Possible values include:
    • "JSON"
    • "YAML"
  • template — (String)

    The environment template to use in 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:

    • queueEnvironmentId — (String)

      The queue environment ID.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.createQueueFleetAssociation(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: {}) —
  • farmId — (String)

    The ID of the farm that the queue and fleet belong to.

  • queueId — (String)

    The queue ID.

  • fleetId — (String)

    The fleet ID.

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 = {
  displayName: 'STRING_VALUE', /* required */
  farmId: 'STRING_VALUE', /* required */
  osFamily: WINDOWS | LINUX | MACOS, /* required */
  clientToken: 'STRING_VALUE',
  fileSystemLocations: [
    {
      name: 'STRING_VALUE', /* required */
      path: 'STRING_VALUE', /* required */
      type: SHARED | LOCAL /* required */
    },
    /* more items */
  ]
};
deadline.createStorageProfile(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The farm ID of the farm to connect to the storage profile.

  • displayName — (String)

    The display name of the storage profile.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • osFamily — (String)

    The type of operating system (OS) for the storage profile.

    Possible values include:
    • "WINDOWS"
    • "LINUX"
    • "MACOS"
  • fileSystemLocations — (Array<map>)

    File system paths to include in the storage profile.

    • name — required — (String)

      The location name.

    • path — required — (String)

      The file path.

    • type — required — (String)

      The type of file.

      Possible values include:
      • "SHARED"
      • "LOCAL"

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:

    • storageProfileId — (String)

      The storage profile ID.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  hostProperties: {
    hostName: 'STRING_VALUE',
    ipAddresses: {
      ipV4Addresses: [
        'STRING_VALUE',
        /* more items */
      ],
      ipV6Addresses: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
deadline.createWorker(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: {}) —
  • farmId — (String)

    The farm ID of the farm to connect to the worker.

  • fleetId — (String)

    The fleet ID to connect to the worker.

  • hostProperties — (map)

    The IP address and host name of the worker.

    • ipAddresses — (map)

      The IP address of the host.

      • ipV4Addresses — (Array<String>)

        The IpV4 address of the network.

      • ipV6Addresses — (Array<String>)

        The IpV6 address for the network and node component.

    • hostName — (String)

      The host name.

  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

    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:

    • workerId — (String)

      The worker ID.

Returns:

• (AWS.Request) —

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

var params = {
  budgetId: 'STRING_VALUE', /* required */
  farmId: 'STRING_VALUE' /* required */
};
deadline.deleteBudget(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: {}) —
  • farmId — (String)

    The farm ID of the farm to remove from the budget.

  • budgetId — (String)

    The budget ID of the budget to delete.

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 = {
  farmId: 'STRING_VALUE' /* required */
};
deadline.deleteFarm(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: {}) —
  • farmId — (String)

    The farm ID of the farm to delete.

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 = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
deadline.deleteFleet(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: {}) —
  • clientToken — (String)

    The unique token which the server uses to recognize retries of the same request.

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

    The farm ID of the farm to remove from the fleet.

  • fleetId — (String)

    The fleet ID of the fleet to delete.

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 = {
  licenseEndpointId: 'STRING_VALUE' /* required */
};
deadline.deleteLicenseEndpoint(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: {}) —
  • licenseEndpointId — (String)

    The license endpoint ID of the license endpoint to delete.

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 = {
  licenseEndpointId: 'STRING_VALUE', /* required */
  productId: 'STRING_VALUE' /* required */
};
deadline.deleteMeteredProduct(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: {}) —
  • licenseEndpointId — (String)

    The ID of the license endpoint from which to remove the metered product.

  • productId — (String)

    The product ID to remove from the license endpoint.

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 = {
  monitorId: 'STRING_VALUE' /* required */
};
deadline.deleteMonitor(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: {}) —
  • monitorId — (String)

    The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.

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 = {
  farmId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.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: {}) —
  • farmId — (String)

    The ID of the farm from which to remove the queue.

  • queueId — (String)

    The queue ID of the queue to delete.

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 = {
  farmId: 'STRING_VALUE', /* required */
  queueEnvironmentId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.deleteQueueEnvironment(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: {}) —
  • farmId — (String)

    The farm ID of the farm from which to remove the queue environment.

  • queueId — (String)

    The queue ID of the queue environment to delete.

  • queueEnvironmentId — (String)

    The queue environment ID of the queue environment to delete.

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 = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.deleteQueueFleetAssociation(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: {}) —
  • farmId — (String)

    The farm ID of the farm that holds the queue-fleet association.

  • queueId — (String)

    The queue ID of the queue-fleet association.

  • fleetId — (String)

    The fleet ID of the queue-fleet association.

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 = {
  farmId: 'STRING_VALUE', /* required */
  storageProfileId: 'STRING_VALUE' /* required */
};
deadline.deleteStorageProfile(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: {}) —
  • farmId — (String)

    The farm ID of the farm from which to remove the storage profile.

  • storageProfileId — (String)

    The storage profile ID of the storage profile to delete.

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 = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  workerId: 'STRING_VALUE' /* required */
};
deadline.deleteWorker(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: {}) —
  • farmId — (String)

    The farm ID of the worker to delete.

  • fleetId — (String)

    The fleet ID of the worker to delete.

  • workerId — (String)

    The worker ID of the worker to delete.

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 = {
  farmId: 'STRING_VALUE', /* required */
  principalId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromFarm(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: {}) —
  • farmId — (String)

    The farm ID of the farm to disassociate from the member.

  • principalId — (String)

    A member's principal ID to disassociate from a farm.

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 = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE', /* required */
  principalId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromFleet(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: {}) —
  • farmId — (String)

    The farm ID of the fleet to disassociate a member from.

  • fleetId — (String)

    The fleet ID of the fleet to from which to disassociate a member.

  • principalId — (String)

    A member's principal ID to disassociate from a fleet.

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 = {
  farmId: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  principalId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromJob(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: {}) —
  • farmId — (String)

    The farm ID for the job to disassociate from the member.

  • queueId — (String)

    The queue ID connected to a job for which you're disassociating a member.

  • jobId — (String)

    The job ID to disassociate from a member in a job.

  • principalId — (String)

    A member's principal ID to disassociate from a job.

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 = {
  farmId: 'STRING_VALUE', /* required */
  principalId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromQueue(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: {}) —
  • farmId — (String)

    The farm ID for the queue to disassociate from a member.

  • queueId — (String)

    The queue ID of the queue in which you're disassociating from a member.

  • principalId — (String)

    A member's principal ID to disassociate from a 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.

Returns:

• (AWS.Request) —

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

var params = {
  budgetId: 'STRING_VALUE', /* required */
  farmId: 'STRING_VALUE' /* required */
};
deadline.getBudget(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: {}) —
  • farmId — (String)

    The farm ID of the farm connected to the budget.

  • budgetId — (String)

    The budget ID.

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:

    • budgetId — (String)

      The budget ID.

    • usageTrackingResource — (map)

      The resource that the budget is tracking usage for.

      • queueId — (String)

        The queue ID.

    • status — (String)

      The status of the budget.

      • ACTIVE–Get a budget being evaluated.

      • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • displayName — (String)

      The display name of the budget.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • description — (String)

      The description of the budget.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • approximateDollarLimit — (Float)

      The consumed usage limit for the budget.

    • usages — (map)

      The usages of the budget.

      • approximateDollarUsage — required — (Float)

        The amount of the budget consumed.

    • actions — (Array<map>)

      The budget actions for the budget.

      • type — required — (String)

        The action taken on the budget once scheduling stops.

        Possible values include:
        • "STOP_SCHEDULING_AND_COMPLETE_TASKS"
        • "STOP_SCHEDULING_AND_CANCEL_TASKS"
      • thresholdPercentage — required — (Float)

        The percentage threshold for the budget.

      • description — (String)

        The budget action description.

        This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • schedule — (map)

      The budget schedule.

      • fixed — (map)

        The fixed start and end time of the budget's schedule.

        • startTime — required — (Date)

          When the budget starts.

        • endTime — required — (Date)

          When the budget ends.

    • createdBy — (String)

      The user or system that created this resource.

    • createdAt — (Date)

      The date and time the resource was created.

    • updatedBy — (String)

      The user or system that updated this resource.

    • updatedAt — (Date)

      The date and time the resource was updated.

    • queueStoppedAt — (Date)

      The date and time the queue stopped.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE' /* required */
};
deadline.getFarm(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: {}) —
  • farmId — (String)

    The farm ID of the farm.

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:

    • farmId — (String)

      The farm ID of the farm to get.

    • displayName — (String)

      The display name of the farm.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • description — (String)

      The description of the farm.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • kmsKeyArn — (String)

      The ARN of the KMS key used on the farm.

    • createdAt — (Date)

      The date and time the resource was created.

    • createdBy — (String)

      The user or system that created this resource.

    • updatedAt — (Date)

      The date and time the resource was updated.

    • updatedBy — (String)

      The user or system that updated this resource.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  fleetId: 'STRING_VALUE' /* required */
};
deadline.getFleet(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: {}) —
  • farmId — (String)

    The farm ID of the farm in the fleet.

  • fleetId — (String)

    The fleet ID of the fleet to get.

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:

    • fleetId — (String)

      The fleet ID.

    • farmId — (String)

      The farm ID of the farm in the fleet.

    • displayName — (String)

      The display name of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • description — (String)

      The description of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • status — (String)

      The Auto Scaling status of the fleet.

      Possible values include:
      • "ACTIVE"
      • "CREATE_IN_PROGRESS"
      • "UPDATE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "UPDATE_FAILED"
    • autoScalingStatus — (String)

      The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.

      Possible values include:
      • "GROWING"
      • "STEADY"
      • "SHRINKING"
    • targetWorkerCount — (Integer)

      The number of target workers in the fleet.

    • workerCount — (Integer)

      The number of workers in the fleet.

    • minWorkerCount — (Integer)

      The minimum number of workers specified in the fleet.

    • maxWorkerCount — (Integer)

      The maximum number of workers specified in the fleet.

    • configuration — (map)

      The configuration setting for the fleet.

      • customerManaged — (map)

        The customer managed fleets within a fleet configuration.

        • mode — required — (String)

          The Auto Scaling mode for the customer managed fleet configuration.

          Possible values include:
          • "NO_SCALING"
          • "EVENT_BASED_AUTO_SCALING"
        • workerCapabilities — required — (map)

          The worker capabilities for a customer managed fleet configuration.

          • vCpuCount — required — (map)

            The vCPU count for the customer manged worker capabilities.

            • min — required — (Integer)

              The minimum amount of vCPU.

            • max — (Integer)

              The maximum amount of vCPU.

          • memoryMiB — required — (map)

            The memory (MiB).

            • min — required — (Integer)

              The minimum amount of memory (in MiB).

            • max — (Integer)

              The maximum amount of memory (in MiB).

          • acceleratorTypes — (Array<String>)

            The accelerator types for the customer managed worker capabilities.

          • acceleratorCount — (map)

            The range of the accelerator.

            • min — required — (Integer)

              The minimum GPU for the accelerator.

            • max — (Integer)

              The maximum GPU for the accelerator.

          • acceleratorTotalMemoryMiB — (map)

            The total memory (MiB) for the customer managed worker capabilities.

            • min — required — (Integer)

              The minimum amount of memory to use for the accelerator, measured in MiB.

            • max — (Integer)

              The maximum amount of memory to use for the accelerator, measured in MiB.

          • osFamily — required — (String)

            The operating system (OS) family.

            Possible values include:
            • "WINDOWS"
            • "LINUX"
            • "MACOS"
          • cpuArchitectureType — required — (String)

            The CPU architecture type for the customer managed worker capabilities.

            Possible values include:
            • "x86_64"
            • "arm64"
          • customAmounts — (Array<map>)

            Custom requirement ranges for customer managed worker capabilities.

            • name — required — (String)

              The name of the fleet capability.

            • min — required — (Float)

              The minimum amount of fleet worker capability.

            • max — (Float)

              The maximum amount of the fleet worker capability.

          • customAttributes — (Array<map>)

            Custom attributes for the customer manged worker capabilities.

            • name — required — (String)

              The name of the fleet attribute capability for the worker.

            • values — required — (Array<String>)

              The number of fleet attribute capabilities.

        • storageProfileId — (String)

          The storage profile ID.

      • serviceManagedEc2 — (map)

        The service managed Amazon EC2 instances for a fleet configuration.

        • instanceCapabilities — required — (map)

          The Amazon EC2 instance capabilities.

          • vCpuCount — required — (map)

            The amount of vCPU to require for instances in this fleet.

            • min — required — (Integer)

              The minimum amount of vCPU.

            • max — (Integer)

              The maximum amount of vCPU.

          • memoryMiB — required — (map)

            The memory, as MiB, for the Amazon EC2 instance type.

            • min — required — (Integer)

              The minimum amount of memory (in MiB).

            • max — (Integer)

              The maximum amount of memory (in MiB).

          • osFamily — required — (String)

            The operating system (OS) family.

            Possible values include:
            • "WINDOWS"
            • "LINUX"
          • cpuArchitectureType — required — (String)

            The CPU architecture type.

            Possible values include:
            • "x86_64"
            • "arm64"
          • rootEbsVolume — (map)

            The root EBS volume.

            • sizeGiB — (Integer)

              The EBS volume size in GiB.

            • iops — (Integer)

              The IOPS per volume.

            • throughputMiB — (Integer)

              The throughput per volume in MiB.

          • allowedInstanceTypes — (Array<String>)

            The allowable Amazon EC2 instance types.

          • excludedInstanceTypes — (Array<String>)

            The instance types to exclude from the fleet.

          • customAmounts — (Array<map>)

            The custom capability amounts to require for instances in this fleet.

            • name — required — (String)

              The name of the fleet capability.

            • min — required — (Float)

              The minimum amount of fleet worker capability.

            • max — (Float)

              The maximum amount of the fleet worker capability.

          • customAttributes — (Array<map>)

            The custom capability attributes to require for instances in this fleet.

            • name — required — (String)

              The name of the fleet attribute capability for the worker.

            • values — required — (Array<String>)

              The number of fleet attribute capabilities.

        • instanceMarketOptions — required — (map)

          The Amazon EC2 market type.

          • type — required — (String)

            The Amazon EC2 instance type.

            Possible values include:
            • "on-demand"
            • "spot"
    • capabilities — (map)

      Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

      • amounts — (Array<map>)

        Amount capabilities of the fleet.

        • name — required — (String)

          The name of the fleet capability.

        • min — required — (Float)

          The minimum amount of fleet worker capability.

        • max — (Float)

          The maximum amount of the fleet worker capability.

      • attributes — (Array<map>)

        Attribute capabilities of the fleet.

        • name — required — (String)

          The name of the fleet attribute capability for the worker.

        • values — required — (Array<String>)

          The number of fleet attribute capabilities.

    • roleArn — (String)

      The IAM role ARN.

    • createdAt — (Date)

      The date and time the resource was created.

    • createdBy — (String)

      The user or system that created this resource.

    • updatedAt — (Date)

      The date and time the resource was updated.

    • updatedBy — (String)

      The user or system that updated this resource.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• fleetActive

var params = {
  farmId: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.getJob(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: {}) —
  • farmId — (String)

    The farm ID of the farm in the job.

  • jobId — (String)

    The job ID.

  • queueId — (String)

    The queue ID associated with the job.

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:

    • jobId — (String)

      The job ID.

    • name — (String)

      The name of the job.

    • lifecycleStatus — (String)

      The life cycle status for the job.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "CREATE_COMPLETE"
      • "UPLOAD_IN_PROGRESS"
      • "UPLOAD_FAILED"
      • "UPDATE_IN_PROGRESS"
      • "UPDATE_FAILED"
      • "UPDATE_SUCCEEDED"
      • "ARCHIVED"
    • lifecycleStatusMessage — (String)

      A message that communicates the status of the life cycle for the job.

    • priority — (Integer)

      The job priority.

    • createdAt — (Date)

      The date and time the resource was created.

    • createdBy — (String)

      The user or system that created this resource.

    • updatedAt — (Date)

      The date and time the resource was updated.

    • updatedBy — (String)

      The user or system that updated this resource.

    • startedAt — (Date)

      The date and time the resource started running.

    • endedAt — (Date)

      The date and time the resource ended running.

    • taskRunStatus — (String)

      The task run status for the job.

      Possible values include:
      • "PENDING"
      • "READY"
      • "ASSIGNED"
      • "STARTING"
      • "SCHEDULED"
      • "INTERRUPTING"
      • "RUNNING"
      • "SUSPENDED"
      • "CANCELED"
      • "FAILED"
      • "SUCCEEDED"
      • "NOT_COMPATIBLE"
    • targetTaskRunStatus — (String)

      The task status with which the job started.

      Possible values include:
      • "READY"
      • "FAILED"
      • "SUCCEEDED"
      • "CANCELED"
      • "SUSPENDED"
      • "PENDING"
    • taskRunStatusCounts — (map<Integer>)

      The number of tasks running on the job.

    • storageProfileId — (String)

      The storage profile ID associated with the job.

    • maxFailedTasksCount — (Integer)

      The number of task failures before the job stops running and is marked as FAILED.

    • maxRetriesPerTask — (Integer)

      The maximum number of retries per failed tasks.

    • parameters — (map<map>)

      The parameters for the job.

      • int — (String)

        A signed integer represented as a string.

      • float — (String)

        A double precision IEEE-754 floating point number represented as a string.

      • string — (String)

        A UTF-8 string.

      • path — (String)

        A file system path represented as a string.

    • attachments — (map)

      The attachments for the job.

      • manifests — required — (Array<map>)

        A list of manifests which describe job attachment configurations.

        • fileSystemLocationName — (String)

          The file system location name.

        • rootPath — required — (String)

          The file's root path.

        • rootPathFormat — required — (String)

          The format of the root path.

          Possible values include:
          • "windows"
          • "posix"
        • outputRelativeDirectories — (Array<String>)

          The file path relative to the directory.

        • inputManifestPath — (String)

          The file path.

        • inputManifestHash — (String)

          The has value of the file.

      • fileSystem — (String)

        The file system.

        Possible values include:
        • "COPIED"
        • "VIRTUAL"
    • description — (String)

      The description of the job.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• jobCreateComplete

var params = {
  licenseEndpointId: 'STRING_VALUE' /* required */
};
deadline.getLicenseEndpoint(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: {}) —
  • licenseEndpointId — (String)

    The license endpoint ID.

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:

    • licenseEndpointId — (String)

      The license endpoint ID.

    • status — (String)

      The status of the license endpoint.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "READY"
      • "NOT_READY"
    • statusMessage — (String)

      The status message of the license endpoint.

    • vpcId — (String)

      The VCP(virtual private cloud) ID associated with the license endpoint.

    • dnsName — (String)

      The DNS name.

    • subnetIds — (Array<String>)

      The subnet IDs.

    • securityGroupIds — (Array<String>)

      The security group IDs for the license endpoint.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• licenseEndpointDeleted

• licenseEndpointValid

var params = {
  monitorId: 'STRING_VALUE' /* required */
};
deadline.getMonitor(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: {}) —
  • monitorId — (String)

    The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.

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:

    • monitorId — (String)

      The unique identifier for the monitor.

    • displayName — (String)

      The name used to identify the monitor on the Deadline Cloud console.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • subdomain — (String)

      The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

    • url — (String)

      The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

    • identityCenterInstanceArn — (String)

      The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

    • identityCenterApplicationArn — (String)

      The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.

    • createdAt — (Date)

      The UNIX timestamp of the date and time that the monitor was created.

    • createdBy — (String)

      The user name of the person that created the monitor.

    • updatedAt — (Date)

      The UNIX timestamp of the last date and time that the monitor was updated.

    • updatedBy — (String)

      The user name of the person that last updated the monitor.

Returns:

• (AWS.Request) —

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

var params = {
  farmId: 'STRING_VALUE', /* required */
  queueId: 'STRING_VALUE' /* required */
};
deadline.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: {}) —
  • farmId — (String)

    The farm ID of the farm in the queue.

  • queueId — (String)

    The queue ID for the queue to retrieve.

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:

    • queueId — (String)

      The queue ID.

    • displayName — (String)

      The display name of the queue.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • description — (String)

      The description of the queue.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • farmId — (String)

      The farm ID for the queue.

    • status — (String)

      The status of the queue.

      • ACTIVE–The queue is active.

      • SCHEDULING–The queue is scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

      Possible values include:
      • "IDLE"
      • "SCHEDULING"
      • "SCHEDULING_BLOCKED"
    • defaultBudgetAction — (String)

      The default action taken on a queue if a budget wasn't configured.

      Possible values include:
      • "NONE"
      • "STOP_SCHEDULING_AND_COMPLETE_TASKS"
      • "STOP_SCHEDULING_AND_CANCEL_TASKS"
    • blockedReason — (String)

      The reason the queue was blocked.

      Possible values include:
      • "NO_BUDGET_CONFIGURED"
      • "BUDGET_THRESHOLD_REACHED"
    • jobAttachmentSettings — (map)

      The job attachment settings for the queue.

      • s3BucketName — required — (String)

        The Amazon S3 bucket name.

      • rootPrefix — required — (String)

        The root prefix.

    • roleArn — (String)

      The IAM role ARN.

    • requiredFileSystemLocationNames — (Array<String>)

      A list of the required file system location names in the queue.

    • allowedStorageProfileIds — (Array<String>)

      The storage profile IDs for the queue.

    • jobRunAsUser — (map)

      The jobs in the queue ran as this specified POSIX user.

      • posix — (map)

        The user and group that the jobs in the queue run as.

        • user — required — (String)

          The name of the POSIX user.

        • group — required — (String)

          The name of the POSIX user's group.

      • windows — (map)

        Identifies a Microsoft Windows user.

        • user — required — (String)

          The user.

        • passwordArn — required — (String)

          The password ARN for the Windows user.

      • runAs — required — (String)

        Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.

        Possible values include:
        • "QUEUE_CONFIGURED_USER"
        • "WORKER_AGENT_USER"
    • createdAt — (Date)

      The date and time the resource was created.

    • createdBy — (String)

      The user or system that created this resource.

    • updatedAt — (Date)

      The date and time the resource was updated.

    • updatedBy — (String)

      The user or system that updated this resource.