(constructor)

[configuration]

Constructs a new instance of the <code>DeadlineClient</code> class

config

The resolved configuration of DeadlineClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-deadline!DeadlineClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

DeadlineClient

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function. With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AssociateMemberToFarmCommand

Assigns a farm membership level to a member.

AssociateMemberToFleetCommand

Assigns a fleet membership level to a member.

AssociateMemberToJobCommand

Assigns a job membership level to a member

AssociateMemberToQueueCommand

Assigns a queue membership level to a member

AssumeFleetRoleForReadCommand

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

AssumeFleetRoleForWorkerCommand

Get credentials from the fleet role for a worker.

AssumeQueueRoleForReadCommand

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

AssumeQueueRoleForUserCommand

Allows a user to assume a role for a queue.

AssumeQueueRoleForWorkerCommand

Allows a worker to assume a queue role.

BatchGetJobEntityCommand

Get batched job details for a worker.

CopyJobTemplateCommand

Copies a job template to an Amazon S3 bucket.

CreateBudgetCommand

Creates a budget to set spending thresholds for your rendering activity.

CreateFarmCommand

Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

CreateFleetCommand

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

CreateJobCommand

Creates a job. A job is a set of instructions that AWS Deadline Cloud uses to schedule and run work on available workers. For more information, see <a href="https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html">Deadline Cloud jobs</a>.

CreateLicenseEndpointCommand

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

CreateMonitorCommand

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

CreateQueueCommand

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

CreateQueueEnvironmentCommand

Creates an environment for a queue that defines how jobs in the queue run.

CreateQueueFleetAssociationCommand

Creates an association between a queue and a fleet.

CreateStorageProfileCommand

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

CreateWorkerCommand

Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.

DeleteBudgetCommand

DeleteFarmCommand

DeleteFleetCommand

DeleteLicenseEndpointCommand

DeleteMeteredProductCommand

DeleteMonitorCommand

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

DeleteQueueCommand

Deletes a queue. <important> You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue. </important>

DeleteQueueEnvironmentCommand

DeleteQueueFleetAssociationCommand

Deletes a queue-fleet association.

DeleteStorageProfileCommand

DeleteWorkerCommand

DisassociateMemberFromFarmCommand

Disassociates a member from a farm.

DisassociateMemberFromFleetCommand

Disassociates a member from a fleet.

DisassociateMemberFromJobCommand

Disassociates a member from a job.

DisassociateMemberFromQueueCommand

Disassociates a member from a queue.

GetBudgetCommand

GetFarmCommand

GetFleetCommand

GetJobCommand

GetLicenseEndpointCommand

GetMonitorCommand

Gets information about the specified monitor.

GetQueueCommand

GetQueueEnvironmentCommand

GetQueueFleetAssociationCommand

GetSessionActionCommand

Gets a session action for the job.

GetSessionCommand

GetSessionsStatisticsAggregationCommand

Gets a set of statistics for queues or farms. Before you can call the <code>GetSessionStatisticsAggregation</code> operation, you must first call the <code>StartSessionsStatisticsAggregation</code> operation. Statistics are available for 1 hour after you call the <code>StartSessionsStatisticsAggregation</code> operation.

GetStepCommand

GetStorageProfileCommand

GetStorageProfileForQueueCommand

Gets a storage profile for a queue.

GetTaskCommand

GetWorkerCommand

ListAvailableMeteredProductsCommand

A list of the available metered products.

ListBudgetsCommand

ListFarmMembersCommand

ListFarmsCommand

ListFleetMembersCommand

ListFleetsCommand

ListJobMembersCommand

ListJobParameterDefinitionsCommand

Lists parameter definitions of a job.

ListJobsCommand

ListLicenseEndpointsCommand

ListMeteredProductsCommand

ListMonitorsCommand

Gets a list of your monitors in Deadline Cloud.

ListQueueEnvironmentsCommand

ListQueueFleetAssociationsCommand

ListQueueMembersCommand

ListQueuesCommand

ListSessionActionsCommand

ListSessionsCommand

ListSessionsForWorkerCommand

ListStepConsumersCommand

ListStepDependenciesCommand

Lists the dependencies for a step.

ListStepsCommand

ListStorageProfilesCommand

ListStorageProfilesForQueueCommand

Lists storage profiles for a queue.

ListTagsForResourceCommand

ListTasksCommand

ListWorkersCommand

PutMeteredProductCommand

SearchJobsCommand

SearchStepsCommand

SearchTasksCommand

SearchWorkersCommand

StartSessionsStatisticsAggregationCommand

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the <code>GetSessionsStatisticsAggregation</code> operation. You can only have one running aggregation for your Deadline Cloud farm. Call the <code>GetSessionsStatisticsAggregation</code> operation and check the <code>status</code> field to see if an aggregation is running. Statistics are available for 1 hour after you call the <code>StartSessionsStatisticsAggregation</code> operation.

TagResourceCommand

Tags a resource using the resource's ARN and desired tags.

UntagResourceCommand

Removes a tag from a resource using the resource's ARN and tag to remove.

UpdateBudgetCommand

Updates a budget that sets spending thresholds for rendering activity.

UpdateFarmCommand

UpdateFleetCommand

UpdateJobCommand

Updates a job. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived. <important> An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered. </important>

UpdateMonitorCommand

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call <code>UpdateMonitor</code>.