DeadlineCloud ************* Client ====== 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: * associate_member_to_farm * associate_member_to_fleet * associate_member_to_job * associate_member_to_queue * assume_fleet_role_for_read * assume_fleet_role_for_worker * assume_queue_role_for_read * assume_queue_role_for_user * assume_queue_role_for_worker * batch_get_job_entity * can_paginate * close * copy_job_template * create_budget * create_farm * create_fleet * create_job * create_license_endpoint * create_limit * create_monitor * create_queue * create_queue_environment * create_queue_fleet_association * create_queue_limit_association * create_storage_profile * create_worker * delete_budget * delete_farm * delete_fleet * delete_license_endpoint * delete_limit * delete_metered_product * delete_monitor * delete_queue * delete_queue_environment * delete_queue_fleet_association * delete_queue_limit_association * delete_storage_profile * delete_worker * disassociate_member_from_farm * disassociate_member_from_fleet * disassociate_member_from_job * disassociate_member_from_queue * get_budget * get_farm * get_fleet * get_job * get_license_endpoint * get_limit * get_monitor * get_paginator * get_queue * get_queue_environment * get_queue_fleet_association * get_queue_limit_association * get_session * get_session_action * get_sessions_statistics_aggregation * get_step * get_storage_profile * get_storage_profile_for_queue * get_task * get_waiter * get_worker * list_available_metered_products * list_budgets * list_farm_members * list_farms * list_fleet_members * list_fleets * list_job_members * list_job_parameter_definitions * list_jobs * list_license_endpoints * list_limits * list_metered_products * list_monitors * list_queue_environments * list_queue_fleet_associations * list_queue_limit_associations * list_queue_members * list_queues * list_session_actions * list_sessions * list_sessions_for_worker * list_step_consumers * list_step_dependencies * list_steps * list_storage_profiles * list_storage_profiles_for_queue * list_tags_for_resource * list_tasks * list_workers * put_metered_product * search_jobs * search_steps * search_tasks * search_workers * start_sessions_statistics_aggregation * tag_resource * untag_resource * update_budget * update_farm * update_fleet * update_job * update_limit * update_monitor * update_queue * update_queue_environment * update_queue_fleet_association * update_queue_limit_association * update_session * update_step * update_storage_profile * update_task * update_worker * 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. The available paginators are: * GetSessionsStatisticsAggregation * ListAvailableMeteredProducts * ListBudgets * ListFarmMembers * ListFarms * ListFleetMembers * ListFleets * ListJobMembers * ListJobParameterDefinitions * ListJobs * ListLicenseEndpoints * ListLimits * ListMeteredProducts * ListMonitors * ListQueueEnvironments * ListQueueFleetAssociations * ListQueueLimitAssociations * ListQueueMembers * ListQueues * ListSessionActions * ListSessions * ListSessionsForWorker * ListStepConsumers * ListStepDependencies * ListSteps * ListStorageProfiles * ListStorageProfilesForQueue * ListTasks * 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. The available waiters are: * FleetActive * JobCreateComplete * LicenseEndpointDeleted * LicenseEndpointValid * QueueFleetAssociationStopped * QueueLimitAssociationStopped * QueueScheduling * QueueSchedulingBlocked DeadlineCloud / Waiter / QueueScheduling QueueScheduling *************** class DeadlineCloud.Waiter.QueueScheduling waiter = client.get_waiter('queue_scheduling') wait(**kwargs) Polls "DeadlineCloud.Client.get_queue()" every 10 seconds until a successful state is reached. An error is raised after 70 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( farmId='string', queueId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm in the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue to retrieve. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 70 Returns: None DeadlineCloud / Waiter / LicenseEndpointDeleted LicenseEndpointDeleted ********************** class DeadlineCloud.Waiter.LicenseEndpointDeleted waiter = client.get_waiter('license_endpoint_deleted') wait(**kwargs) Polls "DeadlineCloud.Client.get_license_endpoint()" every 10 seconds until a successful state is reached. An error is raised after 234 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( licenseEndpointId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **licenseEndpointId** (*string*) -- **[REQUIRED]** The license endpoint ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 234 Returns: None DeadlineCloud / Waiter / QueueSchedulingBlocked QueueSchedulingBlocked ********************** class DeadlineCloud.Waiter.QueueSchedulingBlocked waiter = client.get_waiter('queue_scheduling_blocked') wait(**kwargs) Polls "DeadlineCloud.Client.get_queue()" every 10 seconds until a successful state is reached. An error is raised after 30 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( farmId='string', queueId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm in the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue to retrieve. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 30 Returns: None DeadlineCloud / Waiter / JobCreateComplete JobCreateComplete ***************** class DeadlineCloud.Waiter.JobCreateComplete waiter = client.get_waiter('job_create_complete') wait(**kwargs) Polls "DeadlineCloud.Client.get_job()" every 1 seconds until a successful state is reached. An error is raised after 120 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( farmId='string', queueId='string', jobId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm in the job. * **queueId** (*string*) -- **[REQUIRED]** The queue ID associated with the job. * **jobId** (*string*) -- **[REQUIRED]** The job ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 1 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 120 Returns: None DeadlineCloud / Waiter / FleetActive FleetActive *********** class DeadlineCloud.Waiter.FleetActive waiter = client.get_waiter('fleet_active') wait(**kwargs) Polls "DeadlineCloud.Client.get_fleet()" every 5 seconds until a successful state is reached. An error is raised after 180 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( farmId='string', fleetId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm in the fleet. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the fleet to get. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 5 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 180 Returns: None DeadlineCloud / Waiter / LicenseEndpointValid LicenseEndpointValid ******************** class DeadlineCloud.Waiter.LicenseEndpointValid waiter = client.get_waiter('license_endpoint_valid') wait(**kwargs) Polls "DeadlineCloud.Client.get_license_endpoint()" every 10 seconds until a successful state is reached. An error is raised after 114 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( licenseEndpointId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **licenseEndpointId** (*string*) -- **[REQUIRED]** The license endpoint ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 114 Returns: None DeadlineCloud / Waiter / QueueFleetAssociationStopped QueueFleetAssociationStopped **************************** class DeadlineCloud.Waiter.QueueFleetAssociationStopped waiter = client.get_waiter('queue_fleet_association_stopped') wait(**kwargs) Polls "DeadlineCloud.Client.get_queue_fleet_association()" every 10 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( farmId='string', queueId='string', fleetId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm that contains the queue-fleet association. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue-fleet association. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID for the queue-fleet association. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None DeadlineCloud / Waiter / QueueLimitAssociationStopped QueueLimitAssociationStopped **************************** class DeadlineCloud.Waiter.QueueLimitAssociationStopped waiter = client.get_waiter('queue_limit_association_stopped') wait(**kwargs) Polls "DeadlineCloud.Client.get_queue_limit_association()" every 10 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( farmId='string', queueId='string', limitId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the associated queue and limit. * **queueId** (*string*) -- **[REQUIRED]** The unique identifier of the queue associated with the limit. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit associated with the queue. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None DeadlineCloud / Paginator / ListSessions ListSessions ************ class DeadlineCloud.Paginator.ListSessions paginator = client.get_paginator('list_sessions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_sessions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', jobId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the list of sessions. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the list of sessions * **jobId** (*string*) -- **[REQUIRED]** The job ID for the list of sessions. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'sessions': [ { 'sessionId': 'string', 'fleetId': 'string', 'workerId': 'string', 'startedAt': datetime(2015, 1, 1), 'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED', 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'targetLifecycleStatus': 'ENDED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sessions** *(list) --* The sessions on the list. * *(dict) --* The summary of a session. * **sessionId** *(string) --* The session ID. * **fleetId** *(string) --* The fleet ID. * **workerId** *(string) --* The worker ID. * **startedAt** *(datetime) --* The date and time the resource started running. * **lifecycleStatus** *(string) --* The life cycle status for the session. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **targetLifecycleStatus** *(string) --* The target life cycle status for the session. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListMonitors ListMonitors ************ class DeadlineCloud.Paginator.ListMonitors paginator = client.get_paginator('list_monitors') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_monitors()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'monitors': [ { 'monitorId': 'string', 'displayName': 'string', 'subdomain': 'string', 'url': 'string', 'roleArn': 'string', 'identityCenterInstanceArn': 'string', 'identityCenterApplicationArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **monitors** *(list) --* A list of "MonitorSummary" objects that describe your monitors in the Deadline Cloud. * *(dict) --* Provides information about a monitor in Deadline Cloud. * **monitorId** *(string) --* The unique identifier for the monitor. * **displayName** *(string) --* The name of the monitor that displays on the Deadline Cloud console. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **subdomain** *(string) --* The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. * **url** *(string) --* The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources. * **identityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users. * **identityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created. * **createdAt** *(datetime) --* The UNIX timestamp of the date and time that the monitor was created. * **createdBy** *(string) --* The user name of the person that created the monitor. * **updatedAt** *(datetime) --* The UNIX timestamp of the date and time that the monitor was last updated. * **updatedBy** *(string) --* The user name of the person that last updated the monitor. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListStorageProfiles ListStorageProfiles ******************* class DeadlineCloud.Paginator.ListStorageProfiles paginator = client.get_paginator('list_storage_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_storage_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the storage profile. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'storageProfiles': [ { 'storageProfileId': 'string', 'displayName': 'string', 'osFamily': 'WINDOWS'|'LINUX'|'MACOS' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **storageProfiles** *(list) --* The storage profiles. * *(dict) --* The details of a storage profile. * **storageProfileId** *(string) --* The storage profile ID. * **displayName** *(string) --* The display name of the storage profile summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** *(string) --* The operating system (OS) family. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListMeteredProducts ListMeteredProducts ******************* class DeadlineCloud.Paginator.ListMeteredProducts paginator = client.get_paginator('list_metered_products') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_metered_products()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( licenseEndpointId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **licenseEndpointId** (*string*) -- **[REQUIRED]** The license endpoint ID to include on the list of metered products. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'meteredProducts': [ { 'productId': 'string', 'family': 'string', 'vendor': 'string', 'port': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **meteredProducts** *(list) --* The metered products to list. * *(dict) --* The details of a metered product. * **productId** *(string) --* The product ID. * **family** *(string) --* The family to which the metered product belongs. * **vendor** *(string) --* The vendor. * **port** *(integer) --* The port on which the metered product should run. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListJobParameterDefinitions ListJobParameterDefinitions *************************** class DeadlineCloud.Paginator.ListJobParameterDefinitions paginator = client.get_paginator('list_job_parameter_definitions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_job_parameter_definitions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', jobId='string', queueId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the job to list. * **jobId** (*string*) -- **[REQUIRED]** The job ID to include on the list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'jobParameterDefinitions': [ {...}|[...]|123|123.4|'string'|True|None, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **jobParameterDefinitions** *(list) --* Lists parameter definitions of a job. * (*document*) -- * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListWorkers ListWorkers *********** class DeadlineCloud.Paginator.ListWorkers paginator = client.get_paginator('list_workers') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_workers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', fleetId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID connected to the workers. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the workers. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'workers': [ { 'workerId': 'string', 'farmId': 'string', 'fleetId': 'string', 'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE', 'hostProperties': { 'ipAddresses': { 'ipV4Addresses': [ 'string', ], 'ipV6Addresses': [ 'string', ] }, 'hostName': 'string', 'ec2InstanceArn': 'string', 'ec2InstanceType': 'string' }, 'log': { 'logDriver': 'string', 'options': { 'string': 'string' }, 'parameters': { 'string': 'string' }, 'error': 'string' }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **workers** *(list) --* The workers on the list. * *(dict) --* The summary of details for a worker. * **workerId** *(string) --* The worker ID. * **farmId** *(string) --* The farm ID. * **fleetId** *(string) --* The fleet ID. * **status** *(string) --* The status of the worker. * **hostProperties** *(dict) --* The host properties of the worker. * **ipAddresses** *(dict) --* The IP address of the host. * **ipV4Addresses** *(list) --* The IpV4 address of the network. * *(string) --* * **ipV6Addresses** *(list) --* The IpV6 address for the network and node component. * *(string) --* * **hostName** *(string) --* The host name. * **ec2InstanceArn** *(string) --* The ARN of the host EC2 instance. * **ec2InstanceType** *(string) --* The instance type of the host EC2 instance. * **log** *(dict) --* The log configuration for the worker. * **logDriver** *(string) --* The log drivers for worker related logs. * **options** *(dict) --* The options for a log driver. * *(string) --* * *(string) --* * **parameters** *(dict) --* The parameters for the log configuration. * *(string) --* * *(string) --* * **error** *(string) --* The log configuration error details. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListFarms ListFarms ********* class DeadlineCloud.Paginator.ListFarms paginator = client.get_paginator('list_farms') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_farms()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( principalId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **principalId** (*string*) -- The principal ID of the member to list on the farm. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'farms': [ { 'farmId': 'string', 'displayName': 'string', 'kmsKeyArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **farms** *(list) --* Farms on the list. * *(dict) --* The summary of details for a farm. * **farmId** *(string) --* The farm ID. * **displayName** *(string) --* The display name of the farm. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **kmsKeyArn** *(string) --* The ARN for the KMS key. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListSessionsForWorker ListSessionsForWorker ********************* class DeadlineCloud.Paginator.ListSessionsForWorker paginator = client.get_paginator('list_sessions_for_worker') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_sessions_for_worker()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', fleetId='string', workerId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the session. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID for the session. * **workerId** (*string*) -- **[REQUIRED]** The worker ID for the session. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'sessions': [ { 'sessionId': 'string', 'queueId': 'string', 'jobId': 'string', 'startedAt': datetime(2015, 1, 1), 'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED', 'endedAt': datetime(2015, 1, 1), 'targetLifecycleStatus': 'ENDED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sessions** *(list) --* The sessions in the response. * *(dict) --* Summarizes the session for a particular worker. * **sessionId** *(string) --* The session ID for the session action. * **queueId** *(string) --* The queue ID for the queue associated to the worker. * **jobId** *(string) --* The job ID for the job associated with the worker's session. * **startedAt** *(datetime) --* The date and time the resource started running. * **lifecycleStatus** *(string) --* The life cycle status for the worker's session. * **endedAt** *(datetime) --* The date and time the resource ended running. * **targetLifecycleStatus** *(string) --* The life cycle status * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListQueueMembers ListQueueMembers **************** class DeadlineCloud.Paginator.ListQueueMembers paginator = client.get_paginator('list_queue_members') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_queue_members()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'queueId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The details of a queue member. * **farmId** *(string) --* The farm ID. * **queueId** *(string) --* The queue ID. * **principalId** *(string) --* The principal ID of the queue member. * **principalType** *(string) --* The principal type of the queue member. * **identityStoreId** *(string) --* The identity store ID. * **membershipLevel** *(string) --* The queue member's membership level. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListFleetMembers ListFleetMembers **************** class DeadlineCloud.Paginator.ListFleetMembers paginator = client.get_paginator('list_fleet_members') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_fleet_members()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', fleetId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the fleet. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID to include on the list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'fleetId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The fleet member. * **farmId** *(string) --* The farm ID. * **fleetId** *(string) --* The fleet ID. * **principalId** *(string) --* The principal ID of the fleet member. * **principalType** *(string) --* The principal type of the fleet member. * **identityStoreId** *(string) --* The identity store ID. * **membershipLevel** *(string) --* The fleet member's membership level. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListJobMembers ListJobMembers ************** class DeadlineCloud.Paginator.ListJobMembers paginator = client.get_paginator('list_job_members') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_job_members()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', jobId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the job to list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list. * **jobId** (*string*) -- **[REQUIRED]** The job ID to include on the list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'queueId': 'string', 'jobId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The details for a job member. * **farmId** *(string) --* The farm ID. * **queueId** *(string) --* The queue ID. * **jobId** *(string) --* The job ID. * **principalId** *(string) --* The principal ID of the job member. * **principalType** *(string) --* The principal type of the job member. * **identityStoreId** *(string) --* The identity store ID. * **membershipLevel** *(string) --* The job member's membership level. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListQueues ListQueues ********** class DeadlineCloud.Paginator.ListQueues paginator = client.get_paginator('list_queues') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_queues()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', principalId='string', status='IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the queue. * **principalId** (*string*) -- The principal IDs to include in the list of queues. * **status** (*string*) -- The status of the queues listed. * "ACTIVE"–The queues are active. * "SCHEDULING"–The queues are scheduling. * "SCHEDULING_BLOCKED"–The queue scheduling is blocked for these queues. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'queues': [ { 'farmId': 'string', 'queueId': 'string', 'displayName': 'string', 'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED', 'defaultBudgetAction': 'NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', 'blockedReason': 'NO_BUDGET_CONFIGURED'|'BUDGET_THRESHOLD_REACHED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **queues** *(list) --* The queues on the list. * *(dict) --* The details of a queue summary. * **farmId** *(string) --* The farm ID. * **queueId** *(string) --* The queue ID. * **displayName** *(string) --* The display name of the queue summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** *(string) --* That status of the queue. * **defaultBudgetAction** *(string) --* The default action taken on a queue summary if a budget wasn't configured. * **blockedReason** *(string) --* The reason the queue is blocked, if applicable. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListLimits ListLimits ********** class DeadlineCloud.Paginator.ListLimits paginator = client.get_paginator('list_limits') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_limits()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the limits. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'limits': [ { 'displayName': 'string', 'amountRequirementName': 'string', 'maxCount': 123, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'farmId': 'string', 'limitId': 'string', 'currentCount': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **limits** *(list) --* A list of limits that the farm contains. * *(dict) --* Provides information about a specific limit. * **displayName** *(string) --* The name of the limit used in lists to identify the limit. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **amountRequirementName** *(string) --* The value that you specify as the "name" in the "amounts" field of the "hostRequirements" in a step of a job template to declare the limit requirement. * **maxCount** *(integer) --* The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available. The "maxValue" must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit. * **createdAt** *(datetime) --* The Unix timestamp of the date and time that the limit was created. * **createdBy** *(string) --* The user identifier of the person that created the limit. * **updatedAt** *(datetime) --* The Unix timestamp of the date and time that the limit was last updated. * **updatedBy** *(string) --* The user identifier of the person that last updated the limit. * **farmId** *(string) --* The unique identifier of the farm that contains the limit. * **limitId** *(string) --* The unique identifier of the limit. * **currentCount** *(integer) --* The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListJobs ListJobs ******** class DeadlineCloud.Paginator.ListJobs paginator = client.get_paginator('list_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', principalId='string', queueId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the jobs. * **principalId** (*string*) -- The principal ID of the members on the jobs. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the job. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'jobs': [ { 'jobId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED', 'lifecycleStatusMessage': 'string', 'priority': 123, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'maxFailedTasksCount': 123, 'maxRetriesPerTask': 123, 'maxWorkerCount': 123, 'sourceJobId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **jobs** *(list) --* The jobs on the list. * *(dict) --* A summary of job details. * **jobId** *(string) --* The job ID. * **name** *(string) --* The job name. * **lifecycleStatus** *(string) --* The life cycle status. * **lifecycleStatusMessage** *(string) --* The life cycle status message. * **priority** *(integer) --* The job priority. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **taskRunStatus** *(string) --* The task run status for the job. * "PENDING"–pending and waiting for resources. * "READY"–ready to be processed. * "ASSIGNED"–assigned and will run next on a worker. * "SCHEDULED"–scheduled to be run on a worker. * "INTERRUPTING"–being interrupted. * "RUNNING"–running on a worker. * "SUSPENDED"–the task is suspended. * "CANCELED"–the task has been canceled. * "FAILED"–the task has failed. * "SUCCEEDED"–the task has succeeded. * **targetTaskRunStatus** *(string) --* The task status to start with on the job. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the job failed and were retried. * **maxFailedTasksCount** *(integer) --* The number of task failures before the job stops running and is marked as "FAILED". * **maxRetriesPerTask** *(integer) --* The maximum number of retries for a job. * **maxWorkerCount** *(integer) --* The maximum number of worker hosts that can concurrently process a job. When the "maxWorkerCount" is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers. You can't set the "maxWorkerCount" to 0. If you set it to -1, there is no maximum number of workers. If you don't specify the "maxWorkerCount", the default is -1. * **sourceJobId** *(string) --* The job ID for the source job. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListSessionActions ListSessionActions ****************** class DeadlineCloud.Paginator.ListSessionActions paginator = client.get_paginator('list_session_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_session_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', jobId='string', sessionId='string', taskId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the session actions list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the session actions list. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the session actions list. * **sessionId** (*string*) -- The session ID to include on the sessions action list. * **taskId** (*string*) -- The task ID for the session actions list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'sessionActions': [ { 'sessionActionId': 'string', 'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'workerUpdatedAt': datetime(2015, 1, 1), 'progressPercent': ..., 'definition': { 'envEnter': { 'environmentId': 'string' }, 'envExit': { 'environmentId': 'string' }, 'taskRun': { 'taskId': 'string', 'stepId': 'string', 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } } }, 'syncInputJobAttachments': { 'stepId': 'string' } }, 'manifests': [ { 'outputManifestPath': 'string', 'outputManifestHash': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sessionActions** *(list) --* The session actions. * *(dict) --* The details of a session action. * **sessionActionId** *(string) --* The session action ID. * **status** *(string) --* The status of the session action. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **workerUpdatedAt** *(datetime) --* The Linux timestamp of the last date and time that the session action was updated. * **progressPercent** *(float) --* The completion percentage for the session action. * **definition** *(dict) --* The session action definition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "envEnter", "envExit", "taskRun", "syncInputJobAttachments". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **envEnter** *(dict) --* The environment to enter into. * **environmentId** *(string) --* The environment ID. * **envExit** *(dict) --* The environment to exit from. * **environmentId** *(string) --* The environment ID. * **taskRun** *(dict) --* The task run. * **taskId** *(string) --* The task ID. * **stepId** *(string) --* The step ID. * **parameters** *(dict) --* The parameters of a task run in a session action. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **syncInputJobAttachments** *(dict) --* The job attachments to sync with the session action definition. * **stepId** *(string) --* The step ID of the step in the job attachment. * **manifests** *(list) --* The list of manifest properties that describe file attachments for the task run. * *(dict) --* The manifest properties for a task run, corresponding to the manifest properties in the job. * **outputManifestPath** *(string) --* The manifest file path. * **outputManifestHash** *(string) --* The hash value of the file. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListStorageProfilesForQueue ListStorageProfilesForQueue *************************** class DeadlineCloud.Paginator.ListStorageProfilesForQueue paginator = client.get_paginator('list_storage_profiles_for_queue') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_storage_profiles_for_queue()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the queue's storage profile. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the storage profile. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'storageProfiles': [ { 'storageProfileId': 'string', 'displayName': 'string', 'osFamily': 'WINDOWS'|'LINUX'|'MACOS' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **storageProfiles** *(list) --* The storage profiles in the queue. * *(dict) --* The details of a storage profile. * **storageProfileId** *(string) --* The storage profile ID. * **displayName** *(string) --* The display name of the storage profile summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** *(string) --* The operating system (OS) family. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListTasks ListTasks ********* class DeadlineCloud.Paginator.ListTasks paginator = client.get_paginator('list_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', jobId='string', stepId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID connected to the tasks. * **queueId** (*string*) -- **[REQUIRED]** The queue ID connected to the tasks. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the tasks. * **stepId** (*string*) -- **[REQUIRED]** The step ID for the tasks. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'tasks': [ { 'taskId': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'failureRetryCount': 123, 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } }, 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'latestSessionActionId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **tasks** *(list) --* Tasks for the job. * *(dict) --* The details of a task. * **taskId** *(string) --* The task ID. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **runStatus** *(string) --* The run status of the task. * **targetRunStatus** *(string) --* The run status on which the started. * **failureRetryCount** *(integer) --* The number of times that the task failed and was retried. * **parameters** *(dict) --* The task parameters. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **latestSessionActionId** *(string) --* The latest session action for the task. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListQueueEnvironments ListQueueEnvironments ********************* class DeadlineCloud.Paginator.ListQueueEnvironments paginator = client.get_paginator('list_queue_environments') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_queue_environments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue environment list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue environment list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'environments': [ { 'queueEnvironmentId': 'string', 'name': 'string', 'priority': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **environments** *(list) --* The environments to include in the queue environments list. * *(dict) --* The summary of a queue environment. * **queueEnvironmentId** *(string) --* The queue environment ID. * **name** *(string) --* The name of the queue environment. * **priority** *(integer) --* The queue environment's priority. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListStepConsumers ListStepConsumers ***************** class DeadlineCloud.Paginator.ListStepConsumers paginator = client.get_paginator('list_step_consumers') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_step_consumers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', jobId='string', stepId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the list of step consumers. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the step consumer. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the step consumer. * **stepId** (*string*) -- **[REQUIRED]** The step ID to include on the list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'consumers': [ { 'stepId': 'string', 'status': 'RESOLVED'|'UNRESOLVED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **consumers** *(list) --* The consumers on the list. * *(dict) --* The details of a step consumer. * **stepId** *(string) --* The step ID. * **status** *(string) --* The step consumer status. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListSteps ListSteps ********* class DeadlineCloud.Paginator.ListSteps paginator = client.get_paginator('list_steps') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_steps()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', jobId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to include on the list of steps. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list of steps. * **jobId** (*string*) -- **[REQUIRED]** The job ID to include on the list of steps. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'steps': [ { 'stepId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED', 'lifecycleStatusMessage': 'string', 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'dependencyCounts': { 'dependenciesResolved': 123, 'dependenciesUnresolved': 123, 'consumersResolved': 123, 'consumersUnresolved': 123 } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **steps** *(list) --* The steps on the list. * *(dict) --* The details for a step. * **stepId** *(string) --* The step ID. * **name** *(string) --* The name of the step. * **lifecycleStatus** *(string) --* The life cycle status. * **lifecycleStatusMessage** *(string) --* A message that describes the lifecycle of the step. * **taskRunStatus** *(string) --* The task run status for the job. * "PENDING"–pending and waiting for resources. * "READY"–ready to process. * "ASSIGNED"–assigned and will run next on a worker. * "SCHEDULED"–scheduled to run on a worker. * "INTERRUPTING"–being interrupted. * "RUNNING"–running on a worker. * "SUSPENDED"–the task is suspended. * "CANCELED"–the task has been canceled. * "FAILED"–the task has failed. * "SUCCEEDED"–the task has succeeded. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the step failed and were retried. * **targetTaskRunStatus** *(string) --* The task status to start with on the job. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **dependencyCounts** *(dict) --* The number of dependencies for the step. * **dependenciesResolved** *(integer) --* The number of resolved dependencies. * **dependenciesUnresolved** *(integer) --* The number of unresolved dependencies. * **consumersResolved** *(integer) --* The number of consumers resolved. * **consumersUnresolved** *(integer) --* The number of unresolved consumers. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListFarmMembers ListFarmMembers *************** class DeadlineCloud.Paginator.ListFarmMembers paginator = client.get_paginator('list_farm_members') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_farm_members()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The member of a farm. * **farmId** *(string) --* The farm ID of the farm member. * **principalId** *(string) --* The principal ID of the farm member. * **principalType** *(string) --* The principal type of the farm member. * **identityStoreId** *(string) --* The identity store ID of the farm member. * **membershipLevel** *(string) --* The farm member's membership level. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListQueueLimitAssociations ListQueueLimitAssociations ************************** class DeadlineCloud.Paginator.ListQueueLimitAssociations paginator = client.get_paginator('list_queue_limit_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_queue_limit_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', limitId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the limits and associations. * **queueId** (*string*) -- Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the "queueId" and the "limitId", only the specified limit is returned if it exists. * **limitId** (*string*) -- Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the "queueId" and the "limitId", only the specified limit is returned if it exists. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'queueLimitAssociations': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'queueId': 'string', 'limitId': 'string', 'status': 'ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'|'STOPPED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **queueLimitAssociations** *(list) --* A list of associations between limits and queues in the farm specified in the request. * *(dict) --* Provides information about the association between a queue and a limit. * **createdAt** *(datetime) --* The Unix timestamp of the date and time that the association was created. * **createdBy** *(string) --* The user identifier of the person that created the association. * **updatedAt** *(datetime) --* The Unix timestamp of the date and time that the association was last updated. * **updatedBy** *(string) --* The user identifier of the person that updated the association. * **queueId** *(string) --* The unique identifier of the queue in the association. * **limitId** *(string) --* The unique identifier of the limit in the association. * **status** *(string) --* The status of task scheduling in the queue-limit association. * "ACTIVE" - Association is active. * "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS" - Association has stopped scheduling new tasks and is completing current tasks. * "STOP_LIMIT_USAGE_AND_CANCEL_TASKS" - Association has stopped scheduling new tasks and is canceling current tasks. * "STOPPED" - Association has been stopped. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListFleets ListFleets ********** class DeadlineCloud.Paginator.ListFleets paginator = client.get_paginator('list_fleets') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_fleets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', principalId='string', displayName='string', status='ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the fleets. * **principalId** (*string*) -- The principal ID of the members to include in the fleet. * **displayName** (*string*) -- The display names of a list of fleets. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** (*string*) -- The status of the fleet. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'fleets': [ { 'fleetId': 'string', 'farmId': 'string', 'displayName': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED', 'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING', 'targetWorkerCount': 123, 'workerCount': 123, 'minWorkerCount': 123, 'maxWorkerCount': 123, 'configuration': { 'customerManaged': { 'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING', 'workerCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'acceleratorTypes': [ 'gpu', ], 'acceleratorCount': { 'min': 123, 'max': 123 }, 'acceleratorTotalMemoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'cpuArchitectureType': 'x86_64'|'arm64', 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'storageProfileId': 'string', 'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH' }, 'serviceManagedEc2': { 'instanceCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX', 'cpuArchitectureType': 'x86_64'|'arm64', 'rootEbsVolume': { 'sizeGiB': 123, 'iops': 123, 'throughputMiB': 123 }, 'acceleratorCapabilities': { 'selections': [ { 'name': 't4'|'a10g'|'l4'|'l40s', 'runtime': 'string' }, ], 'count': { 'min': 123, 'max': 123 } }, 'allowedInstanceTypes': [ 'string', ], 'excludedInstanceTypes': [ 'string', ], 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'instanceMarketOptions': { 'type': 'on-demand'|'spot' }, 'vpcConfiguration': { 'resourceConfigurationArns': [ 'string', ] }, 'storageProfileId': 'string' } }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **fleets** *(list) --* The fleets on the list. * *(dict) --* The details of a fleet. * **fleetId** *(string) --* The fleet ID. * **farmId** *(string) --* The farm ID. * **displayName** *(string) --* The display name of the fleet summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** *(string) --* The status of the fleet. * **autoScalingStatus** *(string) --* The Auto Scaling status of a fleet. * **targetWorkerCount** *(integer) --* The target number of workers in a fleet. * **workerCount** *(integer) --* The number of workers in the fleet summary. * **minWorkerCount** *(integer) --* The minimum number of workers in the fleet. * **maxWorkerCount** *(integer) --* The maximum number of workers specified in the fleet. * **configuration** *(dict) --* The configuration details for the fleet. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "customerManaged", "serviceManagedEc2". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **customerManaged** *(dict) --* The customer managed fleets within a fleet configuration. * **mode** *(string) --* The Auto Scaling mode for the customer managed fleet configuration. * **workerCapabilities** *(dict) --* The worker capabilities for a customer managed fleet configuration. * **vCpuCount** *(dict) --* The vCPU count for the customer manged worker capabilities. * **min** *(integer) --* The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* The memory (MiB). * **min** *(integer) --* The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **acceleratorTypes** *(list) --* The accelerator types for the customer managed worker capabilities. * *(string) --* * **acceleratorCount** *(dict) --* The range of the accelerator. * **min** *(integer) --* The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **acceleratorTotalMemoryMiB** *(dict) --* The total memory (MiB) for the customer managed worker capabilities. * **min** *(integer) --* The minimum amount of memory to use for the accelerator, measured in MiB. * **max** *(integer) --* The maximum amount of memory to use for the accelerator, measured in MiB. * **osFamily** *(string) --* The operating system (OS) family. * **cpuArchitectureType** *(string) --* The CPU architecture type for the customer managed worker capabilities. * **customAmounts** *(list) --* Custom requirement ranges for customer managed worker capabilities. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* The name of the fleet capability. * **min** *(float) --* The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* Custom attributes for the customer manged worker capabilities. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* The name of the fleet attribute capability for the worker. * **values** *(list) --* The number of fleet attribute capabilities. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **tagPropagationMode** *(string) --* Specifies whether tags associated with a fleet are attached to workers when the worker is launched. When the "tagPropagationMode" is set to "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers **do not** change. If you don't specify "tagPropagationMode", the default is "NO_PROPAGATION". * **serviceManagedEc2** *(dict) --* The service managed Amazon EC2 instances for a fleet configuration. * **instanceCapabilities** *(dict) --* The Amazon EC2 instance capabilities. * **vCpuCount** *(dict) --* The amount of vCPU to require for instances in this fleet. * **min** *(integer) --* The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* The memory, as MiB, for the Amazon EC2 instance type. * **min** *(integer) --* The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **osFamily** *(string) --* The operating system (OS) family. * **cpuArchitectureType** *(string) --* The CPU architecture type. * **rootEbsVolume** *(dict) --* The root EBS volume. * **sizeGiB** *(integer) --* The EBS volume size in GiB. * **iops** *(integer) --* The IOPS per volume. * **throughputMiB** *(integer) --* The throughput per volume in MiB. * **acceleratorCapabilities** *(dict) --* Describes the GPU accelerator capabilities required for worker host instances in this fleet. * **selections** *(list) --* A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed. * *(dict) --* Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host. * **name** *(string) --* The name of the chip used by the GPU accelerator. If you specify "l4" as the name of the accelerator, you must specify "latest" or "grid:r570" as the runtime. The available GPU accelerators are: * "t4" - NVIDIA T4 Tensor Core GPU * "a10g" - NVIDIA A10G Tensor Core GPU * "l4" - NVIDIA L4 Tensor Core GPU * "l40s" - NVIDIA L40S Tensor Core GPU * **runtime** *(string) --* Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs. You can choose from the following runtimes: * "latest" - Use the latest runtime available for the chip. If you specify "latest" and a new version of the runtime is released, the new version of the runtime is used. * "grid:r570" - NVIDIA vGPU software 18 * "grid:r535" - NVIDIA vGPU software 16 If you don't specify a runtime, Deadline Cloud uses "latest" as the default. However, if you have multiple accelerators and specify "latest" for some and leave others blank, Deadline Cloud raises an exception. * **count** *(dict) --* The number of GPU accelerators specified for worker hosts in this fleet. * **min** *(integer) --* The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **allowedInstanceTypes** *(list) --* The allowable Amazon EC2 instance types. * *(string) --* * **excludedInstanceTypes** *(list) --* The instance types to exclude from the fleet. * *(string) --* * **customAmounts** *(list) --* The custom capability amounts to require for instances in this fleet. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* The name of the fleet capability. * **min** *(float) --* The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* The custom capability attributes to require for instances in this fleet. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* The name of the fleet attribute capability for the worker. * **values** *(list) --* The number of fleet attribute capabilities. * *(string) --* * **instanceMarketOptions** *(dict) --* The Amazon EC2 market type. * **type** *(string) --* The Amazon EC2 instance type. * **vpcConfiguration** *(dict) --* The VPC configuration details for a service managed Amazon EC2 fleet. * **resourceConfigurationArns** *(list) --* The ARNs of the VPC Lattice resource configurations attached to the fleet. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListLicenseEndpoints ListLicenseEndpoints ******************** class DeadlineCloud.Paginator.ListLicenseEndpoints paginator = client.get_paginator('list_license_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_license_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'licenseEndpoints': [ { 'licenseEndpointId': 'string', 'status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'NOT_READY', 'statusMessage': 'string', 'vpcId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **licenseEndpoints** *(list) --* The license endpoints. * *(dict) --* The details for a license endpoint. * **licenseEndpointId** *(string) --* The license endpoint ID. * **status** *(string) --* The status of the license endpoint. * **statusMessage** *(string) --* The status message of the license endpoint. * **vpcId** *(string) --* The VCP(virtual private cloud) ID associated with the license endpoint. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / GetSessionsStatisticsAggregation GetSessionsStatisticsAggregation ******************************** class DeadlineCloud.Paginator.GetSessionsStatisticsAggregation paginator = client.get_paginator('get_sessions_statistics_aggregation') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.get_sessions_statistics_aggregation()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', aggregationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the "StartSessionsStatisticsAggregation" operation. * **aggregationId** (*string*) -- **[REQUIRED]** The identifier returned by the "StartSessionsStatisticsAggregation" operation that identifies the aggregated statistics. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'statistics': [ { 'queueId': 'string', 'fleetId': 'string', 'jobId': 'string', 'jobName': 'string', 'userId': 'string', 'usageType': 'COMPUTE'|'LICENSE', 'licenseProduct': 'string', 'instanceType': 'string', 'count': 123, 'costInUsd': { 'min': 123.0, 'max': 123.0, 'avg': 123.0, 'sum': 123.0 }, 'runtimeInSeconds': { 'min': 123.0, 'max': 123.0, 'avg': 123.0, 'sum': 123.0 }, 'aggregationStartTime': datetime(2015, 1, 1), 'aggregationEndTime': datetime(2015, 1, 1) }, ], 'status': 'IN_PROGRESS'|'TIMEOUT'|'FAILED'|'COMPLETED', 'statusMessage': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **statistics** *(list) --* The statistics for the specified fleets or queues. * *(dict) --* A list of statistics for a session. * **queueId** *(string) --* The queue ID. * **fleetId** *(string) --* The fleet ID. * **jobId** *(string) --* The job ID. * **jobName** *(string) --* The job name. * **userId** *(string) --* The user ID. * **usageType** *(string) --* The type of usage for the statistics. * **licenseProduct** *(string) --* The licensed product. * **instanceType** *(string) --* The type of instance. * **count** *(integer) --* The number of instances in a list of statistics. * **costInUsd** *(dict) --* How the statistics should appear in USD. Options include: minimum, maximum, average or sum. * **min** *(float) --* The minimum of the usage statistics. * **max** *(float) --* The maximum among the usage statistics. * **avg** *(float) --* The average of the usage statistics. * **sum** *(float) --* The sum of the usage statistics. * **runtimeInSeconds** *(dict) --* The total aggregated runtime. * **min** *(float) --* The minimum of the usage statistics. * **max** *(float) --* The maximum among the usage statistics. * **avg** *(float) --* The average of the usage statistics. * **sum** *(float) --* The sum of the usage statistics. * **aggregationStartTime** *(datetime) --* The start time for the aggregation. * **aggregationEndTime** *(datetime) --* The end time for the aggregation. * **status** *(string) --* The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the "StartSessionsStatisticsAggregation" operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length. If you call the "StartSessionsStatisticsAggregation" operation when the status is "IN_PROGRESS", you will receive a "ThrottlingException". * **statusMessage** *(string) --* A message that describes the status. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListBudgets ListBudgets *********** class DeadlineCloud.Paginator.ListBudgets paginator = client.get_paginator('list_budgets') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_budgets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', status='ACTIVE'|'INACTIVE', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID associated with the budgets. * **status** (*string*) -- The status to list for the budgets. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'budgets': [ { 'budgetId': 'string', 'usageTrackingResource': { 'queueId': 'string' }, 'status': 'ACTIVE'|'INACTIVE', 'displayName': 'string', 'description': 'string', 'approximateDollarLimit': ..., 'usages': { 'approximateDollarUsage': ... }, 'createdBy': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **budgets** *(list) --* The budgets to include on the list. * *(dict) --* The budget summary. * **budgetId** *(string) --* The budget ID. * **usageTrackingResource** *(dict) --* The resource used to track expenditure in the budget. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "queueId". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **queueId** *(string) --* The queue ID. * **status** *(string) --* The status of the budget. * "ACTIVE"–The budget is being evaluated. * "INACTIVE"–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses. * **displayName** *(string) --* The display name of the budget summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** *(string) --* The description of the budget summary. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **approximateDollarLimit** *(float) --* The approximate dollar limit of the budget. * **usages** *(dict) --* The consumed usage for the budget. * **approximateDollarUsage** *(float) --* The amount of the budget consumed. * **createdBy** *(string) --* The user or system that created this resource. * **createdAt** *(datetime) --* The date and time the resource was created. * **updatedBy** *(string) --* The user or system that updated this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListAvailableMeteredProducts ListAvailableMeteredProducts **************************** class DeadlineCloud.Paginator.ListAvailableMeteredProducts paginator = client.get_paginator('list_available_metered_products') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_available_metered_products()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'meteredProducts': [ { 'productId': 'string', 'family': 'string', 'vendor': 'string', 'port': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **meteredProducts** *(list) --* The metered products. * *(dict) --* The details of a metered product. * **productId** *(string) --* The product ID. * **family** *(string) --* The family to which the metered product belongs. * **vendor** *(string) --* The vendor. * **port** *(integer) --* The port on which the metered product should run. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListStepDependencies ListStepDependencies ******************** class DeadlineCloud.Paginator.ListStepDependencies paginator = client.get_paginator('list_step_dependencies') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_step_dependencies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', jobId='string', stepId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the step dependencies list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the step dependencies list. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the step dependencies list. * **stepId** (*string*) -- **[REQUIRED]** The step ID to include on the list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'dependencies': [ { 'stepId': 'string', 'status': 'RESOLVED'|'UNRESOLVED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **dependencies** *(list) --* The dependencies on the list. * *(dict) --* The details of step dependency. * **stepId** *(string) --* The step ID. * **status** *(string) --* The step dependency status. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Paginator / ListQueueFleetAssociations ListQueueFleetAssociations ************************** class DeadlineCloud.Paginator.ListQueueFleetAssociations paginator = client.get_paginator('list_queue_fleet_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "DeadlineCloud.Client.list_queue_fleet_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( farmId='string', queueId='string', fleetId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue-fleet association list. * **queueId** (*string*) -- The queue ID for the queue-fleet association list. * **fleetId** (*string*) -- The fleet ID for the queue-fleet association list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'queueFleetAssociations': [ { 'queueId': 'string', 'fleetId': 'string', 'status': 'ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'|'STOPPED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **queueFleetAssociations** *(list) --* The queue-fleet associations on the list. * *(dict) --* The details of a queue-fleet association. * **queueId** *(string) --* The queue ID. * **fleetId** *(string) --* The fleet ID. * **status** *(string) --* The status of task scheduling in the queue-fleet association. * "ACTIVE"–Association is active. * "STOP_SCHEDULING_AND_COMPLETE_TASKS"–Association has stopped scheduling new tasks and is completing current tasks. * "STOP_SCHEDULING_AND_CANCEL_TASKS"–Association has stopped scheduling new tasks and is canceling current tasks. * "STOPPED"–Association has been stopped. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **NextToken** *(string) --* A token to resume pagination. DeadlineCloud / Client / assume_fleet_role_for_worker assume_fleet_role_for_worker **************************** DeadlineCloud.Client.assume_fleet_role_for_worker(**kwargs) Get credentials from the fleet role for a worker. See also: AWS API Documentation **Request Syntax** response = client.assume_fleet_role_for_worker( farmId='string', fleetId='string', workerId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the fleet's farm. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID that contains the worker. * **workerId** (*string*) -- **[REQUIRED]** The ID of the worker assuming the fleet role. Return type: dict Returns: **Response Syntax** { 'credentials': { 'accessKeyId': 'string', 'secretAccessKey': 'string', 'sessionToken': 'string', 'expiration': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **credentials** *(dict) --* The credentials for the worker. * **accessKeyId** *(string) --* The IAM access key ID. * **secretAccessKey** *(string) --* The IAM secret access key. * **sessionToken** *(string) --* The IAM session token * **expiration** *(datetime) --* The expiration date and time of the IAM credentials. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_limit delete_limit ************ DeadlineCloud.Client.delete_limit(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_limit( farmId='string', limitId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the limit to delete. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_budget get_budget ********** DeadlineCloud.Client.get_budget(**kwargs) Get a budget. See also: AWS API Documentation **Request Syntax** response = client.get_budget( farmId='string', budgetId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm connected to the budget. * **budgetId** (*string*) -- **[REQUIRED]** The budget ID. Return type: dict Returns: **Response Syntax** { 'budgetId': 'string', 'usageTrackingResource': { 'queueId': 'string' }, 'status': 'ACTIVE'|'INACTIVE', 'displayName': 'string', 'description': 'string', 'approximateDollarLimit': ..., 'usages': { 'approximateDollarUsage': ... }, 'actions': [ { 'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', 'thresholdPercentage': ..., 'description': 'string' }, ], 'schedule': { 'fixed': { 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } }, 'createdBy': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'queueStoppedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **budgetId** *(string) --* The budget ID. * **usageTrackingResource** *(dict) --* The resource that the budget is tracking usage for. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "queueId". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **queueId** *(string) --* The queue ID. * **status** *(string) --* The status of the budget. * "ACTIVE"–Get a budget being evaluated. * "INACTIVE"–Get an inactive budget. This can include expired, canceled, or deleted statuses. * **displayName** *(string) --* The display name of the budget. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** *(string) --* The description of the budget. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **approximateDollarLimit** *(float) --* The consumed usage limit for the budget. * **usages** *(dict) --* The usages of the budget. * **approximateDollarUsage** *(float) --* The amount of the budget consumed. * **actions** *(list) --* The budget actions for the budget. * *(dict) --* The details of a budget action. * **type** *(string) --* The action taken on the budget once scheduling stops. * **thresholdPercentage** *(float) --* The percentage threshold for the budget. * **description** *(string) --* The budget action description. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **schedule** *(dict) --* The budget schedule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixed** *(dict) --* The fixed start and end time of the budget's schedule. * **startTime** *(datetime) --* When the budget starts. * **endTime** *(datetime) --* When the budget ends. * **createdBy** *(string) --* The user or system that created this resource. * **createdAt** *(datetime) --* The date and time the resource was created. * **updatedBy** *(string) --* The user or system that updated this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **queueStoppedAt** *(datetime) --* The date and time the queue stopped. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / search_workers search_workers ************** DeadlineCloud.Client.search_workers(**kwargs) Searches for workers. See also: AWS API Documentation **Request Syntax** response = client.search_workers( farmId='string', fleetIds=[ 'string', ], filterExpressions={ 'filters': [ { 'dateTimeFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'dateTime': datetime(2015, 1, 1) }, 'parameterFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'searchTermFilter': { 'searchTerm': 'string', 'matchType': 'FUZZY_MATCH'|'CONTAINS' }, 'stringFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'groupFilter': {'... recursive ...'} }, ], 'operator': 'AND'|'OR' }, sortExpressions=[ { 'userJobsFirst': { 'userIdentityId': 'string' }, 'fieldSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' }, 'parameterSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' } }, ], itemOffset=123, pageSize=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID in the workers search. * **fleetIds** (*list*) -- **[REQUIRED]** The fleet ID of the workers to search for. * *(string) --* * **filterExpressions** (*dict*) -- The filter expression, "AND" or "OR", to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis "()". * **filters** *(list) --* **[REQUIRED]** The filters to use for the search. * *(dict) --* The type of search filter to apply. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dateTimeFilter", "parameterFilter", "searchTermFilter", "stringFilter", "groupFilter". * **dateTimeFilter** *(dict) --* Filters based on date and time. * **name** *(string) --* **[REQUIRED]** The name of the date-time field to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter the results. * **dateTime** *(datetime) --* **[REQUIRED]** The date and time. * **parameterFilter** *(dict) --* Filters by parameter. * **name** *(string) --* **[REQUIRED]** The name of the parameter to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter results. * **value** *(string) --* **[REQUIRED]** The parameter's value. * **searchTermFilter** *(dict) --* Filters by a specified search term. * **searchTerm** *(string) --* **[REQUIRED]** The term to search for. * **matchType** *(string) --* Specifies how Deadline Cloud matches your search term in the results. If you don't specify a "matchType" the default is "FUZZY_MATCH". * "FUZZY_MATCH" - Matches if a portion of the search term is found in the result. * "CONTAINS" - Matches if the exact search term is contained in the result. * **stringFilter** *(dict) --* Filters by a string. * **name** *(string) --* **[REQUIRED]** The field name to search. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use for this search. * **value** *(string) --* **[REQUIRED]** The string to search for. * **groupFilter** *(dict) --* Filters by group. * **operator** *(string) --* **[REQUIRED]** The operators to include in the search. * **sortExpressions** (*list*) -- The search terms for a resource. * *(dict) --* The resources to search. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "userJobsFirst", "fieldSort", "parameterSort". * **userJobsFirst** *(dict) --* Options for sorting a particular user's jobs first. * **userIdentityId** *(string) --* **[REQUIRED]** The user's ID. * **fieldSort** *(dict) --* Options for sorting by a field. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the field. * **name** *(string) --* **[REQUIRED]** The name of the field. * **parameterSort** *(dict) --* Options for sorting by a parameter. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the parameter. * **name** *(string) --* **[REQUIRED]** The parameter name to sort by. * **itemOffset** (*integer*) -- **[REQUIRED]** Defines how far into the scrollable list to start the return of results. * **pageSize** (*integer*) -- Specifies the number of items per page for the resource. Return type: dict Returns: **Response Syntax** { 'workers': [ { 'fleetId': 'string', 'workerId': 'string', 'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE', 'hostProperties': { 'ipAddresses': { 'ipV4Addresses': [ 'string', ], 'ipV6Addresses': [ 'string', ] }, 'hostName': 'string', 'ec2InstanceArn': 'string', 'ec2InstanceType': 'string' }, 'createdBy': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextItemOffset': 123, 'totalResults': 123 } **Response Structure** * *(dict) --* * **workers** *(list) --* The workers for the search. * *(dict) --* The details of a worker search. * **fleetId** *(string) --* The fleet ID. * **workerId** *(string) --* The worker ID. * **status** *(string) --* The status of the worker search. * **hostProperties** *(dict) --* Provides the Amazon EC2 instance properties of the worker host. * **ipAddresses** *(dict) --* The IP address of the host. * **ipV4Addresses** *(list) --* The IpV4 address of the network. * *(string) --* * **ipV6Addresses** *(list) --* The IpV6 address for the network and node component. * *(string) --* * **hostName** *(string) --* The host name. * **ec2InstanceArn** *(string) --* The ARN of the host EC2 instance. * **ec2InstanceType** *(string) --* The instance type of the host EC2 instance. * **createdBy** *(string) --* The user or system that created this resource. * **createdAt** *(datetime) --* The date and time the resource was created. * **updatedBy** *(string) --* The user or system that updated this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **nextItemOffset** *(integer) --* The next incremental starting point after the defined "itemOffset". * **totalResults** *(integer) --* The total number of results in the search. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_paginator get_paginator ************* DeadlineCloud.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. DeadlineCloud / Client / update_queue_fleet_association update_queue_fleet_association ****************************** DeadlineCloud.Client.update_queue_fleet_association(**kwargs) Updates a queue-fleet association. See also: AWS API Documentation **Request Syntax** response = client.update_queue_fleet_association( farmId='string', queueId='string', fleetId='string', status='ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to update. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID to update. * **status** (*string*) -- **[REQUIRED]** The status to update. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_metered_product delete_metered_product ********************** DeadlineCloud.Client.delete_metered_product(**kwargs) Deletes a metered product. See also: AWS API Documentation **Request Syntax** response = client.delete_metered_product( licenseEndpointId='string', productId='string' ) Parameters: * **licenseEndpointId** (*string*) -- **[REQUIRED]** The ID of the license endpoint from which to remove the metered product. * **productId** (*string*) -- **[REQUIRED]** The product ID to remove from the license endpoint. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_fleet_members list_fleet_members ****************** DeadlineCloud.Client.list_fleet_members(**kwargs) Lists fleet members. See also: AWS API Documentation **Request Syntax** response = client.list_fleet_members( farmId='string', fleetId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the fleet. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID to include on the list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'fleetId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The fleet member. * **farmId** *(string) --* The farm ID. * **fleetId** *(string) --* The fleet ID. * **principalId** *(string) --* The principal ID of the fleet member. * **principalType** *(string) --* The principal type of the fleet member. * **identityStoreId** *(string) --* The identity store ID. * **membershipLevel** *(string) --* The fleet member's membership level. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_step update_step *********** DeadlineCloud.Client.update_step(**kwargs) Updates a step. See also: AWS API Documentation **Request Syntax** response = client.update_step( targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', clientToken='string', farmId='string', queueId='string', jobId='string', stepId='string' ) Parameters: * **targetTaskRunStatus** (*string*) -- **[REQUIRED]** The task status to update the step's tasks to. * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to update. * **jobId** (*string*) -- **[REQUIRED]** The job ID to update. * **stepId** (*string*) -- **[REQUIRED]** The step ID to update. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_metered_products list_metered_products ********************* DeadlineCloud.Client.list_metered_products(**kwargs) Lists metered products. See also: AWS API Documentation **Request Syntax** response = client.list_metered_products( licenseEndpointId='string', nextToken='string', maxResults=123 ) Parameters: * **licenseEndpointId** (*string*) -- **[REQUIRED]** The license endpoint ID to include on the list of metered products. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'meteredProducts': [ { 'productId': 'string', 'family': 'string', 'vendor': 'string', 'port': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **meteredProducts** *(list) --* The metered products to list. * *(dict) --* The details of a metered product. * **productId** *(string) --* The product ID. * **family** *(string) --* The family to which the metered product belongs. * **vendor** *(string) --* The vendor. * **port** *(integer) --* The port on which the metered product should run. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_job get_job ******* DeadlineCloud.Client.get_job(**kwargs) Gets a Deadline Cloud job. See also: AWS API Documentation **Request Syntax** response = client.get_job( farmId='string', queueId='string', jobId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm in the job. * **queueId** (*string*) -- **[REQUIRED]** The queue ID associated with the job. * **jobId** (*string*) -- **[REQUIRED]** The job ID. Return type: dict Returns: **Response Syntax** { 'jobId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED', 'lifecycleStatusMessage': 'string', 'priority': 123, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'storageProfileId': 'string', 'maxFailedTasksCount': 123, 'maxRetriesPerTask': 123, 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string' } }, 'attachments': { 'manifests': [ { 'fileSystemLocationName': 'string', 'rootPath': 'string', 'rootPathFormat': 'windows'|'posix', 'outputRelativeDirectories': [ 'string', ], 'inputManifestPath': 'string', 'inputManifestHash': 'string' }, ], 'fileSystem': 'COPIED'|'VIRTUAL' }, 'description': 'string', 'maxWorkerCount': 123, 'sourceJobId': 'string' } **Response Structure** * *(dict) --* * **jobId** *(string) --* The job ID. * **name** *(string) --* The name of the job. * **lifecycleStatus** *(string) --* The life cycle status for the job. * **lifecycleStatusMessage** *(string) --* A message that communicates the status of the life cycle for the job. * **priority** *(integer) --* The job priority. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **taskRunStatus** *(string) --* The task run status for the job. * **targetTaskRunStatus** *(string) --* The task status with which the job started. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the job failed and were retried. * **storageProfileId** *(string) --* The storage profile ID associated with the job. * **maxFailedTasksCount** *(integer) --* The number of task failures before the job stops running and is marked as "FAILED". * **maxRetriesPerTask** *(integer) --* The maximum number of retries per failed tasks. * **parameters** *(dict) --* The parameters for the job. * *(string) --* * *(dict) --* The details of job parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **attachments** *(dict) --* The attachments for the job. * **manifests** *(list) --* A list of manifests which describe job attachment configurations. * *(dict) --* The details of the manifest that links a job's source information. * **fileSystemLocationName** *(string) --* The file system location name. * **rootPath** *(string) --* The file's root path. * **rootPathFormat** *(string) --* The format of the root path. * **outputRelativeDirectories** *(list) --* The file path relative to the directory. * *(string) --* * **inputManifestPath** *(string) --* The file path. * **inputManifestHash** *(string) --* The hash value of the file. * **fileSystem** *(string) --* The file system. * **description** *(string) --* The description of the job. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **maxWorkerCount** *(integer) --* The maximum number of worker hosts that can concurrently process a job. When the "maxWorkerCount" is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers. If you don't set the "maxWorkerCount" when you create a job, this value is not returned in the response. * **sourceJobId** *(string) --* The job ID for the source job. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_task get_task ******** DeadlineCloud.Client.get_task(**kwargs) Gets a task. See also: AWS API Documentation **Request Syntax** response = client.get_task( farmId='string', queueId='string', jobId='string', stepId='string', taskId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm connected to the task. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue connected to the task. * **jobId** (*string*) -- **[REQUIRED]** The job ID of the job connected to the task. * **stepId** (*string*) -- **[REQUIRED]** The step ID for the step connected to the task. * **taskId** (*string*) -- **[REQUIRED]** The task ID. Return type: dict Returns: **Response Syntax** { 'taskId': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'failureRetryCount': 123, 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } }, 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'latestSessionActionId': 'string' } **Response Structure** * *(dict) --* * **taskId** *(string) --* The task ID. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **runStatus** *(string) --* The run status for the task. * **targetRunStatus** *(string) --* The run status with which to start the task. * **failureRetryCount** *(integer) --* The number of times that the task failed and was retried. * **parameters** *(dict) --* The parameters for the task. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **latestSessionActionId** *(string) --* The latest session ID for the task. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_farm create_farm *********** DeadlineCloud.Client.create_farm(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_farm( clientToken='string', displayName='string', description='string', kmsKeyArn='string', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **displayName** (*string*) -- **[REQUIRED]** The display name of the farm. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the farm. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **kmsKeyArn** (*string*) -- The ARN of the KMS key to use on the farm. * **tags** (*dict*) -- The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'farmId': 'string' } **Response Structure** * *(dict) --* * **farmId** *(string) --* The farm ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / delete_queue delete_queue ************ DeadlineCloud.Client.delete_queue(**kwargs) Deletes a queue. Warning: You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue. See also: AWS API Documentation **Request Syntax** response = client.delete_queue( farmId='string', queueId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The ID of the farm from which to remove the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the queue to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_task update_task *********** DeadlineCloud.Client.update_task(**kwargs) Updates a task. See also: AWS API Documentation **Request Syntax** response = client.update_task( clientToken='string', targetRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', farmId='string', queueId='string', jobId='string', stepId='string', taskId='string' ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **targetRunStatus** (*string*) -- **[REQUIRED]** The run status with which to start the task. * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to update. * **jobId** (*string*) -- **[REQUIRED]** The job ID to update. * **stepId** (*string*) -- **[REQUIRED]** The step ID to update. * **taskId** (*string*) -- **[REQUIRED]** The task ID to update. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_license_endpoint get_license_endpoint ******************** DeadlineCloud.Client.get_license_endpoint(**kwargs) Gets a licence endpoint. See also: AWS API Documentation **Request Syntax** response = client.get_license_endpoint( licenseEndpointId='string' ) Parameters: **licenseEndpointId** (*string*) -- **[REQUIRED]** The license endpoint ID. Return type: dict Returns: **Response Syntax** { 'licenseEndpointId': 'string', 'status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'NOT_READY', 'statusMessage': 'string', 'vpcId': 'string', 'dnsName': 'string', 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ] } **Response Structure** * *(dict) --* * **licenseEndpointId** *(string) --* The license endpoint ID. * **status** *(string) --* The status of the license endpoint. * **statusMessage** *(string) --* The status message of the license endpoint. * **vpcId** *(string) --* The VCP(virtual private cloud) ID associated with the license endpoint. * **dnsName** *(string) --* The DNS name. * **subnetIds** *(list) --* The subnet IDs. * *(string) --* * **securityGroupIds** *(list) --* The security group IDs for the license endpoint. * *(string) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / can_paginate can_paginate ************ DeadlineCloud.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. DeadlineCloud / Client / assume_queue_role_for_worker assume_queue_role_for_worker **************************** DeadlineCloud.Client.assume_queue_role_for_worker(**kwargs) Allows a worker to assume a queue role. See also: AWS API Documentation **Request Syntax** response = client.assume_queue_role_for_worker( farmId='string', fleetId='string', workerId='string', queueId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the worker assuming the queue role. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the worker assuming the queue role. * **workerId** (*string*) -- **[REQUIRED]** The worker ID of the worker assuming the queue role. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the worker assuming the queue role. Return type: dict Returns: **Response Syntax** { 'credentials': { 'accessKeyId': 'string', 'secretAccessKey': 'string', 'sessionToken': 'string', 'expiration': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **credentials** *(dict) --* The Amazon Web Services credentials for the role that the worker is assuming. * **accessKeyId** *(string) --* The IAM access key ID. * **secretAccessKey** *(string) --* The IAM secret access key. * **sessionToken** *(string) --* The IAM session token * **expiration** *(datetime) --* The expiration date and time of the IAM credentials. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_queue_limit_association update_queue_limit_association ****************************** DeadlineCloud.Client.update_queue_limit_association(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_queue_limit_association( farmId='string', queueId='string', limitId='string', status='ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the associated queues and limits. * **queueId** (*string*) -- **[REQUIRED]** The unique identifier of the queue associated to the limit. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit associated to the queue. * **status** (*string*) -- **[REQUIRED]** Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_farm delete_farm *********** DeadlineCloud.Client.delete_farm(**kwargs) Deletes a farm. See also: AWS API Documentation **Request Syntax** response = client.delete_farm( farmId='string' ) Parameters: **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_queue_environments list_queue_environments *********************** DeadlineCloud.Client.list_queue_environments(**kwargs) Lists queue environments. See also: AWS API Documentation **Request Syntax** response = client.list_queue_environments( farmId='string', queueId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue environment list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue environment list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'environments': [ { 'queueEnvironmentId': 'string', 'name': 'string', 'priority': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **environments** *(list) --* The environments to include in the queue environments list. * *(dict) --* The summary of a queue environment. * **queueEnvironmentId** *(string) --* The queue environment ID. * **name** *(string) --* The name of the queue environment. * **priority** *(integer) --* The queue environment's priority. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / assume_queue_role_for_read assume_queue_role_for_read ************************** DeadlineCloud.Client.assume_queue_role_for_read(**kwargs) Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access. See also: AWS API Documentation **Request Syntax** response = client.assume_queue_role_for_read( farmId='string', queueId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm containing the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID. Return type: dict Returns: **Response Syntax** { 'credentials': { 'accessKeyId': 'string', 'secretAccessKey': 'string', 'sessionToken': 'string', 'expiration': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **credentials** *(dict) --* The credentials for the queue role. * **accessKeyId** *(string) --* The IAM access key ID. * **secretAccessKey** *(string) --* The IAM secret access key. * **sessionToken** *(string) --* The IAM session token * **expiration** *(datetime) --* The expiration date and time of the IAM credentials. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / associate_member_to_job associate_member_to_job *********************** DeadlineCloud.Client.associate_member_to_job(**kwargs) Assigns a job membership level to a member See also: AWS API Documentation **Request Syntax** response = client.associate_member_to_job( farmId='string', queueId='string', jobId='string', principalId='string', principalType='USER'|'GROUP', identityStoreId='string', membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the job to associate with the member. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to associate to the member. * **jobId** (*string*) -- **[REQUIRED]** The job ID to associate with the member. * **principalId** (*string*) -- **[REQUIRED]** The member's principal ID to associate with the job. * **principalType** (*string*) -- **[REQUIRED]** The member's principal type to associate with the job. * **identityStoreId** (*string*) -- **[REQUIRED]** The member's identity store ID to associate with the job. * **membershipLevel** (*string*) -- **[REQUIRED]** The principal's membership level for the associated job. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / list_jobs list_jobs ********* DeadlineCloud.Client.list_jobs(**kwargs) Lists jobs. See also: AWS API Documentation **Request Syntax** response = client.list_jobs( farmId='string', principalId='string', queueId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the jobs. * **principalId** (*string*) -- The principal ID of the members on the jobs. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the job. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'jobs': [ { 'jobId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED', 'lifecycleStatusMessage': 'string', 'priority': 123, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'maxFailedTasksCount': 123, 'maxRetriesPerTask': 123, 'maxWorkerCount': 123, 'sourceJobId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **jobs** *(list) --* The jobs on the list. * *(dict) --* A summary of job details. * **jobId** *(string) --* The job ID. * **name** *(string) --* The job name. * **lifecycleStatus** *(string) --* The life cycle status. * **lifecycleStatusMessage** *(string) --* The life cycle status message. * **priority** *(integer) --* The job priority. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **taskRunStatus** *(string) --* The task run status for the job. * "PENDING"–pending and waiting for resources. * "READY"–ready to be processed. * "ASSIGNED"–assigned and will run next on a worker. * "SCHEDULED"–scheduled to be run on a worker. * "INTERRUPTING"–being interrupted. * "RUNNING"–running on a worker. * "SUSPENDED"–the task is suspended. * "CANCELED"–the task has been canceled. * "FAILED"–the task has failed. * "SUCCEEDED"–the task has succeeded. * **targetTaskRunStatus** *(string) --* The task status to start with on the job. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the job failed and were retried. * **maxFailedTasksCount** *(integer) --* The number of task failures before the job stops running and is marked as "FAILED". * **maxRetriesPerTask** *(integer) --* The maximum number of retries for a job. * **maxWorkerCount** *(integer) --* The maximum number of worker hosts that can concurrently process a job. When the "maxWorkerCount" is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers. You can't set the "maxWorkerCount" to 0. If you set it to -1, there is no maximum number of workers. If you don't specify the "maxWorkerCount", the default is -1. * **sourceJobId** *(string) --* The job ID for the source job. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_queue_members list_queue_members ****************** DeadlineCloud.Client.list_queue_members(**kwargs) Lists the members in a queue. See also: AWS API Documentation **Request Syntax** response = client.list_queue_members( farmId='string', queueId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'queueId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The details of a queue member. * **farmId** *(string) --* The farm ID. * **queueId** *(string) --* The queue ID. * **principalId** *(string) --* The principal ID of the queue member. * **principalType** *(string) --* The principal type of the queue member. * **identityStoreId** *(string) --* The identity store ID. * **membershipLevel** *(string) --* The queue member's membership level. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_session update_session ************** DeadlineCloud.Client.update_session(**kwargs) Updates a session. See also: AWS API Documentation **Request Syntax** response = client.update_session( clientToken='string', targetLifecycleStatus='ENDED', farmId='string', queueId='string', jobId='string', sessionId='string' ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **targetLifecycleStatus** (*string*) -- **[REQUIRED]** The life cycle status to update in the session. * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update in the session. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to update in the session. * **jobId** (*string*) -- **[REQUIRED]** The job ID to update in the session. * **sessionId** (*string*) -- **[REQUIRED]** The session ID to update. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_step get_step ******** DeadlineCloud.Client.get_step(**kwargs) Gets a step. See also: AWS API Documentation **Request Syntax** response = client.get_step( farmId='string', queueId='string', jobId='string', stepId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the step. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the step. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the step. * **stepId** (*string*) -- **[REQUIRED]** The step ID. Return type: dict Returns: **Response Syntax** { 'stepId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED', 'lifecycleStatusMessage': 'string', 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'dependencyCounts': { 'dependenciesResolved': 123, 'dependenciesUnresolved': 123, 'consumersResolved': 123, 'consumersUnresolved': 123 }, 'requiredCapabilities': { 'attributes': [ { 'name': 'string', 'anyOf': [ 'string', ], 'allOf': [ 'string', ] }, ], 'amounts': [ { 'name': 'string', 'min': 123.0, 'max': 123.0, 'value': 123.0 }, ] }, 'parameterSpace': { 'parameters': [ { 'name': 'string', 'type': 'INT'|'FLOAT'|'STRING'|'PATH'|'CHUNK_INT' }, ], 'combination': 'string' }, 'description': 'string' } **Response Structure** * *(dict) --* * **stepId** *(string) --* The step ID. * **name** *(string) --* The name of the step. * **lifecycleStatus** *(string) --* The life cycle status of the step. * **lifecycleStatusMessage** *(string) --* A message that describes the lifecycle status of the step. * **taskRunStatus** *(string) --* The task run status for the job. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the step failed and were retried. * **targetTaskRunStatus** *(string) --* The task status with which the job started. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **dependencyCounts** *(dict) --* The number of dependencies in the step. * **dependenciesResolved** *(integer) --* The number of resolved dependencies. * **dependenciesUnresolved** *(integer) --* The number of unresolved dependencies. * **consumersResolved** *(integer) --* The number of consumers resolved. * **consumersUnresolved** *(integer) --* The number of unresolved consumers. * **requiredCapabilities** *(dict) --* The required capabilities of the step. * **attributes** *(list) --* The capability attributes that the step requires. * *(dict) --* The list of step attributes. * **name** *(string) --* The name of the step attribute. * **anyOf** *(list) --* Requires any of the step attributes in a given list. * *(string) --* * **allOf** *(list) --* Requires all of the step attribute values. * *(string) --* * **amounts** *(list) --* The capability amounts that the step requires. * *(dict) --* The details outlining the minimum and maximum capability of a step. * **name** *(string) --* The name of the step. * **min** *(float) --* The minimum amount. * **max** *(float) --* The maximum amount. * **value** *(float) --* The amount value. * **parameterSpace** *(dict) --* A list of step parameters and the combination expression for the step. * **parameters** *(list) --* The parameters to search for. * *(dict) --* The details of a step parameter. * **name** *(string) --* The name of the parameter. * **type** *(string) --* The data type of the parameter. * **combination** *(string) --* The combination expression to use in the search. * **description** *(string) --* The description of the step. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_farms list_farms ********** DeadlineCloud.Client.list_farms(**kwargs) Lists farms. See also: AWS API Documentation **Request Syntax** response = client.list_farms( nextToken='string', principalId='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **principalId** (*string*) -- The principal ID of the member to list on the farm. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'farms': [ { 'farmId': 'string', 'displayName': 'string', 'kmsKeyArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. * **farms** *(list) --* Farms on the list. * *(dict) --* The summary of details for a farm. * **farmId** *(string) --* The farm ID. * **displayName** *(string) --* The display name of the farm. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **kmsKeyArn** *(string) --* The ARN for the KMS key. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_license_endpoint delete_license_endpoint *********************** DeadlineCloud.Client.delete_license_endpoint(**kwargs) Deletes a license endpoint. See also: AWS API Documentation **Request Syntax** response = client.delete_license_endpoint( licenseEndpointId='string' ) Parameters: **licenseEndpointId** (*string*) -- **[REQUIRED]** The license endpoint ID of the license endpoint to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_queue_fleet_association get_queue_fleet_association *************************** DeadlineCloud.Client.get_queue_fleet_association(**kwargs) Gets a queue-fleet association. See also: AWS API Documentation **Request Syntax** response = client.get_queue_fleet_association( farmId='string', queueId='string', fleetId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm that contains the queue-fleet association. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue-fleet association. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID for the queue-fleet association. Return type: dict Returns: **Response Syntax** { 'queueId': 'string', 'fleetId': 'string', 'status': 'ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'|'STOPPED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **queueId** *(string) --* The queue ID for the queue-fleet association. * **fleetId** *(string) --* The fleet ID for the queue-fleet association. * **status** *(string) --* The status of the queue-fleet association. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_job_members list_job_members **************** DeadlineCloud.Client.list_job_members(**kwargs) Lists members on a job. See also: AWS API Documentation **Request Syntax** response = client.list_job_members( farmId='string', queueId='string', jobId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the job to list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list. * **jobId** (*string*) -- **[REQUIRED]** The job ID to include on the list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'queueId': 'string', 'jobId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The details for a job member. * **farmId** *(string) --* The farm ID. * **queueId** *(string) --* The queue ID. * **jobId** *(string) --* The job ID. * **principalId** *(string) --* The principal ID of the job member. * **principalType** *(string) --* The principal type of the job member. * **identityStoreId** *(string) --* The identity store ID. * **membershipLevel** *(string) --* The job member's membership level. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_job update_job ********** DeadlineCloud.Client.update_job(**kwargs) Updates a job. When you change the status of the job to "ARCHIVED", the job can't be scheduled or archived. Warning: An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered. See also: AWS API Documentation **Request Syntax** response = client.update_job( clientToken='string', targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', priority=123, maxFailedTasksCount=123, maxRetriesPerTask=123, lifecycleStatus='ARCHIVED', maxWorkerCount=123, farmId='string', queueId='string', jobId='string' ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **targetTaskRunStatus** (*string*) -- The task status to update the job's tasks to. * **priority** (*integer*) -- The job priority to update. * **maxFailedTasksCount** (*integer*) -- The number of task failures before the job stops running and is marked as "FAILED". * **maxRetriesPerTask** (*integer*) -- The maximum number of retries for a job. * **lifecycleStatus** (*string*) -- The status of a job in its lifecycle. When you change the status of the job to "ARCHIVED", the job can't be scheduled or archived. Warning: An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered. * **maxWorkerCount** (*integer*) -- The maximum number of worker hosts that can concurrently process a job. When the "maxWorkerCount" is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers. You can't set the "maxWorkerCount" to 0. If you set it to -1, there is no maximum number of workers. If you don't specify the "maxWorkerCount", the default is -1. The maximum number of workers that can process tasks in the job. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the job to update. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the job to update. * **jobId** (*string*) -- **[REQUIRED]** The job ID to update. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_sessions list_sessions ************* DeadlineCloud.Client.list_sessions(**kwargs) Lists sessions. See also: AWS API Documentation **Request Syntax** response = client.list_sessions( farmId='string', queueId='string', jobId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the list of sessions. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the list of sessions * **jobId** (*string*) -- **[REQUIRED]** The job ID for the list of sessions. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'sessions': [ { 'sessionId': 'string', 'fleetId': 'string', 'workerId': 'string', 'startedAt': datetime(2015, 1, 1), 'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED', 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'targetLifecycleStatus': 'ENDED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **sessions** *(list) --* The sessions on the list. * *(dict) --* The summary of a session. * **sessionId** *(string) --* The session ID. * **fleetId** *(string) --* The fleet ID. * **workerId** *(string) --* The worker ID. * **startedAt** *(datetime) --* The date and time the resource started running. * **lifecycleStatus** *(string) --* The life cycle status for the session. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **targetLifecycleStatus** *(string) --* The target life cycle status for the session. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_monitors list_monitors ************* DeadlineCloud.Client.list_monitors(**kwargs) Gets a list of your monitors in Deadline Cloud. See also: AWS API Documentation **Request Syntax** response = client.list_monitors( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'monitors': [ { 'monitorId': 'string', 'displayName': 'string', 'subdomain': 'string', 'url': 'string', 'roleArn': 'string', 'identityCenterInstanceArn': 'string', 'identityCenterApplicationArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. * **monitors** *(list) --* A list of "MonitorSummary" objects that describe your monitors in the Deadline Cloud. * *(dict) --* Provides information about a monitor in Deadline Cloud. * **monitorId** *(string) --* The unique identifier for the monitor. * **displayName** *(string) --* The name of the monitor that displays on the Deadline Cloud console. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **subdomain** *(string) --* The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. * **url** *(string) --* The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources. * **identityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users. * **identityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created. * **createdAt** *(datetime) --* The UNIX timestamp of the date and time that the monitor was created. * **createdBy** *(string) --* The user name of the person that created the monitor. * **updatedAt** *(datetime) --* The UNIX timestamp of the date and time that the monitor was last updated. * **updatedBy** *(string) --* The user name of the person that last updated the monitor. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_queue_fleet_association create_queue_fleet_association ****************************** DeadlineCloud.Client.create_queue_fleet_association(**kwargs) Creates an association between a queue and a fleet. See also: AWS API Documentation **Request Syntax** response = client.create_queue_fleet_association( farmId='string', queueId='string', fleetId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The ID of the farm that the queue and fleet belong to. * **queueId** (*string*) -- **[REQUIRED]** The queue ID. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / put_metered_product put_metered_product ******************* DeadlineCloud.Client.put_metered_product(**kwargs) Adds a metered product. See also: AWS API Documentation **Request Syntax** response = client.put_metered_product( licenseEndpointId='string', productId='string' ) Parameters: * **licenseEndpointId** (*string*) -- **[REQUIRED]** The license endpoint ID to add to the metered product. * **productId** (*string*) -- **[REQUIRED]** The product ID to add to the metered product. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_license_endpoint create_license_endpoint *********************** DeadlineCloud.Client.create_license_endpoint(**kwargs) Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud. See also: AWS API Documentation **Request Syntax** response = client.create_license_endpoint( clientToken='string', vpcId='string', subnetIds=[ 'string', ], securityGroupIds=[ 'string', ], tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **vpcId** (*string*) -- **[REQUIRED]** The VPC (virtual private cloud) ID to use with the license endpoint. * **subnetIds** (*list*) -- **[REQUIRED]** The subnet IDs. * *(string) --* * **securityGroupIds** (*list*) -- **[REQUIRED]** The security group IDs. * *(string) --* * **tags** (*dict*) -- Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'licenseEndpointId': 'string' } **Response Structure** * *(dict) --* * **licenseEndpointId** *(string) --* The license endpoint ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / list_tags_for_resource list_tags_for_resource ********************** DeadlineCloud.Client.list_tags_for_resource(**kwargs) Lists tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The resource ARN to list tags for. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_farm get_farm ******** DeadlineCloud.Client.get_farm(**kwargs) Get a farm. See also: AWS API Documentation **Request Syntax** response = client.get_farm( farmId='string' ) Parameters: **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm. Return type: dict Returns: **Response Syntax** { 'farmId': 'string', 'displayName': 'string', 'description': 'string', 'kmsKeyArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **farmId** *(string) --* The farm ID of the farm to get. * **displayName** *(string) --* The display name of the farm. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** *(string) --* The description of the farm. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **kmsKeyArn** *(string) --* The ARN of the KMS key used on the farm. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_monitor get_monitor *********** DeadlineCloud.Client.get_monitor(**kwargs) Gets information about the specified monitor. See also: AWS API Documentation **Request Syntax** response = client.get_monitor( monitorId='string' ) Parameters: **monitorId** (*string*) -- **[REQUIRED]** The unique identifier for the monitor. This ID is returned by the "CreateMonitor" operation. Return type: dict Returns: **Response Syntax** { 'monitorId': 'string', 'displayName': 'string', 'subdomain': 'string', 'url': 'string', 'roleArn': 'string', 'identityCenterInstanceArn': 'string', 'identityCenterApplicationArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **monitorId** *(string) --* The unique identifier for the monitor. * **displayName** *(string) --* The name used to identify the monitor on the Deadline Cloud console. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **subdomain** *(string) --* The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. * **url** *(string) --* The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources. * **identityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users. * **identityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created. * **createdAt** *(datetime) --* The UNIX timestamp of the date and time that the monitor was created. * **createdBy** *(string) --* The user name of the person that created the monitor. * **updatedAt** *(datetime) --* The UNIX timestamp of the last date and time that the monitor was updated. * **updatedBy** *(string) --* The user name of the person that last updated the monitor. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / untag_resource untag_resource ************** DeadlineCloud.Client.untag_resource(**kwargs) Removes a tag from a resource using the resource's ARN and tag to remove. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource to remove the tag from. * **tagKeys** (*list*) -- **[REQUIRED]** They keys of the tag. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_session_action get_session_action ****************** DeadlineCloud.Client.get_session_action(**kwargs) Gets a session action for the job. See also: AWS API Documentation **Request Syntax** response = client.get_session_action( farmId='string', queueId='string', jobId='string', sessionActionId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the session action. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the session action. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the session. * **sessionActionId** (*string*) -- **[REQUIRED]** The session action ID for the session. Return type: dict Returns: **Response Syntax** { 'sessionActionId': 'string', 'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'workerUpdatedAt': datetime(2015, 1, 1), 'progressPercent': ..., 'sessionId': 'string', 'processExitCode': 123, 'progressMessage': 'string', 'definition': { 'envEnter': { 'environmentId': 'string' }, 'envExit': { 'environmentId': 'string' }, 'taskRun': { 'taskId': 'string', 'stepId': 'string', 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } } }, 'syncInputJobAttachments': { 'stepId': 'string' } }, 'acquiredLimits': [ { 'limitId': 'string', 'count': 123 }, ], 'manifests': [ { 'outputManifestPath': 'string', 'outputManifestHash': 'string' }, ] } **Response Structure** * *(dict) --* * **sessionActionId** *(string) --* The session action ID. * **status** *(string) --* The status of the session action. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **workerUpdatedAt** *(datetime) --* The Linux timestamp of the date and time the session action was last updated. * **progressPercent** *(float) --* The percentage completed for a session action. * **sessionId** *(string) --* The session ID for the session action. * **processExitCode** *(integer) --* The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes. * **progressMessage** *(string) --* The message that communicates the progress of the session action. * **definition** *(dict) --* The session action definition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "envEnter", "envExit", "taskRun", "syncInputJobAttachments". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **envEnter** *(dict) --* The environment to enter into. * **environmentId** *(string) --* The environment ID. * **envExit** *(dict) --* The environment to exit from. * **environmentId** *(string) --* The environment ID. * **taskRun** *(dict) --* The task run in the session. * **taskId** *(string) --* The task ID. * **stepId** *(string) --* The step ID. * **parameters** *(dict) --* The task parameters. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **syncInputJobAttachments** *(dict) --* The job attachments to sync with a session action. * **stepId** *(string) --* The step ID for the step in the job attachment. * **acquiredLimits** *(list) --* The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned. * *(dict) --* Provides information about the number of resources used. * **limitId** *(string) --* The unique identifier of the limit. * **count** *(integer) --* The number of limit resources used. * **manifests** *(list) --* The list of manifest properties that describe file attachments for the task run. * *(dict) --* The manifest properties for a task run, corresponding to the manifest properties in the job. * **outputManifestPath** *(string) --* The manifest file path. * **outputManifestHash** *(string) --* The hash value of the file. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_queue_environment delete_queue_environment ************************ DeadlineCloud.Client.delete_queue_environment(**kwargs) Deletes a queue environment. See also: AWS API Documentation **Request Syntax** response = client.delete_queue_environment( farmId='string', queueId='string', queueEnvironmentId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm from which to remove the queue environment. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the queue environment to delete. * **queueEnvironmentId** (*string*) -- **[REQUIRED]** The queue environment ID of the queue environment to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_workers list_workers ************ DeadlineCloud.Client.list_workers(**kwargs) Lists workers. See also: AWS API Documentation **Request Syntax** response = client.list_workers( farmId='string', fleetId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID connected to the workers. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the workers. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'workers': [ { 'workerId': 'string', 'farmId': 'string', 'fleetId': 'string', 'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE', 'hostProperties': { 'ipAddresses': { 'ipV4Addresses': [ 'string', ], 'ipV6Addresses': [ 'string', ] }, 'hostName': 'string', 'ec2InstanceArn': 'string', 'ec2InstanceType': 'string' }, 'log': { 'logDriver': 'string', 'options': { 'string': 'string' }, 'parameters': { 'string': 'string' }, 'error': 'string' }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. * **workers** *(list) --* The workers on the list. * *(dict) --* The summary of details for a worker. * **workerId** *(string) --* The worker ID. * **farmId** *(string) --* The farm ID. * **fleetId** *(string) --* The fleet ID. * **status** *(string) --* The status of the worker. * **hostProperties** *(dict) --* The host properties of the worker. * **ipAddresses** *(dict) --* The IP address of the host. * **ipV4Addresses** *(list) --* The IpV4 address of the network. * *(string) --* * **ipV6Addresses** *(list) --* The IpV6 address for the network and node component. * *(string) --* * **hostName** *(string) --* The host name. * **ec2InstanceArn** *(string) --* The ARN of the host EC2 instance. * **ec2InstanceType** *(string) --* The instance type of the host EC2 instance. * **log** *(dict) --* The log configuration for the worker. * **logDriver** *(string) --* The log drivers for worker related logs. * **options** *(dict) --* The options for a log driver. * *(string) --* * *(string) --* * **parameters** *(dict) --* The parameters for the log configuration. * *(string) --* * *(string) --* * **error** *(string) --* The log configuration error details. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_farm_members list_farm_members ***************** DeadlineCloud.Client.list_farm_members(**kwargs) Lists the members of a farm. See also: AWS API Documentation **Request Syntax** response = client.list_farm_members( farmId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'members': [ { 'farmId': 'string', 'principalId': 'string', 'principalType': 'USER'|'GROUP', 'identityStoreId': 'string', 'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members on the list. * *(dict) --* The member of a farm. * **farmId** *(string) --* The farm ID of the farm member. * **principalId** *(string) --* The principal ID of the farm member. * **principalType** *(string) --* The principal type of the farm member. * **identityStoreId** *(string) --* The identity store ID of the farm member. * **membershipLevel** *(string) --* The farm member's membership level. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / batch_get_job_entity batch_get_job_entity ******************** DeadlineCloud.Client.batch_get_job_entity(**kwargs) Get batched job details for a worker. See also: AWS API Documentation **Request Syntax** response = client.batch_get_job_entity( farmId='string', fleetId='string', workerId='string', identifiers=[ { 'jobDetails': { 'jobId': 'string' }, 'jobAttachmentDetails': { 'jobId': 'string' }, 'stepDetails': { 'jobId': 'string', 'stepId': 'string' }, 'environmentDetails': { 'jobId': 'string', 'environmentId': 'string' } }, ] ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details. * **workerId** (*string*) -- **[REQUIRED]** The worker ID of the worker containing the job details to get. * **identifiers** (*list*) -- **[REQUIRED]** The job identifiers to include within the job entity batch details. * *(dict) --* The details of a job entity identifier. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "jobDetails", "jobAttachmentDetails", "stepDetails", "environmentDetails". * **jobDetails** *(dict) --* The job details. * **jobId** *(string) --* **[REQUIRED]** The job ID. * **jobAttachmentDetails** *(dict) --* The job attachment details. * **jobId** *(string) --* **[REQUIRED]** The job ID. * **stepDetails** *(dict) --* The step details. * **jobId** *(string) --* **[REQUIRED]** The job ID. * **stepId** *(string) --* **[REQUIRED]** The step ID. * **environmentDetails** *(dict) --* The environment details. * **jobId** *(string) --* **[REQUIRED]** The job ID. * **environmentId** *(string) --* **[REQUIRED]** The environment ID. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'jobDetails': { 'jobId': 'string', 'jobAttachmentSettings': { 's3BucketName': 'string', 'rootPrefix': 'string' }, 'jobRunAsUser': { 'posix': { 'user': 'string', 'group': 'string' }, 'windows': { 'user': 'string', 'passwordArn': 'string' }, 'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER' }, 'logGroupName': 'string', 'queueRoleArn': 'string', 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string' } }, 'schemaVersion': 'string', 'pathMappingRules': [ { 'sourcePathFormat': 'windows'|'posix', 'sourcePath': 'string', 'destinationPath': 'string' }, ] }, 'jobAttachmentDetails': { 'jobId': 'string', 'attachments': { 'manifests': [ { 'fileSystemLocationName': 'string', 'rootPath': 'string', 'rootPathFormat': 'windows'|'posix', 'outputRelativeDirectories': [ 'string', ], 'inputManifestPath': 'string', 'inputManifestHash': 'string' }, ], 'fileSystem': 'COPIED'|'VIRTUAL' } }, 'stepDetails': { 'jobId': 'string', 'stepId': 'string', 'schemaVersion': 'string', 'template': {...}|[...]|123|123.4|'string'|True|None, 'dependencies': [ 'string', ] }, 'environmentDetails': { 'jobId': 'string', 'environmentId': 'string', 'schemaVersion': 'string', 'template': {...}|[...]|123|123.4|'string'|True|None } }, ], 'errors': [ { 'jobDetails': { 'jobId': 'string', 'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException', 'message': 'string' }, 'jobAttachmentDetails': { 'jobId': 'string', 'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException', 'message': 'string' }, 'stepDetails': { 'jobId': 'string', 'stepId': 'string', 'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException', 'message': 'string' }, 'environmentDetails': { 'jobId': 'string', 'environmentId': 'string', 'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException', 'message': 'string' } }, ] } **Response Structure** * *(dict) --* * **entities** *(list) --* A list of the job entities, or details, in the batch. * *(dict) --* The details of a job entity. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "jobDetails", "jobAttachmentDetails", "stepDetails", "environmentDetails". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **jobDetails** *(dict) --* The job details. * **jobId** *(string) --* The job ID. * **jobAttachmentSettings** *(dict) --* The job attachment settings. * **s3BucketName** *(string) --* The Amazon S3 bucket name. * **rootPrefix** *(string) --* The root prefix. * **jobRunAsUser** *(dict) --* The user name and group that the job uses when run. * **posix** *(dict) --* The user and group that the jobs in the queue run as. * **user** *(string) --* The name of the POSIX user. * **group** *(string) --* The name of the POSIX user's group. * **windows** *(dict) --* Identifies a Microsoft Windows user. * **user** *(string) --* The user. * **passwordArn** *(string) --* The password ARN for the Windows user. * **runAs** *(string) --* Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user. * **logGroupName** *(string) --* The log group name. * **queueRoleArn** *(string) --* The queue role ARN. * **parameters** *(dict) --* The parameters. * *(string) --* * *(dict) --* The details of job parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **schemaVersion** *(string) --* The schema version. * **pathMappingRules** *(list) --* The path mapping rules. * *(dict) --* The details of a source and destination path. * **sourcePathFormat** *(string) --* The source path format. * **sourcePath** *(string) --* The source path. * **destinationPath** *(string) --* The destination path. * **jobAttachmentDetails** *(dict) --* The job attachment details. * **jobId** *(string) --* The job ID. * **attachments** *(dict) --* The job attachments. * **manifests** *(list) --* A list of manifests which describe job attachment configurations. * *(dict) --* The details of the manifest that links a job's source information. * **fileSystemLocationName** *(string) --* The file system location name. * **rootPath** *(string) --* The file's root path. * **rootPathFormat** *(string) --* The format of the root path. * **outputRelativeDirectories** *(list) --* The file path relative to the directory. * *(string) --* * **inputManifestPath** *(string) --* The file path. * **inputManifestHash** *(string) --* The hash value of the file. * **fileSystem** *(string) --* The file system. * **stepDetails** *(dict) --* The step details. * **jobId** *(string) --* The job ID. * **stepId** *(string) --* The step ID. * **schemaVersion** *(string) --* The schema version for a step template. * **template** (*document*) -- The template for a step. * **dependencies** *(list) --* The dependencies for a step. * *(string) --* * **environmentDetails** *(dict) --* The environment details for the job entity. * **jobId** *(string) --* The job ID. * **environmentId** *(string) --* The environment ID. * **schemaVersion** *(string) --* The schema version in the environment. * **template** (*document*) -- The template used for the environment. * **errors** *(list) --* A list of errors from the job error logs for the batch. * *(dict) --* The error for the job entity. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "jobDetails", "jobAttachmentDetails", "stepDetails", "environmentDetails". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **jobDetails** *(dict) --* The job details for the failed job entity. * **jobId** *(string) --* The job ID. * **code** *(string) --* The error code. * **message** *(string) --* The error message detailing the error's cause. * **jobAttachmentDetails** *(dict) --* The job attachment details for the failed job entity. * **jobId** *(string) --* The job ID. * **code** *(string) --* The error code. * **message** *(string) --* The error message detailing the error's cause. * **stepDetails** *(dict) --* The step details for the failed job entity. * **jobId** *(string) --* The job ID. * **stepId** *(string) --* The step ID. * **code** *(string) --* The error code. * **message** *(string) --* The error message detailing the error's cause. * **environmentDetails** *(dict) --* The environment details for the failed job entity. * **jobId** *(string) --* The job ID. * **environmentId** *(string) --* The environment ID. * **code** *(string) --* The error code. * **message** *(string) --* The error message detailing the error's cause. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_fleet delete_fleet ************ DeadlineCloud.Client.delete_fleet(**kwargs) Deletes a fleet. See also: AWS API Documentation **Request Syntax** response = client.delete_fleet( clientToken='string', farmId='string', fleetId='string' ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to remove from the fleet. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the fleet to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_waiter get_waiter ********** DeadlineCloud.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" DeadlineCloud / Client / get_queue_limit_association get_queue_limit_association *************************** DeadlineCloud.Client.get_queue_limit_association(**kwargs) Gets information about a specific association between a queue and a limit. See also: AWS API Documentation **Request Syntax** response = client.get_queue_limit_association( farmId='string', queueId='string', limitId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the associated queue and limit. * **queueId** (*string*) -- **[REQUIRED]** The unique identifier of the queue associated with the limit. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit associated with the queue. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'queueId': 'string', 'limitId': 'string', 'status': 'ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'|'STOPPED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The Unix timestamp of the date and time that the association was created. * **createdBy** *(string) --* The user identifier of the person that created the association. * **updatedAt** *(datetime) --* The Unix timestamp of the date and time that the association was last updated. * **updatedBy** *(string) --* The user identifier of the person that last updated the association. * **queueId** *(string) --* The unique identifier of the queue associated with the limit. * **limitId** *(string) --* The unique identifier of the limit associated with the queue. * **status** *(string) --* The current status of the limit. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / disassociate_member_from_farm disassociate_member_from_farm ***************************** DeadlineCloud.Client.disassociate_member_from_farm(**kwargs) Disassociates a member from a farm. See also: AWS API Documentation **Request Syntax** response = client.disassociate_member_from_farm( farmId='string', principalId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to disassociate from the member. * **principalId** (*string*) -- **[REQUIRED]** A member's principal ID to disassociate from a farm. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_queue_limit_association create_queue_limit_association ****************************** DeadlineCloud.Client.create_queue_limit_association(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_queue_limit_association( farmId='string', queueId='string', limitId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the queue and limit to associate. * **queueId** (*string*) -- **[REQUIRED]** The unique identifier of the queue to associate with the limit. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit to associate with the queue. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_farm update_farm *********** DeadlineCloud.Client.update_farm(**kwargs) Updates a farm. See also: AWS API Documentation **Request Syntax** response = client.update_farm( farmId='string', displayName='string', description='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **displayName** (*string*) -- The display name of the farm to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the farm to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_queue_environment get_queue_environment ********************* DeadlineCloud.Client.get_queue_environment(**kwargs) Gets a queue environment. See also: AWS API Documentation **Request Syntax** response = client.get_queue_environment( farmId='string', queueId='string', queueEnvironmentId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue environment. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue environment. * **queueEnvironmentId** (*string*) -- **[REQUIRED]** The queue environment ID. Return type: dict Returns: **Response Syntax** { 'queueEnvironmentId': 'string', 'name': 'string', 'priority': 123, 'templateType': 'JSON'|'YAML', 'template': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **queueEnvironmentId** *(string) --* The queue environment ID. * **name** *(string) --* The name of the queue environment. * **priority** *(integer) --* The priority of the queue environment. * **templateType** *(string) --* The type of template for the queue environment. * **template** *(string) --* The template for the queue environment. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource.> * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_queue_limit_associations list_queue_limit_associations ***************************** DeadlineCloud.Client.list_queue_limit_associations(**kwargs) Gets a list of the associations between queues and limits defined in a farm. See also: AWS API Documentation **Request Syntax** response = client.list_queue_limit_associations( farmId='string', queueId='string', limitId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the limits and associations. * **queueId** (*string*) -- Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the "queueId" and the "limitId", only the specified limit is returned if it exists. * **limitId** (*string*) -- Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the "queueId" and the "limitId", only the specified limit is returned if it exists. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of associations to return in each page of results. Return type: dict Returns: **Response Syntax** { 'queueLimitAssociations': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'queueId': 'string', 'limitId': 'string', 'status': 'ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'|'STOPPED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **queueLimitAssociations** *(list) --* A list of associations between limits and queues in the farm specified in the request. * *(dict) --* Provides information about the association between a queue and a limit. * **createdAt** *(datetime) --* The Unix timestamp of the date and time that the association was created. * **createdBy** *(string) --* The user identifier of the person that created the association. * **updatedAt** *(datetime) --* The Unix timestamp of the date and time that the association was last updated. * **updatedBy** *(string) --* The user identifier of the person that updated the association. * **queueId** *(string) --* The unique identifier of the queue in the association. * **limitId** *(string) --* The unique identifier of the limit in the association. * **status** *(string) --* The status of task scheduling in the queue-limit association. * "ACTIVE" - Association is active. * "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS" - Association has stopped scheduling new tasks and is completing current tasks. * "STOP_LIMIT_USAGE_AND_CANCEL_TASKS" - Association has stopped scheduling new tasks and is canceling current tasks. * "STOPPED" - Association has been stopped. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" DeadlineCloud / Client / get_storage_profile_for_queue get_storage_profile_for_queue ***************************** DeadlineCloud.Client.get_storage_profile_for_queue(**kwargs) Gets a storage profile for a queue. See also: AWS API Documentation **Request Syntax** response = client.get_storage_profile_for_queue( farmId='string', queueId='string', storageProfileId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue in storage profile. * **queueId** (*string*) -- **[REQUIRED]** The queue ID the queue in the storage profile. * **storageProfileId** (*string*) -- **[REQUIRED]** The storage profile ID for the storage profile in the queue. Return type: dict Returns: **Response Syntax** { 'storageProfileId': 'string', 'displayName': 'string', 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'fileSystemLocations': [ { 'name': 'string', 'path': 'string', 'type': 'SHARED'|'LOCAL' }, ] } **Response Structure** * *(dict) --* * **storageProfileId** *(string) --* The storage profile ID. * **displayName** *(string) --* The display name of the storage profile connected to a queue. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** *(string) --* The operating system of the storage profile in the queue. * **fileSystemLocations** *(list) --* The location of the files for the storage profile within the queue. * *(dict) --* The details of the file system location for the resource. * **name** *(string) --* The location name. * **path** *(string) --* The file path. * **type** *(string) --* The type of file. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_worker get_worker ********** DeadlineCloud.Client.get_worker(**kwargs) Gets a worker. See also: AWS API Documentation **Request Syntax** response = client.get_worker( farmId='string', fleetId='string', workerId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the worker. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the worker. * **workerId** (*string*) -- **[REQUIRED]** The worker ID. Return type: dict Returns: **Response Syntax** { 'farmId': 'string', 'fleetId': 'string', 'workerId': 'string', 'hostProperties': { 'ipAddresses': { 'ipV4Addresses': [ 'string', ], 'ipV6Addresses': [ 'string', ] }, 'hostName': 'string', 'ec2InstanceArn': 'string', 'ec2InstanceType': 'string' }, 'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE', 'log': { 'logDriver': 'string', 'options': { 'string': 'string' }, 'parameters': { 'string': 'string' }, 'error': 'string' }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **farmId** *(string) --* The farm ID. * **fleetId** *(string) --* The fleet ID. * **workerId** *(string) --* The worker ID. * **hostProperties** *(dict) --* The host properties for the worker. * **ipAddresses** *(dict) --* The IP address of the host. * **ipV4Addresses** *(list) --* The IpV4 address of the network. * *(string) --* * **ipV6Addresses** *(list) --* The IpV6 address for the network and node component. * *(string) --* * **hostName** *(string) --* The host name. * **ec2InstanceArn** *(string) --* The ARN of the host EC2 instance. * **ec2InstanceType** *(string) --* The instance type of the host EC2 instance. * **status** *(string) --* The status of the worker. * **log** *(dict) --* The logs for the associated worker. * **logDriver** *(string) --* The log drivers for worker related logs. * **options** *(dict) --* The options for a log driver. * *(string) --* * *(string) --* * **parameters** *(dict) --* The parameters for the log configuration. * *(string) --* * *(string) --* * **error** *(string) --* The log configuration error details. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_fleets list_fleets *********** DeadlineCloud.Client.list_fleets(**kwargs) Lists fleets. See also: AWS API Documentation **Request Syntax** response = client.list_fleets( farmId='string', principalId='string', displayName='string', status='ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the fleets. * **principalId** (*string*) -- The principal ID of the members to include in the fleet. * **displayName** (*string*) -- The display names of a list of fleets. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** (*string*) -- The status of the fleet. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'fleets': [ { 'fleetId': 'string', 'farmId': 'string', 'displayName': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED', 'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING', 'targetWorkerCount': 123, 'workerCount': 123, 'minWorkerCount': 123, 'maxWorkerCount': 123, 'configuration': { 'customerManaged': { 'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING', 'workerCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'acceleratorTypes': [ 'gpu', ], 'acceleratorCount': { 'min': 123, 'max': 123 }, 'acceleratorTotalMemoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'cpuArchitectureType': 'x86_64'|'arm64', 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'storageProfileId': 'string', 'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH' }, 'serviceManagedEc2': { 'instanceCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX', 'cpuArchitectureType': 'x86_64'|'arm64', 'rootEbsVolume': { 'sizeGiB': 123, 'iops': 123, 'throughputMiB': 123 }, 'acceleratorCapabilities': { 'selections': [ { 'name': 't4'|'a10g'|'l4'|'l40s', 'runtime': 'string' }, ], 'count': { 'min': 123, 'max': 123 } }, 'allowedInstanceTypes': [ 'string', ], 'excludedInstanceTypes': [ 'string', ], 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'instanceMarketOptions': { 'type': 'on-demand'|'spot' }, 'vpcConfiguration': { 'resourceConfigurationArns': [ 'string', ] }, 'storageProfileId': 'string' } }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **fleets** *(list) --* The fleets on the list. * *(dict) --* The details of a fleet. * **fleetId** *(string) --* The fleet ID. * **farmId** *(string) --* The farm ID. * **displayName** *(string) --* The display name of the fleet summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** *(string) --* The status of the fleet. * **autoScalingStatus** *(string) --* The Auto Scaling status of a fleet. * **targetWorkerCount** *(integer) --* The target number of workers in a fleet. * **workerCount** *(integer) --* The number of workers in the fleet summary. * **minWorkerCount** *(integer) --* The minimum number of workers in the fleet. * **maxWorkerCount** *(integer) --* The maximum number of workers specified in the fleet. * **configuration** *(dict) --* The configuration details for the fleet. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "customerManaged", "serviceManagedEc2". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **customerManaged** *(dict) --* The customer managed fleets within a fleet configuration. * **mode** *(string) --* The Auto Scaling mode for the customer managed fleet configuration. * **workerCapabilities** *(dict) --* The worker capabilities for a customer managed fleet configuration. * **vCpuCount** *(dict) --* The vCPU count for the customer manged worker capabilities. * **min** *(integer) --* The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* The memory (MiB). * **min** *(integer) --* The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **acceleratorTypes** *(list) --* The accelerator types for the customer managed worker capabilities. * *(string) --* * **acceleratorCount** *(dict) --* The range of the accelerator. * **min** *(integer) --* The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **acceleratorTotalMemoryMiB** *(dict) --* The total memory (MiB) for the customer managed worker capabilities. * **min** *(integer) --* The minimum amount of memory to use for the accelerator, measured in MiB. * **max** *(integer) --* The maximum amount of memory to use for the accelerator, measured in MiB. * **osFamily** *(string) --* The operating system (OS) family. * **cpuArchitectureType** *(string) --* The CPU architecture type for the customer managed worker capabilities. * **customAmounts** *(list) --* Custom requirement ranges for customer managed worker capabilities. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* The name of the fleet capability. * **min** *(float) --* The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* Custom attributes for the customer manged worker capabilities. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* The name of the fleet attribute capability for the worker. * **values** *(list) --* The number of fleet attribute capabilities. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **tagPropagationMode** *(string) --* Specifies whether tags associated with a fleet are attached to workers when the worker is launched. When the "tagPropagationMode" is set to "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers **do not** change. If you don't specify "tagPropagationMode", the default is "NO_PROPAGATION". * **serviceManagedEc2** *(dict) --* The service managed Amazon EC2 instances for a fleet configuration. * **instanceCapabilities** *(dict) --* The Amazon EC2 instance capabilities. * **vCpuCount** *(dict) --* The amount of vCPU to require for instances in this fleet. * **min** *(integer) --* The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* The memory, as MiB, for the Amazon EC2 instance type. * **min** *(integer) --* The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **osFamily** *(string) --* The operating system (OS) family. * **cpuArchitectureType** *(string) --* The CPU architecture type. * **rootEbsVolume** *(dict) --* The root EBS volume. * **sizeGiB** *(integer) --* The EBS volume size in GiB. * **iops** *(integer) --* The IOPS per volume. * **throughputMiB** *(integer) --* The throughput per volume in MiB. * **acceleratorCapabilities** *(dict) --* Describes the GPU accelerator capabilities required for worker host instances in this fleet. * **selections** *(list) --* A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed. * *(dict) --* Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host. * **name** *(string) --* The name of the chip used by the GPU accelerator. If you specify "l4" as the name of the accelerator, you must specify "latest" or "grid:r570" as the runtime. The available GPU accelerators are: * "t4" - NVIDIA T4 Tensor Core GPU * "a10g" - NVIDIA A10G Tensor Core GPU * "l4" - NVIDIA L4 Tensor Core GPU * "l40s" - NVIDIA L40S Tensor Core GPU * **runtime** *(string) --* Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs. You can choose from the following runtimes: * "latest" - Use the latest runtime available for the chip. If you specify "latest" and a new version of the runtime is released, the new version of the runtime is used. * "grid:r570" - NVIDIA vGPU software 18 * "grid:r535" - NVIDIA vGPU software 16 If you don't specify a runtime, Deadline Cloud uses "latest" as the default. However, if you have multiple accelerators and specify "latest" for some and leave others blank, Deadline Cloud raises an exception. * **count** *(dict) --* The number of GPU accelerators specified for worker hosts in this fleet. * **min** *(integer) --* The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **allowedInstanceTypes** *(list) --* The allowable Amazon EC2 instance types. * *(string) --* * **excludedInstanceTypes** *(list) --* The instance types to exclude from the fleet. * *(string) --* * **customAmounts** *(list) --* The custom capability amounts to require for instances in this fleet. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* The name of the fleet capability. * **min** *(float) --* The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* The custom capability attributes to require for instances in this fleet. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* The name of the fleet attribute capability for the worker. * **values** *(list) --* The number of fleet attribute capabilities. * *(string) --* * **instanceMarketOptions** *(dict) --* The Amazon EC2 market type. * **type** *(string) --* The Amazon EC2 instance type. * **vpcConfiguration** *(dict) --* The VPC configuration details for a service managed Amazon EC2 fleet. * **resourceConfigurationArns** *(list) --* The ARNs of the VPC Lattice resource configurations attached to the fleet. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_queue update_queue ************ DeadlineCloud.Client.update_queue(**kwargs) Updates a queue. See also: AWS API Documentation **Request Syntax** response = client.update_queue( clientToken='string', farmId='string', queueId='string', displayName='string', description='string', defaultBudgetAction='NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', jobAttachmentSettings={ 's3BucketName': 'string', 'rootPrefix': 'string' }, roleArn='string', jobRunAsUser={ 'posix': { 'user': 'string', 'group': 'string' }, 'windows': { 'user': 'string', 'passwordArn': 'string' }, 'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER' }, requiredFileSystemLocationNamesToAdd=[ 'string', ], requiredFileSystemLocationNamesToRemove=[ 'string', ], allowedStorageProfileIdsToAdd=[ 'string', ], allowedStorageProfileIdsToRemove=[ 'string', ] ) Parameters: * **clientToken** (*string*) -- The idempotency token to update in the queue. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update in the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to update. * **displayName** (*string*) -- The display name of the queue to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the queue to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **defaultBudgetAction** (*string*) -- The default action to take for a queue update if a budget isn't configured. * **jobAttachmentSettings** (*dict*) -- The job attachment settings to update for the queue. * **s3BucketName** *(string) --* **[REQUIRED]** The Amazon S3 bucket name. * **rootPrefix** *(string) --* **[REQUIRED]** The root prefix. * **roleArn** (*string*) -- The IAM role ARN that's used to run jobs from this queue. * **jobRunAsUser** (*dict*) -- Update the jobs in the queue to run as a specified POSIX user. * **posix** *(dict) --* The user and group that the jobs in the queue run as. * **user** *(string) --* **[REQUIRED]** The name of the POSIX user. * **group** *(string) --* **[REQUIRED]** The name of the POSIX user's group. * **windows** *(dict) --* Identifies a Microsoft Windows user. * **user** *(string) --* **[REQUIRED]** The user. * **passwordArn** *(string) --* **[REQUIRED]** The password ARN for the Windows user. * **runAs** *(string) --* **[REQUIRED]** Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user. * **requiredFileSystemLocationNamesToAdd** (*list*) -- The required file system location names to add to the queue. * *(string) --* * **requiredFileSystemLocationNamesToRemove** (*list*) -- The required file system location names to remove from the queue. * *(string) --* * **allowedStorageProfileIdsToAdd** (*list*) -- The storage profile IDs to add. * *(string) --* * **allowedStorageProfileIdsToRemove** (*list*) -- The storage profile ID to remove. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_budget update_budget ************* DeadlineCloud.Client.update_budget(**kwargs) Updates a budget that sets spending thresholds for rendering activity. See also: AWS API Documentation **Request Syntax** response = client.update_budget( clientToken='string', farmId='string', budgetId='string', displayName='string', description='string', status='ACTIVE'|'INACTIVE', approximateDollarLimit=..., actionsToAdd=[ { 'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', 'thresholdPercentage': ..., 'description': 'string' }, ], actionsToRemove=[ { 'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', 'thresholdPercentage': ... }, ], schedule={ 'fixed': { 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the budget to update. * **budgetId** (*string*) -- **[REQUIRED]** The budget ID to update. * **displayName** (*string*) -- The display name of the budget to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the budget to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** (*string*) -- Updates the status of the budget. * "ACTIVE"–The budget is being evaluated. * "INACTIVE"–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses. * **approximateDollarLimit** (*float*) -- The dollar limit to update on the budget. Based on consumed usage. * **actionsToAdd** (*list*) -- The budget actions to add. Budget actions specify what happens when the budget runs out. * *(dict) --* The budget action to add. * **type** *(string) --* **[REQUIRED]** The type of budget action to add. * **thresholdPercentage** *(float) --* **[REQUIRED]** The percentage threshold for the budget action to add. * **description** *(string) --* A description for the budget action to add. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **actionsToRemove** (*list*) -- The budget actions to remove from the budget. * *(dict) --* The budget action to remove. * **type** *(string) --* **[REQUIRED]** The type of budget action to remove. * **thresholdPercentage** *(float) --* **[REQUIRED]** The percentage threshold for the budget action to remove. * **schedule** (*dict*) -- The schedule to update. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed". * **fixed** *(dict) --* The fixed start and end time of the budget's schedule. * **startTime** *(datetime) --* **[REQUIRED]** When the budget starts. * **endTime** *(datetime) --* **[REQUIRED]** When the budget ends. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_budgets list_budgets ************ DeadlineCloud.Client.list_budgets(**kwargs) A list of budgets in a farm. See also: AWS API Documentation **Request Syntax** response = client.list_budgets( nextToken='string', farmId='string', maxResults=123, status='ACTIVE'|'INACTIVE' ) Parameters: * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **farmId** (*string*) -- **[REQUIRED]** The farm ID associated with the budgets. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. * **status** (*string*) -- The status to list for the budgets. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'budgets': [ { 'budgetId': 'string', 'usageTrackingResource': { 'queueId': 'string' }, 'status': 'ACTIVE'|'INACTIVE', 'displayName': 'string', 'description': 'string', 'approximateDollarLimit': ..., 'usages': { 'approximateDollarUsage': ... }, 'createdBy': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'updatedAt': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. * **budgets** *(list) --* The budgets to include on the list. * *(dict) --* The budget summary. * **budgetId** *(string) --* The budget ID. * **usageTrackingResource** *(dict) --* The resource used to track expenditure in the budget. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "queueId". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **queueId** *(string) --* The queue ID. * **status** *(string) --* The status of the budget. * "ACTIVE"–The budget is being evaluated. * "INACTIVE"–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses. * **displayName** *(string) --* The display name of the budget summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** *(string) --* The description of the budget summary. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **approximateDollarLimit** *(float) --* The approximate dollar limit of the budget. * **usages** *(dict) --* The consumed usage for the budget. * **approximateDollarUsage** *(float) --* The amount of the budget consumed. * **createdBy** *(string) --* The user or system that created this resource. * **createdAt** *(datetime) --* The date and time the resource was created. * **updatedBy** *(string) --* The user or system that updated this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / search_jobs search_jobs *********** DeadlineCloud.Client.search_jobs(**kwargs) Searches for jobs. See also: AWS API Documentation **Request Syntax** response = client.search_jobs( farmId='string', queueIds=[ 'string', ], filterExpressions={ 'filters': [ { 'dateTimeFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'dateTime': datetime(2015, 1, 1) }, 'parameterFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'searchTermFilter': { 'searchTerm': 'string', 'matchType': 'FUZZY_MATCH'|'CONTAINS' }, 'stringFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'groupFilter': {'... recursive ...'} }, ], 'operator': 'AND'|'OR' }, sortExpressions=[ { 'userJobsFirst': { 'userIdentityId': 'string' }, 'fieldSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' }, 'parameterSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' } }, ], itemOffset=123, pageSize=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the job. * **queueIds** (*list*) -- **[REQUIRED]** The queue ID to use in the job search. * *(string) --* * **filterExpressions** (*dict*) -- The filter expression, "AND" or "OR", to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis "()". * **filters** *(list) --* **[REQUIRED]** The filters to use for the search. * *(dict) --* The type of search filter to apply. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dateTimeFilter", "parameterFilter", "searchTermFilter", "stringFilter", "groupFilter". * **dateTimeFilter** *(dict) --* Filters based on date and time. * **name** *(string) --* **[REQUIRED]** The name of the date-time field to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter the results. * **dateTime** *(datetime) --* **[REQUIRED]** The date and time. * **parameterFilter** *(dict) --* Filters by parameter. * **name** *(string) --* **[REQUIRED]** The name of the parameter to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter results. * **value** *(string) --* **[REQUIRED]** The parameter's value. * **searchTermFilter** *(dict) --* Filters by a specified search term. * **searchTerm** *(string) --* **[REQUIRED]** The term to search for. * **matchType** *(string) --* Specifies how Deadline Cloud matches your search term in the results. If you don't specify a "matchType" the default is "FUZZY_MATCH". * "FUZZY_MATCH" - Matches if a portion of the search term is found in the result. * "CONTAINS" - Matches if the exact search term is contained in the result. * **stringFilter** *(dict) --* Filters by a string. * **name** *(string) --* **[REQUIRED]** The field name to search. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use for this search. * **value** *(string) --* **[REQUIRED]** The string to search for. * **groupFilter** *(dict) --* Filters by group. * **operator** *(string) --* **[REQUIRED]** The operators to include in the search. * **sortExpressions** (*list*) -- The search terms for a resource. * *(dict) --* The resources to search. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "userJobsFirst", "fieldSort", "parameterSort". * **userJobsFirst** *(dict) --* Options for sorting a particular user's jobs first. * **userIdentityId** *(string) --* **[REQUIRED]** The user's ID. * **fieldSort** *(dict) --* Options for sorting by a field. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the field. * **name** *(string) --* **[REQUIRED]** The name of the field. * **parameterSort** *(dict) --* Options for sorting by a parameter. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the parameter. * **name** *(string) --* **[REQUIRED]** The parameter name to sort by. * **itemOffset** (*integer*) -- **[REQUIRED]** Defines how far into the scrollable list to start the return of results. * **pageSize** (*integer*) -- Specifies the number of items per page for the resource. Return type: dict Returns: **Response Syntax** { 'jobs': [ { 'jobId': 'string', 'queueId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED', 'lifecycleStatusMessage': 'string', 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'priority': 123, 'maxFailedTasksCount': 123, 'maxRetriesPerTask': 123, 'createdBy': 'string', 'createdAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'startedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'jobParameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string' } }, 'maxWorkerCount': 123, 'sourceJobId': 'string' }, ], 'nextItemOffset': 123, 'totalResults': 123 } **Response Structure** * *(dict) --* * **jobs** *(list) --* The jobs in the search. * *(dict) --* The details of a job search. * **jobId** *(string) --* The job ID. * **queueId** *(string) --* The queue ID. * **name** *(string) --* The job name. * **lifecycleStatus** *(string) --* The life cycle status. * **lifecycleStatusMessage** *(string) --* The life cycle status message. * **taskRunStatus** *(string) --* The task run status for the job. * "PENDING"–pending and waiting for resources. * "READY"–ready to be processed. * "ASSIGNED"–assigned and will run next on a worker. * "SCHEDULED"–scheduled to be run on a worker. * "INTERRUPTING"–being interrupted. * "RUNNING"–running on a worker. * "SUSPENDED"–the task is suspended. * "CANCELED"–the task has been canceled. * "FAILED"–the task has failed. * "SUCCEEDED"–the task has succeeded. * **targetTaskRunStatus** *(string) --* The task status to start with on the job. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the job failed and were retried. * **priority** *(integer) --* The job priority. * **maxFailedTasksCount** *(integer) --* The number of task failures before the job stops running and is marked as "FAILED". * **maxRetriesPerTask** *(integer) --* The maximum number of retries for a job. * **createdBy** *(string) --* The user or system that created this resource. * **createdAt** *(datetime) --* The date and time the resource was created. * **endedAt** *(datetime) --* The date and time the resource ended running. * **startedAt** *(datetime) --* The date and time the resource started running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **jobParameters** *(dict) --* The job parameters. * *(string) --* * *(dict) --* The details of job parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **maxWorkerCount** *(integer) --* The maximum number of worker hosts that can concurrently process a job. When the "maxWorkerCount" is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers. You can't set the "maxWorkerCount" to 0. If you set it to -1, there is no maximum number of workers. If you don't specify the "maxWorkerCount", the default is -1. * **sourceJobId** *(string) --* The job ID for the source job. * **nextItemOffset** *(integer) --* The next incremental starting point after the defined "itemOffset". * **totalResults** *(integer) --* The total number of results in the search. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_storage_profile create_storage_profile ********************** DeadlineCloud.Client.create_storage_profile(**kwargs) Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm. See also: AWS API Documentation **Request Syntax** response = client.create_storage_profile( clientToken='string', farmId='string', displayName='string', osFamily='WINDOWS'|'LINUX'|'MACOS', fileSystemLocations=[ { 'name': 'string', 'path': 'string', 'type': 'SHARED'|'LOCAL' }, ] ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to connect to the storage profile. * **displayName** (*string*) -- **[REQUIRED]** The display name of the storage profile. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** (*string*) -- **[REQUIRED]** The type of operating system (OS) for the storage profile. * **fileSystemLocations** (*list*) -- File system paths to include in the storage profile. * *(dict) --* The details of the file system location for the resource. * **name** *(string) --* **[REQUIRED]** The location name. * **path** *(string) --* **[REQUIRED]** The file path. * **type** *(string) --* **[REQUIRED]** The type of file. Return type: dict Returns: **Response Syntax** { 'storageProfileId': 'string' } **Response Structure** * *(dict) --* * **storageProfileId** *(string) --* The storage profile ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / delete_monitor delete_monitor ************** DeadlineCloud.Client.delete_monitor(**kwargs) Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor. See also: AWS API Documentation **Request Syntax** response = client.delete_monitor( monitorId='string' ) Parameters: **monitorId** (*string*) -- **[REQUIRED]** The unique identifier of the monitor to delete. This ID is returned by the "CreateMonitor" operation, and is included in the response to the "GetMonitor" operation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / copy_job_template copy_job_template ***************** DeadlineCloud.Client.copy_job_template(**kwargs) Copies a job template to an Amazon S3 bucket. See also: AWS API Documentation **Request Syntax** response = client.copy_job_template( farmId='string', jobId='string', queueId='string', targetS3Location={ 'bucketName': 'string', 'key': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to copy. * **jobId** (*string*) -- **[REQUIRED]** The job ID to copy. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to copy. * **targetS3Location** (*dict*) -- **[REQUIRED]** The Amazon S3 bucket name and key where you would like to add a copy of the job template. * **bucketName** *(string) --* **[REQUIRED]** The name of the Amazon S3 bucket. * **key** *(string) --* **[REQUIRED]** The Amazon S3 object key that uniquely identifies the Amazon S3 bucket. Return type: dict Returns: **Response Syntax** { 'templateType': 'JSON'|'YAML' } **Response Structure** * *(dict) --* * **templateType** *(string) --* The format of the job template, either "JSON" or "YAML". **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_job create_job ********** DeadlineCloud.Client.create_job(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_job( farmId='string', queueId='string', clientToken='string', template='string', templateType='JSON'|'YAML', priority=123, parameters={ 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string' } }, attachments={ 'manifests': [ { 'fileSystemLocationName': 'string', 'rootPath': 'string', 'rootPathFormat': 'windows'|'posix', 'outputRelativeDirectories': [ 'string', ], 'inputManifestPath': 'string', 'inputManifestHash': 'string' }, ], 'fileSystem': 'COPIED'|'VIRTUAL' }, storageProfileId='string', targetTaskRunStatus='READY'|'SUSPENDED', maxFailedTasksCount=123, maxRetriesPerTask=123, maxWorkerCount=123, sourceJobId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to connect to the job. * **queueId** (*string*) -- **[REQUIRED]** The ID of the queue that the job is submitted to. * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **template** (*string*) -- The job template to use for this job. * **templateType** (*string*) -- The file type for the job template. * **priority** (*integer*) -- **[REQUIRED]** The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first. * **parameters** (*dict*) -- The parameters for the job. * *(string) --* * *(dict) --* The details of job parameters. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "int", "float", "string", "path". * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **attachments** (*dict*) -- The attachments for the job. Attach files required for the job to run to a render job. * **manifests** *(list) --* **[REQUIRED]** A list of manifests which describe job attachment configurations. * *(dict) --* The details of the manifest that links a job's source information. * **fileSystemLocationName** *(string) --* The file system location name. * **rootPath** *(string) --* **[REQUIRED]** The file's root path. * **rootPathFormat** *(string) --* **[REQUIRED]** The format of the root path. * **outputRelativeDirectories** *(list) --* The file path relative to the directory. * *(string) --* * **inputManifestPath** *(string) --* The file path. * **inputManifestHash** *(string) --* The hash value of the file. * **fileSystem** *(string) --* The file system. * **storageProfileId** (*string*) -- The storage profile ID for the storage profile to connect to the job. * **targetTaskRunStatus** (*string*) -- The initial job status when it is created. Jobs that are created with a "SUSPENDED" status will not run until manually requeued. * **maxFailedTasksCount** (*integer*) -- The number of task failures before the job stops running and is marked as "FAILED". * **maxRetriesPerTask** (*integer*) -- The maximum number of retries for each task. * **maxWorkerCount** (*integer*) -- The maximum number of worker hosts that can concurrently process a job. When the "maxWorkerCount" is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers. You can't set the "maxWorkerCount" to 0. If you set it to -1, there is no maximum number of workers. If you don't specify the "maxWorkerCount", Deadline Cloud won't throttle the number of workers used to process the job. * **sourceJobId** (*string*) -- The job ID for the source job. Return type: dict Returns: **Response Syntax** { 'jobId': 'string' } **Response Structure** * *(dict) --* * **jobId** *(string) --* The job ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / create_fleet create_fleet ************ DeadlineCloud.Client.create_fleet(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_fleet( clientToken='string', farmId='string', displayName='string', description='string', roleArn='string', minWorkerCount=123, maxWorkerCount=123, configuration={ 'customerManaged': { 'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING', 'workerCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'acceleratorTypes': [ 'gpu', ], 'acceleratorCount': { 'min': 123, 'max': 123 }, 'acceleratorTotalMemoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'cpuArchitectureType': 'x86_64'|'arm64', 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'storageProfileId': 'string', 'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH' }, 'serviceManagedEc2': { 'instanceCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX', 'cpuArchitectureType': 'x86_64'|'arm64', 'rootEbsVolume': { 'sizeGiB': 123, 'iops': 123, 'throughputMiB': 123 }, 'acceleratorCapabilities': { 'selections': [ { 'name': 't4'|'a10g'|'l4'|'l40s', 'runtime': 'string' }, ], 'count': { 'min': 123, 'max': 123 } }, 'allowedInstanceTypes': [ 'string', ], 'excludedInstanceTypes': [ 'string', ], 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'instanceMarketOptions': { 'type': 'on-demand'|'spot' }, 'vpcConfiguration': { 'resourceConfigurationArns': [ 'string', ] }, 'storageProfileId': 'string' } }, tags={ 'string': 'string' }, hostConfiguration={ 'scriptBody': 'string', 'scriptTimeoutSeconds': 123 } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to connect to the fleet. * **displayName** (*string*) -- **[REQUIRED]** The display name of the fleet. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the fleet. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **roleArn** (*string*) -- **[REQUIRED]** The IAM role ARN for the role that the fleet's workers will use. * **minWorkerCount** (*integer*) -- The minimum number of workers for the fleet. * **maxWorkerCount** (*integer*) -- **[REQUIRED]** The maximum number of workers for the fleet. 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. * **configuration** (*dict*) -- **[REQUIRED]** The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customerManaged", "serviceManagedEc2". * **customerManaged** *(dict) --* The customer managed fleets within a fleet configuration. * **mode** *(string) --* **[REQUIRED]** The Auto Scaling mode for the customer managed fleet configuration. * **workerCapabilities** *(dict) --* **[REQUIRED]** The worker capabilities for a customer managed fleet configuration. * **vCpuCount** *(dict) --* **[REQUIRED]** The vCPU count for the customer manged worker capabilities. * **min** *(integer) --* **[REQUIRED]** The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* **[REQUIRED]** The memory (MiB). * **min** *(integer) --* **[REQUIRED]** The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **acceleratorTypes** *(list) --* The accelerator types for the customer managed worker capabilities. * *(string) --* * **acceleratorCount** *(dict) --* The range of the accelerator. * **min** *(integer) --* **[REQUIRED]** The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **acceleratorTotalMemoryMiB** *(dict) --* The total memory (MiB) for the customer managed worker capabilities. * **min** *(integer) --* **[REQUIRED]** The minimum amount of memory to use for the accelerator, measured in MiB. * **max** *(integer) --* The maximum amount of memory to use for the accelerator, measured in MiB. * **osFamily** *(string) --* **[REQUIRED]** The operating system (OS) family. * **cpuArchitectureType** *(string) --* **[REQUIRED]** The CPU architecture type for the customer managed worker capabilities. * **customAmounts** *(list) --* Custom requirement ranges for customer managed worker capabilities. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* **[REQUIRED]** The name of the fleet capability. * **min** *(float) --* **[REQUIRED]** The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* Custom attributes for the customer manged worker capabilities. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* **[REQUIRED]** The name of the fleet attribute capability for the worker. * **values** *(list) --* **[REQUIRED]** The number of fleet attribute capabilities. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **tagPropagationMode** *(string) --* Specifies whether tags associated with a fleet are attached to workers when the worker is launched. When the "tagPropagationMode" is set to "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers **do not** change. If you don't specify "tagPropagationMode", the default is "NO_PROPAGATION". * **serviceManagedEc2** *(dict) --* The service managed Amazon EC2 instances for a fleet configuration. * **instanceCapabilities** *(dict) --* **[REQUIRED]** The Amazon EC2 instance capabilities. * **vCpuCount** *(dict) --* **[REQUIRED]** The amount of vCPU to require for instances in this fleet. * **min** *(integer) --* **[REQUIRED]** The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* **[REQUIRED]** The memory, as MiB, for the Amazon EC2 instance type. * **min** *(integer) --* **[REQUIRED]** The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **osFamily** *(string) --* **[REQUIRED]** The operating system (OS) family. * **cpuArchitectureType** *(string) --* **[REQUIRED]** The CPU architecture type. * **rootEbsVolume** *(dict) --* The root EBS volume. * **sizeGiB** *(integer) --* The EBS volume size in GiB. * **iops** *(integer) --* The IOPS per volume. * **throughputMiB** *(integer) --* The throughput per volume in MiB. * **acceleratorCapabilities** *(dict) --* Describes the GPU accelerator capabilities required for worker host instances in this fleet. * **selections** *(list) --* **[REQUIRED]** A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed. * *(dict) --* Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host. * **name** *(string) --* **[REQUIRED]** The name of the chip used by the GPU accelerator. If you specify "l4" as the name of the accelerator, you must specify "latest" or "grid:r570" as the runtime. The available GPU accelerators are: * "t4" - NVIDIA T4 Tensor Core GPU * "a10g" - NVIDIA A10G Tensor Core GPU * "l4" - NVIDIA L4 Tensor Core GPU * "l40s" - NVIDIA L40S Tensor Core GPU * **runtime** *(string) --* Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs. You can choose from the following runtimes: * "latest" - Use the latest runtime available for the chip. If you specify "latest" and a new version of the runtime is released, the new version of the runtime is used. * "grid:r570" - NVIDIA vGPU software 18 * "grid:r535" - NVIDIA vGPU software 16 If you don't specify a runtime, Deadline Cloud uses "latest" as the default. However, if you have multiple accelerators and specify "latest" for some and leave others blank, Deadline Cloud raises an exception. * **count** *(dict) --* The number of GPU accelerators specified for worker hosts in this fleet. * **min** *(integer) --* **[REQUIRED]** The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **allowedInstanceTypes** *(list) --* The allowable Amazon EC2 instance types. * *(string) --* * **excludedInstanceTypes** *(list) --* The instance types to exclude from the fleet. * *(string) --* * **customAmounts** *(list) --* The custom capability amounts to require for instances in this fleet. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* **[REQUIRED]** The name of the fleet capability. * **min** *(float) --* **[REQUIRED]** The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* The custom capability attributes to require for instances in this fleet. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* **[REQUIRED]** The name of the fleet attribute capability for the worker. * **values** *(list) --* **[REQUIRED]** The number of fleet attribute capabilities. * *(string) --* * **instanceMarketOptions** *(dict) --* **[REQUIRED]** The Amazon EC2 market type. * **type** *(string) --* **[REQUIRED]** The Amazon EC2 instance type. * **vpcConfiguration** *(dict) --* The VPC configuration details for a service managed Amazon EC2 fleet. * **resourceConfigurationArns** *(list) --* The ARNs of the VPC Lattice resource configurations attached to the fleet. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **tags** (*dict*) -- Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* * **hostConfiguration** (*dict*) -- Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. * **scriptBody** *(string) --* **[REQUIRED]** The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the "STARTING" state and before the worker processes tasks. For more information about using the script, see Run scripts as an administrator to configure workers in the *Deadline Cloud Developer Guide*. Warning: The script runs as an administrative user ( "sudo root" on Linux, as an Administrator on Windows). * **scriptTimeoutSeconds** *(integer) --* The maximum time that the host configuration can run. If the timeout expires, the worker enters the "NOT RESPONDING" state and shuts down. You are charged for the time that the worker is running the host configuration script. Note: You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers. The default is 300 seconds (5 minutes). Return type: dict Returns: **Response Syntax** { 'fleetId': 'string' } **Response Structure** * *(dict) --* * **fleetId** *(string) --* The fleet ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / list_session_actions list_session_actions ******************** DeadlineCloud.Client.list_session_actions(**kwargs) Lists session actions. See also: AWS API Documentation **Request Syntax** response = client.list_session_actions( farmId='string', queueId='string', jobId='string', sessionId='string', taskId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the session actions list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the session actions list. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the session actions list. * **sessionId** (*string*) -- The session ID to include on the sessions action list. * **taskId** (*string*) -- The task ID for the session actions list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'sessionActions': [ { 'sessionActionId': 'string', 'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'workerUpdatedAt': datetime(2015, 1, 1), 'progressPercent': ..., 'definition': { 'envEnter': { 'environmentId': 'string' }, 'envExit': { 'environmentId': 'string' }, 'taskRun': { 'taskId': 'string', 'stepId': 'string', 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } } }, 'syncInputJobAttachments': { 'stepId': 'string' } }, 'manifests': [ { 'outputManifestPath': 'string', 'outputManifestHash': 'string' }, ] }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **sessionActions** *(list) --* The session actions. * *(dict) --* The details of a session action. * **sessionActionId** *(string) --* The session action ID. * **status** *(string) --* The status of the session action. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **workerUpdatedAt** *(datetime) --* The Linux timestamp of the last date and time that the session action was updated. * **progressPercent** *(float) --* The completion percentage for the session action. * **definition** *(dict) --* The session action definition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "envEnter", "envExit", "taskRun", "syncInputJobAttachments". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **envEnter** *(dict) --* The environment to enter into. * **environmentId** *(string) --* The environment ID. * **envExit** *(dict) --* The environment to exit from. * **environmentId** *(string) --* The environment ID. * **taskRun** *(dict) --* The task run. * **taskId** *(string) --* The task ID. * **stepId** *(string) --* The step ID. * **parameters** *(dict) --* The parameters of a task run in a session action. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **syncInputJobAttachments** *(dict) --* The job attachments to sync with the session action definition. * **stepId** *(string) --* The step ID of the step in the job attachment. * **manifests** *(list) --* The list of manifest properties that describe file attachments for the task run. * *(dict) --* The manifest properties for a task run, corresponding to the manifest properties in the job. * **outputManifestPath** *(string) --* The manifest file path. * **outputManifestHash** *(string) --* The hash value of the file. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_queue_environment create_queue_environment ************************ DeadlineCloud.Client.create_queue_environment(**kwargs) Creates an environment for a queue that defines how jobs in the queue run. See also: AWS API Documentation **Request Syntax** response = client.create_queue_environment( clientToken='string', farmId='string', queueId='string', priority=123, templateType='JSON'|'YAML', template='string' ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to connect to the environment. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to connect the queue and environment. * **priority** (*integer*) -- **[REQUIRED]** Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority. * **templateType** (*string*) -- **[REQUIRED]** The template's file type, "JSON" or "YAML". * **template** (*string*) -- **[REQUIRED]** The environment template to use in the queue. Return type: dict Returns: **Response Syntax** { 'queueEnvironmentId': 'string' } **Response Structure** * *(dict) --* * **queueEnvironmentId** *(string) --* The queue environment ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / create_monitor create_monitor ************** DeadlineCloud.Client.create_monitor(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_monitor( clientToken='string', displayName='string', identityCenterInstanceArn='string', subdomain='string', roleArn='string', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **displayName** (*string*) -- **[REQUIRED]** The name that you give the monitor that is displayed in the Deadline Cloud console. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **identityCenterInstanceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users. * **subdomain** (*string*) -- **[REQUIRED]** The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. * **roleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources. * **tags** (*dict*) -- The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'monitorId': 'string', 'identityCenterApplicationArn': 'string' } **Response Structure** * *(dict) --* * **monitorId** *(string) --* The unique identifier of the monitor. * **identityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / list_step_dependencies list_step_dependencies ********************** DeadlineCloud.Client.list_step_dependencies(**kwargs) Lists the dependencies for a step. See also: AWS API Documentation **Request Syntax** response = client.list_step_dependencies( farmId='string', queueId='string', jobId='string', stepId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the step dependencies list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the step dependencies list. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the step dependencies list. * **stepId** (*string*) -- **[REQUIRED]** The step ID to include on the list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'dependencies': [ { 'stepId': 'string', 'status': 'RESOLVED'|'UNRESOLVED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **dependencies** *(list) --* The dependencies on the list. * *(dict) --* The details of step dependency. * **stepId** *(string) --* The step ID. * **status** *(string) --* The step dependency status. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_limit update_limit ************ DeadlineCloud.Client.update_limit(**kwargs) Updates the properties of the specified limit. See also: AWS API Documentation **Request Syntax** response = client.update_limit( farmId='string', limitId='string', displayName='string', description='string', maxCount=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the limit. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit to update. * **displayName** (*string*) -- The new display name of the limit. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The new description of the limit. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **maxCount** (*integer*) -- The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available. If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number. The "maxCount" must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_session get_session *********** DeadlineCloud.Client.get_session(**kwargs) Gets a session. See also: AWS API Documentation **Request Syntax** response = client.get_session( farmId='string', queueId='string', jobId='string', sessionId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the session. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the session. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the session. * **sessionId** (*string*) -- **[REQUIRED]** The session ID. Return type: dict Returns: **Response Syntax** { 'sessionId': 'string', 'fleetId': 'string', 'workerId': 'string', 'startedAt': datetime(2015, 1, 1), 'log': { 'logDriver': 'string', 'options': { 'string': 'string' }, 'parameters': { 'string': 'string' }, 'error': 'string' }, 'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED', 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'targetLifecycleStatus': 'ENDED', 'hostProperties': { 'ipAddresses': { 'ipV4Addresses': [ 'string', ], 'ipV6Addresses': [ 'string', ] }, 'hostName': 'string', 'ec2InstanceArn': 'string', 'ec2InstanceType': 'string' }, 'workerLog': { 'logDriver': 'string', 'options': { 'string': 'string' }, 'parameters': { 'string': 'string' }, 'error': 'string' } } **Response Structure** * *(dict) --* * **sessionId** *(string) --* The session ID. * **fleetId** *(string) --* The fleet ID for the session. * **workerId** *(string) --* The worker ID for the session. * **startedAt** *(datetime) --* The date and time the resource started running. * **log** *(dict) --* The session log. * **logDriver** *(string) --* The log drivers for worker related logs. * **options** *(dict) --* The options for a log driver. * *(string) --* * *(string) --* * **parameters** *(dict) --* The parameters for the log configuration. * *(string) --* * *(string) --* * **error** *(string) --* The log configuration error details. * **lifecycleStatus** *(string) --* The life cycle status of the session. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **targetLifecycleStatus** *(string) --* The life cycle status with which the session started. * **hostProperties** *(dict) --* Provides the Amazon EC2 properties of the host. * **ipAddresses** *(dict) --* The IP address of the host. * **ipV4Addresses** *(list) --* The IpV4 address of the network. * *(string) --* * **ipV6Addresses** *(list) --* The IpV6 address for the network and node component. * *(string) --* * **hostName** *(string) --* The host name. * **ec2InstanceArn** *(string) --* The ARN of the host EC2 instance. * **ec2InstanceType** *(string) --* The instance type of the host EC2 instance. * **workerLog** *(dict) --* The worker log for the session. * **logDriver** *(string) --* The log drivers for worker related logs. * **options** *(dict) --* The options for a log driver. * *(string) --* * *(string) --* * **parameters** *(dict) --* The parameters for the log configuration. * *(string) --* * *(string) --* * **error** *(string) --* The log configuration error details. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_storage_profiles_for_queue list_storage_profiles_for_queue ******************************* DeadlineCloud.Client.list_storage_profiles_for_queue(**kwargs) Lists storage profiles for a queue. See also: AWS API Documentation **Request Syntax** response = client.list_storage_profiles_for_queue( farmId='string', queueId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the queue's storage profile. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the storage profile. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'storageProfiles': [ { 'storageProfileId': 'string', 'displayName': 'string', 'osFamily': 'WINDOWS'|'LINUX'|'MACOS' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **storageProfiles** *(list) --* The storage profiles in the queue. * *(dict) --* The details of a storage profile. * **storageProfileId** *(string) --* The storage profile ID. * **displayName** *(string) --* The display name of the storage profile summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** *(string) --* The operating system (OS) family. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_tasks list_tasks ********** DeadlineCloud.Client.list_tasks(**kwargs) Lists tasks for a job. See also: AWS API Documentation **Request Syntax** response = client.list_tasks( farmId='string', queueId='string', jobId='string', stepId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID connected to the tasks. * **queueId** (*string*) -- **[REQUIRED]** The queue ID connected to the tasks. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the tasks. * **stepId** (*string*) -- **[REQUIRED]** The step ID for the tasks. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'tasks': [ { 'taskId': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'failureRetryCount': 123, 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } }, 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'latestSessionActionId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **tasks** *(list) --* Tasks for the job. * *(dict) --* The details of a task. * **taskId** *(string) --* The task ID. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **runStatus** *(string) --* The run status of the task. * **targetRunStatus** *(string) --* The run status on which the started. * **failureRetryCount** *(integer) --* The number of times that the task failed and was retried. * **parameters** *(dict) --* The task parameters. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **latestSessionActionId** *(string) --* The latest session action for the task. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / associate_member_to_fleet associate_member_to_fleet ************************* DeadlineCloud.Client.associate_member_to_fleet(**kwargs) Assigns a fleet membership level to a member. See also: AWS API Documentation **Request Syntax** response = client.associate_member_to_fleet( farmId='string', fleetId='string', principalId='string', principalType='USER'|'GROUP', identityStoreId='string', membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the fleet to associate with the member. * **fleetId** (*string*) -- **[REQUIRED]** The ID of the fleet to associate with a member. * **principalId** (*string*) -- **[REQUIRED]** The member's principal ID to associate with a fleet. * **principalType** (*string*) -- **[REQUIRED]** The member's principal type to associate with the fleet. * **identityStoreId** (*string*) -- **[REQUIRED]** The member's identity store ID to associate with the fleet. * **membershipLevel** (*string*) -- **[REQUIRED]** The principal's membership level for the associated fleet. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / delete_storage_profile delete_storage_profile ********************** DeadlineCloud.Client.delete_storage_profile(**kwargs) Deletes a storage profile. See also: AWS API Documentation **Request Syntax** response = client.delete_storage_profile( farmId='string', storageProfileId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm from which to remove the storage profile. * **storageProfileId** (*string*) -- **[REQUIRED]** The storage profile ID of the storage profile to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_license_endpoints list_license_endpoints ********************** DeadlineCloud.Client.list_license_endpoints(**kwargs) Lists license endpoints. See also: AWS API Documentation **Request Syntax** response = client.list_license_endpoints( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'licenseEndpoints': [ { 'licenseEndpointId': 'string', 'status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'NOT_READY', 'statusMessage': 'string', 'vpcId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **licenseEndpoints** *(list) --* The license endpoints. * *(dict) --* The details for a license endpoint. * **licenseEndpointId** *(string) --* The license endpoint ID. * **status** *(string) --* The status of the license endpoint. * **statusMessage** *(string) --* The status message of the license endpoint. * **vpcId** *(string) --* The VCP(virtual private cloud) ID associated with the license endpoint. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / disassociate_member_from_job disassociate_member_from_job **************************** DeadlineCloud.Client.disassociate_member_from_job(**kwargs) Disassociates a member from a job. See also: AWS API Documentation **Request Syntax** response = client.disassociate_member_from_job( farmId='string', queueId='string', jobId='string', principalId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the job to disassociate from the member. * **queueId** (*string*) -- **[REQUIRED]** The queue ID connected to a job for which you're disassociating a member. * **jobId** (*string*) -- **[REQUIRED]** The job ID to disassociate from a member in a job. * **principalId** (*string*) -- **[REQUIRED]** A member's principal ID to disassociate from a job. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / search_steps search_steps ************ DeadlineCloud.Client.search_steps(**kwargs) Searches for steps. See also: AWS API Documentation **Request Syntax** response = client.search_steps( farmId='string', queueIds=[ 'string', ], jobId='string', filterExpressions={ 'filters': [ { 'dateTimeFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'dateTime': datetime(2015, 1, 1) }, 'parameterFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'searchTermFilter': { 'searchTerm': 'string', 'matchType': 'FUZZY_MATCH'|'CONTAINS' }, 'stringFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'groupFilter': {'... recursive ...'} }, ], 'operator': 'AND'|'OR' }, sortExpressions=[ { 'userJobsFirst': { 'userIdentityId': 'string' }, 'fieldSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' }, 'parameterSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' } }, ], itemOffset=123, pageSize=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to use for the step search. * **queueIds** (*list*) -- **[REQUIRED]** The queue IDs in the step search. * *(string) --* * **jobId** (*string*) -- The job ID to use in the step search. * **filterExpressions** (*dict*) -- The filter expression, "AND" or "OR", to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis "()". * **filters** *(list) --* **[REQUIRED]** The filters to use for the search. * *(dict) --* The type of search filter to apply. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dateTimeFilter", "parameterFilter", "searchTermFilter", "stringFilter", "groupFilter". * **dateTimeFilter** *(dict) --* Filters based on date and time. * **name** *(string) --* **[REQUIRED]** The name of the date-time field to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter the results. * **dateTime** *(datetime) --* **[REQUIRED]** The date and time. * **parameterFilter** *(dict) --* Filters by parameter. * **name** *(string) --* **[REQUIRED]** The name of the parameter to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter results. * **value** *(string) --* **[REQUIRED]** The parameter's value. * **searchTermFilter** *(dict) --* Filters by a specified search term. * **searchTerm** *(string) --* **[REQUIRED]** The term to search for. * **matchType** *(string) --* Specifies how Deadline Cloud matches your search term in the results. If you don't specify a "matchType" the default is "FUZZY_MATCH". * "FUZZY_MATCH" - Matches if a portion of the search term is found in the result. * "CONTAINS" - Matches if the exact search term is contained in the result. * **stringFilter** *(dict) --* Filters by a string. * **name** *(string) --* **[REQUIRED]** The field name to search. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use for this search. * **value** *(string) --* **[REQUIRED]** The string to search for. * **groupFilter** *(dict) --* Filters by group. * **operator** *(string) --* **[REQUIRED]** The operators to include in the search. * **sortExpressions** (*list*) -- The search terms for a resource. * *(dict) --* The resources to search. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "userJobsFirst", "fieldSort", "parameterSort". * **userJobsFirst** *(dict) --* Options for sorting a particular user's jobs first. * **userIdentityId** *(string) --* **[REQUIRED]** The user's ID. * **fieldSort** *(dict) --* Options for sorting by a field. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the field. * **name** *(string) --* **[REQUIRED]** The name of the field. * **parameterSort** *(dict) --* Options for sorting by a parameter. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the parameter. * **name** *(string) --* **[REQUIRED]** The parameter name to sort by. * **itemOffset** (*integer*) -- **[REQUIRED]** Defines how far into the scrollable list to start the return of results. * **pageSize** (*integer*) -- Specifies the number of items per page for the resource. Return type: dict Returns: **Response Syntax** { 'steps': [ { 'stepId': 'string', 'jobId': 'string', 'queueId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED', 'lifecycleStatusMessage': 'string', 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'parameterSpace': { 'parameters': [ { 'name': 'string', 'type': 'INT'|'FLOAT'|'STRING'|'PATH'|'CHUNK_INT' }, ], 'combination': 'string' } }, ], 'nextItemOffset': 123, 'totalResults': 123 } **Response Structure** * *(dict) --* * **steps** *(list) --* The steps in the search. * *(dict) --* The details of a step search. * **stepId** *(string) --* The step ID. * **jobId** *(string) --* The job ID. * **queueId** *(string) --* The queue ID. * **name** *(string) --* The step name. * **lifecycleStatus** *(string) --* The life cycle status. * **lifecycleStatusMessage** *(string) --* The life cycle status message. * **taskRunStatus** *(string) --* The task run status for the job. * "PENDING"–pending and waiting for resources. * "READY"–ready to be processed. * "ASSIGNED"–assigned and will run next on a worker. * "SCHEDULED"–scheduled to be run on a worker. * "INTERRUPTING"–being interrupted. * "RUNNING"–running on a worker. * "SUSPENDED"–the task is suspended. * "CANCELED"–the task has been canceled. * "FAILED"–the task has failed. * "SUCCEEDED"–the task has succeeded. * **targetTaskRunStatus** *(string) --* The task status to start with on the job. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the step failed and were retried. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **parameterSpace** *(dict) --* The parameters and combination expressions for the search. * **parameters** *(list) --* The parameters to search for. * *(dict) --* The details of a step parameter. * **name** *(string) --* The name of the parameter. * **type** *(string) --* The data type of the parameter. * **combination** *(string) --* The combination expression to use in the search. * **nextItemOffset** *(integer) --* The next incremental starting point after the defined "itemOffset". * **totalResults** *(integer) --* The total number of results in the search. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_fleet get_fleet ********* DeadlineCloud.Client.get_fleet(**kwargs) Get a fleet. See also: AWS API Documentation **Request Syntax** response = client.get_fleet( farmId='string', fleetId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm in the fleet. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the fleet to get. Return type: dict Returns: **Response Syntax** { 'fleetId': 'string', 'farmId': 'string', 'displayName': 'string', 'description': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED', 'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING', 'targetWorkerCount': 123, 'workerCount': 123, 'minWorkerCount': 123, 'maxWorkerCount': 123, 'configuration': { 'customerManaged': { 'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING', 'workerCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'acceleratorTypes': [ 'gpu', ], 'acceleratorCount': { 'min': 123, 'max': 123 }, 'acceleratorTotalMemoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'cpuArchitectureType': 'x86_64'|'arm64', 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'storageProfileId': 'string', 'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH' }, 'serviceManagedEc2': { 'instanceCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX', 'cpuArchitectureType': 'x86_64'|'arm64', 'rootEbsVolume': { 'sizeGiB': 123, 'iops': 123, 'throughputMiB': 123 }, 'acceleratorCapabilities': { 'selections': [ { 'name': 't4'|'a10g'|'l4'|'l40s', 'runtime': 'string' }, ], 'count': { 'min': 123, 'max': 123 } }, 'allowedInstanceTypes': [ 'string', ], 'excludedInstanceTypes': [ 'string', ], 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'instanceMarketOptions': { 'type': 'on-demand'|'spot' }, 'vpcConfiguration': { 'resourceConfigurationArns': [ 'string', ] }, 'storageProfileId': 'string' } }, 'hostConfiguration': { 'scriptBody': 'string', 'scriptTimeoutSeconds': 123 }, 'capabilities': { 'amounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'attributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'roleArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **fleetId** *(string) --* The fleet ID. * **farmId** *(string) --* The farm ID of the farm in the fleet. * **displayName** *(string) --* The display name of the fleet. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** *(string) --* The description of the fleet. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** *(string) --* The status of the fleet. * **autoScalingStatus** *(string) --* The Auto Scaling status of the fleet. Either "GROWING", "STEADY", or "SHRINKING". * **targetWorkerCount** *(integer) --* The number of target workers in the fleet. * **workerCount** *(integer) --* The number of workers in the fleet. * **minWorkerCount** *(integer) --* The minimum number of workers specified in the fleet. * **maxWorkerCount** *(integer) --* The maximum number of workers specified in the fleet. * **configuration** *(dict) --* The configuration setting for the fleet. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "customerManaged", "serviceManagedEc2". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **customerManaged** *(dict) --* The customer managed fleets within a fleet configuration. * **mode** *(string) --* The Auto Scaling mode for the customer managed fleet configuration. * **workerCapabilities** *(dict) --* The worker capabilities for a customer managed fleet configuration. * **vCpuCount** *(dict) --* The vCPU count for the customer manged worker capabilities. * **min** *(integer) --* The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* The memory (MiB). * **min** *(integer) --* The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **acceleratorTypes** *(list) --* The accelerator types for the customer managed worker capabilities. * *(string) --* * **acceleratorCount** *(dict) --* The range of the accelerator. * **min** *(integer) --* The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **acceleratorTotalMemoryMiB** *(dict) --* The total memory (MiB) for the customer managed worker capabilities. * **min** *(integer) --* The minimum amount of memory to use for the accelerator, measured in MiB. * **max** *(integer) --* The maximum amount of memory to use for the accelerator, measured in MiB. * **osFamily** *(string) --* The operating system (OS) family. * **cpuArchitectureType** *(string) --* The CPU architecture type for the customer managed worker capabilities. * **customAmounts** *(list) --* Custom requirement ranges for customer managed worker capabilities. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* The name of the fleet capability. * **min** *(float) --* The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* Custom attributes for the customer manged worker capabilities. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* The name of the fleet attribute capability for the worker. * **values** *(list) --* The number of fleet attribute capabilities. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **tagPropagationMode** *(string) --* Specifies whether tags associated with a fleet are attached to workers when the worker is launched. When the "tagPropagationMode" is set to "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers **do not** change. If you don't specify "tagPropagationMode", the default is "NO_PROPAGATION". * **serviceManagedEc2** *(dict) --* The service managed Amazon EC2 instances for a fleet configuration. * **instanceCapabilities** *(dict) --* The Amazon EC2 instance capabilities. * **vCpuCount** *(dict) --* The amount of vCPU to require for instances in this fleet. * **min** *(integer) --* The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* The memory, as MiB, for the Amazon EC2 instance type. * **min** *(integer) --* The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **osFamily** *(string) --* The operating system (OS) family. * **cpuArchitectureType** *(string) --* The CPU architecture type. * **rootEbsVolume** *(dict) --* The root EBS volume. * **sizeGiB** *(integer) --* The EBS volume size in GiB. * **iops** *(integer) --* The IOPS per volume. * **throughputMiB** *(integer) --* The throughput per volume in MiB. * **acceleratorCapabilities** *(dict) --* Describes the GPU accelerator capabilities required for worker host instances in this fleet. * **selections** *(list) --* A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed. * *(dict) --* Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host. * **name** *(string) --* The name of the chip used by the GPU accelerator. If you specify "l4" as the name of the accelerator, you must specify "latest" or "grid:r570" as the runtime. The available GPU accelerators are: * "t4" - NVIDIA T4 Tensor Core GPU * "a10g" - NVIDIA A10G Tensor Core GPU * "l4" - NVIDIA L4 Tensor Core GPU * "l40s" - NVIDIA L40S Tensor Core GPU * **runtime** *(string) --* Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs. You can choose from the following runtimes: * "latest" - Use the latest runtime available for the chip. If you specify "latest" and a new version of the runtime is released, the new version of the runtime is used. * "grid:r570" - NVIDIA vGPU software 18 * "grid:r535" - NVIDIA vGPU software 16 If you don't specify a runtime, Deadline Cloud uses "latest" as the default. However, if you have multiple accelerators and specify "latest" for some and leave others blank, Deadline Cloud raises an exception. * **count** *(dict) --* The number of GPU accelerators specified for worker hosts in this fleet. * **min** *(integer) --* The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **allowedInstanceTypes** *(list) --* The allowable Amazon EC2 instance types. * *(string) --* * **excludedInstanceTypes** *(list) --* The instance types to exclude from the fleet. * *(string) --* * **customAmounts** *(list) --* The custom capability amounts to require for instances in this fleet. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* The name of the fleet capability. * **min** *(float) --* The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* The custom capability attributes to require for instances in this fleet. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* The name of the fleet attribute capability for the worker. * **values** *(list) --* The number of fleet attribute capabilities. * *(string) --* * **instanceMarketOptions** *(dict) --* The Amazon EC2 market type. * **type** *(string) --* The Amazon EC2 instance type. * **vpcConfiguration** *(dict) --* The VPC configuration details for a service managed Amazon EC2 fleet. * **resourceConfigurationArns** *(list) --* The ARNs of the VPC Lattice resource configurations attached to the fleet. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **hostConfiguration** *(dict) --* The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. * **scriptBody** *(string) --* The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the "STARTING" state and before the worker processes tasks. For more information about using the script, see Run scripts as an administrator to configure workers in the *Deadline Cloud Developer Guide*. Warning: The script runs as an administrative user ( "sudo root" on Linux, as an Administrator on Windows). * **scriptTimeoutSeconds** *(integer) --* The maximum time that the host configuration can run. If the timeout expires, the worker enters the "NOT RESPONDING" state and shuts down. You are charged for the time that the worker is running the host configuration script. Note: You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers. The default is 300 seconds (5 minutes). * **capabilities** *(dict) --* Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values. * **amounts** *(list) --* Amount capabilities of the fleet. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* The name of the fleet capability. * **min** *(float) --* The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **attributes** *(list) --* Attribute capabilities of the fleet. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* The name of the fleet attribute capability for the worker. * **values** *(list) --* The number of fleet attribute capabilities. * *(string) --* * **roleArn** *(string) --* The IAM role ARN. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / close close ***** DeadlineCloud.Client.close() Closes underlying endpoint connections. DeadlineCloud / Client / update_worker_schedule update_worker_schedule ********************** DeadlineCloud.Client.update_worker_schedule(**kwargs) Updates the schedule for a worker. See also: AWS API Documentation **Request Syntax** response = client.update_worker_schedule( farmId='string', fleetId='string', workerId='string', updatedSessionActions={ 'string': { 'completedStatus': 'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED', 'processExitCode': 123, 'progressMessage': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'progressPercent': ..., 'manifests': [ { 'outputManifestPath': 'string', 'outputManifestHash': 'string' }, ] } } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID to update. * **workerId** (*string*) -- **[REQUIRED]** The worker ID to update. * **updatedSessionActions** (*dict*) -- The session actions associated with the worker schedule to update. * *(string) --* * *(dict) --* The updated session action information as it relates to completion and progress of the session. * **completedStatus** *(string) --* The status of the session upon completion. * **processExitCode** *(integer) --* The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes. * **progressMessage** *(string) --* A message to indicate the progress of the updated session action. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The updated time. * **progressPercent** *(float) --* The percentage completed. * **manifests** *(list) --* A list of output manifest properties reported by the worker agent, with each entry corresponding to a manifest property in the job. * *(dict) --* The output manifest properties reported by the worker agent for a completed task run. * **outputManifestPath** *(string) --* The manifest file path. * **outputManifestHash** *(string) --* The hash value of the file. Return type: dict Returns: **Response Syntax** { 'assignedSessions': { 'string': { 'queueId': 'string', 'jobId': 'string', 'sessionActions': [ { 'sessionActionId': 'string', 'definition': { 'envEnter': { 'environmentId': 'string' }, 'envExit': { 'environmentId': 'string' }, 'taskRun': { 'taskId': 'string', 'stepId': 'string', 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } } }, 'syncInputJobAttachments': { 'stepId': 'string' } } }, ], 'logConfiguration': { 'logDriver': 'string', 'options': { 'string': 'string' }, 'parameters': { 'string': 'string' }, 'error': 'string' } } }, 'cancelSessionActions': { 'string': [ 'string', ] }, 'desiredWorkerStatus': 'STOPPED', 'updateIntervalSeconds': 123 } **Response Structure** * *(dict) --* * **assignedSessions** *(dict) --* The assigned sessions to update. * *(string) --* * *(dict) --* The assigned session for the worker. * **queueId** *(string) --* The queue ID of the assigned session. * **jobId** *(string) --* The job ID for the assigned session. * **sessionActions** *(list) --* The session actions to apply to the assigned session. * *(dict) --* The action for a session defined by the session action ID. * **sessionActionId** *(string) --* The session action ID for the assigned session. * **definition** *(dict) --* The definition of the assigned session action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "envEnter", "envExit", "taskRun", "syncInputJobAttachments". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **envEnter** *(dict) --* The environment a session starts on. * **environmentId** *(string) --* The environment ID of the assigned environment at the start of a session. * **envExit** *(dict) --* The environment a session exits from. * **environmentId** *(string) --* The environment ID of the assigned environment when exiting a session. * **taskRun** *(dict) --* The task run. * **taskId** *(string) --* The task ID. * **stepId** *(string) --* The step ID. * **parameters** *(dict) --* The parameters to include. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **syncInputJobAttachments** *(dict) --* The job attachment to sync with an assigned session action. * **stepId** *(string) --* The step ID. * **logConfiguration** *(dict) --* The log configuration for the worker's assigned session. * **logDriver** *(string) --* The log drivers for worker related logs. * **options** *(dict) --* The options for a log driver. * *(string) --* * *(string) --* * **parameters** *(dict) --* The parameters for the log configuration. * *(string) --* * *(string) --* * **error** *(string) --* The log configuration error details. * **cancelSessionActions** *(dict) --* The session actions associated with the worker schedule to cancel. * *(string) --* * *(list) --* * *(string) --* * **desiredWorkerStatus** *(string) --* The status to update the worker to. * **updateIntervalSeconds** *(integer) --* Updates the time interval (in seconds) for the schedule. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_available_metered_products list_available_metered_products ******************************* DeadlineCloud.Client.list_available_metered_products(**kwargs) A list of the available metered products. See also: AWS API Documentation **Request Syntax** response = client.list_available_metered_products( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'meteredProducts': [ { 'productId': 'string', 'family': 'string', 'vendor': 'string', 'port': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **meteredProducts** *(list) --* The metered products. * *(dict) --* The details of a metered product. * **productId** *(string) --* The product ID. * **family** *(string) --* The family to which the metered product belongs. * **vendor** *(string) --* The vendor. * **port** *(integer) --* The port on which the metered product should run. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ThrottlingException" DeadlineCloud / Client / delete_budget delete_budget ************* DeadlineCloud.Client.delete_budget(**kwargs) Deletes a budget. See also: AWS API Documentation **Request Syntax** response = client.delete_budget( farmId='string', budgetId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to remove from the budget. * **budgetId** (*string*) -- **[REQUIRED]** The budget ID of the budget to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / disassociate_member_from_fleet disassociate_member_from_fleet ****************************** DeadlineCloud.Client.disassociate_member_from_fleet(**kwargs) Disassociates a member from a fleet. See also: AWS API Documentation **Request Syntax** response = client.disassociate_member_from_fleet( farmId='string', fleetId='string', principalId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the fleet to disassociate a member from. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the fleet to from which to disassociate a member. * **principalId** (*string*) -- **[REQUIRED]** A member's principal ID to disassociate from a fleet. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / start_sessions_statistics_aggregation start_sessions_statistics_aggregation ************************************* DeadlineCloud.Client.start_sessions_statistics_aggregation(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.start_sessions_statistics_aggregation( farmId='string', resourceIds={ 'queueIds': [ 'string', ], 'fleetIds': [ 'string', ] }, startTime=datetime(2015, 1, 1), endTime=datetime(2015, 1, 1), timezone='string', period='HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY', groupBy=[ 'QUEUE_ID'|'FLEET_ID'|'JOB_ID'|'USER_ID'|'USAGE_TYPE'|'INSTANCE_TYPE'|'LICENSE_PRODUCT', ], statistics=[ 'SUM'|'MIN'|'MAX'|'AVG', ] ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The identifier of the farm that contains queues or fleets to return statistics for. * **resourceIds** (*dict*) -- **[REQUIRED]** A list of fleet IDs or queue IDs to gather statistics for. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "queueIds", "fleetIds". * **queueIds** *(list) --* One to 10 queue IDs that specify the queues to return statistics for. If you specify the "queueIds" field, you can't specify the "fleetIds" field. * *(string) --* * **fleetIds** *(list) --* One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the "fleetIds" field, you can't specify the "queueIds" field. * *(string) --* * **startTime** (*datetime*) -- **[REQUIRED]** The Linux timestamp of the date and time that the statistics start. * **endTime** (*datetime*) -- **[REQUIRED]** The Linux timestamp of the date and time that the statistics end. * **timezone** (*string*) -- The timezone to use for the statistics. Use UTC notation such as "UTC+8." * **period** (*string*) -- The period to aggregate the statistics. * **groupBy** (*list*) -- **[REQUIRED]** The field to use to group the statistics. * *(string) --* * **statistics** (*list*) -- **[REQUIRED]** One to four statistics to return. * *(string) --* Return type: dict Returns: **Response Syntax** { 'aggregationId': 'string' } **Response Structure** * *(dict) --* * **aggregationId** *(string) --* A unique identifier for the aggregated statistics. Use this identifier with the "GetAggregatedStatisticsForSessions" operation to return the statistics. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_job_parameter_definitions list_job_parameter_definitions ****************************** DeadlineCloud.Client.list_job_parameter_definitions(**kwargs) Lists parameter definitions of a job. See also: AWS API Documentation **Request Syntax** response = client.list_job_parameter_definitions( farmId='string', jobId='string', queueId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the job to list. * **jobId** (*string*) -- **[REQUIRED]** The job ID to include on the list. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'jobParameterDefinitions': [ {...}|[...]|123|123.4|'string'|True|None, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **jobParameterDefinitions** *(list) --* Lists parameter definitions of a job. * (*document*) -- * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_budget create_budget ************* DeadlineCloud.Client.create_budget(**kwargs) Creates a budget to set spending thresholds for your rendering activity. See also: AWS API Documentation **Request Syntax** response = client.create_budget( clientToken='string', farmId='string', usageTrackingResource={ 'queueId': 'string' }, displayName='string', description='string', approximateDollarLimit=..., actions=[ { 'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', 'thresholdPercentage': ..., 'description': 'string' }, ], schedule={ 'fixed': { 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID to include in this budget. * **usageTrackingResource** (*dict*) -- **[REQUIRED]** The queue ID provided to this budget to track usage. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "queueId". * **queueId** *(string) --* The queue ID. * **displayName** (*string*) -- **[REQUIRED]** The display name of the budget. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the budget. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **approximateDollarLimit** (*float*) -- **[REQUIRED]** The dollar limit based on consumed usage. * **actions** (*list*) -- **[REQUIRED]** The budget actions to specify what happens when the budget runs out. * *(dict) --* The budget action to add. * **type** *(string) --* **[REQUIRED]** The type of budget action to add. * **thresholdPercentage** *(float) --* **[REQUIRED]** The percentage threshold for the budget action to add. * **description** *(string) --* A description for the budget action to add. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **schedule** (*dict*) -- **[REQUIRED]** The schedule to associate with this budget. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed". * **fixed** *(dict) --* The fixed start and end time of the budget's schedule. * **startTime** *(datetime) --* **[REQUIRED]** When the budget starts. * **endTime** *(datetime) --* **[REQUIRED]** When the budget ends. Return type: dict Returns: **Response Syntax** { 'budgetId': 'string' } **Response Structure** * *(dict) --* * **budgetId** *(string) --* The budget ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / disassociate_member_from_queue disassociate_member_from_queue ****************************** DeadlineCloud.Client.disassociate_member_from_queue(**kwargs) Disassociates a member from a queue. See also: AWS API Documentation **Request Syntax** response = client.disassociate_member_from_queue( farmId='string', queueId='string', principalId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue to disassociate from a member. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the queue in which you're disassociating from a member. * **principalId** (*string*) -- **[REQUIRED]** A member's principal ID to disassociate from a queue. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_queue_environment update_queue_environment ************************ DeadlineCloud.Client.update_queue_environment(**kwargs) Updates the queue environment. See also: AWS API Documentation **Request Syntax** response = client.update_queue_environment( clientToken='string', farmId='string', queueId='string', queueEnvironmentId='string', priority=123, templateType='JSON'|'YAML', template='string' ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the queue environment to update. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the queue environment to update. * **queueEnvironmentId** (*string*) -- **[REQUIRED]** The queue environment ID to update. * **priority** (*integer*) -- The priority to update. * **templateType** (*string*) -- The template type to update. * **template** (*string*) -- The template to update. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / search_tasks search_tasks ************ DeadlineCloud.Client.search_tasks(**kwargs) Searches for tasks. See also: AWS API Documentation **Request Syntax** response = client.search_tasks( farmId='string', queueIds=[ 'string', ], jobId='string', filterExpressions={ 'filters': [ { 'dateTimeFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'dateTime': datetime(2015, 1, 1) }, 'parameterFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'searchTermFilter': { 'searchTerm': 'string', 'matchType': 'FUZZY_MATCH'|'CONTAINS' }, 'stringFilter': { 'name': 'string', 'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN', 'value': 'string' }, 'groupFilter': {'... recursive ...'} }, ], 'operator': 'AND'|'OR' }, sortExpressions=[ { 'userJobsFirst': { 'userIdentityId': 'string' }, 'fieldSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' }, 'parameterSort': { 'sortOrder': 'ASCENDING'|'DESCENDING', 'name': 'string' } }, ], itemOffset=123, pageSize=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the task. * **queueIds** (*list*) -- **[REQUIRED]** The queue IDs to include in the search. * *(string) --* * **jobId** (*string*) -- The job ID for the task search. * **filterExpressions** (*dict*) -- The filter expression, "AND" or "OR", to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis "()". * **filters** *(list) --* **[REQUIRED]** The filters to use for the search. * *(dict) --* The type of search filter to apply. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dateTimeFilter", "parameterFilter", "searchTermFilter", "stringFilter", "groupFilter". * **dateTimeFilter** *(dict) --* Filters based on date and time. * **name** *(string) --* **[REQUIRED]** The name of the date-time field to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter the results. * **dateTime** *(datetime) --* **[REQUIRED]** The date and time. * **parameterFilter** *(dict) --* Filters by parameter. * **name** *(string) --* **[REQUIRED]** The name of the parameter to filter on. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use to filter results. * **value** *(string) --* **[REQUIRED]** The parameter's value. * **searchTermFilter** *(dict) --* Filters by a specified search term. * **searchTerm** *(string) --* **[REQUIRED]** The term to search for. * **matchType** *(string) --* Specifies how Deadline Cloud matches your search term in the results. If you don't specify a "matchType" the default is "FUZZY_MATCH". * "FUZZY_MATCH" - Matches if a portion of the search term is found in the result. * "CONTAINS" - Matches if the exact search term is contained in the result. * **stringFilter** *(dict) --* Filters by a string. * **name** *(string) --* **[REQUIRED]** The field name to search. * **operator** *(string) --* **[REQUIRED]** The type of comparison to use for this search. * **value** *(string) --* **[REQUIRED]** The string to search for. * **groupFilter** *(dict) --* Filters by group. * **operator** *(string) --* **[REQUIRED]** The operators to include in the search. * **sortExpressions** (*list*) -- The search terms for a resource. * *(dict) --* The resources to search. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "userJobsFirst", "fieldSort", "parameterSort". * **userJobsFirst** *(dict) --* Options for sorting a particular user's jobs first. * **userIdentityId** *(string) --* **[REQUIRED]** The user's ID. * **fieldSort** *(dict) --* Options for sorting by a field. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the field. * **name** *(string) --* **[REQUIRED]** The name of the field. * **parameterSort** *(dict) --* Options for sorting by a parameter. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for the parameter. * **name** *(string) --* **[REQUIRED]** The parameter name to sort by. * **itemOffset** (*integer*) -- **[REQUIRED]** Defines how far into the scrollable list to start the return of results. * **pageSize** (*integer*) -- Specifies the number of items per page for the resource. Return type: dict Returns: **Response Syntax** { 'tasks': [ { 'taskId': 'string', 'stepId': 'string', 'jobId': 'string', 'queueId': 'string', 'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'parameters': { 'string': { 'int': 'string', 'float': 'string', 'string': 'string', 'path': 'string', 'chunkInt': 'string' } }, 'failureRetryCount': 123, 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'nextItemOffset': 123, 'totalResults': 123 } **Response Structure** * *(dict) --* * **tasks** *(list) --* Tasks in the search. * *(dict) --* The details of a task search. * **taskId** *(string) --* The task ID. * **stepId** *(string) --* The step ID. * **jobId** *(string) --* The job ID. * **queueId** *(string) --* The queue ID. * **runStatus** *(string) --* The run status of the task. * **targetRunStatus** *(string) --* The run status that the task is being updated to. * **parameters** *(dict) --* The parameters to search for. * *(string) --* * *(dict) --* The data types for the task parameters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "int", "float", "string", "path", "chunkInt". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **int** *(string) --* A signed integer represented as a string. * **float** *(string) --* A double precision IEEE-754 floating point number represented as a string. * **string** *(string) --* A UTF-8 string. * **path** *(string) --* A file system path represented as a string. * **chunkInt** *(string) --* A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string. * **failureRetryCount** *(integer) --* The number of times that the task failed and was retried. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **nextItemOffset** *(integer) --* The next incremental starting point after the defined "itemOffset". * **totalResults** *(integer) --* The total number of results in the search. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_storage_profile update_storage_profile ********************** DeadlineCloud.Client.update_storage_profile(**kwargs) Updates a storage profile. See also: AWS API Documentation **Request Syntax** response = client.update_storage_profile( clientToken='string', farmId='string', storageProfileId='string', displayName='string', osFamily='WINDOWS'|'LINUX'|'MACOS', fileSystemLocationsToAdd=[ { 'name': 'string', 'path': 'string', 'type': 'SHARED'|'LOCAL' }, ], fileSystemLocationsToRemove=[ { 'name': 'string', 'path': 'string', 'type': 'SHARED'|'LOCAL' }, ] ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **storageProfileId** (*string*) -- **[REQUIRED]** The storage profile ID to update. * **displayName** (*string*) -- The display name of the storage profile to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** (*string*) -- The OS system to update. * **fileSystemLocationsToAdd** (*list*) -- The file system location names to add. * *(dict) --* The details of the file system location for the resource. * **name** *(string) --* **[REQUIRED]** The location name. * **path** *(string) --* **[REQUIRED]** The file path. * **type** *(string) --* **[REQUIRED]** The type of file. * **fileSystemLocationsToRemove** (*list*) -- The file system location names to remove. * *(dict) --* The details of the file system location for the resource. * **name** *(string) --* **[REQUIRED]** The location name. * **path** *(string) --* **[REQUIRED]** The file path. * **type** *(string) --* **[REQUIRED]** The type of file. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_step_consumers list_step_consumers ******************* DeadlineCloud.Client.list_step_consumers(**kwargs) Lists step consumers. See also: AWS API Documentation **Request Syntax** response = client.list_step_consumers( farmId='string', queueId='string', jobId='string', stepId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the list of step consumers. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the step consumer. * **jobId** (*string*) -- **[REQUIRED]** The job ID for the step consumer. * **stepId** (*string*) -- **[REQUIRED]** The step ID to include on the list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'consumers': [ { 'stepId': 'string', 'status': 'RESOLVED'|'UNRESOLVED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **consumers** *(list) --* The consumers on the list. * *(dict) --* The details of a step consumer. * **stepId** *(string) --* The step ID. * **status** *(string) --* The step consumer status. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_worker delete_worker ************* DeadlineCloud.Client.delete_worker(**kwargs) Deletes a worker. See also: AWS API Documentation **Request Syntax** response = client.delete_worker( farmId='string', fleetId='string', workerId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the worker to delete. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the worker to delete. * **workerId** (*string*) -- **[REQUIRED]** The worker ID of the worker to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / associate_member_to_farm associate_member_to_farm ************************ DeadlineCloud.Client.associate_member_to_farm(**kwargs) Assigns a farm membership level to a member. See also: AWS API Documentation **Request Syntax** response = client.associate_member_to_farm( farmId='string', principalId='string', principalType='USER'|'GROUP', identityStoreId='string', membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The ID of the farm to associate with the member. * **principalId** (*string*) -- **[REQUIRED]** The member's principal ID to associate with the farm. * **principalType** (*string*) -- **[REQUIRED]** The principal type of the member to associate with the farm. * **identityStoreId** (*string*) -- **[REQUIRED]** The identity store ID of the member to associate with the farm. * **membershipLevel** (*string*) -- **[REQUIRED]** The principal's membership level for the associated farm. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / create_worker create_worker ************* DeadlineCloud.Client.create_worker(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_worker( farmId='string', fleetId='string', hostProperties={ 'ipAddresses': { 'ipV4Addresses': [ 'string', ], 'ipV6Addresses': [ 'string', ] }, 'hostName': 'string' }, clientToken='string', tags={ 'string': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to connect to the worker. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID to connect to the worker. * **hostProperties** (*dict*) -- The IP address and host name of the worker. * **ipAddresses** *(dict) --* The IP address of the host. * **ipV4Addresses** *(list) --* The IpV4 address of the network. * *(string) --* * **ipV6Addresses** *(list) --* The IpV6 address for the network and node component. * *(string) --* * **hostName** *(string) --* The host name. * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **tags** (*dict*) -- Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'workerId': 'string' } **Response Structure** * *(dict) --* * **workerId** *(string) --* The worker ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_queue get_queue ********* DeadlineCloud.Client.get_queue(**kwargs) Gets a queue. See also: AWS API Documentation **Request Syntax** response = client.get_queue( farmId='string', queueId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm in the queue. * **queueId** (*string*) -- **[REQUIRED]** The queue ID for the queue to retrieve. Return type: dict Returns: **Response Syntax** { 'queueId': 'string', 'displayName': 'string', 'description': 'string', 'farmId': 'string', 'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED', 'defaultBudgetAction': 'NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', 'blockedReason': 'NO_BUDGET_CONFIGURED'|'BUDGET_THRESHOLD_REACHED', 'jobAttachmentSettings': { 's3BucketName': 'string', 'rootPrefix': 'string' }, 'roleArn': 'string', 'requiredFileSystemLocationNames': [ 'string', ], 'allowedStorageProfileIds': [ 'string', ], 'jobRunAsUser': { 'posix': { 'user': 'string', 'group': 'string' }, 'windows': { 'user': 'string', 'passwordArn': 'string' }, 'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER' }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **queueId** *(string) --* The queue ID. * **displayName** *(string) --* The display name of the queue. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** *(string) --* The description of the queue. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **farmId** *(string) --* The farm ID for the queue. * **status** *(string) --* The status of the queue. * "ACTIVE"–The queue is active. * "SCHEDULING"–The queue is scheduling. * "SCHEDULING_BLOCKED"–The queue scheduling is blocked. See the provided reason. * **defaultBudgetAction** *(string) --* The default action taken on a queue if a budget wasn't configured. * **blockedReason** *(string) --* The reason the queue was blocked. * **jobAttachmentSettings** *(dict) --* The job attachment settings for the queue. * **s3BucketName** *(string) --* The Amazon S3 bucket name. * **rootPrefix** *(string) --* The root prefix. * **roleArn** *(string) --* The IAM role ARN. * **requiredFileSystemLocationNames** *(list) --* A list of the required file system location names in the queue. * *(string) --* * **allowedStorageProfileIds** *(list) --* The storage profile IDs for the queue. * *(string) --* * **jobRunAsUser** *(dict) --* The jobs in the queue ran as this specified POSIX user. * **posix** *(dict) --* The user and group that the jobs in the queue run as. * **user** *(string) --* The name of the POSIX user. * **group** *(string) --* The name of the POSIX user's group. * **windows** *(dict) --* Identifies a Microsoft Windows user. * **user** *(string) --* The user. * **passwordArn** *(string) --* The password ARN for the Windows user. * **runAs** *(string) --* Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / assume_fleet_role_for_read assume_fleet_role_for_read ************************** DeadlineCloud.Client.assume_fleet_role_for_read(**kwargs) Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access. See also: AWS API Documentation **Request Syntax** response = client.assume_fleet_role_for_read( farmId='string', fleetId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the fleet's farm. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID. Return type: dict Returns: **Response Syntax** { 'credentials': { 'accessKeyId': 'string', 'secretAccessKey': 'string', 'sessionToken': 'string', 'expiration': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **credentials** *(dict) --* The credentials for the fleet role. * **accessKeyId** *(string) --* The IAM access key ID. * **secretAccessKey** *(string) --* The IAM secret access key. * **sessionToken** *(string) --* The IAM session token * **expiration** *(datetime) --* The expiration date and time of the IAM credentials. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / associate_member_to_queue associate_member_to_queue ************************* DeadlineCloud.Client.associate_member_to_queue(**kwargs) Assigns a queue membership level to a member See also: AWS API Documentation **Request Syntax** response = client.associate_member_to_queue( farmId='string', queueId='string', principalId='string', principalType='USER'|'GROUP', identityStoreId='string', membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the queue to associate with the member. * **queueId** (*string*) -- **[REQUIRED]** The ID of the queue to associate to the member. * **principalId** (*string*) -- **[REQUIRED]** The member's principal ID to associate with the queue. * **principalType** (*string*) -- **[REQUIRED]** The member's principal type to associate with the queue. * **identityStoreId** (*string*) -- **[REQUIRED]** The member's identity store ID to associate with the queue. * **membershipLevel** (*string*) -- **[REQUIRED]** The principal's membership level for the associated queue. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / get_limit get_limit ********* DeadlineCloud.Client.get_limit(**kwargs) Gets information about a specific limit. See also: AWS API Documentation **Request Syntax** response = client.get_limit( farmId='string', limitId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the limit. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit to return. Return type: dict Returns: **Response Syntax** { 'displayName': 'string', 'amountRequirementName': 'string', 'maxCount': 123, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'farmId': 'string', 'limitId': 'string', 'currentCount': 123, 'description': 'string' } **Response Structure** * *(dict) --* * **displayName** *(string) --* The display name of the limit. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **amountRequirementName** *(string) --* The value that you specify as the "name" in the "amounts" field of the "hostRequirements" in a step of a job template to declare the limit requirement. * **maxCount** *(integer) --* The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available. The "maxValue" must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit. * **createdAt** *(datetime) --* The Unix timestamp of the date and time that the limit was created. * **createdBy** *(string) --* The user identifier of the person that created the limit. * **updatedAt** *(datetime) --* The Unix timestamp of the date and time that the limit was last updated. * **updatedBy** *(string) --* The user identifier of the person that last updated the limit. * **farmId** *(string) --* The unique identifier of the farm that contains the limit. * **limitId** *(string) --* The unique identifier of the limit. * **currentCount** *(integer) --* The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation. * **description** *(string) --* The description of the limit that helps identify what the limit is used for. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_steps list_steps ********** DeadlineCloud.Client.list_steps(**kwargs) Lists steps for a job. See also: AWS API Documentation **Request Syntax** response = client.list_steps( farmId='string', queueId='string', jobId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to include on the list of steps. * **queueId** (*string*) -- **[REQUIRED]** The queue ID to include on the list of steps. * **jobId** (*string*) -- **[REQUIRED]** The job ID to include on the list of steps. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'steps': [ { 'stepId': 'string', 'name': 'string', 'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED', 'lifecycleStatusMessage': 'string', 'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE', 'taskRunStatusCounts': { 'string': 123 }, 'taskFailureRetryCount': 123, 'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'startedAt': datetime(2015, 1, 1), 'endedAt': datetime(2015, 1, 1), 'dependencyCounts': { 'dependenciesResolved': 123, 'dependenciesUnresolved': 123, 'consumersResolved': 123, 'consumersUnresolved': 123 } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **steps** *(list) --* The steps on the list. * *(dict) --* The details for a step. * **stepId** *(string) --* The step ID. * **name** *(string) --* The name of the step. * **lifecycleStatus** *(string) --* The life cycle status. * **lifecycleStatusMessage** *(string) --* A message that describes the lifecycle of the step. * **taskRunStatus** *(string) --* The task run status for the job. * "PENDING"–pending and waiting for resources. * "READY"–ready to process. * "ASSIGNED"–assigned and will run next on a worker. * "SCHEDULED"–scheduled to run on a worker. * "INTERRUPTING"–being interrupted. * "RUNNING"–running on a worker. * "SUSPENDED"–the task is suspended. * "CANCELED"–the task has been canceled. * "FAILED"–the task has failed. * "SUCCEEDED"–the task has succeeded. * **taskRunStatusCounts** *(dict) --* The number of tasks running on the job. * *(string) --* * *(integer) --* * **taskFailureRetryCount** *(integer) --* The total number of times tasks from the step failed and were retried. * **targetTaskRunStatus** *(string) --* The task status to start with on the job. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **startedAt** *(datetime) --* The date and time the resource started running. * **endedAt** *(datetime) --* The date and time the resource ended running. * **dependencyCounts** *(dict) --* The number of dependencies for the step. * **dependenciesResolved** *(integer) --* The number of resolved dependencies. * **dependenciesUnresolved** *(integer) --* The number of unresolved dependencies. * **consumersResolved** *(integer) --* The number of consumers resolved. * **consumersUnresolved** *(integer) --* The number of unresolved consumers. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / assume_queue_role_for_user assume_queue_role_for_user ************************** DeadlineCloud.Client.assume_queue_role_for_user(**kwargs) Allows a user to assume a role for a queue. See also: AWS API Documentation **Request Syntax** response = client.assume_queue_role_for_user( farmId='string', queueId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the queue that the user assumes the role for. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the queue that the user assumes the role for. Return type: dict Returns: **Response Syntax** { 'credentials': { 'accessKeyId': 'string', 'secretAccessKey': 'string', 'sessionToken': 'string', 'expiration': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **credentials** *(dict) --* The credentials for the queue role that a user has access to. * **accessKeyId** *(string) --* The IAM access key ID. * **secretAccessKey** *(string) --* The IAM secret access key. * **sessionToken** *(string) --* The IAM session token * **expiration** *(datetime) --* The expiration date and time of the IAM credentials. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_queue_fleet_association delete_queue_fleet_association ****************************** DeadlineCloud.Client.delete_queue_fleet_association(**kwargs) Deletes a queue-fleet association. See also: AWS API Documentation **Request Syntax** response = client.delete_queue_fleet_association( farmId='string', queueId='string', fleetId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm that holds the queue-fleet association. * **queueId** (*string*) -- **[REQUIRED]** The queue ID of the queue-fleet association. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID of the queue-fleet association. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_queue_fleet_associations list_queue_fleet_associations ***************************** DeadlineCloud.Client.list_queue_fleet_associations(**kwargs) Lists queue-fleet associations. See also: AWS API Documentation **Request Syntax** response = client.list_queue_fleet_associations( farmId='string', queueId='string', fleetId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the queue-fleet association list. * **queueId** (*string*) -- The queue ID for the queue-fleet association list. * **fleetId** (*string*) -- The fleet ID for the queue-fleet association list. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'queueFleetAssociations': [ { 'queueId': 'string', 'fleetId': 'string', 'status': 'ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'|'STOPPED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **queueFleetAssociations** *(list) --* The queue-fleet associations on the list. * *(dict) --* The details of a queue-fleet association. * **queueId** *(string) --* The queue ID. * **fleetId** *(string) --* The fleet ID. * **status** *(string) --* The status of task scheduling in the queue-fleet association. * "ACTIVE"–Association is active. * "STOP_SCHEDULING_AND_COMPLETE_TASKS"–Association has stopped scheduling new tasks and is completing current tasks. * "STOP_SCHEDULING_AND_CANCEL_TASKS"–Association has stopped scheduling new tasks and is canceling current tasks. * "STOPPED"–Association has been stopped. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" DeadlineCloud / Client / list_storage_profiles list_storage_profiles ********************* DeadlineCloud.Client.list_storage_profiles(**kwargs) Lists storage profiles. See also: AWS API Documentation **Request Syntax** response = client.list_storage_profiles( farmId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the storage profile. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'storageProfiles': [ { 'storageProfileId': 'string', 'displayName': 'string', 'osFamily': 'WINDOWS'|'LINUX'|'MACOS' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **storageProfiles** *(list) --* The storage profiles. * *(dict) --* The details of a storage profile. * **storageProfileId** *(string) --* The storage profile ID. * **displayName** *(string) --* The display name of the storage profile summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** *(string) --* The operating system (OS) family. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / tag_resource tag_resource ************ DeadlineCloud.Client.tag_resource(**kwargs) Tags a resource using the resource's ARN and desired tags. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource to apply tags to. * **tags** (*dict*) -- Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_sessions_for_worker list_sessions_for_worker ************************ DeadlineCloud.Client.list_sessions_for_worker(**kwargs) Lists sessions for a worker. See also: AWS API Documentation **Request Syntax** response = client.list_sessions_for_worker( farmId='string', fleetId='string', workerId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the session. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID for the session. * **workerId** (*string*) -- **[REQUIRED]** The worker ID for the session. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'sessions': [ { 'sessionId': 'string', 'queueId': 'string', 'jobId': 'string', 'startedAt': datetime(2015, 1, 1), 'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED', 'endedAt': datetime(2015, 1, 1), 'targetLifecycleStatus': 'ENDED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **sessions** *(list) --* The sessions in the response. * *(dict) --* Summarizes the session for a particular worker. * **sessionId** *(string) --* The session ID for the session action. * **queueId** *(string) --* The queue ID for the queue associated to the worker. * **jobId** *(string) --* The job ID for the job associated with the worker's session. * **startedAt** *(datetime) --* The date and time the resource started running. * **lifecycleStatus** *(string) --* The life cycle status for the worker's session. * **endedAt** *(datetime) --* The date and time the resource ended running. * **targetLifecycleStatus** *(string) --* The life cycle status * **nextToken** *(string) --* The token for the next set of results, or "null" to start from the beginning. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / list_queues list_queues *********** DeadlineCloud.Client.list_queues(**kwargs) Lists queues. See also: AWS API Documentation **Request Syntax** response = client.list_queues( farmId='string', principalId='string', status='IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the queue. * **principalId** (*string*) -- The principal IDs to include in the list of queues. * **status** (*string*) -- The status of the queues listed. * "ACTIVE"–The queues are active. * "SCHEDULING"–The queues are scheduling. * "SCHEDULING_BLOCKED"–The queue scheduling is blocked for these queues. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. Return type: dict Returns: **Response Syntax** { 'queues': [ { 'farmId': 'string', 'queueId': 'string', 'displayName': 'string', 'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED', 'defaultBudgetAction': 'NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', 'blockedReason': 'NO_BUDGET_CONFIGURED'|'BUDGET_THRESHOLD_REACHED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **queues** *(list) --* The queues on the list. * *(dict) --* The details of a queue summary. * **farmId** *(string) --* The farm ID. * **queueId** *(string) --* The queue ID. * **displayName** *(string) --* The display name of the queue summary to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **status** *(string) --* That status of the queue. * **defaultBudgetAction** *(string) --* The default action taken on a queue summary if a budget wasn't configured. * **blockedReason** *(string) --* The reason the queue is blocked, if applicable. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_limit create_limit ************ DeadlineCloud.Client.create_limit(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_limit( clientToken='string', displayName='string', amountRequirementName='string', maxCount=123, farmId='string', description='string' ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **displayName** (*string*) -- **[REQUIRED]** The display name of the limit. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **amountRequirementName** (*string*) -- **[REQUIRED]** The value that you specify as the "name" in the "amounts" field of the "hostRequirements" in a step of a job template to declare the limit requirement. * **maxCount** (*integer*) -- **[REQUIRED]** The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available. The "maxCount" must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm that contains the limit. * **description** (*string*) -- A description of the limit. A description helps you identify the purpose of the limit. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. Return type: dict Returns: **Response Syntax** { 'limitId': 'string' } **Response Structure** * *(dict) --* * **limitId** *(string) --* A unique identifier for the limit. Use this identifier in other operations, such as "CreateQueueLimitAssociation" and "DeleteLimit". **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / get_storage_profile get_storage_profile ******************* DeadlineCloud.Client.get_storage_profile(**kwargs) Gets a storage profile. See also: AWS API Documentation **Request Syntax** response = client.get_storage_profile( farmId='string', storageProfileId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID for the storage profile. * **storageProfileId** (*string*) -- **[REQUIRED]** The storage profile ID. Return type: dict Returns: **Response Syntax** { 'storageProfileId': 'string', 'displayName': 'string', 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'fileSystemLocations': [ { 'name': 'string', 'path': 'string', 'type': 'SHARED'|'LOCAL' }, ] } **Response Structure** * *(dict) --* * **storageProfileId** *(string) --* The storage profile ID. * **displayName** *(string) --* The display name of the storage profile. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **osFamily** *(string) --* The operating system (OS) for the storage profile. * **createdAt** *(datetime) --* The date and time the resource was created. * **createdBy** *(string) --* The user or system that created this resource. * **updatedAt** *(datetime) --* The date and time the resource was updated. * **updatedBy** *(string) --* The user or system that updated this resource. * **fileSystemLocations** *(list) --* The location of the files for the storage profile. * *(dict) --* The details of the file system location for the resource. * **name** *(string) --* The location name. * **path** *(string) --* The file path. * **type** *(string) --* The type of file. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / create_queue create_queue ************ DeadlineCloud.Client.create_queue(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_queue( clientToken='string', farmId='string', displayName='string', description='string', defaultBudgetAction='NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS', jobAttachmentSettings={ 's3BucketName': 'string', 'rootPrefix': 'string' }, roleArn='string', jobRunAsUser={ 'posix': { 'user': 'string', 'group': 'string' }, 'windows': { 'user': 'string', 'passwordArn': 'string' }, 'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER' }, requiredFileSystemLocationNames=[ 'string', ], allowedStorageProfileIds=[ 'string', ], tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID of the farm to connect to the queue. * **displayName** (*string*) -- **[REQUIRED]** The display name of the queue. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the queue. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **defaultBudgetAction** (*string*) -- The default action to take on a queue if a budget isn't configured. * **jobAttachmentSettings** (*dict*) -- The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix. * **s3BucketName** *(string) --* **[REQUIRED]** The Amazon S3 bucket name. * **rootPrefix** *(string) --* **[REQUIRED]** The root prefix. * **roleArn** (*string*) -- The IAM role ARN that workers will use while running jobs for this queue. * **jobRunAsUser** (*dict*) -- The jobs in the queue run as the specified POSIX user. * **posix** *(dict) --* The user and group that the jobs in the queue run as. * **user** *(string) --* **[REQUIRED]** The name of the POSIX user. * **group** *(string) --* **[REQUIRED]** The name of the POSIX user's group. * **windows** *(dict) --* Identifies a Microsoft Windows user. * **user** *(string) --* **[REQUIRED]** The user. * **passwordArn** *(string) --* **[REQUIRED]** The password ARN for the Windows user. * **runAs** *(string) --* **[REQUIRED]** Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user. * **requiredFileSystemLocationNames** (*list*) -- The file system location name to include in the queue. * *(string) --* * **allowedStorageProfileIds** (*list*) -- The storage profile IDs to include in the queue. * *(string) --* * **tags** (*dict*) -- Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'queueId': 'string' } **Response Structure** * *(dict) --* * **queueId** *(string) --* The queue ID. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / update_worker update_worker ************* DeadlineCloud.Client.update_worker(**kwargs) Updates a worker. See also: AWS API Documentation **Request Syntax** response = client.update_worker( farmId='string', fleetId='string', workerId='string', status='STARTED'|'STOPPING'|'STOPPED', capabilities={ 'amounts': [ { 'name': 'string', 'value': ... }, ], 'attributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, hostProperties={ 'ipAddresses': { 'ipV4Addresses': [ 'string', ], 'ipV6Addresses': [ 'string', ] }, 'hostName': 'string' } ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID to update. * **workerId** (*string*) -- **[REQUIRED]** The worker ID to update. * **status** (*string*) -- The worker status to update. * **capabilities** (*dict*) -- The worker capabilities to update. * **amounts** *(list) --* **[REQUIRED]** The worker capabilities amounts on a list of worker capabilities. * *(dict) --* The details of the worker amount capability. * **name** *(string) --* **[REQUIRED]** The name of the worker amount capability. * **value** *(float) --* **[REQUIRED]** The value of the worker amount capability. * **attributes** *(list) --* **[REQUIRED]** The worker attribute capabilities in the list of attribute capabilities. * *(dict) --* The details of the worker attribute capability. * **name** *(string) --* **[REQUIRED]** The name of the worker attribute capability. * **values** *(list) --* **[REQUIRED]** The values of the worker amount capability. * *(string) --* * **hostProperties** (*dict*) -- The host properties to update. * **ipAddresses** *(dict) --* The IP address of the host. * **ipV4Addresses** *(list) --* The IpV4 address of the network. * *(string) --* * **ipV6Addresses** *(list) --* The IpV6 address for the network and node component. * *(string) --* * **hostName** *(string) --* The host name. Return type: dict Returns: **Response Syntax** { 'log': { 'logDriver': 'string', 'options': { 'string': 'string' }, 'parameters': { 'string': 'string' }, 'error': 'string' }, 'hostConfiguration': { 'scriptBody': 'string', 'scriptTimeoutSeconds': 123 } } **Response Structure** * *(dict) --* * **log** *(dict) --* The worker log to update. * **logDriver** *(string) --* The log drivers for worker related logs. * **options** *(dict) --* The options for a log driver. * *(string) --* * *(string) --* * **parameters** *(dict) --* The parameters for the log configuration. * *(string) --* * *(string) --* * **error** *(string) --* The log configuration error details. * **hostConfiguration** *(dict) --* The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. * **scriptBody** *(string) --* The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the "STARTING" state and before the worker processes tasks. For more information about using the script, see Run scripts as an administrator to configure workers in the *Deadline Cloud Developer Guide*. Warning: The script runs as an administrative user ( "sudo root" on Linux, as an Administrator on Windows). * **scriptTimeoutSeconds** *(integer) --* The maximum time that the host configuration can run. If the timeout expires, the worker enters the "NOT RESPONDING" state and shuts down. You are charged for the time that the worker is running the host configuration script. Note: You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers. The default is 300 seconds (5 minutes). **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / delete_queue_limit_association delete_queue_limit_association ****************************** DeadlineCloud.Client.delete_queue_limit_association(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_queue_limit_association( farmId='string', queueId='string', limitId='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the queue and limit to disassociate. * **queueId** (*string*) -- **[REQUIRED]** The unique identifier of the queue to disassociate. * **limitId** (*string*) -- **[REQUIRED]** The unique identifier of the limit to disassociate. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ConflictException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / get_sessions_statistics_aggregation get_sessions_statistics_aggregation *********************************** DeadlineCloud.Client.get_sessions_statistics_aggregation(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_sessions_statistics_aggregation( farmId='string', aggregationId='string', maxResults=123, nextToken='string' ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the "StartSessionsStatisticsAggregation" operation. * **aggregationId** (*string*) -- **[REQUIRED]** The identifier returned by the "StartSessionsStatisticsAggregation" operation that identifies the aggregated statistics. * **maxResults** (*integer*) -- The maximum number of results to return. Use this parameter with "NextToken" to get results as a set of sequential pages. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. Return type: dict Returns: **Response Syntax** { 'statistics': [ { 'queueId': 'string', 'fleetId': 'string', 'jobId': 'string', 'jobName': 'string', 'userId': 'string', 'usageType': 'COMPUTE'|'LICENSE', 'licenseProduct': 'string', 'instanceType': 'string', 'count': 123, 'costInUsd': { 'min': 123.0, 'max': 123.0, 'avg': 123.0, 'sum': 123.0 }, 'runtimeInSeconds': { 'min': 123.0, 'max': 123.0, 'avg': 123.0, 'sum': 123.0 }, 'aggregationStartTime': datetime(2015, 1, 1), 'aggregationEndTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string', 'status': 'IN_PROGRESS'|'TIMEOUT'|'FAILED'|'COMPLETED', 'statusMessage': 'string' } **Response Structure** * *(dict) --* * **statistics** *(list) --* The statistics for the specified fleets or queues. * *(dict) --* A list of statistics for a session. * **queueId** *(string) --* The queue ID. * **fleetId** *(string) --* The fleet ID. * **jobId** *(string) --* The job ID. * **jobName** *(string) --* The job name. * **userId** *(string) --* The user ID. * **usageType** *(string) --* The type of usage for the statistics. * **licenseProduct** *(string) --* The licensed product. * **instanceType** *(string) --* The type of instance. * **count** *(integer) --* The number of instances in a list of statistics. * **costInUsd** *(dict) --* How the statistics should appear in USD. Options include: minimum, maximum, average or sum. * **min** *(float) --* The minimum of the usage statistics. * **max** *(float) --* The maximum among the usage statistics. * **avg** *(float) --* The average of the usage statistics. * **sum** *(float) --* The sum of the usage statistics. * **runtimeInSeconds** *(dict) --* The total aggregated runtime. * **min** *(float) --* The minimum of the usage statistics. * **max** *(float) --* The maximum among the usage statistics. * **avg** *(float) --* The average of the usage statistics. * **sum** *(float) --* The sum of the usage statistics. * **aggregationStartTime** *(datetime) --* The start time for the aggregation. * **aggregationEndTime** *(datetime) --* The end time for the aggregation. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. * **status** *(string) --* The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the "StartSessionsStatisticsAggregation" operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length. If you call the "StartSessionsStatisticsAggregation" operation when the status is "IN_PROGRESS", you will receive a "ThrottlingException". * **statusMessage** *(string) --* A message that describes the status. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_fleet update_fleet ************ DeadlineCloud.Client.update_fleet(**kwargs) Updates a fleet. See also: AWS API Documentation **Request Syntax** response = client.update_fleet( clientToken='string', farmId='string', fleetId='string', displayName='string', description='string', roleArn='string', minWorkerCount=123, maxWorkerCount=123, configuration={ 'customerManaged': { 'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING', 'workerCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'acceleratorTypes': [ 'gpu', ], 'acceleratorCount': { 'min': 123, 'max': 123 }, 'acceleratorTotalMemoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'cpuArchitectureType': 'x86_64'|'arm64', 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'storageProfileId': 'string', 'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH' }, 'serviceManagedEc2': { 'instanceCapabilities': { 'vCpuCount': { 'min': 123, 'max': 123 }, 'memoryMiB': { 'min': 123, 'max': 123 }, 'osFamily': 'WINDOWS'|'LINUX', 'cpuArchitectureType': 'x86_64'|'arm64', 'rootEbsVolume': { 'sizeGiB': 123, 'iops': 123, 'throughputMiB': 123 }, 'acceleratorCapabilities': { 'selections': [ { 'name': 't4'|'a10g'|'l4'|'l40s', 'runtime': 'string' }, ], 'count': { 'min': 123, 'max': 123 } }, 'allowedInstanceTypes': [ 'string', ], 'excludedInstanceTypes': [ 'string', ], 'customAmounts': [ { 'name': 'string', 'min': ..., 'max': ... }, ], 'customAttributes': [ { 'name': 'string', 'values': [ 'string', ] }, ] }, 'instanceMarketOptions': { 'type': 'on-demand'|'spot' }, 'vpcConfiguration': { 'resourceConfigurationArns': [ 'string', ] }, 'storageProfileId': 'string' } }, hostConfiguration={ 'scriptBody': 'string', 'scriptTimeoutSeconds': 123 } ) Parameters: * **clientToken** (*string*) -- The unique token which the server uses to recognize retries of the same request. This field is autopopulated if not provided. * **farmId** (*string*) -- **[REQUIRED]** The farm ID to update. * **fleetId** (*string*) -- **[REQUIRED]** The fleet ID to update. * **displayName** (*string*) -- The display name of the fleet to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **description** (*string*) -- The description of the fleet to update. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **roleArn** (*string*) -- The IAM role ARN that the fleet's workers assume while running jobs. * **minWorkerCount** (*integer*) -- The minimum number of workers in the fleet. * **maxWorkerCount** (*integer*) -- The maximum number of workers in the fleet. 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. * **configuration** (*dict*) -- The fleet configuration to update. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customerManaged", "serviceManagedEc2". * **customerManaged** *(dict) --* The customer managed fleets within a fleet configuration. * **mode** *(string) --* **[REQUIRED]** The Auto Scaling mode for the customer managed fleet configuration. * **workerCapabilities** *(dict) --* **[REQUIRED]** The worker capabilities for a customer managed fleet configuration. * **vCpuCount** *(dict) --* **[REQUIRED]** The vCPU count for the customer manged worker capabilities. * **min** *(integer) --* **[REQUIRED]** The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* **[REQUIRED]** The memory (MiB). * **min** *(integer) --* **[REQUIRED]** The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **acceleratorTypes** *(list) --* The accelerator types for the customer managed worker capabilities. * *(string) --* * **acceleratorCount** *(dict) --* The range of the accelerator. * **min** *(integer) --* **[REQUIRED]** The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **acceleratorTotalMemoryMiB** *(dict) --* The total memory (MiB) for the customer managed worker capabilities. * **min** *(integer) --* **[REQUIRED]** The minimum amount of memory to use for the accelerator, measured in MiB. * **max** *(integer) --* The maximum amount of memory to use for the accelerator, measured in MiB. * **osFamily** *(string) --* **[REQUIRED]** The operating system (OS) family. * **cpuArchitectureType** *(string) --* **[REQUIRED]** The CPU architecture type for the customer managed worker capabilities. * **customAmounts** *(list) --* Custom requirement ranges for customer managed worker capabilities. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* **[REQUIRED]** The name of the fleet capability. * **min** *(float) --* **[REQUIRED]** The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* Custom attributes for the customer manged worker capabilities. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* **[REQUIRED]** The name of the fleet attribute capability for the worker. * **values** *(list) --* **[REQUIRED]** The number of fleet attribute capabilities. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **tagPropagationMode** *(string) --* Specifies whether tags associated with a fleet are attached to workers when the worker is launched. When the "tagPropagationMode" is set to "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers **do not** change. If you don't specify "tagPropagationMode", the default is "NO_PROPAGATION". * **serviceManagedEc2** *(dict) --* The service managed Amazon EC2 instances for a fleet configuration. * **instanceCapabilities** *(dict) --* **[REQUIRED]** The Amazon EC2 instance capabilities. * **vCpuCount** *(dict) --* **[REQUIRED]** The amount of vCPU to require for instances in this fleet. * **min** *(integer) --* **[REQUIRED]** The minimum amount of vCPU. * **max** *(integer) --* The maximum amount of vCPU. * **memoryMiB** *(dict) --* **[REQUIRED]** The memory, as MiB, for the Amazon EC2 instance type. * **min** *(integer) --* **[REQUIRED]** The minimum amount of memory (in MiB). * **max** *(integer) --* The maximum amount of memory (in MiB). * **osFamily** *(string) --* **[REQUIRED]** The operating system (OS) family. * **cpuArchitectureType** *(string) --* **[REQUIRED]** The CPU architecture type. * **rootEbsVolume** *(dict) --* The root EBS volume. * **sizeGiB** *(integer) --* The EBS volume size in GiB. * **iops** *(integer) --* The IOPS per volume. * **throughputMiB** *(integer) --* The throughput per volume in MiB. * **acceleratorCapabilities** *(dict) --* Describes the GPU accelerator capabilities required for worker host instances in this fleet. * **selections** *(list) --* **[REQUIRED]** A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed. * *(dict) --* Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host. * **name** *(string) --* **[REQUIRED]** The name of the chip used by the GPU accelerator. If you specify "l4" as the name of the accelerator, you must specify "latest" or "grid:r570" as the runtime. The available GPU accelerators are: * "t4" - NVIDIA T4 Tensor Core GPU * "a10g" - NVIDIA A10G Tensor Core GPU * "l4" - NVIDIA L4 Tensor Core GPU * "l40s" - NVIDIA L40S Tensor Core GPU * **runtime** *(string) --* Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs. You can choose from the following runtimes: * "latest" - Use the latest runtime available for the chip. If you specify "latest" and a new version of the runtime is released, the new version of the runtime is used. * "grid:r570" - NVIDIA vGPU software 18 * "grid:r535" - NVIDIA vGPU software 16 If you don't specify a runtime, Deadline Cloud uses "latest" as the default. However, if you have multiple accelerators and specify "latest" for some and leave others blank, Deadline Cloud raises an exception. * **count** *(dict) --* The number of GPU accelerators specified for worker hosts in this fleet. * **min** *(integer) --* **[REQUIRED]** The minimum number of GPU accelerators in the worker host. * **max** *(integer) --* The maximum number of GPU accelerators in the worker host. * **allowedInstanceTypes** *(list) --* The allowable Amazon EC2 instance types. * *(string) --* * **excludedInstanceTypes** *(list) --* The instance types to exclude from the fleet. * *(string) --* * **customAmounts** *(list) --* The custom capability amounts to require for instances in this fleet. * *(dict) --* The fleet amount and attribute capabilities. * **name** *(string) --* **[REQUIRED]** The name of the fleet capability. * **min** *(float) --* **[REQUIRED]** The minimum amount of fleet worker capability. * **max** *(float) --* The maximum amount of the fleet worker capability. * **customAttributes** *(list) --* The custom capability attributes to require for instances in this fleet. * *(dict) --* Defines the fleet's capability name, minimum, and maximum. * **name** *(string) --* **[REQUIRED]** The name of the fleet attribute capability for the worker. * **values** *(list) --* **[REQUIRED]** The number of fleet attribute capabilities. * *(string) --* * **instanceMarketOptions** *(dict) --* **[REQUIRED]** The Amazon EC2 market type. * **type** *(string) --* **[REQUIRED]** The Amazon EC2 instance type. * **vpcConfiguration** *(dict) --* The VPC configuration details for a service managed Amazon EC2 fleet. * **resourceConfigurationArns** *(list) --* The ARNs of the VPC Lattice resource configurations attached to the fleet. * *(string) --* * **storageProfileId** *(string) --* The storage profile ID. * **hostConfiguration** (*dict*) -- Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. * **scriptBody** *(string) --* **[REQUIRED]** The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the "STARTING" state and before the worker processes tasks. For more information about using the script, see Run scripts as an administrator to configure workers in the *Deadline Cloud Developer Guide*. Warning: The script runs as an administrative user ( "sudo root" on Linux, as an Administrator on Windows). * **scriptTimeoutSeconds** *(integer) --* The maximum time that the host configuration can run. If the timeout expires, the worker enters the "NOT RESPONDING" state and shuts down. You are charged for the time that the worker is running the host configuration script. Note: You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers. The default is 300 seconds (5 minutes). Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" * "DeadlineCloud.Client.exceptions.ServiceQuotaExceededException" DeadlineCloud / Client / list_limits list_limits *********** DeadlineCloud.Client.list_limits(**kwargs) Gets a list of limits defined in the specified farm. See also: AWS API Documentation **Request Syntax** response = client.list_limits( farmId='string', nextToken='string', maxResults=123 ) Parameters: * **farmId** (*string*) -- **[REQUIRED]** The unique identifier of the farm that contains the limits. * **nextToken** (*string*) -- The token for the next set of results, or "null" to start from the beginning. * **maxResults** (*integer*) -- The maximum number of limits to return in each page of results. Return type: dict Returns: **Response Syntax** { 'limits': [ { 'displayName': 'string', 'amountRequirementName': 'string', 'maxCount': 123, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'farmId': 'string', 'limitId': 'string', 'currentCount': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **limits** *(list) --* A list of limits that the farm contains. * *(dict) --* Provides information about a specific limit. * **displayName** *(string) --* The name of the limit used in lists to identify the limit. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **amountRequirementName** *(string) --* The value that you specify as the "name" in the "amounts" field of the "hostRequirements" in a step of a job template to declare the limit requirement. * **maxCount** *(integer) --* The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available. The "maxValue" must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit. * **createdAt** *(datetime) --* The Unix timestamp of the date and time that the limit was created. * **createdBy** *(string) --* The user identifier of the person that created the limit. * **updatedAt** *(datetime) --* The Unix timestamp of the date and time that the limit was last updated. * **updatedBy** *(string) --* The user identifier of the person that last updated the limit. * **farmId** *(string) --* The unique identifier of the farm that contains the limit. * **limitId** *(string) --* The unique identifier of the limit. * **currentCount** *(integer) --* The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation. * **nextToken** *(string) --* If Deadline Cloud returns "nextToken", then there are more results available. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 "ValidationException" error. **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException" DeadlineCloud / Client / update_monitor update_monitor ************** DeadlineCloud.Client.update_monitor(**kwargs) Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call "UpdateMonitor". See also: AWS API Documentation **Request Syntax** response = client.update_monitor( monitorId='string', subdomain='string', displayName='string', roleArn='string' ) Parameters: * **monitorId** (*string*) -- **[REQUIRED]** The unique identifier of the monitor to update. * **subdomain** (*string*) -- The new value of the subdomain to use when forming the monitor URL. * **displayName** (*string*) -- The new value to use for the monitor's display name. Warning: This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of the new IAM role to use with the monitor. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DeadlineCloud.Client.exceptions.AccessDeniedException" * "DeadlineCloud.Client.exceptions.InternalServerErrorException" * "DeadlineCloud.Client.exceptions.ResourceNotFoundException" * "DeadlineCloud.Client.exceptions.ThrottlingException" * "DeadlineCloud.Client.exceptions.ValidationException"