- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
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.
Installation
npm install @aws-sdk/client-deadline
yarn add @aws-sdk/client-deadline
pnpm add @aws-sdk/client-deadline
DeadlineClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
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 Deadline Cloud jobs . |
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 | Deletes a budget. |
DeleteFarmCommand | Deletes a farm. |
DeleteFleetCommand | Deletes a fleet. |
DeleteLicenseEndpointCommand | Deletes a license endpoint. |
DeleteMeteredProductCommand | Deletes a metered product. |
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. You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue. |
DeleteQueueEnvironmentCommand | Deletes a queue environment. |
DeleteQueueFleetAssociationCommand | Deletes a queue-fleet association. |
DeleteStorageProfileCommand | Deletes a storage profile. |
DeleteWorkerCommand | Deletes a worker. |
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 | Get a budget. |
GetFarmCommand | Get a farm. |
GetFleetCommand | Get a fleet. |
GetJobCommand | Gets a Deadline Cloud job. |
GetLicenseEndpointCommand | Gets a licence endpoint. |
GetMonitorCommand | Gets information about the specified monitor. |
GetQueueCommand | Gets a queue. |
GetQueueEnvironmentCommand | Gets a queue environment. |
GetQueueFleetAssociationCommand | Gets a queue-fleet association. |
GetSessionActionCommand | Gets a session action for the job. |
GetSessionCommand | Gets a session. |
GetSessionsStatisticsAggregationCommand | Gets a set of statistics for queues or farms. Before you can call the |
GetStepCommand | Gets a step. |
GetStorageProfileCommand | Gets a storage profile. |
GetStorageProfileForQueueCommand | Gets a storage profile for a queue. |
GetTaskCommand | Gets a task. |
GetWorkerCommand | Gets a worker. |
ListAvailableMeteredProductsCommand | A list of the available metered products. |
ListBudgetsCommand | A list of budgets in a farm. |
ListFarmMembersCommand | Lists the members of a farm. |
ListFarmsCommand | Lists farms. |
ListFleetMembersCommand | Lists fleet members. |
ListFleetsCommand | Lists fleets. |
ListJobMembersCommand | Lists members on a job. |
ListJobParameterDefinitionsCommand | Lists parameter definitions of a job. |
ListJobsCommand | Lists jobs. |
ListLicenseEndpointsCommand | Lists license endpoints. |
ListMeteredProductsCommand | Lists metered products. |
ListMonitorsCommand | Gets a list of your monitors in Deadline Cloud. |
ListQueueEnvironmentsCommand | Lists queue environments. |
ListQueueFleetAssociationsCommand | Lists queue-fleet associations. |
ListQueueMembersCommand | Lists the members in a queue. |
ListQueuesCommand | Lists queues. |
ListSessionActionsCommand | Lists session actions. |
ListSessionsCommand | Lists sessions. |
ListSessionsForWorkerCommand | Lists sessions for a worker. |
ListStepConsumersCommand | Lists step consumers. |
ListStepDependenciesCommand | Lists the dependencies for a step. |
ListStepsCommand | Lists steps for a job. |
ListStorageProfilesCommand | Lists storage profiles. |
ListStorageProfilesForQueueCommand | Lists storage profiles for a queue. |
ListTagsForResourceCommand | Lists tags for a resource. |
ListTasksCommand | Lists tasks for a job. |
ListWorkersCommand | Lists workers. |
PutMeteredProductCommand | Adds a metered product. |
SearchJobsCommand | Searches for jobs. |
SearchStepsCommand | Searches for steps. |
SearchTasksCommand | Searches for tasks. |
SearchWorkersCommand | Searches for workers. |
StartSessionsStatisticsAggregationCommand | Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the |
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 | Updates a farm. |
UpdateFleetCommand | Updates a fleet. |
UpdateJobCommand | Updates a job. When you change the status of the job to An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered. |
UpdateMonitorCommand | Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call |
UpdateQueueCommand | Updates a queue. |
UpdateQueueEnvironmentCommand | Updates the queue environment. |
UpdateQueueFleetAssociationCommand | Updates a queue-fleet association. |
UpdateSessionCommand | Updates a session. |
UpdateStepCommand | Updates a step. |
UpdateStorageProfileCommand | Updates a storage profile. |
UpdateTaskCommand | Updates a task. |
UpdateWorkerCommand | Updates a worker. |
UpdateWorkerScheduleCommand | Updates the schedule for a worker. |
DeadlineClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: DeadlineClientConfig