Class: Aws::Deadline::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Deadline::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb
Overview
An API client for Deadline. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Deadline::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_member_to_farm(params = {}) ⇒ Struct
Assigns a farm membership level to a member.
-
#associate_member_to_fleet(params = {}) ⇒ Struct
Assigns a fleet membership level to a member.
-
#associate_member_to_job(params = {}) ⇒ Struct
Assigns a job membership level to a member.
-
#associate_member_to_queue(params = {}) ⇒ Struct
Assigns a queue membership level to a member.
-
#assume_fleet_role_for_read(params = {}) ⇒ Types::AssumeFleetRoleForReadResponse
Get Amazon Web Services credentials from the fleet role.
-
#assume_fleet_role_for_worker(params = {}) ⇒ Types::AssumeFleetRoleForWorkerResponse
Get credentials from the fleet role for a worker.
-
#assume_queue_role_for_read(params = {}) ⇒ Types::AssumeQueueRoleForReadResponse
Gets Amazon Web Services credentials from the queue role.
-
#assume_queue_role_for_user(params = {}) ⇒ Types::AssumeQueueRoleForUserResponse
Allows a user to assume a role for a queue.
-
#assume_queue_role_for_worker(params = {}) ⇒ Types::AssumeQueueRoleForWorkerResponse
Allows a worker to assume a queue role.
-
#batch_get_job_entity(params = {}) ⇒ Types::BatchGetJobEntityResponse
Get batched job details for a worker.
-
#copy_job_template(params = {}) ⇒ Types::CopyJobTemplateResponse
Copies a job template to an Amazon S3 bucket.
-
#create_budget(params = {}) ⇒ Types::CreateBudgetResponse
Creates a budget to set spending thresholds for your rendering activity.
-
#create_farm(params = {}) ⇒ Types::CreateFarmResponse
Creates a farm to allow space for queues and fleets.
-
#create_fleet(params = {}) ⇒ Types::CreateFleetResponse
Creates a fleet.
-
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a job.
-
#create_license_endpoint(params = {}) ⇒ Types::CreateLicenseEndpointResponse
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
-
#create_monitor(params = {}) ⇒ Types::CreateMonitorResponse
Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets.
-
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
Creates a queue to coordinate the order in which jobs run on a farm.
-
#create_queue_environment(params = {}) ⇒ Types::CreateQueueEnvironmentResponse
Creates an environment for a queue that defines how jobs in the queue run.
-
#create_queue_fleet_association(params = {}) ⇒ Struct
Creates an association between a queue and a fleet.
-
#create_storage_profile(params = {}) ⇒ Types::CreateStorageProfileResponse
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
-
#create_worker(params = {}) ⇒ Types::CreateWorkerResponse
Creates a worker.
-
#delete_budget(params = {}) ⇒ Struct
Deletes a budget.
-
#delete_farm(params = {}) ⇒ Struct
Deletes a farm.
-
#delete_fleet(params = {}) ⇒ Struct
Deletes a fleet.
-
#delete_license_endpoint(params = {}) ⇒ Struct
Deletes a license endpoint.
-
#delete_metered_product(params = {}) ⇒ Struct
Deletes a metered product.
-
#delete_monitor(params = {}) ⇒ Struct
Removes a Deadline Cloud monitor.
-
#delete_queue(params = {}) ⇒ Struct
Deletes a queue.
-
#delete_queue_environment(params = {}) ⇒ Struct
Deletes a queue environment.
-
#delete_queue_fleet_association(params = {}) ⇒ Struct
Deletes a queue-fleet association.
-
#delete_storage_profile(params = {}) ⇒ Struct
Deletes a storage profile.
-
#delete_worker(params = {}) ⇒ Struct
Deletes a worker.
-
#disassociate_member_from_farm(params = {}) ⇒ Struct
Disassociates a member from a farm.
-
#disassociate_member_from_fleet(params = {}) ⇒ Struct
Disassociates a member from a fleet.
-
#disassociate_member_from_job(params = {}) ⇒ Struct
Disassociates a member from a job.
-
#disassociate_member_from_queue(params = {}) ⇒ Struct
Disassociates a member from a queue.
-
#get_budget(params = {}) ⇒ Types::GetBudgetResponse
Get a budget.
-
#get_farm(params = {}) ⇒ Types::GetFarmResponse
Get a farm.
-
#get_fleet(params = {}) ⇒ Types::GetFleetResponse
Get a fleet.
-
#get_job(params = {}) ⇒ Types::GetJobResponse
Gets a Deadline Cloud job.
-
#get_license_endpoint(params = {}) ⇒ Types::GetLicenseEndpointResponse
Gets a licence endpoint.
-
#get_monitor(params = {}) ⇒ Types::GetMonitorResponse
Gets information about the specified monitor.
-
#get_queue(params = {}) ⇒ Types::GetQueueResponse
Gets a queue.
-
#get_queue_environment(params = {}) ⇒ Types::GetQueueEnvironmentResponse
Gets a queue environment.
-
#get_queue_fleet_association(params = {}) ⇒ Types::GetQueueFleetAssociationResponse
Gets a queue-fleet association.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Gets a session.
-
#get_session_action(params = {}) ⇒ Types::GetSessionActionResponse
Gets a session action for the job.
-
#get_sessions_statistics_aggregation(params = {}) ⇒ Types::GetSessionsStatisticsAggregationResponse
Gets a set of statistics for queues or farms.
-
#get_step(params = {}) ⇒ Types::GetStepResponse
Gets a step.
-
#get_storage_profile(params = {}) ⇒ Types::GetStorageProfileResponse
Gets a storage profile.
-
#get_storage_profile_for_queue(params = {}) ⇒ Types::GetStorageProfileForQueueResponse
Gets a storage profile for a queue.
-
#get_task(params = {}) ⇒ Types::GetTaskResponse
Gets a task.
-
#get_worker(params = {}) ⇒ Types::GetWorkerResponse
Gets a worker.
-
#list_available_metered_products(params = {}) ⇒ Types::ListAvailableMeteredProductsResponse
A list of the available metered products.
-
#list_budgets(params = {}) ⇒ Types::ListBudgetsResponse
A list of budgets in a farm.
-
#list_farm_members(params = {}) ⇒ Types::ListFarmMembersResponse
Lists the members of a farm.
-
#list_farms(params = {}) ⇒ Types::ListFarmsResponse
Lists farms.
-
#list_fleet_members(params = {}) ⇒ Types::ListFleetMembersResponse
Lists fleet members.
-
#list_fleets(params = {}) ⇒ Types::ListFleetsResponse
Lists fleets.
-
#list_job_members(params = {}) ⇒ Types::ListJobMembersResponse
Lists members on a job.
-
#list_job_parameter_definitions(params = {}) ⇒ Types::ListJobParameterDefinitionsResponse
Lists parameter definitions of a job.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists jobs.
-
#list_license_endpoints(params = {}) ⇒ Types::ListLicenseEndpointsResponse
Lists license endpoints.
-
#list_metered_products(params = {}) ⇒ Types::ListMeteredProductsResponse
Lists metered products.
-
#list_monitors(params = {}) ⇒ Types::ListMonitorsResponse
Gets a list of your monitors in Deadline Cloud.
-
#list_queue_environments(params = {}) ⇒ Types::ListQueueEnvironmentsResponse
Lists queue environments.
-
#list_queue_fleet_associations(params = {}) ⇒ Types::ListQueueFleetAssociationsResponse
Lists queue-fleet associations.
-
#list_queue_members(params = {}) ⇒ Types::ListQueueMembersResponse
Lists the members in a queue.
-
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
Lists queues.
-
#list_session_actions(params = {}) ⇒ Types::ListSessionActionsResponse
Lists session actions.
-
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Lists sessions.
-
#list_sessions_for_worker(params = {}) ⇒ Types::ListSessionsForWorkerResponse
Lists sessions for a worker.
-
#list_step_consumers(params = {}) ⇒ Types::ListStepConsumersResponse
Lists step consumers.
-
#list_step_dependencies(params = {}) ⇒ Types::ListStepDependenciesResponse
Lists the dependencies for a step.
-
#list_steps(params = {}) ⇒ Types::ListStepsResponse
Lists steps for a job.
-
#list_storage_profiles(params = {}) ⇒ Types::ListStorageProfilesResponse
Lists storage profiles.
-
#list_storage_profiles_for_queue(params = {}) ⇒ Types::ListStorageProfilesForQueueResponse
Lists storage profiles for a queue.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource.
-
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Lists tasks for a job.
-
#list_workers(params = {}) ⇒ Types::ListWorkersResponse
Lists workers.
-
#put_metered_product(params = {}) ⇒ Struct
Adds a metered product.
-
#search_jobs(params = {}) ⇒ Types::SearchJobsResponse
Searches for jobs.
-
#search_steps(params = {}) ⇒ Types::SearchStepsResponse
Searches for steps.
-
#search_tasks(params = {}) ⇒ Types::SearchTasksResponse
Searches for tasks.
-
#search_workers(params = {}) ⇒ Types::SearchWorkersResponse
Searches for workers.
-
#start_sessions_statistics_aggregation(params = {}) ⇒ Types::StartSessionsStatisticsAggregationResponse
Starts an asynchronous request for getting aggregated statistics about queues and farms.
-
#tag_resource(params = {}) ⇒ Struct
Tags a resource using the resource's ARN and desired tags.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource using the resource's ARN and tag to remove.
-
#update_budget(params = {}) ⇒ Struct
Updates a budget that sets spending thresholds for rendering activity.
-
#update_farm(params = {}) ⇒ Struct
Updates a farm.
-
#update_fleet(params = {}) ⇒ Struct
Updates a fleet.
-
#update_job(params = {}) ⇒ Struct
Updates a job.
-
#update_monitor(params = {}) ⇒ Struct
Modifies the settings for a Deadline Cloud monitor.
-
#update_queue(params = {}) ⇒ Struct
Updates a queue.
-
#update_queue_environment(params = {}) ⇒ Struct
Updates the queue environment.
-
#update_queue_fleet_association(params = {}) ⇒ Struct
Updates a queue-fleet association.
-
#update_session(params = {}) ⇒ Struct
Updates a session.
-
#update_step(params = {}) ⇒ Struct
Updates a step.
-
#update_storage_profile(params = {}) ⇒ Struct
Updates a storage profile.
-
#update_task(params = {}) ⇒ Struct
Updates a task.
-
#update_worker(params = {}) ⇒ Types::UpdateWorkerResponse
Updates a worker.
-
#update_worker_schedule(params = {}) ⇒ Types::UpdateWorkerScheduleResponse
Updates the schedule for a worker.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#associate_member_to_farm(params = {}) ⇒ Struct
Assigns a farm membership level to a member.
483 484 485 486 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 483 def associate_member_to_farm(params = {}, = {}) req = build_request(:associate_member_to_farm, params) req.send_request() end |
#associate_member_to_fleet(params = {}) ⇒ Struct
Assigns a fleet membership level to a member.
525 526 527 528 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 525 def associate_member_to_fleet(params = {}, = {}) req = build_request(:associate_member_to_fleet, params) req.send_request() end |
#associate_member_to_job(params = {}) ⇒ Struct
Assigns a job membership level to a member
571 572 573 574 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 571 def associate_member_to_job(params = {}, = {}) req = build_request(:associate_member_to_job, params) req.send_request() end |
#associate_member_to_queue(params = {}) ⇒ Struct
Assigns a queue membership level to a member
613 614 615 616 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 613 def associate_member_to_queue(params = {}, = {}) req = build_request(:associate_member_to_queue, params) req.send_request() end |
#assume_fleet_role_for_read(params = {}) ⇒ Types::AssumeFleetRoleForReadResponse
Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
650 651 652 653 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 650 def assume_fleet_role_for_read(params = {}, = {}) req = build_request(:assume_fleet_role_for_read, params) req.send_request() end |
#assume_fleet_role_for_worker(params = {}) ⇒ Types::AssumeFleetRoleForWorkerResponse
Get credentials from the fleet role for a worker.
689 690 691 692 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 689 def assume_fleet_role_for_worker(params = {}, = {}) req = build_request(:assume_fleet_role_for_worker, params) req.send_request() end |
#assume_queue_role_for_read(params = {}) ⇒ Types::AssumeQueueRoleForReadResponse
Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
726 727 728 729 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 726 def assume_queue_role_for_read(params = {}, = {}) req = build_request(:assume_queue_role_for_read, params) req.send_request() end |
#assume_queue_role_for_user(params = {}) ⇒ Types::AssumeQueueRoleForUserResponse
Allows a user to assume a role for a queue.
761 762 763 764 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 761 def assume_queue_role_for_user(params = {}, = {}) req = build_request(:assume_queue_role_for_user, params) req.send_request() end |
#assume_queue_role_for_worker(params = {}) ⇒ Types::AssumeQueueRoleForWorkerResponse
Allows a worker to assume a queue role.
804 805 806 807 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 804 def assume_queue_role_for_worker(params = {}, = {}) req = build_request(:assume_queue_role_for_worker, params) req.send_request() end |
#batch_get_job_entity(params = {}) ⇒ Types::BatchGetJobEntityResponse
Get batched job details for a worker.
917 918 919 920 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 917 def batch_get_job_entity(params = {}, = {}) req = build_request(:batch_get_job_entity, params) req.send_request() end |
#copy_job_template(params = {}) ⇒ Types::CopyJobTemplateResponse
Copies a job template to an Amazon S3 bucket.
961 962 963 964 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 961 def copy_job_template(params = {}, = {}) req = build_request(:copy_job_template, params) req.send_request() end |
#create_budget(params = {}) ⇒ Types::CreateBudgetResponse
Creates a budget to set spending thresholds for your rendering activity.
1043 1044 1045 1046 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1043 def create_budget(params = {}, = {}) req = build_request(:create_budget, params) req.send_request() end |
#create_farm(params = {}) ⇒ Types::CreateFarmResponse
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.
1107 1108 1109 1110 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1107 def create_farm(params = {}, = {}) req = build_request(:create_farm, params) req.send_request() end |
#create_fleet(params = {}) ⇒ Types::CreateFleetResponse
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.
1274 1275 1276 1277 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1274 def create_fleet(params = {}, = {}) req = build_request(:create_fleet, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResponse
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.
1384 1385 1386 1387 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1384 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_license_endpoint(params = {}) ⇒ Types::CreateLicenseEndpointResponse
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1436 def create_license_endpoint(params = {}, = {}) req = build_request(:create_license_endpoint, params) req.send_request() end |
#create_monitor(params = {}) ⇒ Types::CreateMonitorResponse
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.
1499 1500 1501 1502 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1499 def create_monitor(params = {}, = {}) req = build_request(:create_monitor, params) req.send_request() end |
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
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.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1599 def create_queue(params = {}, = {}) req = build_request(:create_queue, params) req.send_request() end |
#create_queue_environment(params = {}) ⇒ Types::CreateQueueEnvironmentResponse
Creates an environment for a queue that defines how jobs in the queue run.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1654 def create_queue_environment(params = {}, = {}) req = build_request(:create_queue_environment, params) req.send_request() end |
#create_queue_fleet_association(params = {}) ⇒ Struct
Creates an association between a queue and a fleet.
1684 1685 1686 1687 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1684 def create_queue_fleet_association(params = {}, = {}) req = build_request(:create_queue_fleet_association, params) req.send_request() end |
#create_storage_profile(params = {}) ⇒ Types::CreateStorageProfileResponse
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
1743 1744 1745 1746 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1743 def create_storage_profile(params = {}, = {}) req = build_request(:create_storage_profile, params) req.send_request() end |
#create_worker(params = {}) ⇒ Types::CreateWorkerResponse
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.
1797 1798 1799 1800 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1797 def create_worker(params = {}, = {}) req = build_request(:create_worker, params) req.send_request() end |
#delete_budget(params = {}) ⇒ Struct
Deletes a budget.
1823 1824 1825 1826 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1823 def delete_budget(params = {}, = {}) req = build_request(:delete_budget, params) req.send_request() end |
#delete_farm(params = {}) ⇒ Struct
Deletes a farm.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1845 def delete_farm(params = {}, = {}) req = build_request(:delete_farm, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes a fleet.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1879 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#delete_license_endpoint(params = {}) ⇒ Struct
Deletes a license endpoint.
1901 1902 1903 1904 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1901 def delete_license_endpoint(params = {}, = {}) req = build_request(:delete_license_endpoint, params) req.send_request() end |
#delete_metered_product(params = {}) ⇒ Struct
Deletes a metered product.
1928 1929 1930 1931 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1928 def delete_metered_product(params = {}, = {}) req = build_request(:delete_metered_product, params) req.send_request() end |
#delete_monitor(params = {}) ⇒ Struct
Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
1953 1954 1955 1956 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1953 def delete_monitor(params = {}, = {}) req = build_request(:delete_monitor, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
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.
1982 1983 1984 1985 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1982 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#delete_queue_environment(params = {}) ⇒ Struct
Deletes a queue environment.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2012 def delete_queue_environment(params = {}, = {}) req = build_request(:delete_queue_environment, params) req.send_request() end |
#delete_queue_fleet_association(params = {}) ⇒ Struct
Deletes a queue-fleet association.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2042 def delete_queue_fleet_association(params = {}, = {}) req = build_request(:delete_queue_fleet_association, params) req.send_request() end |
#delete_storage_profile(params = {}) ⇒ Struct
Deletes a storage profile.
2068 2069 2070 2071 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2068 def delete_storage_profile(params = {}, = {}) req = build_request(:delete_storage_profile, params) req.send_request() end |
#delete_worker(params = {}) ⇒ Struct
Deletes a worker.
2098 2099 2100 2101 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2098 def delete_worker(params = {}, = {}) req = build_request(:delete_worker, params) req.send_request() end |
#disassociate_member_from_farm(params = {}) ⇒ Struct
Disassociates a member from a farm.
2124 2125 2126 2127 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2124 def disassociate_member_from_farm(params = {}, = {}) req = build_request(:disassociate_member_from_farm, params) req.send_request() end |
#disassociate_member_from_fleet(params = {}) ⇒ Struct
Disassociates a member from a fleet.
2154 2155 2156 2157 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2154 def disassociate_member_from_fleet(params = {}, = {}) req = build_request(:disassociate_member_from_fleet, params) req.send_request() end |
#disassociate_member_from_job(params = {}) ⇒ Struct
Disassociates a member from a job.
2189 2190 2191 2192 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2189 def disassociate_member_from_job(params = {}, = {}) req = build_request(:disassociate_member_from_job, params) req.send_request() end |
#disassociate_member_from_queue(params = {}) ⇒ Struct
Disassociates a member from a queue.
2220 2221 2222 2223 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2220 def disassociate_member_from_queue(params = {}, = {}) req = build_request(:disassociate_member_from_queue, params) req.send_request() end |
#get_budget(params = {}) ⇒ Types::GetBudgetResponse
Get a budget.
2282 2283 2284 2285 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2282 def get_budget(params = {}, = {}) req = build_request(:get_budget, params) req.send_request() end |
#get_farm(params = {}) ⇒ Types::GetFarmResponse
Get a farm.
2324 2325 2326 2327 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2324 def get_farm(params = {}, = {}) req = build_request(:get_farm, params) req.send_request() end |
#get_fleet(params = {}) ⇒ Types::GetFleetResponse
Get a fleet.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- fleet_active
2448 2449 2450 2451 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2448 def get_fleet(params = {}, = {}) req = build_request(:get_fleet, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResponse
Gets a Deadline Cloud job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- job_create_complete
2542 2543 2544 2545 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2542 def get_job(params = {}, = {}) req = build_request(:get_job, params) req.send_request() end |
#get_license_endpoint(params = {}) ⇒ Types::GetLicenseEndpointResponse
Gets a licence endpoint.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- license_endpoint_deleted
- license_endpoint_valid
2590 2591 2592 2593 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2590 def get_license_endpoint(params = {}, = {}) req = build_request(:get_license_endpoint, params) req.send_request() end |
#get_monitor(params = {}) ⇒ Types::GetMonitorResponse
Gets information about the specified monitor.
2639 2640 2641 2642 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2639 def get_monitor(params = {}, = {}) req = build_request(:get_monitor, params) req.send_request() end |
#get_queue(params = {}) ⇒ Types::GetQueueResponse
Gets a queue.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- queue_scheduling
- queue_scheduling_blocked
2714 2715 2716 2717 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2714 def get_queue(params = {}, = {}) req = build_request(:get_queue, params) req.send_request() end |
#get_queue_environment(params = {}) ⇒ Types::GetQueueEnvironmentResponse
Gets a queue environment.
2766 2767 2768 2769 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2766 def get_queue_environment(params = {}, = {}) req = build_request(:get_queue_environment, params) req.send_request() end |
#get_queue_fleet_association(params = {}) ⇒ Types::GetQueueFleetAssociationResponse
Gets a queue-fleet association.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- queue_fleet_association_stopped
2819 2820 2821 2822 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2819 def get_queue_fleet_association(params = {}, = {}) req = build_request(:get_queue_fleet_association, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Gets a session.
2897 2898 2899 2900 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2897 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_session_action(params = {}) ⇒ Types::GetSessionActionResponse
Gets a session action for the job.
2964 2965 2966 2967 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2964 def get_session_action(params = {}, = {}) req = build_request(:get_session_action, params) req.send_request() end |
#get_sessions_statistics_aggregation(params = {}) ⇒ Types::GetSessionsStatisticsAggregationResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3040 3041 3042 3043 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3040 def get_sessions_statistics_aggregation(params = {}, = {}) req = build_request(:get_sessions_statistics_aggregation, params) req.send_request() end |
#get_step(params = {}) ⇒ Types::GetStepResponse
Gets a step.
3129 3130 3131 3132 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3129 def get_step(params = {}, = {}) req = build_request(:get_step, params) req.send_request() end |
#get_storage_profile(params = {}) ⇒ Types::GetStorageProfileResponse
Gets a storage profile.
3178 3179 3180 3181 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3178 def get_storage_profile(params = {}, = {}) req = build_request(:get_storage_profile, params) req.send_request() end |
#get_storage_profile_for_queue(params = {}) ⇒ Types::GetStorageProfileForQueueResponse
Gets a storage profile for a queue.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3223 def get_storage_profile_for_queue(params = {}, = {}) req = build_request(:get_storage_profile_for_queue, params) req.send_request() end |
#get_task(params = {}) ⇒ Types::GetTaskResponse
Gets a task.
3293 3294 3295 3296 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3293 def get_task(params = {}, = {}) req = build_request(:get_task, params) req.send_request() end |
#get_worker(params = {}) ⇒ Types::GetWorkerResponse
Gets a worker.
3358 3359 3360 3361 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3358 def get_worker(params = {}, = {}) req = build_request(:get_worker, params) req.send_request() end |
#list_available_metered_products(params = {}) ⇒ Types::ListAvailableMeteredProductsResponse
A list of the available metered products.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3400 3401 3402 3403 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3400 def list_available_metered_products(params = {}, = {}) req = build_request(:list_available_metered_products, params) req.send_request() end |
#list_budgets(params = {}) ⇒ Types::ListBudgetsResponse
A list of budgets in a farm.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3457 3458 3459 3460 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3457 def list_budgets(params = {}, = {}) req = build_request(:list_budgets, params) req.send_request() end |
#list_farm_members(params = {}) ⇒ Types::ListFarmMembersResponse
Lists the members of a farm.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3504 3505 3506 3507 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3504 def list_farm_members(params = {}, = {}) req = build_request(:list_farm_members, params) req.send_request() end |
#list_farms(params = {}) ⇒ Types::ListFarmsResponse
Lists farms.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3553 3554 3555 3556 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3553 def list_farms(params = {}, = {}) req = build_request(:list_farms, params) req.send_request() end |
#list_fleet_members(params = {}) ⇒ Types::ListFleetMembersResponse
Lists fleet members.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3605 3606 3607 3608 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3605 def list_fleet_members(params = {}, = {}) req = build_request(:list_fleet_members, params) req.send_request() end |
#list_fleets(params = {}) ⇒ Types::ListFleetsResponse
Lists fleets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3725 3726 3727 3728 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3725 def list_fleets(params = {}, = {}) req = build_request(:list_fleets, params) req.send_request() end |
#list_job_members(params = {}) ⇒ Types::ListJobMembersResponse
Lists members on a job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3782 3783 3784 3785 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3782 def list_job_members(params = {}, = {}) req = build_request(:list_job_members, params) req.send_request() end |
#list_job_parameter_definitions(params = {}) ⇒ Types::ListJobParameterDefinitionsResponse
Lists parameter definitions of a job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3832 3833 3834 3835 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3832 def list_job_parameter_definitions(params = {}, = {}) req = build_request(:list_job_parameter_definitions, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3900 3901 3902 3903 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3900 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_license_endpoints(params = {}) ⇒ Types::ListLicenseEndpointsResponse
Lists license endpoints.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3942 3943 3944 3945 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3942 def list_license_endpoints(params = {}, = {}) req = build_request(:list_license_endpoints, params) req.send_request() end |
#list_metered_products(params = {}) ⇒ Types::ListMeteredProductsResponse
Lists metered products.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3988 3989 3990 3991 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3988 def list_metered_products(params = {}, = {}) req = build_request(:list_metered_products, params) req.send_request() end |
#list_monitors(params = {}) ⇒ Types::ListMonitorsResponse
Gets a list of your monitors in Deadline Cloud.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4037 4038 4039 4040 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4037 def list_monitors(params = {}, = {}) req = build_request(:list_monitors, params) req.send_request() end |
#list_queue_environments(params = {}) ⇒ Types::ListQueueEnvironmentsResponse
Lists queue environments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4086 4087 4088 4089 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4086 def list_queue_environments(params = {}, = {}) req = build_request(:list_queue_environments, params) req.send_request() end |
#list_queue_fleet_associations(params = {}) ⇒ Types::ListQueueFleetAssociationsResponse
Lists queue-fleet associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4143 4144 4145 4146 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4143 def list_queue_fleet_associations(params = {}, = {}) req = build_request(:list_queue_fleet_associations, params) req.send_request() end |
#list_queue_members(params = {}) ⇒ Types::ListQueueMembersResponse
Lists the members in a queue.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4195 4196 4197 4198 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4195 def list_queue_members(params = {}, = {}) req = build_request(:list_queue_members, params) req.send_request() end |
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
Lists queues.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4262 4263 4264 4265 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4262 def list_queues(params = {}, = {}) req = build_request(:list_queues, params) req.send_request() end |
#list_session_actions(params = {}) ⇒ Types::ListSessionActionsResponse
Lists session actions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4331 4332 4333 4334 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4331 def list_session_actions(params = {}, = {}) req = build_request(:list_session_actions, params) req.send_request() end |
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Lists sessions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4390 4391 4392 4393 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4390 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_sessions_for_worker(params = {}) ⇒ Types::ListSessionsForWorkerResponse
Lists sessions for a worker.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4447 4448 4449 4450 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4447 def list_sessions_for_worker(params = {}, = {}) req = build_request(:list_sessions_for_worker, params) req.send_request() end |
#list_step_consumers(params = {}) ⇒ Types::ListStepConsumersResponse
Lists step consumers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4503 4504 4505 4506 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4503 def list_step_consumers(params = {}, = {}) req = build_request(:list_step_consumers, params) req.send_request() end |
#list_step_dependencies(params = {}) ⇒ Types::ListStepDependenciesResponse
Lists the dependencies for a step.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4559 4560 4561 4562 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4559 def list_step_dependencies(params = {}, = {}) req = build_request(:list_step_dependencies, params) req.send_request() end |
#list_steps(params = {}) ⇒ Types::ListStepsResponse
Lists steps for a job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4627 4628 4629 4630 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4627 def list_steps(params = {}, = {}) req = build_request(:list_steps, params) req.send_request() end |
#list_storage_profiles(params = {}) ⇒ Types::ListStorageProfilesResponse
Lists storage profiles.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4672 4673 4674 4675 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4672 def list_storage_profiles(params = {}, = {}) req = build_request(:list_storage_profiles, params) req.send_request() end |
#list_storage_profiles_for_queue(params = {}) ⇒ Types::ListStorageProfilesForQueueResponse
Lists storage profiles for a queue.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4721 4722 4723 4724 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4721 def list_storage_profiles_for_queue(params = {}, = {}) req = build_request(:list_storage_profiles_for_queue, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource.
4750 4751 4752 4753 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4750 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Lists tasks for a job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4820 4821 4822 4823 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4820 def list_tasks(params = {}, = {}) req = build_request(:list_tasks, params) req.send_request() end |
#list_workers(params = {}) ⇒ Types::ListWorkersResponse
Lists workers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4887 4888 4889 4890 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4887 def list_workers(params = {}, = {}) req = build_request(:list_workers, params) req.send_request() end |
#put_metered_product(params = {}) ⇒ Struct
Adds a metered product.
4913 4914 4915 4916 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4913 def put_metered_product(params = {}, = {}) req = build_request(:put_metered_product, params) req.send_request() end |
#search_jobs(params = {}) ⇒ Types::SearchJobsResponse
Searches for jobs.
5031 5032 5033 5034 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5031 def search_jobs(params = {}, = {}) req = build_request(:search_jobs, params) req.send_request() end |
#search_steps(params = {}) ⇒ Types::SearchStepsResponse
Searches for steps.
5148 5149 5150 5151 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5148 def search_steps(params = {}, = {}) req = build_request(:search_steps, params) req.send_request() end |
#search_tasks(params = {}) ⇒ Types::SearchTasksResponse
Searches for tasks.