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_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.
1262 1263 1264 1265 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1262 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.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1368 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.
1420 1421 1422 1423 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1420 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.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1483 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.
1583 1584 1585 1586 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1583 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.
1638 1639 1640 1641 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1638 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.
1668 1669 1670 1671 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1668 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.
1727 1728 1729 1730 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1727 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.
1781 1782 1783 1784 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1781 def create_worker(params = {}, = {}) req = build_request(:create_worker, params) req.send_request() end |
#delete_budget(params = {}) ⇒ Struct
Deletes a budget.
1807 1808 1809 1810 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1807 def delete_budget(params = {}, = {}) req = build_request(:delete_budget, params) req.send_request() end |
#delete_farm(params = {}) ⇒ Struct
Deletes a farm.
1829 1830 1831 1832 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1829 def delete_farm(params = {}, = {}) req = build_request(:delete_farm, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes a fleet.
1863 1864 1865 1866 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1863 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#delete_license_endpoint(params = {}) ⇒ Struct
Deletes a license endpoint.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1885 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.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1912 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.
1937 1938 1939 1940 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1937 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.
1966 1967 1968 1969 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1966 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#delete_queue_environment(params = {}) ⇒ Struct
Deletes a queue environment.
1996 1997 1998 1999 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1996 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.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2026 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.
2052 2053 2054 2055 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2052 def delete_storage_profile(params = {}, = {}) req = build_request(:delete_storage_profile, params) req.send_request() end |
#delete_worker(params = {}) ⇒ Struct
Deletes a worker.
2082 2083 2084 2085 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2082 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2108 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2138 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.
2173 2174 2175 2176 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2173 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.
2204 2205 2206 2207 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2204 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.
2266 2267 2268 2269 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2266 def get_budget(params = {}, = {}) req = build_request(:get_budget, params) req.send_request() end |
#get_farm(params = {}) ⇒ Types::GetFarmResponse
Get a farm.
2308 2309 2310 2311 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2308 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
2427 2428 2429 2430 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2427 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
2519 2520 2521 2522 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2519 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
2567 2568 2569 2570 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2567 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.
2616 2617 2618 2619 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2616 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
2691 2692 2693 2694 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2691 def get_queue(params = {}, = {}) req = build_request(:get_queue, params) req.send_request() end |
#get_queue_environment(params = {}) ⇒ Types::GetQueueEnvironmentResponse
Gets a queue environment.
2743 2744 2745 2746 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2743 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
2796 2797 2798 2799 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2796 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.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2874 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.
2941 2942 2943 2944 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2941 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.
3017 3018 3019 3020 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3017 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.
3106 3107 3108 3109 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3106 def get_step(params = {}, = {}) req = build_request(:get_step, params) req.send_request() end |
#get_storage_profile(params = {}) ⇒ Types::GetStorageProfileResponse
Gets a storage profile.
3155 3156 3157 3158 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3155 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.
3200 3201 3202 3203 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3200 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.
3270 3271 3272 3273 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3270 def get_task(params = {}, = {}) req = build_request(:get_task, params) req.send_request() end |
#get_worker(params = {}) ⇒ Types::GetWorkerResponse
Gets a worker.
3335 3336 3337 3338 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3335 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.
3377 3378 3379 3380 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3377 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.
3434 3435 3436 3437 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3434 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.
3481 3482 3483 3484 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3481 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.
3530 3531 3532 3533 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3530 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.
3582 3583 3584 3585 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3582 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.
3697 3698 3699 3700 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3697 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.
3754 3755 3756 3757 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3754 def list_job_members(params = {}, = {}) req = build_request(:list_job_members, 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.
3821 3822 3823 3824 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3821 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.
3863 3864 3865 3866 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3863 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.
3909 3910 3911 3912 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3909 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.
3958 3959 3960 3961 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3958 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.
4007 4008 4009 4010 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4007 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.
4064 4065 4066 4067 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4064 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.
4116 4117 4118 4119 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4116 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.
4183 4184 4185 4186 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4183 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.
4252 4253 4254 4255 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4252 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.
4311 4312 4313 4314 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4311 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.
4368 4369 4370 4371 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4368 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.
4424 4425 4426 4427 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4424 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.
4480 4481 4482 4483 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4480 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.
4548 4549 4550 4551 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4548 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.
4593 4594 4595 4596 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4593 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.
4642 4643 4644 4645 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4642 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.
4671 4672 4673 4674 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4671 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.
4741 4742 4743 4744 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4741 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.
4808 4809 4810 4811 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4808 def list_workers(params = {}, = {}) req = build_request(:list_workers, params) req.send_request() end |
#put_metered_product(params = {}) ⇒ Struct
Adds a metered product.
4834 4835 4836 4837 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4834 def put_metered_product(params = {}, = {}) req = build_request(:put_metered_product, params) req.send_request() end |
#search_jobs(params = {}) ⇒ Types::SearchJobsResponse
Searches for jobs.
4951 4952 4953 4954 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4951 def search_jobs(params = {}, = {}) req = build_request(:search_jobs, params) req.send_request() end |
#search_steps(params = {}) ⇒ Types::SearchStepsResponse
Searches for steps.
5068 5069 5070 5071 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5068 def search_steps(params = {}, = {}) req = build_request(:search_steps, params) req.send_request() end |
#search_tasks(params = {}) ⇒ Types::SearchTasksResponse
Searches for tasks.
5182 5183 5184 5185 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5182 def search_tasks(params = {}, = {}) req = build_request(:search_tasks, params) req.send_request() end |
#search_workers(params = {}) ⇒ Types::SearchWorkersResponse
Searches for workers.
5292 5293 5294 5295 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5292 def search_workers(params = {}, = {}) req = build_request(:search_workers, params) req.send_request() end |
#start_sessions_statistics_aggregation(params = {}) ⇒ Types::StartSessionsStatisticsAggregationResponse
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.
5360 5361 5362 5363 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5360 def start_sessions_statistics_aggregation(params = {}, = {}) req = build_request(:start_sessions_statistics_aggregation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a resource using the resource's ARN and desired tags.
5389 5390 5391 5392 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5389 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource using the resource's ARN and tag to remove.
5416 5417 5418 5419 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5416 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_budget(params = {}) ⇒ Struct
Updates a budget that sets spending thresholds for rendering activity.
5508 5509 5510 5511 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5508 def update_budget(params = {}, = {}) req = build_request(:update_budget, params) req.send_request() end |
#update_farm(params = {}) ⇒ Struct
Updates a farm.
5546 5547 5548 5549 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5546 def update_farm(params = {}, = {}) req = build_request(:update_farm, params) req.send_request() end |
#update_fleet(params = {}) ⇒ Struct
Updates a fleet.
5688 5689 5690 5691 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5688 def update_fleet(params = {}, = {}) req = build_request(:update_fleet, params) req.send_request() end |
#update_job(params = {}) ⇒ Struct
Updates a job.
When you change the status of the job to ARCHIVED
, the job can't be
scheduled or archived.
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.
5757 5758 5759 5760 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5757 def update_job(params = {}, = {}) req = build_request(:update_job, params) req.send_request() end |
#update_monitor(params = {}) ⇒ Struct
Modifies the settings for a Deadline Cloud monitor. You can modify one
or all of the settings when you call UpdateMonitor
.
5797 5798 5799 5800 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5797 def update_monitor(params = {}, = {}) req = build_request(:update_monitor, params) req.send_request() end |
#update_queue(params = {}) ⇒ Struct
Updates a queue.
5892 5893 5894 5895 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5892 def update_queue(params = {}, = {}) req = build_request(:update_queue, params) req.send_request() end |
#update_queue_environment(params = {}) ⇒ Struct
Updates the queue environment.
5942 5943 5944 5945 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5942 def update_queue_environment(params = {}, = {}) req = build_request(:update_queue_environment, params) req.send_request() end |
#update_queue_fleet_association(params = {}) ⇒ Struct
Updates a queue-fleet association.
5976 5977 5978 5979 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5976 def update_queue_fleet_association(params = {}, = {}) req = build_request(:update_queue_fleet_association, params) req.send_request() end |
#update_session(params = {}) ⇒ Struct
Updates a session.
6022 6023 6024 6025 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6022 def update_session(params = {}, = {}) req = build_request(:update_session, params) req.send_request() end |
#update_step(params = {}) ⇒ Struct
Updates a step.
6068 6069 6070 6071 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6068 def update_step(params = {}, = {}) req = build_request(:update_step, params) req.send_request() end |
#update_storage_profile(params = {}) ⇒ Struct
Updates a storage profile.
6134 6135 6136 6137 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6134 def update_storage_profile(params = {}, = {}) req = build_request(:update_storage_profile, params) req.send_request() end |
#update_task(params = {}) ⇒ Struct
Updates a task.
6184 6185 6186 6187 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6184 def update_task(params = {}, = {}) req = build_request(:update_task, params) req.send_request() end |
#update_worker(params = {}) ⇒ Types::UpdateWorkerResponse
Updates a worker.
6256 6257 6258 6259 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6256 def update_worker(params = {}, = {}) req = build_request(:update_worker, params) req.send_request() end |
#update_worker_schedule(params = {}) ⇒ Types::UpdateWorkerScheduleResponse
Updates the schedule for a worker.
6334 6335 6336 6337 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6334 def update_worker_schedule(params = {}, = {}) req = build_request(:update_worker_schedule, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
fleet_active | #get_fleet | 5 | 180 |
job_create_complete | #get_job | 1 | 120 |
license_endpoint_deleted | #get_license_endpoint | 10 | 234 |
license_endpoint_valid | #get_license_endpoint | 10 | 114 |
queue_fleet_association_stopped | #get_queue_fleet_association | 10 | 60 |
queue_scheduling | #get_queue | 10 | 70 |
queue_scheduling_blocked | #get_queue | 10 | 30 |
6455 6456 6457 6458 6459 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6455 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |