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.
410 411 412 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#associate_member_to_farm(params = {}) ⇒ Struct
Assigns a farm membership level to a member.
449 450 451 452 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 449 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.
491 492 493 494 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 491 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
537 538 539 540 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 537 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
579 580 581 582 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 579 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.
616 617 618 619 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 616 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.
655 656 657 658 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 655 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.
692 693 694 695 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 692 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.
727 728 729 730 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 727 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.
770 771 772 773 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 770 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.
883 884 885 886 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 883 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.
927 928 929 930 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 927 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.
1001 1002 1003 1004 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1001 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.
1057 1058 1059 1060 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1057 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.
1204 1205 1206 1207 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1204 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 render submission submitted by a user. It contains specific job properties outlined as steps and tasks.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1305 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.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1357 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.
1416 1417 1418 1419 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1416 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.
1508 1509 1510 1511 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1508 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.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1563 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.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1593 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.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1648 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.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1702 def create_worker(params = {}, = {}) req = build_request(:create_worker, params) req.send_request() end |
#delete_budget(params = {}) ⇒ Struct
Deletes a budget.
1728 1729 1730 1731 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1728 def delete_budget(params = {}, = {}) req = build_request(:delete_budget, params) req.send_request() end |
#delete_farm(params = {}) ⇒ Struct
Deletes a farm.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1750 def delete_farm(params = {}, = {}) req = build_request(:delete_farm, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes a fleet.
1784 1785 1786 1787 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1784 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#delete_license_endpoint(params = {}) ⇒ Struct
Deletes a license endpoint.
1806 1807 1808 1809 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1806 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.
1833 1834 1835 1836 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1833 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.
1858 1859 1860 1861 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1858 def delete_monitor(params = {}, = {}) req = build_request(:delete_monitor, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
Deletes a queue.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1884 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#delete_queue_environment(params = {}) ⇒ Struct
Deletes a queue environment.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1914 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.
1944 1945 1946 1947 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1944 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.
1970 1971 1972 1973 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1970 def delete_storage_profile(params = {}, = {}) req = build_request(:delete_storage_profile, params) req.send_request() end |
#delete_worker(params = {}) ⇒ Struct
Deletes a worker.
2000 2001 2002 2003 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2000 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.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2026 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.
2056 2057 2058 2059 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2056 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.
2091 2092 2093 2094 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2091 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.
2122 2123 2124 2125 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2122 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.
2184 2185 2186 2187 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2184 def get_budget(params = {}, = {}) req = build_request(:get_budget, params) req.send_request() end |
#get_farm(params = {}) ⇒ Types::GetFarmResponse
Get a farm.
2226 2227 2228 2229 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2226 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
2345 2346 2347 2348 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2345 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
2437 2438 2439 2440 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2437 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
2485 2486 2487 2488 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2485 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.
2534 2535 2536 2537 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2534 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
2609 2610 2611 2612 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2609 def get_queue(params = {}, = {}) req = build_request(:get_queue, params) req.send_request() end |
#get_queue_environment(params = {}) ⇒ Types::GetQueueEnvironmentResponse
Gets a queue environment.
2661 2662 2663 2664 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2661 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
2714 2715 2716 2717 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2714 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.
2792 2793 2794 2795 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2792 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.
2859 2860 2861 2862 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2859 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.
2935 2936 2937 2938 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2935 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.
3024 3025 3026 3027 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3024 def get_step(params = {}, = {}) req = build_request(:get_step, params) req.send_request() end |
#get_storage_profile(params = {}) ⇒ Types::GetStorageProfileResponse
Gets a storage profile.
3073 3074 3075 3076 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3073 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.
3118 3119 3120 3121 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3118 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.
3188 3189 3190 3191 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3188 def get_task(params = {}, = {}) req = build_request(:get_task, params) req.send_request() end |
#get_worker(params = {}) ⇒ Types::GetWorkerResponse
Gets a worker.
3253 3254 3255 3256 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3253 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.
3295 3296 3297 3298 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3295 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.
3352 3353 3354 3355 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3352 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.
3399 3400 3401 3402 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3399 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.
3448 3449 3450 3451 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3448 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.
3500 3501 3502 3503 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3500 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.
3611 3612 3613 3614 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3611 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.
3668 3669 3670 3671 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3668 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.
3735 3736 3737 3738 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3735 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.
3777 3778 3779 3780 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3777 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.
3823 3824 3825 3826 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3823 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.
3872 3873 3874 3875 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3872 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.
3921 3922 3923 3924 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3921 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.
3978 3979 3980 3981 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3978 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.
4030 4031 4032 4033 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4030 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.
4099 4100 4101 4102 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4099 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.
4168 4169 4170 4171 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4168 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.
4227 4228 4229 4230 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4227 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.
4284 4285 4286 4287 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4284 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.
4340 4341 4342 4343 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4340 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.
4396 4397 4398 4399 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4396 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.
4464 4465 4466 4467 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4464 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.
4509 4510 4511 4512 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4509 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.
4558 4559 4560 4561 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4558 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.
4587 4588 4589 4590 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4587 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.
4657 4658 4659 4660 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4657 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.
4724 4725 4726 4727 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4724 def list_workers(params = {}, = {}) req = build_request(:list_workers, params) req.send_request() end |
#put_metered_product(params = {}) ⇒ Struct
Adds a metered product.
4750 4751 4752 4753 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4750 def put_metered_product(params = {}, = {}) req = build_request(:put_metered_product, params) req.send_request() end |
#search_jobs(params = {}) ⇒ Types::SearchJobsResponse
Searches for jobs.
4867 4868 4869 4870 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4867 def search_jobs(params = {}, = {}) req = build_request(:search_jobs, params) req.send_request() end |
#search_steps(params = {}) ⇒ Types::SearchStepsResponse
Searches for steps.
4984 4985 4986 4987 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4984 def search_steps(params = {}, = {}) req = build_request(:search_steps, params) req.send_request() end |
#search_tasks(params = {}) ⇒ Types::SearchTasksResponse
Searches for tasks.
5098 5099 5100 5101 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5098 def search_tasks(params = {}, = {}) req = build_request(:search_tasks, params) req.send_request() end |
#search_workers(params = {}) ⇒ Types::SearchWorkersResponse
Searches for workers.
5208 5209 5210 5211 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5208 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. Statistics are available
for 1 hour after you call the StartSessionsStatisticsAggregation
operation.
5273 5274 5275 5276 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5273 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.
5302 5303 5304 5305 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5302 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.
5329 5330 5331 5332 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5329 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.
5413 5414 5415 5416 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5413 def update_budget(params = {}, = {}) req = build_request(:update_budget, params) req.send_request() end |
#update_farm(params = {}) ⇒ Struct
Updates a farm.
5443 5444 5445 5446 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5443 def update_farm(params = {}, = {}) req = build_request(:update_farm, params) req.send_request() end |
#update_fleet(params = {}) ⇒ Struct
Updates a fleet.
5577 5578 5579 5580 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5577 def update_fleet(params = {}, = {}) req = build_request(:update_fleet, params) req.send_request() end |
#update_job(params = {}) ⇒ Struct
Updates a job.
5636 5637 5638 5639 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5636 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
.
5672 5673 5674 5675 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5672 def update_monitor(params = {}, = {}) req = build_request(:update_monitor, params) req.send_request() end |
#update_queue(params = {}) ⇒ Struct
Updates a queue.
5759 5760 5761 5762 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5759 def update_queue(params = {}, = {}) req = build_request(:update_queue, params) req.send_request() end |
#update_queue_environment(params = {}) ⇒ Struct
Updates the queue environment.
5809 5810 5811 5812 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5809 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.
5843 5844 5845 5846 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5843 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.
5889 5890 5891 5892 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5889 def update_session(params = {}, = {}) req = build_request(:update_session, params) req.send_request() end |
#update_step(params = {}) ⇒ Struct
Updates a step.
5935 5936 5937 5938 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5935 def update_step(params = {}, = {}) req = build_request(:update_step, params) req.send_request() end |
#update_storage_profile(params = {}) ⇒ Struct
Updates a storage profile.
5997 5998 5999 6000 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5997 def update_storage_profile(params = {}, = {}) req = build_request(:update_storage_profile, params) req.send_request() end |
#update_task(params = {}) ⇒ Struct
Updates a task.
6047 6048 6049 6050 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6047 def update_task(params = {}, = {}) req = build_request(:update_task, params) req.send_request() end |
#update_worker(params = {}) ⇒ Types::UpdateWorkerResponse
Updates a worker.
6119 6120 6121 6122 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6119 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.
6197 6198 6199 6200 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6197 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 |
6313 6314 6315 6316 6317 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6313 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |