2025/03/31 - AWSDeadlineCloud - 4 updated api methods
Changes With this release you can use a new field to specify the search term match type. Search term match types currently support fuzzy and contains matching.
{'filterExpressions': {'filters': {'searchTermFilter': {'matchType': 'FUZZY_MATCH '
'| '
'CONTAINS'}}}}
Searches for jobs.
See also: AWS API Documentation
Request Syntax
client.search_jobs(
farmId='string',
queueIds=[
'string',
],
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'dateTime': datetime(2015, 1, 1)
},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string',
'matchType': 'FUZZY_MATCH'|'CONTAINS'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'groupFilter': {'... recursive ...'}
},
],
'operator': 'AND'|'OR'
},
sortExpressions=[
{
'userJobsFirst': {
'userIdentityId': 'string'
},
'fieldSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
},
'parameterSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
}
},
],
itemOffset=123,
pageSize=123
)
string
[REQUIRED]
The farm ID of the job.
list
[REQUIRED]
The queue ID to use in the job search.
(string) --
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.
name (string) -- [REQUIRED]
The name of the date-time field to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter the results.
dateTime (datetime) -- [REQUIRED]
The date and time.
parameterFilter (dict) --
Filters by parameter.
name (string) -- [REQUIRED]
The name of the parameter to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter results.
value (string) -- [REQUIRED]
The parameter's value.
searchTermFilter (dict) --
Filters by a specified search term.
searchTerm (string) -- [REQUIRED]
The term to search for.
matchType (string) --
Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.
FUZZY_MATCH - Matches if a portion of the search term is found in the result.
CONTAINS - Matches if the exact search term is contained in the result.
stringFilter (dict) --
Filters by a string.
name (string) -- [REQUIRED]
The field name to search.
operator (string) -- [REQUIRED]
The type of comparison to use for this search.
value (string) -- [REQUIRED]
The string to search for.
groupFilter (dict) --
Filters by group.
operator (string) -- [REQUIRED]
The operators to include in the search.
list
The search terms for a resource.
(dict) --
The resources to search.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
fieldSort (dict) --
Options for sorting by a field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
name (string) -- [REQUIRED]
The name of the field.
parameterSort (dict) --
Options for sorting by a parameter.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
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.
dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'queueId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
'lifecycleStatusMessage': 'string',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatusCounts': {
'string': 123
},
'priority': 123,
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'jobParameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string'
}
},
'maxWorkerCount': 123,
'sourceJobId': 'string'
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
jobs (list) --
The jobs in the search.
(dict) --
The details of a job search.
jobId (string) --
The job ID.
queueId (string) --
The queue ID.
name (string) --
The job name.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
The life cycle status message.
taskRunStatus (string) --
The task run status for the job.
PENDING–pending and waiting for resources.
READY–ready to be processed.
ASSIGNED–assigned and will run next on a worker.
SCHEDULED–scheduled to be run on a worker.
INTERRUPTING–being interrupted.
RUNNING–running on a worker.
SUSPENDED–the task is suspended.
CANCELED–the task has been canceled.
FAILED–the task has failed.
SUCCEEDED–the task has succeeded.
targetTaskRunStatus (string) --
The task status to start with on the job.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
priority (integer) --
The job priority.
maxFailedTasksCount (integer) --
The number of task failures before the job stops running and is marked as FAILED.
maxRetriesPerTask (integer) --
The maximum number of retries for a job.
createdBy (string) --
The user or system that created this resource.
createdAt (datetime) --
The date and time the resource was created.
endedAt (datetime) --
The date and time the resource ended running.
startedAt (datetime) --
The date and time the resource started running.
jobParameters (dict) --
The job parameters.
(string) --
(dict) --
The details of job parameters.
int (string) --
A signed integer represented as a string.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
string (string) --
A UTF-8 string.
path (string) --
A file system path represented as a string.
maxWorkerCount (integer) --
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
sourceJobId (string) --
The job ID for the source job.
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset.
totalResults (integer) --
The total number of results in the search.
{'filterExpressions': {'filters': {'searchTermFilter': {'matchType': 'FUZZY_MATCH '
'| '
'CONTAINS'}}}}
Searches for steps.
See also: AWS API Documentation
Request Syntax
client.search_steps(
farmId='string',
queueIds=[
'string',
],
jobId='string',
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'dateTime': datetime(2015, 1, 1)
},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string',
'matchType': 'FUZZY_MATCH'|'CONTAINS'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'groupFilter': {'... recursive ...'}
},
],
'operator': 'AND'|'OR'
},
sortExpressions=[
{
'userJobsFirst': {
'userIdentityId': 'string'
},
'fieldSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
},
'parameterSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
}
},
],
itemOffset=123,
pageSize=123
)
string
[REQUIRED]
The farm ID to use for the step search.
list
[REQUIRED]
The queue IDs in the step search.
(string) --
string
The job ID to use in 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.
name (string) -- [REQUIRED]
The name of the date-time field to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter the results.
dateTime (datetime) -- [REQUIRED]
The date and time.
parameterFilter (dict) --
Filters by parameter.
name (string) -- [REQUIRED]
The name of the parameter to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter results.
value (string) -- [REQUIRED]
The parameter's value.
searchTermFilter (dict) --
Filters by a specified search term.
searchTerm (string) -- [REQUIRED]
The term to search for.
matchType (string) --
Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.
FUZZY_MATCH - Matches if a portion of the search term is found in the result.
CONTAINS - Matches if the exact search term is contained in the result.
stringFilter (dict) --
Filters by a string.
name (string) -- [REQUIRED]
The field name to search.
operator (string) -- [REQUIRED]
The type of comparison to use for this search.
value (string) -- [REQUIRED]
The string to search for.
groupFilter (dict) --
Filters by group.
operator (string) -- [REQUIRED]
The operators to include in the search.
list
The search terms for a resource.
(dict) --
The resources to search.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
fieldSort (dict) --
Options for sorting by a field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
name (string) -- [REQUIRED]
The name of the field.
parameterSort (dict) --
Options for sorting by a parameter.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
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.
dict
Response Syntax
{
'steps': [
{
'stepId': 'string',
'jobId': 'string',
'queueId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
'lifecycleStatusMessage': 'string',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatusCounts': {
'string': 123
},
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'parameterSpace': {
'parameters': [
{
'name': 'string',
'type': 'INT'|'FLOAT'|'STRING'|'PATH'
},
],
'combination': 'string'
}
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
steps (list) --
The steps in the search.
(dict) --
The details of a step search.
stepId (string) --
The step ID.
jobId (string) --
The job ID.
queueId (string) --
The queue ID.
name (string) --
The step name.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
The life cycle status message.
taskRunStatus (string) --
The task run status for the job.
PENDING–pending and waiting for resources.
READY–ready to be processed.
ASSIGNED–assigned and will run next on a worker.
SCHEDULED–scheduled to be run on a worker.
INTERRUPTING–being interrupted.
RUNNING–running on a worker.
SUSPENDED–the task is suspended.
CANCELED–the task has been canceled.
FAILED–the task has failed.
SUCCEEDED–the task has succeeded.
targetTaskRunStatus (string) --
The task status to start with on the job.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
createdAt (datetime) --
The date and time the resource was created.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
parameterSpace (dict) --
The parameters and combination expressions for the search.
parameters (list) --
The parameters to search for.
(dict) --
The details of a step parameter.
name (string) --
The name of the parameter.
type (string) --
The data type of the parameter.
combination (string) --
The combination expression to use in the search.
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset.
totalResults (integer) --
The total number of results in the search.
{'filterExpressions': {'filters': {'searchTermFilter': {'matchType': 'FUZZY_MATCH '
'| '
'CONTAINS'}}}}
Searches for tasks.
See also: AWS API Documentation
Request Syntax
client.search_tasks(
farmId='string',
queueIds=[
'string',
],
jobId='string',
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'dateTime': datetime(2015, 1, 1)
},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string',
'matchType': 'FUZZY_MATCH'|'CONTAINS'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'groupFilter': {'... recursive ...'}
},
],
'operator': 'AND'|'OR'
},
sortExpressions=[
{
'userJobsFirst': {
'userIdentityId': 'string'
},
'fieldSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
},
'parameterSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
}
},
],
itemOffset=123,
pageSize=123
)
string
[REQUIRED]
The farm ID of the task.
list
[REQUIRED]
The queue IDs to include in the search.
(string) --
string
The job ID for the task 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.
name (string) -- [REQUIRED]
The name of the date-time field to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter the results.
dateTime (datetime) -- [REQUIRED]
The date and time.
parameterFilter (dict) --
Filters by parameter.
name (string) -- [REQUIRED]
The name of the parameter to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter results.
value (string) -- [REQUIRED]
The parameter's value.
searchTermFilter (dict) --
Filters by a specified search term.
searchTerm (string) -- [REQUIRED]
The term to search for.
matchType (string) --
Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.
FUZZY_MATCH - Matches if a portion of the search term is found in the result.
CONTAINS - Matches if the exact search term is contained in the result.
stringFilter (dict) --
Filters by a string.
name (string) -- [REQUIRED]
The field name to search.
operator (string) -- [REQUIRED]
The type of comparison to use for this search.
value (string) -- [REQUIRED]
The string to search for.
groupFilter (dict) --
Filters by group.
operator (string) -- [REQUIRED]
The operators to include in the search.
list
The search terms for a resource.
(dict) --
The resources to search.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
fieldSort (dict) --
Options for sorting by a field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
name (string) -- [REQUIRED]
The name of the field.
parameterSort (dict) --
Options for sorting by a parameter.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
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.
dict
Response Syntax
{
'tasks': [
{
'taskId': 'string',
'stepId': 'string',
'jobId': 'string',
'queueId': 'string',
'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string'
}
},
'failureRetryCount': 123,
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1)
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
tasks (list) --
Tasks in the search.
(dict) --
The details of a task search.
taskId (string) --
The task ID.
stepId (string) --
The step ID.
jobId (string) --
The job ID.
queueId (string) --
The queue ID.
runStatus (string) --
The run status of the task.
targetRunStatus (string) --
The run status that the task is being updated to.
parameters (dict) --
The parameters to search for.
(string) --
(dict) --
The data types for the task parameters.
int (string) --
A signed integer represented as a string.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
string (string) --
A UTF-8 string.
path (string) --
A file system path represented as a string.
failureRetryCount (integer) --
The number of times that the task failed and was retried.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset.
totalResults (integer) --
The total number of results in the search.
{'filterExpressions': {'filters': {'searchTermFilter': {'matchType': 'FUZZY_MATCH '
'| '
'CONTAINS'}}}}
Searches for workers.
See also: AWS API Documentation
Request Syntax
client.search_workers(
farmId='string',
fleetIds=[
'string',
],
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'dateTime': datetime(2015, 1, 1)
},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string',
'matchType': 'FUZZY_MATCH'|'CONTAINS'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'groupFilter': {'... recursive ...'}
},
],
'operator': 'AND'|'OR'
},
sortExpressions=[
{
'userJobsFirst': {
'userIdentityId': 'string'
},
'fieldSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
},
'parameterSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
}
},
],
itemOffset=123,
pageSize=123
)
string
[REQUIRED]
The farm ID in the workers search.
list
[REQUIRED]
The fleet ID of the workers to search for.
(string) --
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.
name (string) -- [REQUIRED]
The name of the date-time field to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter the results.
dateTime (datetime) -- [REQUIRED]
The date and time.
parameterFilter (dict) --
Filters by parameter.
name (string) -- [REQUIRED]
The name of the parameter to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter results.
value (string) -- [REQUIRED]
The parameter's value.
searchTermFilter (dict) --
Filters by a specified search term.
searchTerm (string) -- [REQUIRED]
The term to search for.
matchType (string) --
Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.
FUZZY_MATCH - Matches if a portion of the search term is found in the result.
CONTAINS - Matches if the exact search term is contained in the result.
stringFilter (dict) --
Filters by a string.
name (string) -- [REQUIRED]
The field name to search.
operator (string) -- [REQUIRED]
The type of comparison to use for this search.
value (string) -- [REQUIRED]
The string to search for.
groupFilter (dict) --
Filters by group.
operator (string) -- [REQUIRED]
The operators to include in the search.
list
The search terms for a resource.
(dict) --
The resources to search.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
fieldSort (dict) --
Options for sorting by a field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
name (string) -- [REQUIRED]
The name of the field.
parameterSort (dict) --
Options for sorting by a parameter.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
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.
dict
Response Syntax
{
'workers': [
{
'fleetId': 'string',
'workerId': 'string',
'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE',
'hostProperties': {
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
},
'hostName': 'string',
'ec2InstanceArn': 'string',
'ec2InstanceType': 'string'
},
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'updatedAt': datetime(2015, 1, 1)
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
workers (list) --
The workers for the search.
(dict) --
The details of a worker search.
fleetId (string) --
The fleet ID.
workerId (string) --
The worker ID.
status (string) --
The status of the worker search.
hostProperties (dict) --
Provides the Amazon EC2 instance properties of the worker host.
ipAddresses (dict) --
The IP address of the host.
ipV4Addresses (list) --
The IpV4 address of the network.
(string) --
ipV6Addresses (list) --
The IpV6 address for the network and node component.
(string) --
hostName (string) --
The host name.
ec2InstanceArn (string) --
The ARN of the host EC2 instance.
ec2InstanceType (string) --
The instance type of the host EC2 instance.
createdBy (string) --
The user or system that created this resource.
createdAt (datetime) --
The date and time the resource was created.
updatedBy (string) --
The user or system that updated this resource.
updatedAt (datetime) --
The date and time the resource was updated.
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset.
totalResults (integer) --
The total number of results in the search.