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.
Functions
Assigns a farm membership level to a member.
Assigns a fleet membership level to a member.
Assigns a job membership level to a member
Assigns a queue membership level to a member
Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
Get credentials from the fleet role for a worker.
Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
Allows a user to assume a role for a queue.
Allows a worker to assume a queue role.
Get batched job details for a worker.
Copies a job template to an Amazon S3 bucket.
Creates a budget to set spending thresholds for your rendering activity.
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.
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.
Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
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.
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.
Creates an environment for a queue that defines how jobs in the queue run.
Creates an association between a queue and a fleet.
Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
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.
Deletes a budget.
Deletes a farm.
Deletes a fleet.
Deletes a license endpoint.
Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.
Deletes a metered product.
Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
Deletes a queue.
Deletes a queue environment.
Deletes a queue-fleet association.
Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.
Deletes a storage profile.
Deletes a worker.
Disassociates a member from a farm.
Disassociates a member from a fleet.
Disassociates a member from a job.
Disassociates a member from a queue.
Get a budget.
Get a farm.
Get a fleet.
Gets a Deadline Cloud job.
Gets a licence endpoint.
Gets information about a specific limit.
Gets information about the specified monitor.
Gets a queue.
Gets a queue environment.
Gets a queue-fleet association.
Gets information about a specific association between a queue and a limit.
Gets a session.
Gets a session action for the job.
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.
Gets a step.
Gets a storage profile.
Gets a storage profile for a queue.
Gets a task.
Gets a worker.
A list of the available metered products.
A list of budgets in a farm.
Lists the members of a farm.
Lists farms.
Lists fleet members.
Lists fleets.
Lists members on a job.
Lists parameter definitions of a job.
Lists jobs.
Lists license endpoints.
Gets a list of limits defined in the specified farm.
Lists metered products.
Gets a list of your monitors in Deadline Cloud.
Lists queue environments.
Lists queue-fleet associations.
Gets a list of the associations between queues and limits defined in a farm.
Lists the members in a queue.
Lists queues.
Lists session actions.
Lists sessions.
Lists sessions for a worker.
Lists step consumers.
Lists the dependencies for a step.
Lists steps for a job.
Lists storage profiles.
Lists storage profiles for a queue.
Lists tags for a resource.
Lists tasks for a job.
Lists workers.
Adds a metered product.
Searches for jobs.
Searches for steps.
Searches for tasks.
Searches for workers.
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.
Tags a resource using the resource's ARN and desired tags.
Removes a tag from a resource using the resource's ARN and tag to remove.
Updates a budget that sets spending thresholds for rendering activity.
Updates a farm.
Updates a fleet.
Updates a job.
Updates the properties of the specified limit.
Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.
Updates a queue.
Updates the queue environment.
Updates a queue-fleet association.
Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.
Updates a session.
Updates a step.
Updates a storage profile.
Updates a task.
Updates a worker.
Updates the schedule for a worker.
Inherited functions
Assigns a farm membership level to a member.
Assigns a fleet membership level to a member.
Assigns a job membership level to a member
Assigns a queue membership level to a member
Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
Get credentials from the fleet role for a worker.
Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
Allows a user to assume a role for a queue.
Allows a worker to assume a queue role.
Get batched job details for a worker.
Copies a job template to an Amazon S3 bucket.
Creates a budget to set spending thresholds for your rendering activity.
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.
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.
Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
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.
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.
Creates an environment for a queue that defines how jobs in the queue run.
Creates an association between a queue and a fleet.
Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
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.
Deletes a budget.
Deletes a farm.
Deletes a fleet.
Deletes a license endpoint.
Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.
Deletes a metered product.
Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
Deletes a queue.
Deletes a queue environment.
Deletes a queue-fleet association.
Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.
Deletes a storage profile.
Deletes a worker.
Disassociates a member from a farm.
Disassociates a member from a fleet.
Disassociates a member from a job.
Disassociates a member from a queue.
Get a budget.
Get a farm.
Get a fleet.
Gets a Deadline Cloud job.
Gets a licence endpoint.
Gets information about a specific limit.
Gets information about the specified monitor.
Gets a queue.
Gets a queue environment.
Gets a queue-fleet association.
Gets information about a specific association between a queue and a limit.
Gets a session.
Gets a session action for the job.
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.
Paginate over GetSessionsStatisticsAggregationResponse results.
Gets a step.
Gets a storage profile.
Gets a storage profile for a queue.
Gets a task.
Gets a worker.
A list of the available metered products.
Paginate over ListAvailableMeteredProductsResponse results.
A list of budgets in a farm.
Paginate over ListBudgetsResponse results.
Lists the members of a farm.
Paginate over ListFarmMembersResponse results.
Lists farms.
Paginate over ListFarmsResponse results.
Lists fleet members.
Paginate over ListFleetMembersResponse results.
Lists fleets.
Paginate over ListFleetsResponse results.
Lists members on a job.
Paginate over ListJobMembersResponse results.
Lists parameter definitions of a job.
Paginate over ListJobParameterDefinitionsResponse results.
Lists jobs.
Paginate over ListJobsResponse results.
Lists license endpoints.
Paginate over ListLicenseEndpointsResponse results.
Gets a list of limits defined in the specified farm.
Paginate over ListLimitsResponse results.
Lists metered products.
Paginate over ListMeteredProductsResponse results.
Gets a list of your monitors in Deadline Cloud.
Paginate over ListMonitorsResponse results.
Lists queue environments.
Paginate over ListQueueEnvironmentsResponse results.
Lists queue-fleet associations.
Paginate over ListQueueFleetAssociationsResponse results.
Gets a list of the associations between queues and limits defined in a farm.
Paginate over ListQueueLimitAssociationsResponse results.
Lists the members in a queue.
Paginate over ListQueueMembersResponse results.
Lists queues.
Paginate over ListQueuesResponse results.
Lists session actions.
Paginate over ListSessionActionsResponse results.
Lists sessions.
Lists sessions for a worker.
Paginate over ListSessionsForWorkerResponse results.
Paginate over ListSessionsResponse results.
Lists step consumers.
Paginate over ListStepConsumersResponse results.
Lists the dependencies for a step.
Paginate over ListStepDependenciesResponse results.
Lists steps for a job.
Paginate over ListStepsResponse results.
Lists storage profiles.
Lists storage profiles for a queue.
Paginate over ListStorageProfilesForQueueResponse results.
Paginate over ListStorageProfilesResponse results.
Lists tags for a resource.
Lists tasks for a job.
Paginate over ListTasksResponse results.
Lists workers.
Paginate over ListWorkersResponse results.
Adds a metered product.
Searches for jobs.
Searches for steps.
Searches for tasks.
Searches for workers.
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.
Tags a resource using the resource's ARN and desired tags.
Removes a tag from a resource using the resource's ARN and tag to remove.
Updates a budget that sets spending thresholds for rendering activity.
Updates a farm.
Updates a fleet.
Updates a job.
Updates the properties of the specified limit.
Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.
Updates a queue.
Updates the queue environment.
Updates a queue-fleet association.
Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.
Updates a session.
Updates a step.
Updates a storage profile.
Updates a task.
Updates a worker.
Updates the schedule for a worker.
Wait until a Fleet is activated. Use this after invoking CreateFleet or UpdateFleet.
Wait until a Job is created. Use this after invoking CreateJob.
Wait until a LicenseEndpoint is Deleted. Use this after invoking DeleteLicenseEndpoint.
Wait until a LicenseEndpoint is Ready. Use this after invoking CreateLicenseEndpoint.
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
Wait until a QueueLimitAssociation is stopped. Use this after setting the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS to wait for a QueueLimitAssociation to reach STOPPED
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.