Deadline

import { Deadline } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/deadline.ts?docs=full";

class Deadline {

constructor(apiFactory: client.ApiFactory);

async associateMemberToFarm(params: AssociateMemberToFarmRequest, opts?: client.RequestOptions): Promise<void>;

async associateMemberToFleet(params: AssociateMemberToFleetRequest, opts?: client.RequestOptions): Promise<void>;

async associateMemberToJob(params: AssociateMemberToJobRequest, opts?: client.RequestOptions): Promise<void>;

async associateMemberToQueue(params: AssociateMemberToQueueRequest, opts?: client.RequestOptions): Promise<void>;

async assumeFleetRoleForRead(params: AssumeFleetRoleForReadRequest, opts?: client.RequestOptions): Promise<AssumeFleetRoleForReadResponse>;

async assumeFleetRoleForWorker(params: AssumeFleetRoleForWorkerRequest, opts?: client.RequestOptions): Promise<AssumeFleetRoleForWorkerResponse>;

async assumeQueueRoleForRead(params: AssumeQueueRoleForReadRequest, opts?: client.RequestOptions): Promise<AssumeQueueRoleForReadResponse>;

async assumeQueueRoleForUser(params: AssumeQueueRoleForUserRequest, opts?: client.RequestOptions): Promise<AssumeQueueRoleForUserResponse>;

async assumeQueueRoleForWorker(params: AssumeQueueRoleForWorkerRequest, opts?: client.RequestOptions): Promise<AssumeQueueRoleForWorkerResponse>;

async batchGetJobEntity(params: BatchGetJobEntityRequest, opts?: client.RequestOptions): Promise<BatchGetJobEntityResponse>;

async copyJobTemplate(params: CopyJobTemplateRequest, opts?: client.RequestOptions): Promise<CopyJobTemplateResponse>;

async createBudget(params: CreateBudgetRequest, opts?: client.RequestOptions): Promise<CreateBudgetResponse>;

async createFarm(params: CreateFarmRequest, opts?: client.RequestOptions): Promise<CreateFarmResponse>;

async createFleet(params: CreateFleetRequest, opts?: client.RequestOptions): Promise<CreateFleetResponse>;

async createJob(params: CreateJobRequest, opts?: client.RequestOptions): Promise<CreateJobResponse>;

async createLicenseEndpoint(params: CreateLicenseEndpointRequest, opts?: client.RequestOptions): Promise<CreateLicenseEndpointResponse>;

async createMonitor(params: CreateMonitorRequest, opts?: client.RequestOptions): Promise<CreateMonitorResponse>;

async createQueue(params: CreateQueueRequest, opts?: client.RequestOptions): Promise<CreateQueueResponse>;

async createQueueEnvironment(params: CreateQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<CreateQueueEnvironmentResponse>;

async createQueueFleetAssociation(params: CreateQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<void>;

async createStorageProfile(params: CreateStorageProfileRequest, opts?: client.RequestOptions): Promise<CreateStorageProfileResponse>;

async createWorker(params: CreateWorkerRequest, opts?: client.RequestOptions): Promise<CreateWorkerResponse>;

async deleteBudget(params: DeleteBudgetRequest, opts?: client.RequestOptions): Promise<void>;

async deleteFarm(params: DeleteFarmRequest, opts?: client.RequestOptions): Promise<void>;

async deleteFleet(params: DeleteFleetRequest, opts?: client.RequestOptions): Promise<void>;

async deleteLicenseEndpoint(params: DeleteLicenseEndpointRequest, opts?: client.RequestOptions): Promise<void>;

async deleteMeteredProduct(params: DeleteMeteredProductRequest, opts?: client.RequestOptions): Promise<void>;

async deleteMonitor(params: DeleteMonitorRequest, opts?: client.RequestOptions): Promise<void>;

async deleteQueue(params: DeleteQueueRequest, opts?: client.RequestOptions): Promise<void>;

async deleteQueueEnvironment(params: DeleteQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<void>;

async deleteQueueFleetAssociation(params: DeleteQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteStorageProfile(params: DeleteStorageProfileRequest, opts?: client.RequestOptions): Promise<void>;

async deleteWorker(params: DeleteWorkerRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateMemberFromFarm(params: DisassociateMemberFromFarmRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateMemberFromFleet(params: DisassociateMemberFromFleetRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateMemberFromJob(params: DisassociateMemberFromJobRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateMemberFromQueue(params: DisassociateMemberFromQueueRequest, opts?: client.RequestOptions): Promise<void>;

async getBudget(params: GetBudgetRequest, opts?: client.RequestOptions): Promise<GetBudgetResponse>;

async getFarm(params: GetFarmRequest, opts?: client.RequestOptions): Promise<GetFarmResponse>;

async getFleet(params: GetFleetRequest, opts?: client.RequestOptions): Promise<GetFleetResponse>;

async getJob(params: GetJobRequest, opts?: client.RequestOptions): Promise<GetJobResponse>;

async getLicenseEndpoint(params: GetLicenseEndpointRequest, opts?: client.RequestOptions): Promise<GetLicenseEndpointResponse>;

async getMonitor(params: GetMonitorRequest, opts?: client.RequestOptions): Promise<GetMonitorResponse>;

async getQueue(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>;

async getQueueEnvironment(params: GetQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<GetQueueEnvironmentResponse>;

async getQueueFleetAssociation(params: GetQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<GetQueueFleetAssociationResponse>;

async getSession(params: GetSessionRequest, opts?: client.RequestOptions): Promise<GetSessionResponse>;

async getSessionAction(params: GetSessionActionRequest, opts?: client.RequestOptions): Promise<GetSessionActionResponse>;

async getSessionsStatisticsAggregation(params: GetSessionsStatisticsAggregationRequest, opts?: client.RequestOptions): Promise<GetSessionsStatisticsAggregationResponse>;

async getStep(params: GetStepRequest, opts?: client.RequestOptions): Promise<GetStepResponse>;

async getStorageProfile(params: GetStorageProfileRequest, opts?: client.RequestOptions): Promise<GetStorageProfileResponse>;

async getStorageProfileForQueue(params: GetStorageProfileForQueueRequest, opts?: client.RequestOptions): Promise<GetStorageProfileForQueueResponse>;

async getTask(params: GetTaskRequest, opts?: client.RequestOptions): Promise<GetTaskResponse>;

async getWorker(params: GetWorkerRequest, opts?: client.RequestOptions): Promise<GetWorkerResponse>;

async listAvailableMeteredProducts(params?: ListAvailableMeteredProductsRequest, opts?: client.RequestOptions): Promise<ListAvailableMeteredProductsResponse>;

async listBudgets(params: ListBudgetsRequest, opts?: client.RequestOptions): Promise<ListBudgetsResponse>;

async listFarmMembers(params: ListFarmMembersRequest, opts?: client.RequestOptions): Promise<ListFarmMembersResponse>;

async listFarms(params?: ListFarmsRequest, opts?: client.RequestOptions): Promise<ListFarmsResponse>;

async listFleetMembers(params: ListFleetMembersRequest, opts?: client.RequestOptions): Promise<ListFleetMembersResponse>;

async listFleets(params: ListFleetsRequest, opts?: client.RequestOptions): Promise<ListFleetsResponse>;

async listJobMembers(params: ListJobMembersRequest, opts?: client.RequestOptions): Promise<ListJobMembersResponse>;

async listJobs(params: ListJobsRequest, opts?: client.RequestOptions): Promise<ListJobsResponse>;

async listLicenseEndpoints(params?: ListLicenseEndpointsRequest, opts?: client.RequestOptions): Promise<ListLicenseEndpointsResponse>;

async listMeteredProducts(params: ListMeteredProductsRequest, opts?: client.RequestOptions): Promise<ListMeteredProductsResponse>;

async listMonitors(params?: ListMonitorsRequest, opts?: client.RequestOptions): Promise<ListMonitorsResponse>;

async listQueueEnvironments(params: ListQueueEnvironmentsRequest, opts?: client.RequestOptions): Promise<ListQueueEnvironmentsResponse>;

async listQueueFleetAssociations(params: ListQueueFleetAssociationsRequest, opts?: client.RequestOptions): Promise<ListQueueFleetAssociationsResponse>;

async listQueueMembers(params: ListQueueMembersRequest, opts?: client.RequestOptions): Promise<ListQueueMembersResponse>;

async listQueues(params: ListQueuesRequest, opts?: client.RequestOptions): Promise<ListQueuesResponse>;

async listSessionActions(params: ListSessionActionsRequest, opts?: client.RequestOptions): Promise<ListSessionActionsResponse>;

async listSessions(params: ListSessionsRequest, opts?: client.RequestOptions): Promise<ListSessionsResponse>;

async listSessionsForWorker(params: ListSessionsForWorkerRequest, opts?: client.RequestOptions): Promise<ListSessionsForWorkerResponse>;

async listStepConsumers(params: ListStepConsumersRequest, opts?: client.RequestOptions): Promise<ListStepConsumersResponse>;

async listStepDependencies(params: ListStepDependenciesRequest, opts?: client.RequestOptions): Promise<ListStepDependenciesResponse>;

async listSteps(params: ListStepsRequest, opts?: client.RequestOptions): Promise<ListStepsResponse>;

async listStorageProfiles(params: ListStorageProfilesRequest, opts?: client.RequestOptions): Promise<ListStorageProfilesResponse>;

async listStorageProfilesForQueue(params: ListStorageProfilesForQueueRequest, opts?: client.RequestOptions): Promise<ListStorageProfilesForQueueResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTasks(params: ListTasksRequest, opts?: client.RequestOptions): Promise<ListTasksResponse>;

async listWorkers(params: ListWorkersRequest, opts?: client.RequestOptions): Promise<ListWorkersResponse>;

async putMeteredProduct(params: PutMeteredProductRequest, opts?: client.RequestOptions): Promise<void>;

async searchJobs(params: SearchJobsRequest, opts?: client.RequestOptions): Promise<SearchJobsResponse>;

async searchSteps(params: SearchStepsRequest, opts?: client.RequestOptions): Promise<SearchStepsResponse>;

async searchTasks(params: SearchTasksRequest, opts?: client.RequestOptions): Promise<SearchTasksResponse>;

async searchWorkers(params: SearchWorkersRequest, opts?: client.RequestOptions): Promise<SearchWorkersResponse>;

async startSessionsStatisticsAggregation(params: StartSessionsStatisticsAggregationRequest, opts?: client.RequestOptions): Promise<StartSessionsStatisticsAggregationResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateBudget(params: UpdateBudgetRequest, opts?: client.RequestOptions): Promise<void>;

async updateFarm(params: UpdateFarmRequest, opts?: client.RequestOptions): Promise<void>;

async updateFleet(params: UpdateFleetRequest, opts?: client.RequestOptions): Promise<void>;

async updateJob(params: UpdateJobRequest, opts?: client.RequestOptions): Promise<void>;

async updateMonitor(params: UpdateMonitorRequest, opts?: client.RequestOptions): Promise<void>;

async updateQueue(params: UpdateQueueRequest, opts?: client.RequestOptions): Promise<void>;

async updateQueueEnvironment(params: UpdateQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<void>;

async updateQueueFleetAssociation(params: UpdateQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<void>;

async updateSession(params: UpdateSessionRequest, opts?: client.RequestOptions): Promise<void>;

async updateStep(params: UpdateStepRequest, opts?: client.RequestOptions): Promise<void>;

async updateStorageProfile(params: UpdateStorageProfileRequest, opts?: client.RequestOptions): Promise<void>;

async updateTask(params: UpdateTaskRequest, opts?: client.RequestOptions): Promise<void>;

async updateWorker(params: UpdateWorkerRequest, opts?: client.RequestOptions): Promise<UpdateWorkerResponse>;

async updateWorkerSchedule(params: UpdateWorkerScheduleRequest, opts?: client.RequestOptions): Promise<UpdateWorkerScheduleResponse>;

async waitForFleetActive(params: GetFleetRequest, opts?: client.RequestOptions): Promise<GetFleetResponse>;

async waitForJobCreateComplete(params: GetJobRequest, opts?: client.RequestOptions): Promise<GetJobResponse>;

async waitForLicenseEndpointDeleted(params: GetLicenseEndpointRequest, opts?: client.RequestOptions): Promise<Error | GetLicenseEndpointResponse>;

async waitForLicenseEndpointValid(params: GetLicenseEndpointRequest, opts?: client.RequestOptions): Promise<GetLicenseEndpointResponse>;

async waitForQueueFleetAssociationStopped(params: GetQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<GetQueueFleetAssociationResponse>;

async waitForQueueScheduling(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>;

async waitForQueueSchedulingBlocked(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Deadline(apiFactory: client.ApiFactory)

[src]

§Methods

associateMemberToFarm(params: AssociateMemberToFarmRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns a farm membership level to a member.

associateMemberToFleet(params: AssociateMemberToFleetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns a fleet membership level to a member.

associateMemberToJob(params: AssociateMemberToJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns a job membership level to a member

associateMemberToQueue(params: AssociateMemberToQueueRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns a queue membership level to a member

assumeFleetRoleForRead(params: AssumeFleetRoleForReadRequest, opts?: client.RequestOptions): Promise<AssumeFleetRoleForReadResponse>

[src]

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

assumeFleetRoleForWorker(params: AssumeFleetRoleForWorkerRequest, opts?: client.RequestOptions): Promise<AssumeFleetRoleForWorkerResponse>

[src]

Get credentials from the fleet role for a worker.

assumeQueueRoleForRead(params: AssumeQueueRoleForReadRequest, opts?: client.RequestOptions): Promise<AssumeQueueRoleForReadResponse>

[src]

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

assumeQueueRoleForUser(params: AssumeQueueRoleForUserRequest, opts?: client.RequestOptions): Promise<AssumeQueueRoleForUserResponse>

[src]

Allows a user to assume a role for a queue.

assumeQueueRoleForWorker(params: AssumeQueueRoleForWorkerRequest, opts?: client.RequestOptions): Promise<AssumeQueueRoleForWorkerResponse>

[src]

Allows a worker to assume a queue role.

batchGetJobEntity(params: BatchGetJobEntityRequest, opts?: client.RequestOptions): Promise<BatchGetJobEntityResponse>

[src]

Get batched job details for a worker.

copyJobTemplate(params: CopyJobTemplateRequest, opts?: client.RequestOptions): Promise<CopyJobTemplateResponse>

[src]

Copies a job template to an Amazon S3 bucket.

createBudget(params: CreateBudgetRequest, opts?: client.RequestOptions): Promise<CreateBudgetResponse>

[src]

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

createFarm(params: CreateFarmRequest, opts?: client.RequestOptions): Promise<CreateFarmResponse>

[src]

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.

createFleet(params: CreateFleetRequest, opts?: client.RequestOptions): Promise<CreateFleetResponse>

[src]

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.

createJob(params: CreateJobRequest, opts?: client.RequestOptions): Promise<CreateJobResponse>

[src]

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.

createLicenseEndpoint(params: CreateLicenseEndpointRequest, opts?: client.RequestOptions): Promise<CreateLicenseEndpointResponse>

[src]

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

createMonitor(params: CreateMonitorRequest, opts?: client.RequestOptions): Promise<CreateMonitorResponse>

[src]

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.

createQueue(params: CreateQueueRequest, opts?: client.RequestOptions): Promise<CreateQueueResponse>

[src]

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.

createQueueEnvironment(params: CreateQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<CreateQueueEnvironmentResponse>

[src]

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

createQueueFleetAssociation(params: CreateQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates an association between a queue and a fleet.

createStorageProfile(params: CreateStorageProfileRequest, opts?: client.RequestOptions): Promise<CreateStorageProfileResponse>

[src]

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

createWorker(params: CreateWorkerRequest, opts?: client.RequestOptions): Promise<CreateWorkerResponse>

[src]

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.

deleteBudget(params: DeleteBudgetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a budget.

deleteFarm(params: DeleteFarmRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a farm.

deleteFleet(params: DeleteFleetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a fleet.

deleteLicenseEndpoint(params: DeleteLicenseEndpointRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a license endpoint.

deleteMeteredProduct(params: DeleteMeteredProductRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a metered product.

deleteMonitor(params: DeleteMonitorRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteQueue(params: DeleteQueueRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteQueueEnvironment(params: DeleteQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a queue environment.

deleteQueueFleetAssociation(params: DeleteQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a queue-fleet association.

deleteStorageProfile(params: DeleteStorageProfileRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a storage profile.

deleteWorker(params: DeleteWorkerRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a worker.

disassociateMemberFromFarm(params: DisassociateMemberFromFarmRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociates a member from a farm.

disassociateMemberFromFleet(params: DisassociateMemberFromFleetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociates a member from a fleet.

disassociateMemberFromJob(params: DisassociateMemberFromJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociates a member from a job.

disassociateMemberFromQueue(params: DisassociateMemberFromQueueRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociates a member from a queue.

getBudget(params: GetBudgetRequest, opts?: client.RequestOptions): Promise<GetBudgetResponse>

[src]

Get a budget.

getFarm(params: GetFarmRequest, opts?: client.RequestOptions): Promise<GetFarmResponse>

[src]

Get a farm.

getFleet(params: GetFleetRequest, opts?: client.RequestOptions): Promise<GetFleetResponse>

[src]

Get a fleet.

getJob(params: GetJobRequest, opts?: client.RequestOptions): Promise<GetJobResponse>

[src]

Gets a Deadline Cloud job.

getLicenseEndpoint(params: GetLicenseEndpointRequest, opts?: client.RequestOptions): Promise<GetLicenseEndpointResponse>

[src]

Gets a licence endpoint.

getMonitor(params: GetMonitorRequest, opts?: client.RequestOptions): Promise<GetMonitorResponse>

[src]

Gets information about the specified monitor.

getQueue(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>

[src]

Gets a queue.

getQueueEnvironment(params: GetQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<GetQueueEnvironmentResponse>

[src]

Gets a queue environment.

getQueueFleetAssociation(params: GetQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<GetQueueFleetAssociationResponse>

[src]

Gets a queue-fleet association.

getSession(params: GetSessionRequest, opts?: client.RequestOptions): Promise<GetSessionResponse>

[src]

Gets a session.

getSessionAction(params: GetSessionActionRequest, opts?: client.RequestOptions): Promise<GetSessionActionResponse>

[src]

Gets a session action for the job.

getSessionsStatisticsAggregation(params: GetSessionsStatisticsAggregationRequest, opts?: client.RequestOptions): Promise<GetSessionsStatisticsAggregationResponse>

[src]

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

getStep(params: GetStepRequest, opts?: client.RequestOptions): Promise<GetStepResponse>

[src]

Gets a step.

getStorageProfile(params: GetStorageProfileRequest, opts?: client.RequestOptions): Promise<GetStorageProfileResponse>

[src]

Gets a storage profile.

getStorageProfileForQueue(params: GetStorageProfileForQueueRequest, opts?: client.RequestOptions): Promise<GetStorageProfileForQueueResponse>

[src]

Gets a storage profile for a queue.

getTask(params: GetTaskRequest, opts?: client.RequestOptions): Promise<GetTaskResponse>

[src]

Gets a task.

getWorker(params: GetWorkerRequest, opts?: client.RequestOptions): Promise<GetWorkerResponse>

[src]

Gets a worker.

listAvailableMeteredProducts(params?: ListAvailableMeteredProductsRequest, opts?: client.RequestOptions): Promise<ListAvailableMeteredProductsResponse>

[src]

A list of the available metered products.

listBudgets(params: ListBudgetsRequest, opts?: client.RequestOptions): Promise<ListBudgetsResponse>

[src]

A list of budgets in a farm.

listFarmMembers(params: ListFarmMembersRequest, opts?: client.RequestOptions): Promise<ListFarmMembersResponse>

[src]

Lists the members of a farm.

listFarms(params?: ListFarmsRequest, opts?: client.RequestOptions): Promise<ListFarmsResponse>

[src]

Lists farms.

listFleetMembers(params: ListFleetMembersRequest, opts?: client.RequestOptions): Promise<ListFleetMembersResponse>

[src]

Lists fleet members.

listFleets(params: ListFleetsRequest, opts?: client.RequestOptions): Promise<ListFleetsResponse>

[src]

Lists fleets.

listJobMembers(params: ListJobMembersRequest, opts?: client.RequestOptions): Promise<ListJobMembersResponse>

[src]

Lists members on a job.

listJobs(params: ListJobsRequest, opts?: client.RequestOptions): Promise<ListJobsResponse>

[src]

Lists jobs.

listLicenseEndpoints(params?: ListLicenseEndpointsRequest, opts?: client.RequestOptions): Promise<ListLicenseEndpointsResponse>

[src]

Lists license endpoints.

listMeteredProducts(params: ListMeteredProductsRequest, opts?: client.RequestOptions): Promise<ListMeteredProductsResponse>

[src]

Lists metered products.

listMonitors(params?: ListMonitorsRequest, opts?: client.RequestOptions): Promise<ListMonitorsResponse>

[src]

Gets a list of your monitors in Deadline Cloud.

listQueueEnvironments(params: ListQueueEnvironmentsRequest, opts?: client.RequestOptions): Promise<ListQueueEnvironmentsResponse>

[src]

Lists queue environments.

listQueueFleetAssociations(params: ListQueueFleetAssociationsRequest, opts?: client.RequestOptions): Promise<ListQueueFleetAssociationsResponse>

[src]

Lists queue-fleet associations.

listQueueMembers(params: ListQueueMembersRequest, opts?: client.RequestOptions): Promise<ListQueueMembersResponse>

[src]

Lists the members in a queue.

listQueues(params: ListQueuesRequest, opts?: client.RequestOptions): Promise<ListQueuesResponse>

[src]

Lists queues.

listSessionActions(params: ListSessionActionsRequest, opts?: client.RequestOptions): Promise<ListSessionActionsResponse>

[src]

Lists session actions.

listSessions(params: ListSessionsRequest, opts?: client.RequestOptions): Promise<ListSessionsResponse>

[src]

Lists sessions.

listSessionsForWorker(params: ListSessionsForWorkerRequest, opts?: client.RequestOptions): Promise<ListSessionsForWorkerResponse>

[src]

Lists sessions for a worker.

listStepConsumers(params: ListStepConsumersRequest, opts?: client.RequestOptions): Promise<ListStepConsumersResponse>

[src]

Lists step consumers.

listStepDependencies(params: ListStepDependenciesRequest, opts?: client.RequestOptions): Promise<ListStepDependenciesResponse>

[src]

Lists the dependencies for a step.

listSteps(params: ListStepsRequest, opts?: client.RequestOptions): Promise<ListStepsResponse>

[src]

Lists steps for a job.

listStorageProfiles(params: ListStorageProfilesRequest, opts?: client.RequestOptions): Promise<ListStorageProfilesResponse>

[src]

Lists storage profiles.

listStorageProfilesForQueue(params: ListStorageProfilesForQueueRequest, opts?: client.RequestOptions): Promise<ListStorageProfilesForQueueResponse>

[src]

Lists storage profiles for a queue.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists tags for a resource.

listTasks(params: ListTasksRequest, opts?: client.RequestOptions): Promise<ListTasksResponse>

[src]

Lists tasks for a job.

listWorkers(params: ListWorkersRequest, opts?: client.RequestOptions): Promise<ListWorkersResponse>

[src]

Lists workers.

putMeteredProduct(params: PutMeteredProductRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds a metered product.

searchJobs(params: SearchJobsRequest, opts?: client.RequestOptions): Promise<SearchJobsResponse>

[src]

Searches for jobs.

searchSteps(params: SearchStepsRequest, opts?: client.RequestOptions): Promise<SearchStepsResponse>

[src]

Searches for steps.

searchTasks(params: SearchTasksRequest, opts?: client.RequestOptions): Promise<SearchTasksResponse>

[src]

Searches for tasks.

searchWorkers(params: SearchWorkersRequest, opts?: client.RequestOptions): Promise<SearchWorkersResponse>

[src]

Searches for workers.

startSessionsStatisticsAggregation(params: StartSessionsStatisticsAggregationRequest, opts?: client.RequestOptions): Promise<StartSessionsStatisticsAggregationResponse>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updateBudget(params: UpdateBudgetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a budget that sets spending thresholds for rendering activity.

updateFarm(params: UpdateFarmRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a farm.

updateFleet(params: UpdateFleetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a fleet.

updateJob(params: UpdateJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a job.

When you change the status of the job to ARCHIVED, 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.

updateMonitor(params: UpdateMonitorRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updateQueue(params: UpdateQueueRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a queue.

updateQueueEnvironment(params: UpdateQueueEnvironmentRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the queue environment.

updateQueueFleetAssociation(params: UpdateQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a queue-fleet association.

updateSession(params: UpdateSessionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a session.

updateStep(params: UpdateStepRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a step.

updateStorageProfile(params: UpdateStorageProfileRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a storage profile.

updateTask(params: UpdateTaskRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a task.

updateWorker(params: UpdateWorkerRequest, opts?: client.RequestOptions): Promise<UpdateWorkerResponse>

[src]

Updates a worker.

updateWorkerSchedule(params: UpdateWorkerScheduleRequest, opts?: client.RequestOptions): Promise<UpdateWorkerScheduleResponse>

[src]

Updates the schedule for a worker.

waitForFleetActive(params: GetFleetRequest, opts?: client.RequestOptions): Promise<GetFleetResponse>

[src]

Wait until a Fleet is activated. Use this after invoking CreateFleet or UpdateFleet. Checks state up to 180 times, 5 seconds apart (about 15 minutes max wait time).

waitForJobCreateComplete(params: GetJobRequest, opts?: client.RequestOptions): Promise<GetJobResponse>

[src]

Wait until a Job is created. Use this after invoking CreateJob. Checks state up to 120 times, 1 seconds apart (about 2 minutes max wait time).

waitForLicenseEndpointDeleted(params: GetLicenseEndpointRequest, opts?: client.RequestOptions): Promise<Error | GetLicenseEndpointResponse>

[src]

Wait until a LicenseEndpoint is Deleted. Use this after invoking DeleteLicenseEndpoint. Checks state up to 234 times, 10 seconds apart (about 39 minutes max wait time).

waitForLicenseEndpointValid(params: GetLicenseEndpointRequest, opts?: client.RequestOptions): Promise<GetLicenseEndpointResponse>

[src]

Wait until a LicenseEndpoint is Ready. Use this after invoking CreateLicenseEndpoint. Checks state up to 114 times, 10 seconds apart (about 19 minutes max wait time).

waitForQueueFleetAssociationStopped(params: GetQueueFleetAssociationRequest, opts?: client.RequestOptions): Promise<GetQueueFleetAssociationResponse>

[src]

Wait until a QueueFleetAssociation is stopped. Use this after setting the status to STOP_SCHEDULING_AND_COMPLETE_TASKS or STOP_SCHEDULING_AND_CANCEL_TASKS to wait for a QueueFleetAssociation to reach STOPPED Checks state up to 60 times, 10 seconds apart (about 10 minutes max wait time).

waitForQueueScheduling(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>

[src]

Checks state up to 70 times, 10 seconds apart (about 12 minutes max wait time).

waitForQueueSchedulingBlocked(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>

[src]

Checks state up to 30 times, 10 seconds apart (about 5 minutes max wait time).

§Static Properties

ApiMetadata: client.ApiMetadata

[src]