2024/04/01 - AWSDeadlineCloud - 102 new api methods
Changes AWS Deadline Cloud is a new fully managed service that helps customers set up, deploy, and scale rendering projects in minutes, so they can improve the efficiency of their rendering pipelines and take on more projects.
Searches for workers.
See also: AWS API Documentation
Request Syntax
client.search_workers(
farmId='string',
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'dateTime': datetime(2015, 1, 1),
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'
},
'groupFilter': {'... recursive ...'},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
}
},
],
'operator': 'AND'|'OR'
},
fleetIds=[
'string',
],
itemOffset=123,
pageSize=123,
sortExpressions=[
{
'fieldSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'parameterSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'userJobsFirst': {
'userIdentityId': 'string'
}
},
]
)
string
[REQUIRED]
The farm ID in the workers search.
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.
dateTimeFilter (dict) --
Filters based on date and time.
dateTime (datetime) -- [REQUIRED]
The 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.
groupFilter (dict) --
Filters by group.
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.
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.
operator (string) -- [REQUIRED]
The operators to include in the search.
list
[REQUIRED]
The fleet ID of the workers to search for.
(string) --
integer
[REQUIRED]
Defines how far into the scrollable list to start the return of results.
integer
Specifies the number of items per page for the resource.
list
The search terms for a resource.
(dict) --
The resources to search.
fieldSort (dict) --
Options for sorting by a field.
name (string) -- [REQUIRED]
The name of the field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
parameterSort (dict) --
Options for sorting by a parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
dict
Response Syntax
{
'nextItemOffset': 123,
'totalResults': 123,
'workers': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'fleetId': 'string',
'hostProperties': {
'ec2InstanceArn': 'string',
'ec2InstanceType': 'string',
'hostName': 'string',
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
}
},
'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'workerId': 'string'
},
]
}
Response Structure
(dict) --
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset .
totalResults (integer) --
The total number of results in the search.
workers (list) --
The workers for the search.
(dict) --
The details of a worker search.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
fleetId (string) --
The fleet ID.
hostProperties (dict) --
Provides the Amazon EC2 instance properties of the worker host.
ec2InstanceArn (string) --
The ARN of the host EC2 instance.
ec2InstanceType (string) --
The instance type of the host EC2 instance.
hostName (string) --
The host name.
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) --
status (string) --
The status of the worker search.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
workerId (string) --
The worker ID.
Lists storage profiles.
See also: AWS API Documentation
Request Syntax
client.list_storage_profiles(
farmId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The farm ID of the storage profile.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'nextToken': 'string',
'storageProfiles': [
{
'displayName': 'string',
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'storageProfileId': '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.
storageProfiles (list) --
The storage profiles.
(dict) --
The details of a storage profile.
displayName (string) --
The display name of the storage profile summary to update.
osFamily (string) --
The operating system (OS) family.
storageProfileId (string) --
The storage profile ID.
Deletes a worker.
See also: AWS API Documentation
Request Syntax
client.delete_worker(
farmId='string',
fleetId='string',
workerId='string'
)
string
[REQUIRED]
The farm ID of the worker to delete.
string
[REQUIRED]
The fleet ID of the worker to delete.
string
[REQUIRED]
The worker ID of the worker to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a farm.
See also: AWS API Documentation
Request Syntax
client.delete_farm(
farmId='string'
)
string
[REQUIRED]
The farm ID of the farm to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates a member from a fleet.
See also: AWS API Documentation
Request Syntax
client.disassociate_member_from_fleet(
farmId='string',
fleetId='string',
principalId='string'
)
string
[REQUIRED]
The farm ID of the fleet to disassociate a member from.
string
[REQUIRED]
The fleet ID of the fleet to from which to disassociate a member.
string
[REQUIRED]
A member's principal ID to disassociate from a fleet.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a queue-fleet association.
See also: AWS API Documentation
Request Syntax
client.update_queue_fleet_association(
farmId='string',
fleetId='string',
queueId='string',
status='ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'
)
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The fleet ID to update.
string
[REQUIRED]
The queue ID to update.
string
[REQUIRED]
The status to update.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates a member from a farm.
See also: AWS API Documentation
Request Syntax
client.disassociate_member_from_farm(
farmId='string',
principalId='string'
)
string
[REQUIRED]
The farm ID of the farm to disassociate from the member.
string
[REQUIRED]
A member's principal ID to disassociate from a farm.
dict
Response Syntax
{}
Response Structure
(dict) --
Get a farm.
See also: AWS API Documentation
Request Syntax
client.get_farm(
farmId='string'
)
string
[REQUIRED]
The farm ID of the farm.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'displayName': 'string',
'farmId': 'string',
'kmsKeyArn': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
description (string) --
The description of the farm.
displayName (string) --
The display name of the farm.
farmId (string) --
The farm ID of the farm to get.
kmsKeyArn (string) --
The ARN of the KMS key used on the farm.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Deletes a queue environment.
See also: AWS API Documentation
Request Syntax
client.delete_queue_environment(
farmId='string',
queueEnvironmentId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the farm from which to remove the queue environment.
string
[REQUIRED]
The queue environment ID of the queue environment to delete.
string
[REQUIRED]
The queue ID of the queue environment to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists license endpoints.
See also: AWS API Documentation
Request Syntax
client.list_license_endpoints(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
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.
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
client.delete_monitor(
monitorId='string'
)
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the dependencies for a step.
See also: AWS API Documentation
Request Syntax
client.list_step_dependencies(
farmId='string',
jobId='string',
maxResults=123,
nextToken='string',
queueId='string',
stepId='string'
)
string
[REQUIRED]
The farm ID for the step dependencies list.
string
[REQUIRED]
The job ID for the step dependencies list.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID for the step dependencies list.
string
[REQUIRED]
The step ID to include on the list.
dict
Response Syntax
{
'dependencies': [
{
'status': 'RESOLVED'|'UNRESOLVED',
'stepId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dependencies (list) --
The dependencies on the list.
(dict) --
The details of step dependency.
status (string) --
The step dependency status.
stepId (string) --
The step ID.
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.
Gets information about the specified monitor.
See also: AWS API Documentation
Request Syntax
client.get_monitor(
monitorId='string'
)
string
[REQUIRED]
The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'displayName': 'string',
'identityCenterApplicationArn': 'string',
'identityCenterInstanceArn': 'string',
'monitorId': 'string',
'roleArn': 'string',
'subdomain': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'url': 'string'
}
Response Structure
(dict) --
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.
displayName (string) --
The name used to identify the monitor on the Deadline Cloud console.
identityCenterApplicationArn (string) --
The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
identityCenterInstanceArn (string) --
The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
monitorId (string) --
The unique identifier for the monitor.
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.
subdomain (string) --
The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
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.
url (string) --
The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
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
client.create_storage_profile(
clientToken='string',
displayName='string',
farmId='string',
fileSystemLocations=[
{
'name': 'string',
'path': 'string',
'type': 'SHARED'|'LOCAL'
},
],
osFamily='WINDOWS'|'LINUX'|'MACOS'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The display name of the storage profile.
string
[REQUIRED]
The farm ID of the farm to connect to the storage profile.
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.
string
[REQUIRED]
The type of operating system (OS) for the storage profile.
dict
Response Syntax
{
'storageProfileId': 'string'
}
Response Structure
(dict) --
storageProfileId (string) --
The storage profile ID.
Get a budget.
See also: AWS API Documentation
Request Syntax
client.get_budget(
budgetId='string',
farmId='string'
)
string
[REQUIRED]
The budget ID.
string
[REQUIRED]
The farm ID of the farm connected to the budget.
dict
Response Syntax
{
'actions': [
{
'description': 'string',
'thresholdPercentage': ...,
'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'
},
],
'approximateDollarLimit': ...,
'budgetId': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'displayName': 'string',
'queueStoppedAt': datetime(2015, 1, 1),
'schedule': {
'fixed': {
'endTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1)
}
},
'status': 'ACTIVE'|'INACTIVE',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'usageTrackingResource': {
'queueId': 'string'
},
'usages': {
'approximateDollarUsage': ...
}
}
Response Structure
(dict) --
actions (list) --
The budget actions for the budget.
(dict) --
The details of a budget action.
description (string) --
The budget action description.
thresholdPercentage (float) --
The percentage threshold for the budget.
type (string) --
The action taken on the budget once scheduling stops.
approximateDollarLimit (float) --
The consumed usage limit for the budget.
budgetId (string) --
The budget ID.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
description (string) --
The description of the budget.
displayName (string) --
The display name of the budget.
queueStoppedAt (datetime) --
The date and time the queue stopped.
schedule (dict) --
The budget schedule.
fixed (dict) --
The fixed start and end time of the budget's schedule.
endTime (datetime) --
When the budget ends.
startTime (datetime) --
When the budget starts.
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.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
usageTrackingResource (dict) --
The resource that the budget is tracking usage for.
queueId (string) --
The queue ID.
usages (dict) --
The usages of the budget.
approximateDollarUsage (float) --
The amount of the budget consumed.
Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
See also: AWS API Documentation
Request Syntax
client.start_sessions_statistics_aggregation(
endTime=datetime(2015, 1, 1),
farmId='string',
groupBy=[
'QUEUE_ID'|'FLEET_ID'|'JOB_ID'|'USER_ID'|'USAGE_TYPE'|'INSTANCE_TYPE'|'LICENSE_PRODUCT',
],
period='HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
resourceIds={
'fleetIds': [
'string',
],
'queueIds': [
'string',
]
},
startTime=datetime(2015, 1, 1),
statistics=[
'SUM'|'MIN'|'MAX'|'AVG',
],
timezone='string'
)
datetime
[REQUIRED]
The Linux timestamp of the date and time that the statistics end.
string
[REQUIRED]
The identifier of the farm that contains queues or fleets to return statistics for.
list
[REQUIRED]
The field to use to group the statistics.
(string) --
string
The period to aggregate the statistics.
dict
[REQUIRED]
A list of fleet IDs or queue IDs to gather statistics for.
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) --
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) --
datetime
[REQUIRED]
The Linux timestamp of the date and time that the statistics start.
list
[REQUIRED]
One to four statistics to return.
(string) --
string
The timezone to use for the statistics. Use UTC notation such as "UTC+8."
dict
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.
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
client.get_sessions_statistics_aggregation(
aggregationId='string',
farmId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.
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.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'nextToken': 'string',
'statistics': [
{
'aggregationEndTime': datetime(2015, 1, 1),
'aggregationStartTime': datetime(2015, 1, 1),
'costInUsd': {
'avg': 123.0,
'max': 123.0,
'min': 123.0,
'sum': 123.0
},
'count': 123,
'fleetId': 'string',
'instanceType': 'string',
'jobId': 'string',
'jobName': 'string',
'licenseProduct': 'string',
'queueId': 'string',
'runtimeInSeconds': {
'avg': 123.0,
'max': 123.0,
'min': 123.0,
'sum': 123.0
},
'usageType': 'COMPUTE'|'LICENSE',
'userId': 'string'
},
],
'status': 'IN_PROGRESS'|'TIMEOUT'|'FAILED'|'COMPLETED',
'statusMessage': '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.
statistics (list) --
The statistics for the specified fleets or queues.
(dict) --
A list of statistics for a session.
aggregationEndTime (datetime) --
The end time for the aggregation.
aggregationStartTime (datetime) --
The start time for the aggregation.
costInUsd (dict) --
How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
avg (float) --
The average of the usage statistics.
max (float) --
The maximum among the usage statistics.
min (float) --
The minimum of the usage statistics.
sum (float) --
The sum of the usage statistics.
count (integer) --
The number of instances in a list of statistics.
fleetId (string) --
The fleet ID.
instanceType (string) --
The type of instance.
jobId (string) --
The job ID.
jobName (string) --
The job name.
licenseProduct (string) --
The licensed product.
queueId (string) --
The queue ID.
runtimeInSeconds (dict) --
The total aggregated runtime.
avg (float) --
The average of the usage statistics.
max (float) --
The maximum among the usage statistics.
min (float) --
The minimum of the usage statistics.
sum (float) --
The sum of the usage statistics.
usageType (string) --
The type of usage for the statistics.
userId (string) --
The user ID.
status (string) --
The status of the aggregated results.
statusMessage (string) --
A message that describes the status.
Deletes a license endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_license_endpoint(
licenseEndpointId='string'
)
string
[REQUIRED]
The license endpoint ID of the license endpoint to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an environment for a queue that defines how jobs in the queue run.
See also: AWS API Documentation
Request Syntax
client.create_queue_environment(
clientToken='string',
farmId='string',
priority=123,
queueId='string',
template='string',
templateType='JSON'|'YAML'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID of the farm to connect to the environment.
integer
[REQUIRED]
Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.
string
[REQUIRED]
The queue ID to connect the queue and environment.
string
[REQUIRED]
The environment template to use in the queue.
string
[REQUIRED]
The template's file type, JSON or YAML .
dict
Response Syntax
{
'queueEnvironmentId': 'string'
}
Response Structure
(dict) --
queueEnvironmentId (string) --
The queue environment ID.
Lists fleets.
See also: AWS API Documentation
Request Syntax
client.list_fleets(
displayName='string',
farmId='string',
maxResults=123,
nextToken='string',
principalId='string',
status='ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'
)
string
The display names of a list of fleets.
string
[REQUIRED]
The farm ID of the fleets.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
The principal ID of the members to include in the fleet.
string
The status of the fleet.
dict
Response Syntax
{
'fleets': [
{
'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING',
'configuration': {
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'storageProfileId': 'string',
'workerCapabilities': {
'acceleratorCount': {
'max': 123,
'min': 123
},
'acceleratorTotalMemoryMiB': {
'max': 123,
'min': 123
},
'acceleratorTypes': [
'gpu',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'vCpuCount': {
'max': 123,
'min': 123
}
}
},
'serviceManagedEc2': {
'instanceCapabilities': {
'allowedInstanceTypes': [
'string',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'excludedInstanceTypes': [
'string',
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'rootEbsVolume': {
'iops': 123,
'sizeGiB': 123,
'throughputMiB': 123
},
'vCpuCount': {
'max': 123,
'min': 123
}
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'
}
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'displayName': 'string',
'farmId': 'string',
'fleetId': 'string',
'maxWorkerCount': 123,
'minWorkerCount': 123,
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED',
'targetWorkerCount': 123,
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'workerCount': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
fleets (list) --
The fleets on the list.
(dict) --
The details of a fleet.
autoScalingStatus (string) --
The Auto Scaling status of a fleet.
configuration (dict) --
The configuration details for the fleet.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) --
The Auto Scaling mode for the customer managed fleet configuration.
storageProfileId (string) --
The storage profile ID.
workerCapabilities (dict) --
The worker capabilities for a customer managed fleet configuration.
acceleratorCount (dict) --
The range of the accelerator.
max (integer) --
The maximum GPU for the accelerator.
min (integer) --
The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
min (integer) --
The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
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.
max (float) --
The maximum amount of the fleet worker capability.
min (float) --
The minimum amount of fleet worker capability.
name (string) --
The name of the fleet 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) --
memoryMiB (dict) --
The memory (MiB).
max (integer) --
The maximum amount of memory (in MiB).
min (integer) --
The minimum amount of memory (in MiB).
osFamily (string) --
The operating system (OS) family.
vCpuCount (dict) --
The vCPU count for the customer manged worker capabilities.
max (integer) --
The maximum amount of vCPU.
min (integer) --
The minimum amount of vCPU.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) --
The Amazon EC2 instance capabilities.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
cpuArchitectureType (string) --
The CPU architecture type.
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
max (float) --
The maximum amount of the fleet worker capability.
min (float) --
The minimum amount of fleet worker capability.
name (string) --
The name of the fleet 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) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
memoryMiB (dict) --
The memory, as MiB, for the Amazon EC2 instance type.
max (integer) --
The maximum amount of memory (in MiB).
min (integer) --
The minimum amount of memory (in MiB).
osFamily (string) --
The operating system (OS) family.
rootEbsVolume (dict) --
The root EBS volume.
iops (integer) --
The IOPS per volume.
sizeGiB (integer) --
The EBS volume size in GiB.
throughputMiB (integer) --
The throughput per volume in MiB.
vCpuCount (dict) --
The amount of vCPU to require for instances in this fleet.
max (integer) --
The maximum amount of vCPU.
min (integer) --
The minimum amount of vCPU.
instanceMarketOptions (dict) --
The Amazon EC2 market type.
type (string) --
The Amazon EC2 instance type.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
displayName (string) --
The display name of the fleet summary to update.
farmId (string) --
The farm ID.
fleetId (string) --
The fleet ID.
maxWorkerCount (integer) --
The maximum number of workers specified in the fleet.
minWorkerCount (integer) --
The minimum number of workers in the fleet.
status (string) --
The status of the fleet.
targetWorkerCount (integer) --
The target number of workers in a fleet.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
workerCount (integer) --
The number of workers in the fleet summary.
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.
Updates a storage profile.
See also: AWS API Documentation
Request Syntax
client.update_storage_profile(
clientToken='string',
displayName='string',
farmId='string',
fileSystemLocationsToAdd=[
{
'name': 'string',
'path': 'string',
'type': 'SHARED'|'LOCAL'
},
],
fileSystemLocationsToRemove=[
{
'name': 'string',
'path': 'string',
'type': 'SHARED'|'LOCAL'
},
],
osFamily='WINDOWS'|'LINUX'|'MACOS',
storageProfileId='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The display name of the storage profile to update.
string
[REQUIRED]
The farm ID to update.
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.
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.
string
The OS system to update.
string
[REQUIRED]
The storage profile ID to update.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a budget.
See also: AWS API Documentation
Request Syntax
client.delete_budget(
budgetId='string',
farmId='string'
)
string
[REQUIRED]
The budget ID of the budget to delete.
string
[REQUIRED]
The farm ID of the farm to remove from the budget.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an association between a queue and a fleet.
See also: AWS API Documentation
Request Syntax
client.create_queue_fleet_association(
farmId='string',
fleetId='string',
queueId='string'
)
string
[REQUIRED]
The ID of the farm that the queue and fleet belong to.
string
[REQUIRED]
The fleet ID.
string
[REQUIRED]
The queue ID.
dict
Response Syntax
{}
Response Structure
(dict) --
Allows a user to assume a role for a queue.
See also: AWS API Documentation
Request Syntax
client.assume_queue_role_for_user(
farmId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the queue that the user assumes the role for.
string
[REQUIRED]
The queue ID of the queue that the user assumes the role for.
dict
Response Syntax
{
'credentials': {
'accessKeyId': 'string',
'expiration': datetime(2015, 1, 1),
'secretAccessKey': 'string',
'sessionToken': 'string'
}
}
Response Structure
(dict) --
credentials (dict) --
The credentials for the queue role that a user has access to.
accessKeyId (string) --
The IAM access key ID.
expiration (datetime) --
The expiration date and time of the IAM credentials.
secretAccessKey (string) --
The IAM secret access key.
sessionToken (string) --
The IAM session token
Lists queue-fleet associations.
See also: AWS API Documentation
Request Syntax
client.list_queue_fleet_associations(
farmId='string',
fleetId='string',
maxResults=123,
nextToken='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the queue-fleet association list.
string
The fleet ID for the queue-fleet association list.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
The queue ID for the queue-fleet association list.
dict
Response Syntax
{
'nextToken': 'string',
'queueFleetAssociations': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'fleetId': 'string',
'queueId': 'string',
'status': 'ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'|'STOPPED',
'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.
queueFleetAssociations (list) --
The queue-fleet associations on the list.
(dict) --
The details of a queue-fleet association.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
fleetId (string) --
The fleet ID.
queueId (string) --
The queue 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.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Gets a session action for the job.
See also: AWS API Documentation
Request Syntax
client.get_session_action(
farmId='string',
jobId='string',
queueId='string',
sessionActionId='string'
)
string
[REQUIRED]
The farm ID for the session action.
string
[REQUIRED]
The job ID for the session.
string
[REQUIRED]
The queue ID for the session action.
string
[REQUIRED]
The session action ID for the session.
dict
Response Syntax
{
'definition': {
'envEnter': {
'environmentId': 'string'
},
'envExit': {
'environmentId': 'string'
},
'syncInputJobAttachments': {
'stepId': 'string'
},
'taskRun': {
'parameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'stepId': 'string',
'taskId': 'string'
}
},
'endedAt': datetime(2015, 1, 1),
'processExitCode': 123,
'progressMessage': 'string',
'progressPercent': ...,
'sessionActionId': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED',
'workerUpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
definition (dict) --
The session action definition.
envEnter (dict) --
The environment to enter into.
environmentId (string) --
The environment ID.
envExit (dict) --
The environment to exit from.
environmentId (string) --
The environment ID.
syncInputJobAttachments (dict) --
The job attachments to sync with a session action.
stepId (string) --
The step ID for the step in the job attachment.
taskRun (dict) --
The task run in the session.
parameters (dict) --
The task parameters.
(string) --
(dict) --
The data types for the task parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
stepId (string) --
The step ID.
taskId (string) --
The task ID.
endedAt (datetime) --
The date and time the resource ended running.
processExitCode (integer) --
The exit code to exit the session.
progressMessage (string) --
The message that communicates the progress of the session action.
progressPercent (float) --
The percentage completed for a session action.
sessionActionId (string) --
The session action ID.
sessionId (string) --
The session ID for the session action.
startedAt (datetime) --
The date and time the resource started running.
status (string) --
The status of the session action.
workerUpdatedAt (datetime) --
The Linux timestamp of the date and time the session action was last updated.
Updates the queue environment.
See also: AWS API Documentation
Request Syntax
client.update_queue_environment(
clientToken='string',
farmId='string',
priority=123,
queueEnvironmentId='string',
queueId='string',
template='string',
templateType='JSON'|'YAML'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID of the queue environment to update.
integer
The priority to update.
string
[REQUIRED]
The queue environment ID to update.
string
[REQUIRED]
The queue ID of the queue environment to update.
string
The template to update.
string
The template type to update.
dict
Response Syntax
{}
Response Structure
(dict) --
Tags a resource using the resource's ARN and desired tags.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource to apply tags to.
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) --
dict
Response Syntax
{}
Response Structure
(dict) --
Lists tasks for a job.
See also: AWS API Documentation
Request Syntax
client.list_tasks(
farmId='string',
jobId='string',
maxResults=123,
nextToken='string',
queueId='string',
stepId='string'
)
string
[REQUIRED]
The farm ID connected to the tasks.
string
[REQUIRED]
The job ID for the tasks.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID connected to the tasks.
string
[REQUIRED]
The step ID for the tasks.
dict
Response Syntax
{
'nextToken': 'string',
'tasks': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'endedAt': datetime(2015, 1, 1),
'failureRetryCount': 123,
'latestSessionActionId': 'string',
'parameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'startedAt': datetime(2015, 1, 1),
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskId': '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.
tasks (list) --
Tasks for the job.
(dict) --
The details of a task.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
endedAt (datetime) --
The date and time the resource ended running.
failureRetryCount (integer) --
The number of times that the task failed and was retried.
latestSessionActionId (string) --
The latest session action for the task.
parameters (dict) --
The task parameters.
(string) --
(dict) --
The data types for the task parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
runStatus (string) --
The run status of the task.
startedAt (datetime) --
The date and time the resource started running.
targetRunStatus (string) --
The run status on which the started.
taskId (string) --
The task ID.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
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
client.create_fleet(
clientToken='string',
configuration={
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'storageProfileId': 'string',
'workerCapabilities': {
'acceleratorCount': {
'max': 123,
'min': 123
},
'acceleratorTotalMemoryMiB': {
'max': 123,
'min': 123
},
'acceleratorTypes': [
'gpu',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'vCpuCount': {
'max': 123,
'min': 123
}
}
},
'serviceManagedEc2': {
'instanceCapabilities': {
'allowedInstanceTypes': [
'string',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'excludedInstanceTypes': [
'string',
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'rootEbsVolume': {
'iops': 123,
'sizeGiB': 123,
'throughputMiB': 123
},
'vCpuCount': {
'max': 123,
'min': 123
}
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'
}
}
},
description='string',
displayName='string',
farmId='string',
maxWorkerCount=123,
minWorkerCount=123,
roleArn='string',
tags={
'string': 'string'
}
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
dict
[REQUIRED]
The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) -- [REQUIRED]
The Auto Scaling mode for the customer managed fleet configuration.
storageProfileId (string) --
The storage profile ID.
workerCapabilities (dict) -- [REQUIRED]
The worker capabilities for a customer managed fleet configuration.
acceleratorCount (dict) --
The range of the accelerator.
max (integer) --
The maximum GPU for the accelerator.
min (integer) -- [REQUIRED]
The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
min (integer) -- [REQUIRED]
The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
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.
max (float) --
The maximum amount of the fleet worker capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
name (string) -- [REQUIRED]
The name of the fleet 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) --
memoryMiB (dict) -- [REQUIRED]
The memory (MiB).
max (integer) --
The maximum amount of memory (in MiB).
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
vCpuCount (dict) -- [REQUIRED]
The vCPU count for the customer manged worker capabilities.
max (integer) --
The maximum amount of vCPU.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) -- [REQUIRED]
The Amazon EC2 instance capabilities.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
cpuArchitectureType (string) -- [REQUIRED]
The CPU architecture type.
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
max (float) --
The maximum amount of the fleet worker capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
name (string) -- [REQUIRED]
The name of the fleet 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) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
memoryMiB (dict) -- [REQUIRED]
The memory, as MiB, for the Amazon EC2 instance type.
max (integer) --
The maximum amount of memory (in MiB).
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
rootEbsVolume (dict) --
The root EBS volume.
iops (integer) --
The IOPS per volume.
sizeGiB (integer) --
The EBS volume size in GiB.
throughputMiB (integer) --
The throughput per volume in MiB.
vCpuCount (dict) -- [REQUIRED]
The amount of vCPU to require for instances in this fleet.
max (integer) --
The maximum amount of vCPU.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
instanceMarketOptions (dict) -- [REQUIRED]
The Amazon EC2 market type.
type (string) -- [REQUIRED]
The Amazon EC2 instance type.
string
The description of the fleet.
string
[REQUIRED]
The display name of the fleet.
string
[REQUIRED]
The farm ID of the farm to connect to the fleet.
integer
[REQUIRED]
The maximum number of workers for the fleet.
integer
The minimum number of workers for the fleet.
string
[REQUIRED]
The IAM role ARN for the role that the fleet's workers will use.
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) --
dict
Response Syntax
{
'fleetId': 'string'
}
Response Structure
(dict) --
fleetId (string) --
The fleet ID.
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
client.create_farm(
clientToken='string',
description='string',
displayName='string',
kmsKeyArn='string',
tags={
'string': 'string'
}
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The description of the farm.
string
[REQUIRED]
The display name of the farm.
string
The ARN of the KMS key to use on the farm.
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) --
dict
Response Syntax
{
'farmId': 'string'
}
Response Structure
(dict) --
farmId (string) --
The farm ID.
Gets a step.
See also: AWS API Documentation
Request Syntax
client.get_step(
farmId='string',
jobId='string',
queueId='string',
stepId='string'
)
string
[REQUIRED]
The farm ID for the step.
string
[REQUIRED]
The job ID for the step.
string
[REQUIRED]
The queue ID for the step.
string
[REQUIRED]
The step ID.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'dependencyCounts': {
'consumersResolved': 123,
'consumersUnresolved': 123,
'dependenciesResolved': 123,
'dependenciesUnresolved': 123
},
'description': 'string',
'endedAt': datetime(2015, 1, 1),
'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
'lifecycleStatusMessage': 'string',
'name': 'string',
'parameterSpace': {
'combination': 'string',
'parameters': [
{
'name': 'string',
'type': 'INT'|'FLOAT'|'STRING'|'PATH'
},
]
},
'requiredCapabilities': {
'amounts': [
{
'max': 123.0,
'min': 123.0,
'name': 'string',
'value': 123.0
},
],
'attributes': [
{
'allOf': [
'string',
],
'anyOf': [
'string',
],
'name': 'string'
},
]
},
'startedAt': datetime(2015, 1, 1),
'stepId': 'string',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
dependencyCounts (dict) --
The number of dependencies in the step.
consumersResolved (integer) --
The number of consumers resolved.
consumersUnresolved (integer) --
The number of unresolved consumers.
dependenciesResolved (integer) --
The number of resolved dependencies.
dependenciesUnresolved (integer) --
The number of unresolved dependencies.
description (string) --
The description of the step.
endedAt (datetime) --
The date and time the resource ended running.
lifecycleStatus (string) --
The life cycle status of the step.
lifecycleStatusMessage (string) --
A message that describes the lifecycle status of the step.
name (string) --
The name of the step.
parameterSpace (dict) --
A list of step parameters and the combination expression for the step.
combination (string) --
The combination expression to use in 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.
requiredCapabilities (dict) --
The required capabilities of the step.
amounts (list) --
The capability amounts that the step requires.
(dict) --
The details outlining the minimum and maximum capability of a step.
max (float) --
The maximum amount.
min (float) --
The minimum amount.
name (string) --
The name of the step.
value (float) --
The amount value.
attributes (list) --
The capability attributes that the step requires.
(dict) --
The list of step attributes.
allOf (list) --
Requires all of the step attribute values.
(string) --
anyOf (list) --
Requires any of the step attributes in a given list.
(string) --
name (string) --
The name of the step attribute.
startedAt (datetime) --
The date and time the resource started running.
stepId (string) --
The step ID.
targetTaskRunStatus (string) --
The task status with which the job started.
taskRunStatus (string) --
The task run status for the job.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Updates a fleet.
See also: AWS API Documentation
Request Syntax
client.update_fleet(
clientToken='string',
configuration={
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'storageProfileId': 'string',
'workerCapabilities': {
'acceleratorCount': {
'max': 123,
'min': 123
},
'acceleratorTotalMemoryMiB': {
'max': 123,
'min': 123
},
'acceleratorTypes': [
'gpu',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'vCpuCount': {
'max': 123,
'min': 123
}
}
},
'serviceManagedEc2': {
'instanceCapabilities': {
'allowedInstanceTypes': [
'string',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'excludedInstanceTypes': [
'string',
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'rootEbsVolume': {
'iops': 123,
'sizeGiB': 123,
'throughputMiB': 123
},
'vCpuCount': {
'max': 123,
'min': 123
}
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'
}
}
},
description='string',
displayName='string',
farmId='string',
fleetId='string',
maxWorkerCount=123,
minWorkerCount=123,
roleArn='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
dict
The fleet configuration to update.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) -- [REQUIRED]
The Auto Scaling mode for the customer managed fleet configuration.
storageProfileId (string) --
The storage profile ID.
workerCapabilities (dict) -- [REQUIRED]
The worker capabilities for a customer managed fleet configuration.
acceleratorCount (dict) --
The range of the accelerator.
max (integer) --
The maximum GPU for the accelerator.
min (integer) -- [REQUIRED]
The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
min (integer) -- [REQUIRED]
The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
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.
max (float) --
The maximum amount of the fleet worker capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
name (string) -- [REQUIRED]
The name of the fleet 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) --
memoryMiB (dict) -- [REQUIRED]
The memory (MiB).
max (integer) --
The maximum amount of memory (in MiB).
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
vCpuCount (dict) -- [REQUIRED]
The vCPU count for the customer manged worker capabilities.
max (integer) --
The maximum amount of vCPU.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) -- [REQUIRED]
The Amazon EC2 instance capabilities.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
cpuArchitectureType (string) -- [REQUIRED]
The CPU architecture type.
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
max (float) --
The maximum amount of the fleet worker capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
name (string) -- [REQUIRED]
The name of the fleet 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) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
memoryMiB (dict) -- [REQUIRED]
The memory, as MiB, for the Amazon EC2 instance type.
max (integer) --
The maximum amount of memory (in MiB).
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
rootEbsVolume (dict) --
The root EBS volume.
iops (integer) --
The IOPS per volume.
sizeGiB (integer) --
The EBS volume size in GiB.
throughputMiB (integer) --
The throughput per volume in MiB.
vCpuCount (dict) -- [REQUIRED]
The amount of vCPU to require for instances in this fleet.
max (integer) --
The maximum amount of vCPU.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
instanceMarketOptions (dict) -- [REQUIRED]
The Amazon EC2 market type.
type (string) -- [REQUIRED]
The Amazon EC2 instance type.
string
The description of the fleet to update.
string
The display name of the fleet to update.
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The fleet ID to update.
integer
The maximum number of workers in the fleet.
integer
The minimum number of workers in the fleet.
string
The IAM role ARN that the fleet's workers assume while running jobs.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists steps for a job.
See also: AWS API Documentation
Request Syntax
client.list_steps(
farmId='string',
jobId='string',
maxResults=123,
nextToken='string',
queueId='string'
)
string
[REQUIRED]
The farm ID to include on the list of steps.
string
[REQUIRED]
The job ID to include on the list of steps.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID to include on the list of steps.
dict
Response Syntax
{
'nextToken': 'string',
'steps': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'dependencyCounts': {
'consumersResolved': 123,
'consumersUnresolved': 123,
'dependenciesResolved': 123,
'dependenciesUnresolved': 123
},
'endedAt': datetime(2015, 1, 1),
'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
'lifecycleStatusMessage': 'string',
'name': 'string',
'startedAt': datetime(2015, 1, 1),
'stepId': 'string',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
},
'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.
steps (list) --
The steps on the list.
(dict) --
The details for a step.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
dependencyCounts (dict) --
The number of dependencies for the step.
consumersResolved (integer) --
The number of consumers resolved.
consumersUnresolved (integer) --
The number of unresolved consumers.
dependenciesResolved (integer) --
The number of resolved dependencies.
dependenciesUnresolved (integer) --
The number of unresolved dependencies.
endedAt (datetime) --
The date and time the resource ended running.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
A message that describes the lifecycle of the step.
name (string) --
The name of the step.
startedAt (datetime) --
The date and time the resource started running.
stepId (string) --
The step ID.
targetTaskRunStatus (string) --
The task status to start with on the job.
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) --
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Adds a metered product.
See also: AWS API Documentation
Request Syntax
client.put_metered_product(
licenseEndpointId='string',
productId='string'
)
string
[REQUIRED]
The license endpoint ID to add to the metered product.
string
[REQUIRED]
The product ID to add to the metered product.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a list of your monitors in Deadline Cloud.
See also: AWS API Documentation
Request Syntax
client.list_monitors(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'monitors': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'displayName': 'string',
'identityCenterApplicationArn': 'string',
'identityCenterInstanceArn': 'string',
'monitorId': 'string',
'roleArn': 'string',
'subdomain': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'url': '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.
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.
displayName (string) --
The name of the monitor that displays on the Deadline Cloud console.
identityCenterApplicationArn (string) --
The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
identityCenterInstanceArn (string) --
The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
monitorId (string) --
The unique identifier for the monitor.
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.
subdomain (string) --
The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
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.
url (string) --
The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
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.
Lists storage profiles for a queue.
See also: AWS API Documentation
Request Syntax
client.list_storage_profiles_for_queue(
farmId='string',
maxResults=123,
nextToken='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the queue's storage profile.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID for the storage profile.
dict
Response Syntax
{
'nextToken': 'string',
'storageProfiles': [
{
'displayName': 'string',
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'storageProfileId': '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.
storageProfiles (list) --
The storage profiles in the queue.
(dict) --
The details of a storage profile.
displayName (string) --
The display name of the storage profile summary to update.
osFamily (string) --
The operating system (OS) family.
storageProfileId (string) --
The storage profile ID.
Lists session actions.
See also: AWS API Documentation
Request Syntax
client.list_session_actions(
farmId='string',
jobId='string',
maxResults=123,
nextToken='string',
queueId='string',
sessionId='string',
taskId='string'
)
string
[REQUIRED]
The farm ID for the session actions list.
string
[REQUIRED]
The job ID for the session actions list.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID for the session actions list.
string
The session ID to include on the sessions action list.
string
The task ID for the session actions list.
dict
Response Syntax
{
'nextToken': 'string',
'sessionActions': [
{
'definition': {
'envEnter': {
'environmentId': 'string'
},
'envExit': {
'environmentId': 'string'
},
'syncInputJobAttachments': {
'stepId': 'string'
},
'taskRun': {
'stepId': 'string',
'taskId': 'string'
}
},
'endedAt': datetime(2015, 1, 1),
'progressPercent': ...,
'sessionActionId': 'string',
'startedAt': datetime(2015, 1, 1),
'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED',
'workerUpdatedAt': 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.
sessionActions (list) --
The session actions.
(dict) --
The details of a session action.
definition (dict) --
The session action definition.
envEnter (dict) --
The environment to enter into.
environmentId (string) --
The environment ID.
envExit (dict) --
The environment to exit from.
environmentId (string) --
The environment ID.
syncInputJobAttachments (dict) --
The job attachments to sync with the session action definition.
stepId (string) --
The step ID of the step in the job attachment.
taskRun (dict) --
The task run.
stepId (string) --
The step ID.
taskId (string) --
The task ID.
endedAt (datetime) --
The date and time the resource ended running.
progressPercent (float) --
The completion percentage for the session action.
sessionActionId (string) --
The session action ID.
startedAt (datetime) --
The date and time the resource started running.
status (string) --
The status of the session action.
workerUpdatedAt (datetime) --
The Linux timestamp of the last date and time that the session action was updated.
Lists the members of a farm.
See also: AWS API Documentation
Request Syntax
client.list_farm_members(
farmId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The farm ID.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'members': [
{
'farmId': 'string',
'identityStoreId': 'string',
'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
'principalId': 'string',
'principalType': 'USER'|'GROUP'
},
],
'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.
identityStoreId (string) --
The identity store ID of the farm member.
membershipLevel (string) --
The farm member's membership level.
principalId (string) --
The principal ID of the farm member.
principalType (string) --
The principal type of the farm member.
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.
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
client.create_monitor(
clientToken='string',
displayName='string',
identityCenterInstanceArn='string',
roleArn='string',
subdomain='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The name that you give the monitor that is displayed in the Deadline Cloud console.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.
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.
string
[REQUIRED]
The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
dict
Response Syntax
{
'identityCenterApplicationArn': 'string',
'monitorId': 'string'
}
Response Structure
(dict) --
identityCenterApplicationArn (string) --
The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.
monitorId (string) --
The unique identifier of the monitor.
Gets a session.
See also: AWS API Documentation
Request Syntax
client.get_session(
farmId='string',
jobId='string',
queueId='string',
sessionId='string'
)
string
[REQUIRED]
The farm ID for the session.
string
[REQUIRED]
The job ID for the session.
string
[REQUIRED]
The queue ID for the session.
string
[REQUIRED]
The session ID.
dict
Response Syntax
{
'endedAt': datetime(2015, 1, 1),
'fleetId': 'string',
'hostProperties': {
'ec2InstanceArn': 'string',
'ec2InstanceType': 'string',
'hostName': 'string',
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
}
},
'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
'log': {
'error': 'string',
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
}
},
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'targetLifecycleStatus': 'ENDED',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'workerId': 'string',
'workerLog': {
'error': 'string',
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
}
}
}
Response Structure
(dict) --
endedAt (datetime) --
The date and time the resource ended running.
fleetId (string) --
The fleet ID for the session.
hostProperties (dict) --
Provides the Amazon EC2 properties of the host.
ec2InstanceArn (string) --
The ARN of the host EC2 instance.
ec2InstanceType (string) --
The instance type of the host EC2 instance.
hostName (string) --
The host name.
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) --
lifecycleStatus (string) --
The life cycle status of the session.
log (dict) --
The session log.
error (string) --
The log configuration error details.
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) --
sessionId (string) --
The session ID.
startedAt (datetime) --
The date and time the resource started running.
targetLifecycleStatus (string) --
The life cycle status with which the session started.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
workerId (string) --
The worker ID for the session.
workerLog (dict) --
The worker log for the session.
error (string) --
The log configuration error details.
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) --
Lists workers.
See also: AWS API Documentation
Request Syntax
client.list_workers(
farmId='string',
fleetId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The farm ID connected to the workers.
string
[REQUIRED]
The fleet ID of the workers.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'nextToken': 'string',
'workers': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'farmId': 'string',
'fleetId': 'string',
'hostProperties': {
'ec2InstanceArn': 'string',
'ec2InstanceType': 'string',
'hostName': 'string',
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
}
},
'log': {
'error': 'string',
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
}
},
'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'workerId': '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.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
farmId (string) --
The farm ID.
fleetId (string) --
The fleet ID.
hostProperties (dict) --
The host properties of the worker.
ec2InstanceArn (string) --
The ARN of the host EC2 instance.
ec2InstanceType (string) --
The instance type of the host EC2 instance.
hostName (string) --
The host name.
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) --
log (dict) --
The log configuration for the worker.
error (string) --
The log configuration error details.
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) --
status (string) --
The status of the worker.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
workerId (string) --
The worker ID.
Gets a storage profile for a queue.
See also: AWS API Documentation
Request Syntax
client.get_storage_profile_for_queue(
farmId='string',
queueId='string',
storageProfileId='string'
)
string
[REQUIRED]
The farm ID for the queue in storage profile.
string
[REQUIRED]
The queue ID the queue in the storage profile.
string
[REQUIRED]
The storage profile ID for the storage profile in the queue.
dict
Response Syntax
{
'displayName': 'string',
'fileSystemLocations': [
{
'name': 'string',
'path': 'string',
'type': 'SHARED'|'LOCAL'
},
],
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'storageProfileId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The display name of the storage profile connected to a 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.
osFamily (string) --
The operating system of the storage profile in the queue.
storageProfileId (string) --
The storage profile ID.
Deletes a queue.
See also: AWS API Documentation
Request Syntax
client.delete_queue(
farmId='string',
queueId='string'
)
string
[REQUIRED]
The ID of the farm from which to remove the queue.
string
[REQUIRED]
The queue ID of the queue to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a fleet.
See also: AWS API Documentation
Request Syntax
client.delete_fleet(
clientToken='string',
farmId='string',
fleetId='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID of the farm to remove from the fleet.
string
[REQUIRED]
The fleet ID of the fleet to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Get credentials from the fleet role for a worker.
See also: AWS API Documentation
Request Syntax
client.assume_fleet_role_for_worker(
farmId='string',
fleetId='string',
workerId='string'
)
string
[REQUIRED]
The farm ID for the fleet's farm.
string
[REQUIRED]
The fleet ID that contains the worker.
string
[REQUIRED]
The ID of the worker assuming the fleet role.
dict
Response Syntax
{
'credentials': {
'accessKeyId': 'string',
'expiration': datetime(2015, 1, 1),
'secretAccessKey': 'string',
'sessionToken': 'string'
}
}
Response Structure
(dict) --
credentials (dict) --
The credentials for the worker.
accessKeyId (string) --
The IAM access key ID.
expiration (datetime) --
The expiration date and time of the IAM credentials.
secretAccessKey (string) --
The IAM secret access key.
sessionToken (string) --
The IAM session token
Disassociates a member from a queue.
See also: AWS API Documentation
Request Syntax
client.disassociate_member_from_queue(
farmId='string',
principalId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the queue to disassociate from a member.
string
[REQUIRED]
A member's principal ID to disassociate from a queue.
string
[REQUIRED]
The queue ID of the queue in which you're disassociating from a member.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.create_worker(
clientToken='string',
farmId='string',
fleetId='string',
hostProperties={
'hostName': 'string',
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
}
}
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID of the farm to connect to the worker.
string
[REQUIRED]
The fleet ID to connect to the worker.
dict
The IP address and host name of the worker.
hostName (string) --
The host name.
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) --
dict
Response Syntax
{
'workerId': 'string'
}
Response Structure
(dict) --
workerId (string) --
The worker ID.
Lists sessions for a worker.
See also: AWS API Documentation
Request Syntax
client.list_sessions_for_worker(
farmId='string',
fleetId='string',
maxResults=123,
nextToken='string',
workerId='string'
)
string
[REQUIRED]
The farm ID for the session.
string
[REQUIRED]
The fleet ID for the session.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The worker ID for the session.
dict
Response Syntax
{
'nextToken': 'string',
'sessions': [
{
'endedAt': datetime(2015, 1, 1),
'jobId': 'string',
'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
'queueId': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'targetLifecycleStatus': 'ENDED'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null to start from the beginning.
sessions (list) --
The sessions in the response.
(dict) --
Summarizes the session for a particular worker.
endedAt (datetime) --
The date and time the resource ended running.
jobId (string) --
The job ID for the job associated with the worker's session.
lifecycleStatus (string) --
The life cycle status for the worker's session.
queueId (string) --
The queue ID for the queue associated to the worker.
sessionId (string) --
The session ID for the session action.
startedAt (datetime) --
The date and time the resource started running.
targetLifecycleStatus (string) --
The life cycle status
Assigns a fleet membership level to a member.
See also: AWS API Documentation
Request Syntax
client.associate_member_to_fleet(
farmId='string',
fleetId='string',
identityStoreId='string',
membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
principalId='string',
principalType='USER'|'GROUP'
)
string
[REQUIRED]
The farm ID of the fleet to associate with the member.
string
[REQUIRED]
The ID of the fleet to associate with a member.
string
[REQUIRED]
The member's identity store ID to associate with the fleet.
string
[REQUIRED]
The principal's membership level for the associated fleet.
string
[REQUIRED]
The member's principal ID to associate with a fleet.
string
[REQUIRED]
The member's principal type to associate with the fleet.
dict
Response Syntax
{}
Response Structure
(dict) --
Assigns a queue membership level to a member
See also: AWS API Documentation
Request Syntax
client.associate_member_to_queue(
farmId='string',
identityStoreId='string',
membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
principalId='string',
principalType='USER'|'GROUP',
queueId='string'
)
string
[REQUIRED]
The farm ID of the queue to associate with the member.
string
[REQUIRED]
The member's identity store ID to associate with the queue.
string
[REQUIRED]
The principal's membership level for the associated queue.
string
[REQUIRED]
The member's principal ID to associate with the queue.
string
[REQUIRED]
The member's principal type to associate with the queue.
string
[REQUIRED]
The ID of the queue to associate to the member.
dict
Response Syntax
{}
Response Structure
(dict) --
Get batched job details for a worker.
See also: AWS API Documentation
Request Syntax
client.batch_get_job_entity(
farmId='string',
fleetId='string',
identifiers=[
{
'environmentDetails': {
'environmentId': 'string',
'jobId': 'string'
},
'jobAttachmentDetails': {
'jobId': 'string'
},
'jobDetails': {
'jobId': 'string'
},
'stepDetails': {
'jobId': 'string',
'stepId': 'string'
}
},
],
workerId='string'
)
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.
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.
list
[REQUIRED]
The job identifiers to include within the job entity batch details.
(dict) --
The details of a job entity identifier.
environmentDetails (dict) --
The environment details.
environmentId (string) -- [REQUIRED]
The environment ID.
jobId (string) -- [REQUIRED]
The job ID.
jobAttachmentDetails (dict) --
The job attachment details.
jobId (string) -- [REQUIRED]
The job ID.
jobDetails (dict) --
The job details.
jobId (string) -- [REQUIRED]
The job ID.
stepDetails (dict) --
The step details.
jobId (string) -- [REQUIRED]
The job ID.
stepId (string) -- [REQUIRED]
The step ID.
string
[REQUIRED]
The worker ID of the worker containing the job details to get.
dict
Response Syntax
{
'entities': [
{
'environmentDetails': {
'environmentId': 'string',
'jobId': 'string',
'schemaVersion': 'string',
'template': {}
},
'jobAttachmentDetails': {
'attachments': {
'fileSystem': 'COPIED'|'VIRTUAL',
'manifests': [
{
'fileSystemLocationName': 'string',
'inputManifestHash': 'string',
'inputManifestPath': 'string',
'outputRelativeDirectories': [
'string',
],
'rootPath': 'string',
'rootPathFormat': 'windows'|'posix'
},
]
},
'jobId': 'string'
},
'jobDetails': {
'jobAttachmentSettings': {
'rootPrefix': 'string',
's3BucketName': 'string'
},
'jobId': 'string',
'jobRunAsUser': {
'posix': {
'group': 'string',
'user': 'string'
},
'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER',
'windows': {
'passwordArn': 'string',
'user': 'string'
}
},
'logGroupName': 'string',
'parameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'pathMappingRules': [
{
'destinationPath': 'string',
'sourcePath': 'string',
'sourcePathFormat': 'windows'|'posix'
},
],
'queueRoleArn': 'string',
'schemaVersion': 'string'
},
'stepDetails': {
'dependencies': [
'string',
],
'jobId': 'string',
'schemaVersion': 'string',
'stepId': 'string',
'template': {}
}
},
],
'errors': [
{
'environmentDetails': {
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'environmentId': 'string',
'jobId': 'string',
'message': 'string'
},
'jobAttachmentDetails': {
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'jobId': 'string',
'message': 'string'
},
'jobDetails': {
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'jobId': 'string',
'message': 'string'
},
'stepDetails': {
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'jobId': 'string',
'message': 'string',
'stepId': 'string'
}
},
]
}
Response Structure
(dict) --
entities (list) --
A list of the job entities, or details, in the batch.
(dict) --
The details of a job entity.
environmentDetails (dict) --
The environment details for the job entity.
environmentId (string) --
The environment ID.
jobId (string) --
The job ID.
schemaVersion (string) --
The schema version in the environment.
template (dict) --
The template used for the environment.
jobAttachmentDetails (dict) --
The job attachment details.
attachments (dict) --
The job attachments.
fileSystem (string) --
The file system.
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.
inputManifestHash (string) --
The has value of the file.
inputManifestPath (string) --
The file path.
outputRelativeDirectories (list) --
The file path relative to the directory.
(string) --
rootPath (string) --
The file's root path.
rootPathFormat (string) --
The format of the root path.
jobId (string) --
The job ID.
jobDetails (dict) --
The job details.
jobAttachmentSettings (dict) --
The job attachment settings.
rootPrefix (string) --
The root prefix.
s3BucketName (string) --
The Amazon S3 bucket name.
jobId (string) --
The job ID.
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.
group (string) --
The name of the POSIX user's group.
user (string) --
The name of the POSIX 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.
windows (dict) --
Identifies a Microsoft Windows user.
passwordArn (string) --
The password ARN for the Windows user.
user (string) --
The user.
logGroupName (string) --
The log group name.
parameters (dict) --
The parameters.
(string) --
(dict) --
The details of job parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
pathMappingRules (list) --
The path mapping rules.
(dict) --
The details of a source and destination path.
destinationPath (string) --
The destination path.
sourcePath (string) --
The source path.
sourcePathFormat (string) --
The source path format.
queueRoleArn (string) --
The queue role ARN.
schemaVersion (string) --
The schema version.
stepDetails (dict) --
The step details.
dependencies (list) --
The dependencies for a step.
(string) --
jobId (string) --
The job ID.
schemaVersion (string) --
The schema version for a step template.
stepId (string) --
The step ID.
template (dict) --
The template for a step.
errors (list) --
A list of errors from the job error logs for the batch.
(dict) --
The error for the job entity.
environmentDetails (dict) --
The environment details for the failed job entity.
code (string) --
The error code.
environmentId (string) --
The environment ID.
jobId (string) --
The job ID.
message (string) --
The error message detailing the error's cause.
jobAttachmentDetails (dict) --
The job attachment details for the failed job entity.
code (string) --
The error code.
jobId (string) --
The job ID.
message (string) --
The error message detailing the error's cause.
jobDetails (dict) --
The job details for the failed job entity.
code (string) --
The error code.
jobId (string) --
The job ID.
message (string) --
The error message detailing the error's cause.
stepDetails (dict) --
The step details for the failed job entity.
code (string) --
The error code.
jobId (string) --
The job ID.
message (string) --
The error message detailing the error's cause.
stepId (string) --
The step ID.
Updates a budget that sets spending thresholds for rendering activity.
See also: AWS API Documentation
Request Syntax
client.update_budget(
actionsToAdd=[
{
'description': 'string',
'thresholdPercentage': ...,
'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'
},
],
actionsToRemove=[
{
'thresholdPercentage': ...,
'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'
},
],
approximateDollarLimit=...,
budgetId='string',
clientToken='string',
description='string',
displayName='string',
farmId='string',
schedule={
'fixed': {
'endTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1)
}
},
status='ACTIVE'|'INACTIVE'
)
list
The budget actions to add. Budget actions specify what happens when the budget runs out.
(dict) --
The budget action to add.
description (string) --
A description for the budget action to add.
thresholdPercentage (float) -- [REQUIRED]
The percentage threshold for the budget action to add.
type (string) -- [REQUIRED]
The type of budget action to add.
list
The budget actions to remove from the budget.
(dict) --
The budget action to remove.
thresholdPercentage (float) -- [REQUIRED]
The percentage threshold for the budget action to remove.
type (string) -- [REQUIRED]
The type of budget action to remove.
float
The dollar limit to update on the budget. Based on consumed usage.
string
[REQUIRED]
The budget ID to update.
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The description of the budget to update.
string
The display name of the budget to update.
string
[REQUIRED]
The farm ID of the budget to update.
dict
The schedule to update.
fixed (dict) --
The fixed start and end time of the budget's schedule.
endTime (datetime) -- [REQUIRED]
When the budget ends.
startTime (datetime) -- [REQUIRED]
When the budget starts.
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.
dict
Response Syntax
{}
Response Structure
(dict) --
A list of budgets in a farm.
See also: AWS API Documentation
Request Syntax
client.list_budgets(
farmId='string',
maxResults=123,
nextToken='string',
status='ACTIVE'|'INACTIVE'
)
string
[REQUIRED]
The farm ID associated with the budgets.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
The status to list for the budgets.
dict
Response Syntax
{
'budgets': [
{
'approximateDollarLimit': ...,
'budgetId': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'displayName': 'string',
'status': 'ACTIVE'|'INACTIVE',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'usageTrackingResource': {
'queueId': 'string'
},
'usages': {
'approximateDollarUsage': ...
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
budgets (list) --
The budgets to include on the list.
(dict) --
The budget summary.
approximateDollarLimit (float) --
The approximate dollar limit of the budget.
budgetId (string) --
The budget ID.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
description (string) --
The description of the budget summary.
displayName (string) --
The display name of the budget summary to update.
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.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
usageTrackingResource (dict) --
The resource used to track expenditure in the budget.
queueId (string) --
The queue ID.
usages (dict) --
The consumed usage for the budget.
approximateDollarUsage (float) --
The amount of the budget consumed.
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.
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
client.assume_fleet_role_for_read(
farmId='string',
fleetId='string'
)
string
[REQUIRED]
The farm ID for the fleet's farm.
string
[REQUIRED]
The fleet ID.
dict
Response Syntax
{
'credentials': {
'accessKeyId': 'string',
'expiration': datetime(2015, 1, 1),
'secretAccessKey': 'string',
'sessionToken': 'string'
}
}
Response Structure
(dict) --
credentials (dict) --
The credentials for the fleet role.
accessKeyId (string) --
The IAM access key ID.
expiration (datetime) --
The expiration date and time of the IAM credentials.
secretAccessKey (string) --
The IAM secret access key.
sessionToken (string) --
The IAM session token
Lists the members in a queue.
See also: AWS API Documentation
Request Syntax
client.list_queue_members(
farmId='string',
maxResults=123,
nextToken='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the queue.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID to include on the list.
dict
Response Syntax
{
'members': [
{
'farmId': 'string',
'identityStoreId': 'string',
'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
'principalId': 'string',
'principalType': 'USER'|'GROUP',
'queueId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
members (list) --
The members on the list.
(dict) --
The details of a queue member.
farmId (string) --
The farm ID.
identityStoreId (string) --
The identity store ID.
membershipLevel (string) --
The queue member's membership level.
principalId (string) --
The principal ID of the queue member.
principalType (string) --
The principal type of the queue member.
queueId (string) --
The queue ID.
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.
Lists farms.
See also: AWS API Documentation
Request Syntax
client.list_farms(
maxResults=123,
nextToken='string',
principalId='string'
)
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
The principal ID of the member to list on the farm.
dict
Response Syntax
{
'farms': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'displayName': 'string',
'farmId': 'string',
'kmsKeyArn': '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.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
displayName (string) --
The display name of the farm.
farmId (string) --
The farm ID.
kmsKeyArn (string) --
The ARN for the KMS key.
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.
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
See also: AWS API Documentation
Request Syntax
client.create_license_endpoint(
clientToken='string',
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
tags={
'string': 'string'
},
vpcId='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
list
[REQUIRED]
The security group IDs.
(string) --
list
[REQUIRED]
The subnet IDs.
(string) --
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) --
string
[REQUIRED]
The VPC (virtual private cloud) ID to use with the license endpoint.
dict
Response Syntax
{
'licenseEndpointId': 'string'
}
Response Structure
(dict) --
licenseEndpointId (string) --
The license endpoint ID.
Updates a queue.
See also: AWS API Documentation
Request Syntax
client.update_queue(
allowedStorageProfileIdsToAdd=[
'string',
],
allowedStorageProfileIdsToRemove=[
'string',
],
clientToken='string',
defaultBudgetAction='NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
description='string',
displayName='string',
farmId='string',
jobAttachmentSettings={
'rootPrefix': 'string',
's3BucketName': 'string'
},
jobRunAsUser={
'posix': {
'group': 'string',
'user': 'string'
},
'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER',
'windows': {
'passwordArn': 'string',
'user': 'string'
}
},
queueId='string',
requiredFileSystemLocationNamesToAdd=[
'string',
],
requiredFileSystemLocationNamesToRemove=[
'string',
],
roleArn='string'
)
list
The storage profile IDs to add.
(string) --
list
The storage profile ID to remove.
(string) --
string
The idempotency token to update in the queue.
This field is autopopulated if not provided.
string
The default action to take for a queue update if a budget isn't configured.
string
The description of the queue to update.
string
The display name of the queue to update.
string
[REQUIRED]
The farm ID to update in the queue.
dict
The job attachment settings to update for the queue.
rootPrefix (string) -- [REQUIRED]
The root prefix.
s3BucketName (string) -- [REQUIRED]
The Amazon S3 bucket name.
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.
group (string) -- [REQUIRED]
The name of the POSIX user's group.
user (string) -- [REQUIRED]
The name of the POSIX 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.
windows (dict) --
Identifies a Microsoft Windows user.
passwordArn (string) -- [REQUIRED]
The password ARN for the Windows user.
user (string) -- [REQUIRED]
The user.
string
[REQUIRED]
The queue ID to update.
list
The required file system location names to add to the queue.
(string) --
list
The required file system location names to remove from the queue.
(string) --
string
The IAM role ARN that's used to run jobs from this queue.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.update_monitor(
displayName='string',
monitorId='string',
roleArn='string',
subdomain='string'
)
string
The new value to use for the monitor's display name.
string
[REQUIRED]
The unique identifier of the monitor to update.
string
The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
string
The new value of the subdomain to use when forming the monitor URL.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists jobs.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
farmId='string',
maxResults=123,
nextToken='string',
principalId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the jobs.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
The principal ID of the members on the jobs.
string
[REQUIRED]
The queue ID for the job.
dict
Response Syntax
{
'jobs': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'endedAt': datetime(2015, 1, 1),
'jobId': 'string',
'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
'lifecycleStatusMessage': 'string',
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'name': 'string',
'priority': 123,
'startedAt': datetime(2015, 1, 1),
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobs (list) --
The jobs on the list.
(dict) --
A summary of job details.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
endedAt (datetime) --
The date and time the resource ended running.
jobId (string) --
The job ID.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
The life cycle status message.
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.
name (string) --
The job name.
priority (integer) --
The job priority.
startedAt (datetime) --
The date and time the resource started running.
targetTaskRunStatus (string) --
The task status to start with on the job.
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.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
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.
Searches for steps.
See also: AWS API Documentation
Request Syntax
client.search_steps(
farmId='string',
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'dateTime': datetime(2015, 1, 1),
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'
},
'groupFilter': {'... recursive ...'},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
}
},
],
'operator': 'AND'|'OR'
},
itemOffset=123,
jobId='string',
pageSize=123,
queueIds=[
'string',
],
sortExpressions=[
{
'fieldSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'parameterSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'userJobsFirst': {
'userIdentityId': 'string'
}
},
]
)
string
[REQUIRED]
The farm ID to use for the step search.
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.
dateTimeFilter (dict) --
Filters based on date and time.
dateTime (datetime) -- [REQUIRED]
The 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.
groupFilter (dict) --
Filters by group.
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.
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.
operator (string) -- [REQUIRED]
The operators to include in the search.
integer
[REQUIRED]
Defines how far into the scrollable list to start the return of results.
string
The job ID to use in the step search.
integer
Specifies the number of items per page for the resource.
list
[REQUIRED]
The queue IDs in the step search.
(string) --
list
The search terms for a resource.
(dict) --
The resources to search.
fieldSort (dict) --
Options for sorting by a field.
name (string) -- [REQUIRED]
The name of the field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
parameterSort (dict) --
Options for sorting by a parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
dict
Response Syntax
{
'nextItemOffset': 123,
'steps': [
{
'createdAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'jobId': 'string',
'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
'lifecycleStatusMessage': 'string',
'name': 'string',
'parameterSpace': {
'combination': 'string',
'parameters': [
{
'name': 'string',
'type': 'INT'|'FLOAT'|'STRING'|'PATH'
},
]
},
'queueId': 'string',
'startedAt': datetime(2015, 1, 1),
'stepId': 'string',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
}
},
],
'totalResults': 123
}
Response Structure
(dict) --
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset .
steps (list) --
The steps in the search.
(dict) --
The details of a step search.
createdAt (datetime) --
The date and time the resource was created.
endedAt (datetime) --
The date and time the resource ended running.
jobId (string) --
The job ID.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
The life cycle status message.
name (string) --
The step name.
parameterSpace (dict) --
The parameters and combination expressions for the search.
combination (string) --
The combination expression to use in 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.
queueId (string) --
The queue ID.
startedAt (datetime) --
The date and time the resource started running.
stepId (string) --
The step ID.
targetTaskRunStatus (string) --
The task status to start with on the job.
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.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
totalResults (integer) --
The total number of results in the search.
Lists metered products.
See also: AWS API Documentation
Request Syntax
client.list_metered_products(
licenseEndpointId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The license endpoint ID to include on the list of metered products.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'meteredProducts': [
{
'family': 'string',
'port': 123,
'productId': 'string',
'vendor': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
meteredProducts (list) --
The metered products to list.
(dict) --
The details of a metered product.
family (string) --
The family to which the metered product belongs.
port (integer) --
The port on which the metered product should run.
productId (string) --
The product ID.
vendor (string) --
The vendor.
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.
Gets a worker.
See also: AWS API Documentation
Request Syntax
client.get_worker(
farmId='string',
fleetId='string',
workerId='string'
)
string
[REQUIRED]
The farm ID for the worker.
string
[REQUIRED]
The fleet ID of the worker.
string
[REQUIRED]
The worker ID.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'farmId': 'string',
'fleetId': 'string',
'hostProperties': {
'ec2InstanceArn': 'string',
'ec2InstanceType': 'string',
'hostName': 'string',
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
}
},
'log': {
'error': 'string',
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
}
},
'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'workerId': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
farmId (string) --
The farm ID.
fleetId (string) --
The fleet ID.
hostProperties (dict) --
The host properties for the worker.
ec2InstanceArn (string) --
The ARN of the host EC2 instance.
ec2InstanceType (string) --
The instance type of the host EC2 instance.
hostName (string) --
The host name.
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) --
log (dict) --
The logs for the associated worker.
error (string) --
The log configuration error details.
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) --
status (string) --
The status of the worker.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
workerId (string) --
The worker ID.
Lists sessions.
See also: AWS API Documentation
Request Syntax
client.list_sessions(
farmId='string',
jobId='string',
maxResults=123,
nextToken='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the list of sessions.
string
[REQUIRED]
The job ID for the list of sessions.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID for the list of sessions
dict
Response Syntax
{
'nextToken': 'string',
'sessions': [
{
'endedAt': datetime(2015, 1, 1),
'fleetId': 'string',
'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'targetLifecycleStatus': 'ENDED',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'workerId': '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.
sessions (list) --
The sessions on the list.
(dict) --
The summary of a session.
endedAt (datetime) --
The date and time the resource ended running.
fleetId (string) --
The fleet ID.
lifecycleStatus (string) --
The life cycle status for the session.
sessionId (string) --
The session ID.
startedAt (datetime) --
The date and time the resource started running.
targetLifecycleStatus (string) --
The target life cycle status for the session.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
workerId (string) --
The worker ID.
Gets a storage profile.
See also: AWS API Documentation
Request Syntax
client.get_storage_profile(
farmId='string',
storageProfileId='string'
)
string
[REQUIRED]
The farm ID for the storage profile.
string
[REQUIRED]
The storage profile ID.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'displayName': 'string',
'fileSystemLocations': [
{
'name': 'string',
'path': 'string',
'type': 'SHARED'|'LOCAL'
},
],
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'storageProfileId': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
displayName (string) --
The display name of the storage profile.
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.
osFamily (string) --
The operating system (OS) for the storage profile.
storageProfileId (string) --
The storage profile ID.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Lists queues.
See also: AWS API Documentation
Request Syntax
client.list_queues(
farmId='string',
maxResults=123,
nextToken='string',
principalId='string',
status='IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED'
)
string
[REQUIRED]
The farm ID of the queue.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.
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.
dict
Response Syntax
{
'nextToken': 'string',
'queues': [
{
'blockedReason': 'NO_BUDGET_CONFIGURED'|'BUDGET_THRESHOLD_REACHED',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'defaultBudgetAction': 'NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
'displayName': 'string',
'farmId': 'string',
'queueId': 'string',
'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED',
'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.
queues (list) --
The queues on the list.
(dict) --
The details of a queue summary.
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.
defaultBudgetAction (string) --
The default action taken on a queue summary if a budget wasn't configured.
displayName (string) --
The display name of the queue summary to update.
farmId (string) --
The farm ID.
queueId (string) --
The queue ID.
status (string) --
That status of the queue.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Creates a budget to set spending thresholds for your rendering activity.
See also: AWS API Documentation
Request Syntax
client.create_budget(
actions=[
{
'description': 'string',
'thresholdPercentage': ...,
'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'
},
],
approximateDollarLimit=...,
clientToken='string',
description='string',
displayName='string',
farmId='string',
schedule={
'fixed': {
'endTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1)
}
},
usageTrackingResource={
'queueId': 'string'
}
)
list
[REQUIRED]
The budget actions to specify what happens when the budget runs out.
(dict) --
The budget action to add.
description (string) --
A description for the budget action to add.
thresholdPercentage (float) -- [REQUIRED]
The percentage threshold for the budget action to add.
type (string) -- [REQUIRED]
The type of budget action to add.
float
[REQUIRED]
The dollar limit based on consumed usage.
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The description of the budget.
string
[REQUIRED]
The display name of the budget.
string
[REQUIRED]
The farm ID to include in this budget.
dict
[REQUIRED]
The schedule to associate with this budget.
fixed (dict) --
The fixed start and end time of the budget's schedule.
endTime (datetime) -- [REQUIRED]
When the budget ends.
startTime (datetime) -- [REQUIRED]
When the budget starts.
dict
[REQUIRED]
The queue ID provided to this budget to track usage.
queueId (string) --
The queue ID.
dict
Response Syntax
{
'budgetId': 'string'
}
Response Structure
(dict) --
budgetId (string) --
The budget ID.
Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.
See also: AWS API Documentation
Request Syntax
client.create_job(
attachments={
'fileSystem': 'COPIED'|'VIRTUAL',
'manifests': [
{
'fileSystemLocationName': 'string',
'inputManifestHash': 'string',
'inputManifestPath': 'string',
'outputRelativeDirectories': [
'string',
],
'rootPath': 'string',
'rootPathFormat': 'windows'|'posix'
},
]
},
clientToken='string',
farmId='string',
maxFailedTasksCount=123,
maxRetriesPerTask=123,
parameters={
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
priority=123,
queueId='string',
storageProfileId='string',
targetTaskRunStatus='READY'|'SUSPENDED',
template='string',
templateType='JSON'|'YAML'
)
dict
The attachments for the job. Attach files required for the job to run to a render job.
fileSystem (string) --
The file system.
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.
inputManifestHash (string) --
The has value of the file.
inputManifestPath (string) --
The file path.
outputRelativeDirectories (list) --
The file path relative to the directory.
(string) --
rootPath (string) -- [REQUIRED]
The file's root path.
rootPathFormat (string) -- [REQUIRED]
The format of the root path.
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID of the farm to connect to the job.
integer
The number of task failures before the job stops running and is marked as FAILED .
integer
The maximum number of retries for a job.
dict
The parameters for the job.
(string) --
(dict) --
The details of job parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
integer
[REQUIRED]
The priority of the job on a scale of 1 to 100. The highest priority is 1.
string
[REQUIRED]
The ID of the queue that the job is submitted to.
string
The storage profile ID for the storage profile to connect to the job.
string
The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.
string
[REQUIRED]
The job template to use for this job.
string
[REQUIRED]
The file type for the job template.
dict
Response Syntax
{
'jobId': 'string'
}
Response Structure
(dict) --
jobId (string) --
The job ID.
Updates the schedule for a worker.
See also: AWS API Documentation
Request Syntax
client.update_worker_schedule(
farmId='string',
fleetId='string',
updatedSessionActions={
'string': {
'completedStatus': 'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED',
'endedAt': datetime(2015, 1, 1),
'processExitCode': 123,
'progressMessage': 'string',
'progressPercent': ...,
'startedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
},
workerId='string'
)
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The fleet ID to update.
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.
endedAt (datetime) --
The date and time the resource ended running.
processExitCode (integer) --
The process exit code.
progressMessage (string) --
A message to indicate the progress of the updated session action.
progressPercent (float) --
The percentage completed.
startedAt (datetime) --
The date and time the resource started running.
updatedAt (datetime) --
The updated time.
string
[REQUIRED]
The worker ID to update.
dict
Response Syntax
{
'assignedSessions': {
'string': {
'jobId': 'string',
'logConfiguration': {
'error': 'string',
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
}
},
'queueId': 'string',
'sessionActions': [
{
'definition': {
'envEnter': {
'environmentId': 'string'
},
'envExit': {
'environmentId': 'string'
},
'syncInputJobAttachments': {
'stepId': 'string'
},
'taskRun': {
'parameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'stepId': 'string',
'taskId': 'string'
}
},
'sessionActionId': '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.
jobId (string) --
The job ID for the assigned session.
logConfiguration (dict) --
The log configuration for the worker's assigned session.
error (string) --
The log configuration error details.
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) --
queueId (string) --
The queue ID of 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.
definition (dict) --
The definition of the assigned session action.
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.
syncInputJobAttachments (dict) --
The job attachment to sync with an assigned session action.
stepId (string) --
The step ID.
taskRun (dict) --
The task run.
parameters (dict) --
The parameters to include.
(string) --
(dict) --
The data types for the task parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
stepId (string) --
The step ID.
taskId (string) --
The task ID.
sessionActionId (string) --
The session action ID for the assigned session.
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.
Updates a session.
See also: AWS API Documentation
Request Syntax
client.update_session(
clientToken='string',
farmId='string',
jobId='string',
queueId='string',
sessionId='string',
targetLifecycleStatus='ENDED'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID to update in the session.
string
[REQUIRED]
The job ID to update in the session.
string
[REQUIRED]
The queue ID to update in the session.
string
[REQUIRED]
The session ID to update.
string
[REQUIRED]
The life cycle status to update in the session.
dict
Response Syntax
{}
Response Structure
(dict) --
Get a fleet.
See also: AWS API Documentation
Request Syntax
client.get_fleet(
farmId='string',
fleetId='string'
)
string
[REQUIRED]
The farm ID of the farm in the fleet.
string
[REQUIRED]
The fleet ID of the fleet to get.
dict
Response Syntax
{
'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING',
'capabilities': {
'amounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'attributes': [
{
'name': 'string',
'values': [
'string',
]
},
]
},
'configuration': {
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'storageProfileId': 'string',
'workerCapabilities': {
'acceleratorCount': {
'max': 123,
'min': 123
},
'acceleratorTotalMemoryMiB': {
'max': 123,
'min': 123
},
'acceleratorTypes': [
'gpu',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'vCpuCount': {
'max': 123,
'min': 123
}
}
},
'serviceManagedEc2': {
'instanceCapabilities': {
'allowedInstanceTypes': [
'string',
],
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'max': ...,
'min': ...,
'name': 'string'
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'excludedInstanceTypes': [
'string',
],
'memoryMiB': {
'max': 123,
'min': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'rootEbsVolume': {
'iops': 123,
'sizeGiB': 123,
'throughputMiB': 123
},
'vCpuCount': {
'max': 123,
'min': 123
}
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'
}
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'displayName': 'string',
'farmId': 'string',
'fleetId': 'string',
'maxWorkerCount': 123,
'minWorkerCount': 123,
'roleArn': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED',
'targetWorkerCount': 123,
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'workerCount': 123
}
Response Structure
(dict) --
autoScalingStatus (string) --
The Auto Scaling status of the fleet. Either GROWING , STEADY , or SHRINKING .
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.
max (float) --
The maximum amount of the fleet worker capability.
min (float) --
The minimum amount of fleet worker capability.
name (string) --
The name of the fleet 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) --
configuration (dict) --
The configuration setting for the fleet.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) --
The Auto Scaling mode for the customer managed fleet configuration.
storageProfileId (string) --
The storage profile ID.
workerCapabilities (dict) --
The worker capabilities for a customer managed fleet configuration.
acceleratorCount (dict) --
The range of the accelerator.
max (integer) --
The maximum GPU for the accelerator.
min (integer) --
The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
min (integer) --
The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
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.
max (float) --
The maximum amount of the fleet worker capability.
min (float) --
The minimum amount of fleet worker capability.
name (string) --
The name of the fleet 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) --
memoryMiB (dict) --
The memory (MiB).
max (integer) --
The maximum amount of memory (in MiB).
min (integer) --
The minimum amount of memory (in MiB).
osFamily (string) --
The operating system (OS) family.
vCpuCount (dict) --
The vCPU count for the customer manged worker capabilities.
max (integer) --
The maximum amount of vCPU.
min (integer) --
The minimum amount of vCPU.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) --
The Amazon EC2 instance capabilities.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
cpuArchitectureType (string) --
The CPU architecture type.
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
max (float) --
The maximum amount of the fleet worker capability.
min (float) --
The minimum amount of fleet worker capability.
name (string) --
The name of the fleet 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) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
memoryMiB (dict) --
The memory, as MiB, for the Amazon EC2 instance type.
max (integer) --
The maximum amount of memory (in MiB).
min (integer) --
The minimum amount of memory (in MiB).
osFamily (string) --
The operating system (OS) family.
rootEbsVolume (dict) --
The root EBS volume.
iops (integer) --
The IOPS per volume.
sizeGiB (integer) --
The EBS volume size in GiB.
throughputMiB (integer) --
The throughput per volume in MiB.
vCpuCount (dict) --
The amount of vCPU to require for instances in this fleet.
max (integer) --
The maximum amount of vCPU.
min (integer) --
The minimum amount of vCPU.
instanceMarketOptions (dict) --
The Amazon EC2 market type.
type (string) --
The Amazon EC2 instance type.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
description (string) --
The description of the fleet.
displayName (string) --
The display name of the fleet.
farmId (string) --
The farm ID of the farm in the fleet.
fleetId (string) --
The fleet ID.
maxWorkerCount (integer) --
The maximum number of workers specified in the fleet.
minWorkerCount (integer) --
The minimum number of workers specified in the fleet.
roleArn (string) --
The IAM role ARN.
status (string) --
The Auto Scaling status of the fleet.
targetWorkerCount (integer) --
The number of target workers in the fleet.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
workerCount (integer) --
The number of workers in the fleet.
A list of the available metered products.
See also: AWS API Documentation
Request Syntax
client.list_available_metered_products(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'meteredProducts': [
{
'family': 'string',
'port': 123,
'productId': 'string',
'vendor': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
meteredProducts (list) --
The metered products.
(dict) --
The details of a metered product.
family (string) --
The family to which the metered product belongs.
port (integer) --
The port on which the metered product should run.
productId (string) --
The product ID.
vendor (string) --
The vendor.
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.
Updates a step.
See also: AWS API Documentation
Request Syntax
client.update_step(
clientToken='string',
farmId='string',
jobId='string',
queueId='string',
stepId='string',
targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The job ID to update.
string
[REQUIRED]
The queue ID to update.
string
[REQUIRED]
The step ID to update.
string
[REQUIRED]
The task status to update the step's tasks to.
dict
Response Syntax
{}
Response Structure
(dict) --
Assigns a job membership level to a member
See also: AWS API Documentation
Request Syntax
client.associate_member_to_job(
farmId='string',
identityStoreId='string',
jobId='string',
membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
principalId='string',
principalType='USER'|'GROUP',
queueId='string'
)
string
[REQUIRED]
The farm ID of the job to associate with the member.
string
[REQUIRED]
The member's identity store ID to associate with the job.
string
[REQUIRED]
The job ID to associate with the member.
string
[REQUIRED]
The principal's membership level for the associated job.
string
[REQUIRED]
The member's principal ID to associate with the job.
string
[REQUIRED]
The member's principal type to associate with the job.
string
[REQUIRED]
The queue ID to associate to the member.
dict
Response Syntax
{}
Response Structure
(dict) --
Copies a job template to an Amazon S3 bucket.
See also: AWS API Documentation
Request Syntax
client.copy_job_template(
farmId='string',
jobId='string',
queueId='string',
targetS3Location={
'bucketName': 'string',
'key': 'string'
}
)
string
[REQUIRED]
The farm ID to copy.
string
[REQUIRED]
The job ID to copy.
string
[REQUIRED]
The queue ID to copy.
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.
dict
Response Syntax
{
'templateType': 'JSON'|'YAML'
}
Response Structure
(dict) --
templateType (string) --
The format of the job template, either JSON or YAML .
Updates a farm.
See also: AWS API Documentation
Request Syntax
client.update_farm(
description='string',
displayName='string',
farmId='string'
)
string
The description of the farm to update.
string
The display name of the farm to update.
string
[REQUIRED]
The farm ID to update.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches for jobs.
See also: AWS API Documentation
Request Syntax
client.search_jobs(
farmId='string',
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'dateTime': datetime(2015, 1, 1),
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'
},
'groupFilter': {'... recursive ...'},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
}
},
],
'operator': 'AND'|'OR'
},
itemOffset=123,
pageSize=123,
queueIds=[
'string',
],
sortExpressions=[
{
'fieldSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'parameterSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'userJobsFirst': {
'userIdentityId': 'string'
}
},
]
)
string
[REQUIRED]
The farm ID of the job.
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.
dateTimeFilter (dict) --
Filters based on date and time.
dateTime (datetime) -- [REQUIRED]
The 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.
groupFilter (dict) --
Filters by group.
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.
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.
operator (string) -- [REQUIRED]
The operators to include in the search.
integer
[REQUIRED]
Defines how far into the scrollable list to start the return of results.
integer
Specifies the number of items per page for the resource.
list
[REQUIRED]
The queue ID to use in the job search.
(string) --
list
The search terms for a resource.
(dict) --
The resources to search.
fieldSort (dict) --
Options for sorting by a field.
name (string) -- [REQUIRED]
The name of the field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
parameterSort (dict) --
Options for sorting by a parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
dict
Response Syntax
{
'jobs': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'endedAt': datetime(2015, 1, 1),
'jobId': 'string',
'jobParameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
'lifecycleStatusMessage': 'string',
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'name': 'string',
'priority': 123,
'queueId': 'string',
'startedAt': datetime(2015, 1, 1),
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
}
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
jobs (list) --
The jobs in the search.
(dict) --
The details of a job search.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
endedAt (datetime) --
The date and time the resource ended running.
jobId (string) --
The job ID.
jobParameters (dict) --
The job parameters.
(string) --
(dict) --
The details of job parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
The life cycle status message.
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.
name (string) --
The job name.
priority (integer) --
The job priority.
queueId (string) --
The queue ID.
startedAt (datetime) --
The date and time the resource started running.
targetTaskRunStatus (string) --
The task status to start with on the job.
taskRunStatus (string) --
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.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset .
totalResults (integer) --
The total number of results in the search.
Searches for tasks.
See also: AWS API Documentation
Request Syntax
client.search_tasks(
farmId='string',
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'dateTime': datetime(2015, 1, 1),
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'
},
'groupFilter': {'... recursive ...'},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
}
},
],
'operator': 'AND'|'OR'
},
itemOffset=123,
jobId='string',
pageSize=123,
queueIds=[
'string',
],
sortExpressions=[
{
'fieldSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'parameterSort': {
'name': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
},
'userJobsFirst': {
'userIdentityId': 'string'
}
},
]
)
string
[REQUIRED]
The farm ID of the task.
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.
dateTimeFilter (dict) --
Filters based on date and time.
dateTime (datetime) -- [REQUIRED]
The 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.
groupFilter (dict) --
Filters by group.
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.
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.
operator (string) -- [REQUIRED]
The operators to include in the search.
integer
[REQUIRED]
Defines how far into the scrollable list to start the return of results.
string
The job ID for the task search.
integer
Specifies the number of items per page for the resource.
list
[REQUIRED]
The queue IDs to include in the search.
(string) --
list
The search terms for a resource.
(dict) --
The resources to search.
fieldSort (dict) --
Options for sorting by a field.
name (string) -- [REQUIRED]
The name of the field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
parameterSort (dict) --
Options for sorting by a parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
dict
Response Syntax
{
'nextItemOffset': 123,
'tasks': [
{
'endedAt': datetime(2015, 1, 1),
'failureRetryCount': 123,
'jobId': 'string',
'parameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'queueId': 'string',
'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'startedAt': datetime(2015, 1, 1),
'stepId': 'string',
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskId': 'string'
},
],
'totalResults': 123
}
Response Structure
(dict) --
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset .
tasks (list) --
Tasks in the search.
(dict) --
The details of a task search.
endedAt (datetime) --
The date and time the resource ended running.
failureRetryCount (integer) --
The number of times that the task failed and was retried.
jobId (string) --
The job ID.
parameters (dict) --
The parameters to search for.
(string) --
(dict) --
The data types for the task parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
queueId (string) --
The queue ID.
runStatus (string) --
The run status of the task.
startedAt (datetime) --
The date and time the resource started running.
stepId (string) --
The step ID.
targetRunStatus (string) --
The run status that the task is being updated to.
taskId (string) --
The task ID.
totalResults (integer) --
The total number of results in the search.
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
client.create_queue(
allowedStorageProfileIds=[
'string',
],
clientToken='string',
defaultBudgetAction='NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
description='string',
displayName='string',
farmId='string',
jobAttachmentSettings={
'rootPrefix': 'string',
's3BucketName': 'string'
},
jobRunAsUser={
'posix': {
'group': 'string',
'user': 'string'
},
'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER',
'windows': {
'passwordArn': 'string',
'user': 'string'
}
},
requiredFileSystemLocationNames=[
'string',
],
roleArn='string',
tags={
'string': 'string'
}
)
list
The storage profile IDs to include in the queue.
(string) --
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The default action to take on a queue if a budget isn't configured.
string
The description of the queue.
string
[REQUIRED]
The display name of the queue.
string
[REQUIRED]
The farm ID of the farm to connect to the queue.
dict
The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
rootPrefix (string) -- [REQUIRED]
The root prefix.
s3BucketName (string) -- [REQUIRED]
The Amazon S3 bucket name.
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.
group (string) -- [REQUIRED]
The name of the POSIX user's group.
user (string) -- [REQUIRED]
The name of the POSIX 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.
windows (dict) --
Identifies a Microsoft Windows user.
passwordArn (string) -- [REQUIRED]
The password ARN for the Windows user.
user (string) -- [REQUIRED]
The user.
list
The file system location name to include in the queue.
(string) --
string
The IAM role ARN that workers will use while running jobs for this queue.
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) --
dict
Response Syntax
{
'queueId': 'string'
}
Response Structure
(dict) --
queueId (string) --
The queue ID.
Updates a task.
See also: AWS API Documentation
Request Syntax
client.update_task(
clientToken='string',
farmId='string',
jobId='string',
queueId='string',
stepId='string',
targetRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
taskId='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The job ID to update.
string
[REQUIRED]
The queue ID to update.
string
[REQUIRED]
The step ID to update.
string
[REQUIRED]
The run status with which to start the task.
string
[REQUIRED]
The task ID to update.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a queue-fleet association.
See also: AWS API Documentation
Request Syntax
client.delete_queue_fleet_association(
farmId='string',
fleetId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the farm that holds the queue-fleet association.
string
[REQUIRED]
The fleet ID of the queue-fleet association.
string
[REQUIRED]
The queue ID of the queue-fleet association.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a job.
See also: AWS API Documentation
Request Syntax
client.update_job(
clientToken='string',
farmId='string',
jobId='string',
lifecycleStatus='ARCHIVED',
maxFailedTasksCount=123,
maxRetriesPerTask=123,
priority=123,
queueId='string',
targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The farm ID of the job to update.
string
[REQUIRED]
The job ID to update.
string
The status of a job in its lifecycle.
integer
The number of task failures before the job stops running and is marked as FAILED .
integer
The maximum number of retries for a job.
integer
The job priority to update.
string
[REQUIRED]
The queue ID of the job to update.
string
The task status to update the job's tasks to.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists tags for a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The resource ARN to list tags for.
dict
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) --
Gets a licence endpoint.
See also: AWS API Documentation
Request Syntax
client.get_license_endpoint(
licenseEndpointId='string'
)
string
[REQUIRED]
The license endpoint ID.
dict
Response Syntax
{
'dnsName': 'string',
'licenseEndpointId': 'string',
'securityGroupIds': [
'string',
],
'status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'NOT_READY',
'statusMessage': 'string',
'subnetIds': [
'string',
],
'vpcId': 'string'
}
Response Structure
(dict) --
dnsName (string) --
The DNS name.
licenseEndpointId (string) --
The license endpoint ID.
securityGroupIds (list) --
The security group IDs for the license endpoint.
(string) --
status (string) --
The status of the license endpoint.
statusMessage (string) --
The status message of the license endpoint.
subnetIds (list) --
The subnet IDs.
(string) --
vpcId (string) --
The VCP(virtual private cloud) ID associated with the license endpoint.
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
client.assume_queue_role_for_read(
farmId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the farm containing the queue.
string
[REQUIRED]
The queue ID.
dict
Response Syntax
{
'credentials': {
'accessKeyId': 'string',
'expiration': datetime(2015, 1, 1),
'secretAccessKey': 'string',
'sessionToken': 'string'
}
}
Response Structure
(dict) --
credentials (dict) --
The credentials for the queue role.
accessKeyId (string) --
The IAM access key ID.
expiration (datetime) --
The expiration date and time of the IAM credentials.
secretAccessKey (string) --
The IAM secret access key.
sessionToken (string) --
The IAM session token
Lists members on a job.
See also: AWS API Documentation
Request Syntax
client.list_job_members(
farmId='string',
jobId='string',
maxResults=123,
nextToken='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the job to list.
string
[REQUIRED]
The job ID to include on the list.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID to include on the list.
dict
Response Syntax
{
'members': [
{
'farmId': 'string',
'identityStoreId': 'string',
'jobId': 'string',
'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
'principalId': 'string',
'principalType': 'USER'|'GROUP',
'queueId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
members (list) --
The members on the list.
(dict) --
The details for a job member.
farmId (string) --
The farm ID.
identityStoreId (string) --
The identity store ID.
jobId (string) --
The job ID.
membershipLevel (string) --
The job member's membership level.
principalId (string) --
The principal ID of the job member.
principalType (string) --
The principal type of the job member.
queueId (string) --
The queue ID.
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.
Gets a Deadline Cloud job.
See also: AWS API Documentation
Request Syntax
client.get_job(
farmId='string',
jobId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the farm in the job.
string
[REQUIRED]
The job ID.
string
[REQUIRED]
The queue ID associated with the job.
dict
Response Syntax
{
'attachments': {
'fileSystem': 'COPIED'|'VIRTUAL',
'manifests': [
{
'fileSystemLocationName': 'string',
'inputManifestHash': 'string',
'inputManifestPath': 'string',
'outputRelativeDirectories': [
'string',
],
'rootPath': 'string',
'rootPathFormat': 'windows'|'posix'
},
]
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'endedAt': datetime(2015, 1, 1),
'jobId': 'string',
'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
'lifecycleStatusMessage': 'string',
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'name': 'string',
'parameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'priority': 123,
'startedAt': datetime(2015, 1, 1),
'storageProfileId': 'string',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
attachments (dict) --
The attachments for the job.
fileSystem (string) --
The file system.
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.
inputManifestHash (string) --
The has value of the file.
inputManifestPath (string) --
The file path.
outputRelativeDirectories (list) --
The file path relative to the directory.
(string) --
rootPath (string) --
The file's root path.
rootPathFormat (string) --
The format of the root path.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
description (string) --
The description of the job.
endedAt (datetime) --
The date and time the resource ended running.
jobId (string) --
The job ID.
lifecycleStatus (string) --
The life cycle status for the job.
lifecycleStatusMessage (string) --
A message that communicates the status of the life cycle for 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.
name (string) --
The name of the job.
parameters (dict) --
The parameters for the job.
(string) --
(dict) --
The details of job parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
priority (integer) --
The job priority.
startedAt (datetime) --
The date and time the resource started running.
storageProfileId (string) --
The storage profile ID associated with the job.
targetTaskRunStatus (string) --
The task status with which the job started.
taskRunStatus (string) --
The task run status for the job.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Removes a tag from a resource using the resource's ARN and tag to remove.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource to remove the tag from.
list
[REQUIRED]
They keys of the tag.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a task.
See also: AWS API Documentation
Request Syntax
client.get_task(
farmId='string',
jobId='string',
queueId='string',
stepId='string',
taskId='string'
)
string
[REQUIRED]
The farm ID of the farm connected to the task.
string
[REQUIRED]
The job ID of the job connected to the task.
string
[REQUIRED]
The queue ID for the queue connected to the task.
string
[REQUIRED]
The step ID for the step connected to the task.
string
[REQUIRED]
The task ID.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'endedAt': datetime(2015, 1, 1),
'failureRetryCount': 123,
'latestSessionActionId': 'string',
'parameters': {
'string': {
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'
}
},
'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'startedAt': datetime(2015, 1, 1),
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskId': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
endedAt (datetime) --
The date and time the resource ended running.
failureRetryCount (integer) --
The number of times that the task failed and was retried.
latestSessionActionId (string) --
The latest session ID for the task.
parameters (dict) --
The parameters for the task.
(string) --
(dict) --
The data types for the task parameters.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
int (string) --
A signed integer represented as a string.
path (string) --
A file system path represented as a string.
string (string) --
A UTF-8 string.
runStatus (string) --
The run status for the task.
startedAt (datetime) --
The date and time the resource started running.
targetRunStatus (string) --
The run status with which to start the task.
taskId (string) --
The task ID.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Updates a worker.
See also: AWS API Documentation
Request Syntax
client.update_worker(
capabilities={
'amounts': [
{
'name': 'string',
'value': ...
},
],
'attributes': [
{
'name': 'string',
'values': [
'string',
]
},
]
},
farmId='string',
fleetId='string',
hostProperties={
'hostName': 'string',
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
}
},
status='STARTED'|'STOPPING'|'STOPPED',
workerId='string'
)
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) --
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The fleet ID to update.
dict
The host properties to update.
hostName (string) --
The host name.
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) --
string
The worker status to update.
string
[REQUIRED]
The worker ID to update.
dict
Response Syntax
{
'log': {
'error': 'string',
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
}
}
}
Response Structure
(dict) --
log (dict) --
The worker log to update.
error (string) --
The log configuration error details.
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) --
Deletes a storage profile.
See also: AWS API Documentation
Request Syntax
client.delete_storage_profile(
farmId='string',
storageProfileId='string'
)
string
[REQUIRED]
The farm ID of the farm from which to remove the storage profile.
string
[REQUIRED]
The storage profile ID of the storage profile to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a queue.
See also: AWS API Documentation
Request Syntax
client.get_queue(
farmId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the farm in the queue.
string
[REQUIRED]
The queue ID for the queue to retrieve.
dict
Response Syntax
{
'allowedStorageProfileIds': [
'string',
],
'blockedReason': 'NO_BUDGET_CONFIGURED'|'BUDGET_THRESHOLD_REACHED',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'defaultBudgetAction': 'NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
'description': 'string',
'displayName': 'string',
'farmId': 'string',
'jobAttachmentSettings': {
'rootPrefix': 'string',
's3BucketName': 'string'
},
'jobRunAsUser': {
'posix': {
'group': 'string',
'user': 'string'
},
'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER',
'windows': {
'passwordArn': 'string',
'user': 'string'
}
},
'queueId': 'string',
'requiredFileSystemLocationNames': [
'string',
],
'roleArn': 'string',
'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
allowedStorageProfileIds (list) --
The storage profile IDs for the queue.
(string) --
blockedReason (string) --
The reason the queue was blocked.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
defaultBudgetAction (string) --
The default action taken on a queue if a budget wasn't configured.
description (string) --
The description of the queue.
displayName (string) --
The display name of the queue.
farmId (string) --
The farm ID for the queue.
jobAttachmentSettings (dict) --
The job attachment settings for the queue.
rootPrefix (string) --
The root prefix.
s3BucketName (string) --
The Amazon S3 bucket name.
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.
group (string) --
The name of the POSIX user's group.
user (string) --
The name of the POSIX 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.
windows (dict) --
Identifies a Microsoft Windows user.
passwordArn (string) --
The password ARN for the Windows user.
user (string) --
The user.
queueId (string) --
The queue ID.
requiredFileSystemLocationNames (list) --
A list of the required file system location names in the queue.
(string) --
roleArn (string) --
The IAM role ARN.
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.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Gets a queue environment.
See also: AWS API Documentation
Request Syntax
client.get_queue_environment(
farmId='string',
queueEnvironmentId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the queue environment.
string
[REQUIRED]
The queue environment ID.
string
[REQUIRED]
The queue ID for the queue environment.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'name': 'string',
'priority': 123,
'queueEnvironmentId': 'string',
'template': 'string',
'templateType': 'JSON'|'YAML',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.>
name (string) --
The name of the queue environment.
priority (integer) --
The priority of the queue environment.
queueEnvironmentId (string) --
The queue environment ID.
template (string) --
The template for the queue environment.
templateType (string) --
The type of template for the queue environment.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Allows a worker to assume a queue role.
See also: AWS API Documentation
Request Syntax
client.assume_queue_role_for_worker(
farmId='string',
fleetId='string',
queueId='string',
workerId='string'
)
string
[REQUIRED]
The farm ID of the worker assuming the queue role.
string
[REQUIRED]
The fleet ID of the worker assuming the queue role.
string
[REQUIRED]
The queue ID of the worker assuming the queue role.
string
[REQUIRED]
The worker ID of the worker assuming the queue role.
dict
Response Syntax
{
'credentials': {
'accessKeyId': 'string',
'expiration': datetime(2015, 1, 1),
'secretAccessKey': 'string',
'sessionToken': 'string'
}
}
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.
expiration (datetime) --
The expiration date and time of the IAM credentials.
secretAccessKey (string) --
The IAM secret access key.
sessionToken (string) --
The IAM session token
Lists fleet members.
See also: AWS API Documentation
Request Syntax
client.list_fleet_members(
farmId='string',
fleetId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The farm ID of the fleet.
string
[REQUIRED]
The fleet ID to include on the list.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
dict
Response Syntax
{
'members': [
{
'farmId': 'string',
'fleetId': 'string',
'identityStoreId': 'string',
'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
'principalId': 'string',
'principalType': 'USER'|'GROUP'
},
],
'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.
identityStoreId (string) --
The identity store ID.
membershipLevel (string) --
The fleet member's membership level.
principalId (string) --
The principal ID of the fleet member.
principalType (string) --
The principal type of the fleet member.
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.
Lists step consumers.
See also: AWS API Documentation
Request Syntax
client.list_step_consumers(
farmId='string',
jobId='string',
maxResults=123,
nextToken='string',
queueId='string',
stepId='string'
)
string
[REQUIRED]
The farm ID for the list of step consumers.
string
[REQUIRED]
The job ID for the step consumer.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID for the step consumer.
string
[REQUIRED]
The step ID to include on the list.
dict
Response Syntax
{
'consumers': [
{
'status': 'RESOLVED'|'UNRESOLVED',
'stepId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
consumers (list) --
The consumers on the list.
(dict) --
The details of a step consumer.
status (string) --
The step consumer status.
stepId (string) --
The step ID.
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.
Gets a queue-fleet association.
See also: AWS API Documentation
Request Syntax
client.get_queue_fleet_association(
farmId='string',
fleetId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID of the farm that contains the queue-fleet association.
string
[REQUIRED]
The fleet ID for the queue-fleet association.
string
[REQUIRED]
The queue ID for the queue-fleet association.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'fleetId': 'string',
'queueId': 'string',
'status': 'ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'|'STOPPED',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
fleetId (string) --
The fleet ID for the queue-fleet association.
queueId (string) --
The queue ID for the queue-fleet association.
status (string) --
The status of the queue-fleet association.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
Disassociates a member from a job.
See also: AWS API Documentation
Request Syntax
client.disassociate_member_from_job(
farmId='string',
jobId='string',
principalId='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the job to disassociate from the member.
string
[REQUIRED]
The job ID to disassociate from a member in a job.
string
[REQUIRED]
A member's principal ID to disassociate from a job.
string
[REQUIRED]
The queue ID connected to a job for which you're disassociating a member.
dict
Response Syntax
{}
Response Structure
(dict) --
Assigns a farm membership level to a member.
See also: AWS API Documentation
Request Syntax
client.associate_member_to_farm(
farmId='string',
identityStoreId='string',
membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
principalId='string',
principalType='USER'|'GROUP'
)
string
[REQUIRED]
The ID of the farm to associate with the member.
string
[REQUIRED]
The identity store ID of the member to associate with the farm.
string
[REQUIRED]
The principal's membership level for the associated farm.
string
[REQUIRED]
The member's principal ID to associate with the farm.
string
[REQUIRED]
The principal type of the member to associate with the farm.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists queue environments.
See also: AWS API Documentation
Request Syntax
client.list_queue_environments(
farmId='string',
maxResults=123,
nextToken='string',
queueId='string'
)
string
[REQUIRED]
The farm ID for the queue environment list.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
The token for the next set of results, or null to start from the beginning.
string
[REQUIRED]
The queue ID for the queue environment list.
dict
Response Syntax
{
'environments': [
{
'name': 'string',
'priority': 123,
'queueEnvironmentId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
environments (list) --
The environments to include in the queue environments list.
(dict) --
The summary of a queue environment.
name (string) --
The name of the queue environment.
priority (integer) --
The queue environment's priority.
queueEnvironmentId (string) --
The queue environment ID.
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.
Deletes a metered product.
See also: AWS API Documentation
Request Syntax
client.delete_metered_product(
licenseEndpointId='string',
productId='string'
)
string
[REQUIRED]
The ID of the license endpoint from which to remove the metered product.
string
[REQUIRED]
The product ID to remove from the license endpoint.
dict
Response Syntax
{}
Response Structure
(dict) --