

*************
DeadlineCloud
*************



======
Client
======



.. py:class:: DeadlineCloud.Client

  A low-level client representing AWSDeadlineCloud
  

  The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.

   

  With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.

  ::

    
    import boto3
    
    client = boto3.client('deadline')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  deadline/client/associate_member_to_farm
  deadline/client/associate_member_to_fleet
  deadline/client/associate_member_to_job
  deadline/client/associate_member_to_queue
  deadline/client/assume_fleet_role_for_read
  deadline/client/assume_fleet_role_for_worker
  deadline/client/assume_queue_role_for_read
  deadline/client/assume_queue_role_for_user
  deadline/client/assume_queue_role_for_worker
  deadline/client/batch_get_job_entity
  deadline/client/can_paginate
  deadline/client/close
  deadline/client/copy_job_template
  deadline/client/create_budget
  deadline/client/create_farm
  deadline/client/create_fleet
  deadline/client/create_job
  deadline/client/create_license_endpoint
  deadline/client/create_limit
  deadline/client/create_monitor
  deadline/client/create_queue
  deadline/client/create_queue_environment
  deadline/client/create_queue_fleet_association
  deadline/client/create_queue_limit_association
  deadline/client/create_storage_profile
  deadline/client/create_worker
  deadline/client/delete_budget
  deadline/client/delete_farm
  deadline/client/delete_fleet
  deadline/client/delete_license_endpoint
  deadline/client/delete_limit
  deadline/client/delete_metered_product
  deadline/client/delete_monitor
  deadline/client/delete_queue
  deadline/client/delete_queue_environment
  deadline/client/delete_queue_fleet_association
  deadline/client/delete_queue_limit_association
  deadline/client/delete_storage_profile
  deadline/client/delete_worker
  deadline/client/disassociate_member_from_farm
  deadline/client/disassociate_member_from_fleet
  deadline/client/disassociate_member_from_job
  deadline/client/disassociate_member_from_queue
  deadline/client/get_budget
  deadline/client/get_farm
  deadline/client/get_fleet
  deadline/client/get_job
  deadline/client/get_license_endpoint
  deadline/client/get_limit
  deadline/client/get_monitor
  deadline/client/get_paginator
  deadline/client/get_queue
  deadline/client/get_queue_environment
  deadline/client/get_queue_fleet_association
  deadline/client/get_queue_limit_association
  deadline/client/get_session
  deadline/client/get_session_action
  deadline/client/get_sessions_statistics_aggregation
  deadline/client/get_step
  deadline/client/get_storage_profile
  deadline/client/get_storage_profile_for_queue
  deadline/client/get_task
  deadline/client/get_waiter
  deadline/client/get_worker
  deadline/client/list_available_metered_products
  deadline/client/list_budgets
  deadline/client/list_farm_members
  deadline/client/list_farms
  deadline/client/list_fleet_members
  deadline/client/list_fleets
  deadline/client/list_job_members
  deadline/client/list_job_parameter_definitions
  deadline/client/list_jobs
  deadline/client/list_license_endpoints
  deadline/client/list_limits
  deadline/client/list_metered_products
  deadline/client/list_monitors
  deadline/client/list_queue_environments
  deadline/client/list_queue_fleet_associations
  deadline/client/list_queue_limit_associations
  deadline/client/list_queue_members
  deadline/client/list_queues
  deadline/client/list_session_actions
  deadline/client/list_sessions
  deadline/client/list_sessions_for_worker
  deadline/client/list_step_consumers
  deadline/client/list_step_dependencies
  deadline/client/list_steps
  deadline/client/list_storage_profiles
  deadline/client/list_storage_profiles_for_queue
  deadline/client/list_tags_for_resource
  deadline/client/list_tasks
  deadline/client/list_workers
  deadline/client/put_metered_product
  deadline/client/search_jobs
  deadline/client/search_steps
  deadline/client/search_tasks
  deadline/client/search_workers
  deadline/client/start_sessions_statistics_aggregation
  deadline/client/tag_resource
  deadline/client/untag_resource
  deadline/client/update_budget
  deadline/client/update_farm
  deadline/client/update_fleet
  deadline/client/update_job
  deadline/client/update_limit
  deadline/client/update_monitor
  deadline/client/update_queue
  deadline/client/update_queue_environment
  deadline/client/update_queue_fleet_association
  deadline/client/update_queue_limit_association
  deadline/client/update_session
  deadline/client/update_step
  deadline/client/update_storage_profile
  deadline/client/update_task
  deadline/client/update_worker
  deadline/client/update_worker_schedule


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  deadline/paginator/GetSessionsStatisticsAggregation
  deadline/paginator/ListAvailableMeteredProducts
  deadline/paginator/ListBudgets
  deadline/paginator/ListFarmMembers
  deadline/paginator/ListFarms
  deadline/paginator/ListFleetMembers
  deadline/paginator/ListFleets
  deadline/paginator/ListJobMembers
  deadline/paginator/ListJobParameterDefinitions
  deadline/paginator/ListJobs
  deadline/paginator/ListLicenseEndpoints
  deadline/paginator/ListLimits
  deadline/paginator/ListMeteredProducts
  deadline/paginator/ListMonitors
  deadline/paginator/ListQueueEnvironments
  deadline/paginator/ListQueueFleetAssociations
  deadline/paginator/ListQueueLimitAssociations
  deadline/paginator/ListQueueMembers
  deadline/paginator/ListQueues
  deadline/paginator/ListSessionActions
  deadline/paginator/ListSessions
  deadline/paginator/ListSessionsForWorker
  deadline/paginator/ListStepConsumers
  deadline/paginator/ListStepDependencies
  deadline/paginator/ListSteps
  deadline/paginator/ListStorageProfiles
  deadline/paginator/ListStorageProfilesForQueue
  deadline/paginator/ListTasks
  deadline/paginator/ListWorkers


=======
Waiters
=======


Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  deadline/waiter/FleetActive
  deadline/waiter/JobComplete
  deadline/waiter/JobCreateComplete
  deadline/waiter/JobSucceeded
  deadline/waiter/LicenseEndpointDeleted
  deadline/waiter/LicenseEndpointValid
  deadline/waiter/QueueFleetAssociationStopped
  deadline/waiter/QueueLimitAssociationStopped
  deadline/waiter/QueueScheduling
  deadline/waiter/QueueSchedulingBlocked
