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_limit(params = {}) ⇒ Types::CreateLimitResponse
Creates a limit that manages the distribution of shared resources, such as floating licenses.
-
#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_queue_limit_association(params = {}) ⇒ Struct
Associates a limit with a particular queue.
-
#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_limit(params = {}) ⇒ Struct
Removes a limit from the specified farm.
-
#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_queue_limit_association(params = {}) ⇒ Struct
Removes the association between a queue and a limit.
-
#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_limit(params = {}) ⇒ Types::GetLimitResponse
Gets information about a specific limit.
-
#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_queue_limit_association(params = {}) ⇒ Types::GetQueueLimitAssociationResponse
Gets information about a specific association between a queue and a limit.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Gets a session.
-
#get_session_action(params = {}) ⇒ Types::GetSessionActionResponse
Gets a session action for the job.
-
#get_sessions_statistics_aggregation(params = {}) ⇒ Types::GetSessionsStatisticsAggregationResponse
Gets a set of statistics for queues or farms.
-
#get_step(params = {}) ⇒ Types::GetStepResponse
Gets a step.
-
#get_storage_profile(params = {}) ⇒ Types::GetStorageProfileResponse
Gets a storage profile.
-
#get_storage_profile_for_queue(params = {}) ⇒ Types::GetStorageProfileForQueueResponse
Gets a storage profile for a queue.
-
#get_task(params = {}) ⇒ Types::GetTaskResponse
Gets a task.
-
#get_worker(params = {}) ⇒ Types::GetWorkerResponse
Gets a worker.
-
#list_available_metered_products(params = {}) ⇒ Types::ListAvailableMeteredProductsResponse
A list of the available metered products.
-
#list_budgets(params = {}) ⇒ Types::ListBudgetsResponse
A list of budgets in a farm.
-
#list_farm_members(params = {}) ⇒ Types::ListFarmMembersResponse
Lists the members of a farm.
-
#list_farms(params = {}) ⇒ Types::ListFarmsResponse
Lists farms.
-
#list_fleet_members(params = {}) ⇒ Types::ListFleetMembersResponse
Lists fleet members.
-
#list_fleets(params = {}) ⇒ Types::ListFleetsResponse
Lists fleets.
-
#list_job_members(params = {}) ⇒ Types::ListJobMembersResponse
Lists members on a job.
-
#list_job_parameter_definitions(params = {}) ⇒ Types::ListJobParameterDefinitionsResponse
Lists parameter definitions of a job.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists jobs.
-
#list_license_endpoints(params = {}) ⇒ Types::ListLicenseEndpointsResponse
Lists license endpoints.
-
#list_limits(params = {}) ⇒ Types::ListLimitsResponse
Gets a list of limits defined in the specified farm.
-
#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_limit_associations(params = {}) ⇒ Types::ListQueueLimitAssociationsResponse
Gets a list of the associations between queues and limits defined in a farm.
-
#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_limit(params = {}) ⇒ Struct
Updates the properties of the specified limit.
-
#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_queue_limit_association(params = {}) ⇒ Struct
Updates the status of the queue.
-
#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.
466 467 468 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#associate_member_to_farm(params = {}) ⇒ Struct
Assigns a farm membership level to a member.
505 506 507 508 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 505 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.
547 548 549 550 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 547 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
593 594 595 596 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 593 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
635 636 637 638 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 635 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.
672 673 674 675 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 672 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.
711 712 713 714 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 711 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.
748 749 750 751 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 748 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.
783 784 785 786 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 783 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.
826 827 828 829 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 826 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.
939 940 941 942 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 939 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.
983 984 985 986 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 983 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.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1065 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.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1129 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.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1314 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 Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1437 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.
1489 1490 1491 1492 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1489 def create_license_endpoint(params = {}, = {}) req = build_request(:create_license_endpoint, params) req.send_request() end |
#create_limit(params = {}) ⇒ Types::CreateLimitResponse
Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
You must add the amountRequirementName
to a step in a job template
to declare the limit requirement.
1564 1565 1566 1567 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1564 def create_limit(params = {}, = {}) req = build_request(:create_limit, 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.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1627 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.
1727 1728 1729 1730 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1727 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.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1783 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.
1813 1814 1815 1816 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1813 def create_queue_fleet_association(params = {}, = {}) req = build_request(:create_queue_fleet_association, params) req.send_request() end |
#create_queue_limit_association(params = {}) ⇒ Struct
Associates a limit with a particular queue. After the limit is
associated, all workers for jobs that specify the limit associated
with the queue are subject to the limit. You can't associate two
limits with the same amountRequirementName
to the same queue.
1847 1848 1849 1850 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1847 def create_queue_limit_association(params = {}, = {}) req = build_request(:create_queue_limit_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.
1906 1907 1908 1909 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1906 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.
Deadline Cloud limits the number of workers to less than or equal to
the fleet's maximum worker count. The service maintains eventual
consistency for the worker count. If you make multiple rapid calls to
CreateWorker
before the field updates, you might exceed your
fleet's maximum worker count. For example, if your maxWorkerCount
is 10 and you currently have 9 workers, making two quick
CreateWorker
calls might successfully create 2 workers instead of 1,
resulting in 11 total workers.
1976 1977 1978 1979 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 1976 def create_worker(params = {}, = {}) req = build_request(:create_worker, params) req.send_request() end |
#delete_budget(params = {}) ⇒ Struct
Deletes a budget.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2002 def delete_budget(params = {}, = {}) req = build_request(:delete_budget, params) req.send_request() end |
#delete_farm(params = {}) ⇒ Struct
Deletes a farm.
2024 2025 2026 2027 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2024 def delete_farm(params = {}, = {}) req = build_request(:delete_farm, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes a fleet.
2058 2059 2060 2061 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2058 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#delete_license_endpoint(params = {}) ⇒ Struct
Deletes a license endpoint.
2080 2081 2082 2083 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2080 def delete_license_endpoint(params = {}, = {}) req = build_request(:delete_license_endpoint, params) req.send_request() end |
#delete_limit(params = {}) ⇒ Struct
Removes a limit from the specified farm. Before you delete a limit you
must use the DeleteQueueLimitAssociation
operation to remove the
association with any queues.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2108 def delete_limit(params = {}, = {}) req = build_request(:delete_limit, params) req.send_request() end |
#delete_metered_product(params = {}) ⇒ Struct
Deletes a metered product.
2135 2136 2137 2138 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2135 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.
2160 2161 2162 2163 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2160 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.
2189 2190 2191 2192 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2189 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#delete_queue_environment(params = {}) ⇒ Struct
Deletes a queue environment.
2219 2220 2221 2222 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2219 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.
2249 2250 2251 2252 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2249 def delete_queue_fleet_association(params = {}, = {}) req = build_request(:delete_queue_fleet_association, params) req.send_request() end |
#delete_queue_limit_association(params = {}) ⇒ Struct
Removes the association between a queue and a limit. You must use the
UpdateQueueLimitAssociation
operation to set the status to
STOP_LIMIT_USAGE_AND_COMPLETE_TASKS
or
STOP_LIMIT_USAGE_AND_CANCEL_TASKS
. The status does not change
immediately. Use the GetQueueLimitAssociation
operation to see if
the status changed to STOPPED
before deleting the association.
2285 2286 2287 2288 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2285 def delete_queue_limit_association(params = {}, = {}) req = build_request(:delete_queue_limit_association, params) req.send_request() end |
#delete_storage_profile(params = {}) ⇒ Struct
Deletes a storage profile.
2311 2312 2313 2314 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2311 def delete_storage_profile(params = {}, = {}) req = build_request(:delete_storage_profile, params) req.send_request() end |
#delete_worker(params = {}) ⇒ Struct
Deletes a worker.
2341 2342 2343 2344 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2341 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.
2367 2368 2369 2370 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2367 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.
2397 2398 2399 2400 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2397 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.
2432 2433 2434 2435 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2432 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.
2463 2464 2465 2466 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2463 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.
2525 2526 2527 2528 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2525 def get_budget(params = {}, = {}) req = build_request(:get_budget, params) req.send_request() end |
#get_farm(params = {}) ⇒ Types::GetFarmResponse
Get a farm.
2567 2568 2569 2570 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2567 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
2695 2696 2697 2698 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2695 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
2791 2792 2793 2794 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2791 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
2839 2840 2841 2842 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2839 def get_license_endpoint(params = {}, = {}) req = build_request(:get_license_endpoint, params) req.send_request() end |
#get_limit(params = {}) ⇒ Types::GetLimitResponse
Gets information about a specific limit.
2891 2892 2893 2894 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2891 def get_limit(params = {}, = {}) req = build_request(:get_limit, params) req.send_request() end |
#get_monitor(params = {}) ⇒ Types::GetMonitorResponse
Gets information about the specified monitor.
2940 2941 2942 2943 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 2940 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
3015 3016 3017 3018 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3015 def get_queue(params = {}, = {}) req = build_request(:get_queue, params) req.send_request() end |
#get_queue_environment(params = {}) ⇒ Types::GetQueueEnvironmentResponse
Gets a queue environment.
3067 3068 3069 3070 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3067 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
3120 3121 3122 3123 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3120 def get_queue_fleet_association(params = {}, = {}) req = build_request(:get_queue_fleet_association, params) req.send_request() end |
#get_queue_limit_association(params = {}) ⇒ Types::GetQueueLimitAssociationResponse
Gets information about a specific association between a queue and a limit.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- queue_limit_association_stopped
3175 3176 3177 3178 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3175 def get_queue_limit_association(params = {}, = {}) req = build_request(:get_queue_limit_association, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Gets a session.
3253 3254 3255 3256 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3253 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.
3324 3325 3326 3327 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3324 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.
3400 3401 3402 3403 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3400 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.
3489 3490 3491 3492 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3489 def get_step(params = {}, = {}) req = build_request(:get_step, params) req.send_request() end |
#get_storage_profile(params = {}) ⇒ Types::GetStorageProfileResponse
Gets a storage profile.
3538 3539 3540 3541 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3538 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.
3583 3584 3585 3586 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3583 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.
3653 3654 3655 3656 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3653 def get_task(params = {}, = {}) req = build_request(:get_task, params) req.send_request() end |
#get_worker(params = {}) ⇒ Types::GetWorkerResponse
Gets a worker.
3718 3719 3720 3721 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3718 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.
3760 3761 3762 3763 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3760 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.
3817 3818 3819 3820 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3817 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.
3864 3865 3866 3867 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3864 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.
3913 3914 3915 3916 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3913 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.
3965 3966 3967 3968 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 3965 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.
4086 4087 4088 4089 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4086 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.
4143 4144 4145 4146 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4143 def list_job_members(params = {}, = {}) req = build_request(:list_job_members, params) req.send_request() end |
#list_job_parameter_definitions(params = {}) ⇒ Types::ListJobParameterDefinitionsResponse
Lists parameter definitions of a job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4193 4194 4195 4196 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4193 def list_job_parameter_definitions(params = {}, = {}) req = build_request(:list_job_parameter_definitions, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4262 4263 4264 4265 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4262 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.
4304 4305 4306 4307 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4304 def list_license_endpoints(params = {}, = {}) req = build_request(:list_license_endpoints, params) req.send_request() end |
#list_limits(params = {}) ⇒ Types::ListLimitsResponse
Gets a list of limits defined in the specified farm.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4355 4356 4357 4358 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4355 def list_limits(params = {}, = {}) req = build_request(:list_limits, 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.
4401 4402 4403 4404 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4401 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.
4450 4451 4452 4453 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4450 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.
4499 4500 4501 4502 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4499 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.
4556 4557 4558 4559 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4556 def list_queue_fleet_associations(params = {}, = {}) req = build_request(:list_queue_fleet_associations, params) req.send_request() end |
#list_queue_limit_associations(params = {}) ⇒ Types::ListQueueLimitAssociationsResponse
Gets a list of the associations between queues and limits defined in a farm.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4620 4621 4622 4623 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4620 def list_queue_limit_associations(params = {}, = {}) req = build_request(:list_queue_limit_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.
4672 4673 4674 4675 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4672 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.
4739 4740 4741 4742 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4739 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.
4808 4809 4810 4811 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4808 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.
4867 4868 4869 4870 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4867 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.
4924 4925 4926 4927 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4924 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.
4980 4981 4982 4983 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 4980 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.
5036 5037 5038 5039 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5036 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.
5104 5105 5106 5107 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5104 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.
5149 5150 5151 5152 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5149 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.
5198 5199 5200 5201 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5198 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.
5227 5228 5229 5230 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5227 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.
5297 5298 5299 5300 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5297 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.
5364 5365 5366 5367 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5364 def list_workers(params = {}, = {}) req = build_request(:list_workers, params) req.send_request() end |
#put_metered_product(params = {}) ⇒ Struct
Adds a metered product.
5390 5391 5392 5393 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5390 def put_metered_product(params = {}, = {}) req = build_request(:put_metered_product, params) req.send_request() end |
#search_jobs(params = {}) ⇒ Types::SearchJobsResponse
Searches for jobs.
5510 5511 5512 5513 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5510 def search_jobs(params = {}, = {}) req = build_request(:search_jobs, params) req.send_request() end |
#search_steps(params = {}) ⇒ Types::SearchStepsResponse
Searches for steps.
5628 5629 5630 5631 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5628 def search_steps(params = {}, = {}) req = build_request(:search_steps, params) req.send_request() end |
#search_tasks(params = {}) ⇒ Types::SearchTasksResponse
Searches for tasks.
5743 5744 5745 5746 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5743 def search_tasks(params = {}, = {}) req = build_request(:search_tasks, params) req.send_request() end |
#search_workers(params = {}) ⇒ Types::SearchWorkersResponse
Searches for workers.
5854 5855 5856 5857 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5854 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.
5922 5923 5924 5925 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5922 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.
5951 5952 5953 5954 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5951 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.
5978 5979 5980 5981 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 5978 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.
6070 6071 6072 6073 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6070 def update_budget(params = {}, = {}) req = build_request(:update_budget, params) req.send_request() end |
#update_farm(params = {}) ⇒ Struct
Updates a farm.
6108 6109 6110 6111 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6108 def update_farm(params = {}, = {}) req = build_request(:update_farm, params) req.send_request() end |
#update_fleet(params = {}) ⇒ Struct
Updates a fleet.
6280 6281 6282 6283 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6280 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.
6363 6364 6365 6366 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6363 def update_job(params = {}, = {}) req = build_request(:update_job, params) req.send_request() end |
#update_limit(params = {}) ⇒ Struct
Updates the properties of the specified limit.
6419 6420 6421 6422 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6419 def update_limit(params = {}, = {}) req = build_request(:update_limit, 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
.
6459 6460 6461 6462 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6459 def update_monitor(params = {}, = {}) req = build_request(:update_monitor, params) req.send_request() end |
#update_queue(params = {}) ⇒ Struct
Updates a queue.
6554 6555 6556 6557 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6554 def update_queue(params = {}, = {}) req = build_request(:update_queue, params) req.send_request() end |
#update_queue_environment(params = {}) ⇒ Struct
Updates the queue environment.
6604 6605 6606 6607 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6604 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.
6638 6639 6640 6641 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6638 def update_queue_fleet_association(params = {}, = {}) req = build_request(:update_queue_fleet_association, params) req.send_request() end |
#update_queue_limit_association(params = {}) ⇒ Struct
Updates the status of the queue. If you set the status to one of the
STOP_LIMIT_USAGE*
values, there will be a delay before the status
transitions to the STOPPED
state.
6677 6678 6679 6680 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6677 def update_queue_limit_association(params = {}, = {}) req = build_request(:update_queue_limit_association, params) req.send_request() end |
#update_session(params = {}) ⇒ Struct
Updates a session.
6723 6724 6725 6726 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6723 def update_session(params = {}, = {}) req = build_request(:update_session, params) req.send_request() end |
#update_step(params = {}) ⇒ Struct
Updates a step.
6769 6770 6771 6772 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6769 def update_step(params = {}, = {}) req = build_request(:update_step, params) req.send_request() end |
#update_storage_profile(params = {}) ⇒ Struct
Updates a storage profile.
6835 6836 6837 6838 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6835 def update_storage_profile(params = {}, = {}) req = build_request(:update_storage_profile, params) req.send_request() end |
#update_task(params = {}) ⇒ Struct
Updates a task.
6885 6886 6887 6888 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6885 def update_task(params = {}, = {}) req = build_request(:update_task, params) req.send_request() end |
#update_worker(params = {}) ⇒ Types::UpdateWorkerResponse
Updates a worker.
6960 6961 6962 6963 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 6960 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.
7038 7039 7040 7041 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 7038 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_limit_association_stopped | #get_queue_limit_association | 10 | 60 |
queue_scheduling | #get_queue | 10 | 70 |
queue_scheduling_blocked | #get_queue | 10 | 30 |
7160 7161 7162 7163 7164 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/client.rb', line 7160 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |