{ "smithy": "2.0", "shapes": { "aws.cloudformation#StructureIdList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#idRef": { "failWhenMissing": true, "selector": "structure" } } }, "traits": { "smithy.api#private": {} } }, "com.amazonaws.deadline#AcceleratorCapabilities": { "type": "structure", "members": { "selections": { "target": "com.amazonaws.deadline#AcceleratorSelections", "traits": { "smithy.api#documentation": "
A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Amazon Web Services Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.
You must specify at least one accelerator selection.
You cannot specify the same accelerator name multiple times in the selections list.
All accelerators in the selections must use the same runtime version.
The number of GPU accelerators specified for worker hosts in this fleet.
You must specify either acceleratorCapabilities.count.max or allowedInstanceTypes when using accelerator capabilities. If you don't specify a maximum count, Amazon Web Services Deadline Cloud uses the instance types you specify in allowedInstanceTypes to determine the maximum number of accelerators.
Provides information about the GPU accelerators used for jobs processed by a fleet.
Accelerator capabilities cannot be used with wait-and-save fleets. If you specify accelerator capabilities, you must use either spot or on-demand instance market options.
Each accelerator type maps to specific EC2 instance families:
t4: Uses G4dn instance family
a10g: Uses G5 instance family
l4: Uses G6, G6f, Gr6, and Gr6f instance families
l40s: Uses G6e instance family
rtx-pro-server-6000: Uses G7e instance family
rtx-pro-4500: Uses G7 instance family
The name of the chip used by the GPU accelerator.
The available GPU accelerators are:
t4 - NVIDIA T4 Tensor Core GPU (16 GiB memory)
a10g - NVIDIA A10G Tensor Core GPU (24 GiB memory)
l4 - NVIDIA L4 Tensor Core GPU (24 GiB memory)
l40s - NVIDIA L40S Tensor Core GPU (48 GiB memory)
rtx-pro-server-6000 - NVIDIA RTX PRO Server 6000 GPU (96 GiB memory)
rtx-pro-4500 - NVIDIA RTX PRO 4500 GPU (32 GiB memory)
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs in a fleet.
You can choose from the following runtimes:
latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.
grid:r595 - NVIDIA vGPU software 20
grid:r580 - NVIDIA vGPU software 19
If you don't specify a runtime, Amazon Web Services Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Amazon Web Services Deadline Cloud raises an exception.
All accelerator types support grid:r595 and grid:r580.
All accelerators in a fleet must use the same runtime version. You cannot mix different runtime versions within a single fleet.
When you specify latest, it resolves to grid:r595 for all currently supported accelerators.
GetJob API.\n\nThe result of getting each job is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.\n",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Get multiple jobs in a single request",
"input": {
"identifiers": [
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef"
},
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-234567890abcdef1234567890abcdef1"
}
]
}
}
],
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/batch-get-job",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#BatchGetJobEntity": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#BatchGetJobEntityRequest"
},
"output": {
"target": "com.amazonaws.deadline#BatchGetJobEntityResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "BatchGetJobEntity",
"documentation": "Grants permission to get a job entity for a worker",
"resources": {
"required": {
"worker": {}
}
}
},
"smithy.api#documentation": "Get batched job details for a worker.",
"smithy.api#endpoint": {
"hostPrefix": "scheduling."
},
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}/batchGetJobEntity",
"code": 200
},
"smithy.api#readonly": {},
"smithy.api#suppress": [
"HttpMethodSemantics.UnnecessaryReadonlyTrait"
]
}
},
"com.amazonaws.deadline#BatchGetJobEntityErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#GetJobEntityError"
}
},
"com.amazonaws.deadline#BatchGetJobEntityList": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#JobEntity"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 25
}
}
},
"com.amazonaws.deadline#BatchGetJobEntityRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"workerId": {
"target": "com.amazonaws.deadline#WorkerId",
"traits": {
"smithy.api#documentation": "The worker ID of the worker containing the job details to get.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"identifiers": {
"target": "com.amazonaws.deadline#JobEntityIdentifiers",
"traits": {
"smithy.api#documentation": "The job identifiers to include within the job entity batch details.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchGetJobEntityResponse": {
"type": "structure",
"members": {
"entities": {
"target": "com.amazonaws.deadline#BatchGetJobEntityList",
"traits": {
"smithy.api#documentation": "A list of the job entities, or details, in the batch.",
"smithy.api#required": {}
}
},
"errors": {
"target": "com.amazonaws.deadline#BatchGetJobEntityErrors",
"traits": {
"smithy.api#documentation": "A list of errors from the job error logs for the batch.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BatchGetJobError": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the job that could not be retrieved.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the job that could not be retrieved.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the job that could not be retrieved.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#BatchGetJobErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for a job that could not be retrieved in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetJobErrorCode": {
"type": "enum",
"members": {
"InternalServerErrorException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InternalServerErrorException"
}
},
"ResourceNotFoundException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ResourceNotFoundException"
}
},
"ValidationException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ValidationException"
}
},
"AccessDeniedException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AccessDeniedException"
}
},
"ThrottlingException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ThrottlingException"
}
}
}
},
"com.amazonaws.deadline#BatchGetJobErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetJobError"
}
},
"com.amazonaws.deadline#BatchGetJobIdentifier": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the job.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the job.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The identifiers for a job.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetJobIdentifiers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetJobIdentifier"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#BatchGetJobItem": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the job.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the job.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.deadline#JobName",
"traits": {
"smithy.api#documentation": "The name of the job.",
"smithy.api#required": {}
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#JobLifecycleStatus",
"traits": {
"smithy.api#documentation": "The life cycle status of the job.",
"smithy.api#required": {}
}
},
"lifecycleStatusMessage": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "A message that communicates the status of the life cycle.",
"smithy.api#required": {}
}
},
"priority": {
"target": "com.amazonaws.deadline#JobPriority",
"traits": {
"smithy.api#documentation": "The job priority.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated. Task status changes don't update this value."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running. Requeuing the job doesn't change this value."
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running. Returned only when the job has finished."
}
},
"taskRunStatus": {
"target": "com.amazonaws.deadline#TaskRunStatus",
"traits": {
"smithy.api#documentation": "The task run status for the job."
}
},
"targetTaskRunStatus": {
"target": "com.amazonaws.deadline#JobTargetTaskRunStatus",
"traits": {
"smithy.api#documentation": "The task status to start with on the job."
}
},
"taskRunStatusCounts": {
"target": "com.amazonaws.deadline#TaskRunStatusCounts",
"traits": {
"smithy.api#documentation": "The number of tasks for each run status for the job."
}
},
"taskFailureRetryCount": {
"target": "com.amazonaws.deadline#TaskFailureRetryCount",
"traits": {
"smithy.api#documentation": "The number of times that tasks failed and were retried."
}
},
"storageProfileId": {
"target": "com.amazonaws.deadline#StorageProfileId",
"traits": {
"smithy.api#documentation": "The storage profile ID associated with the job."
}
},
"maxFailedTasksCount": {
"target": "com.amazonaws.deadline#MaxFailedTasksCount",
"traits": {
"smithy.api#documentation": "The number of task failures before the job stops running and is marked as FAILED."
}
},
"maxRetriesPerTask": {
"target": "com.amazonaws.deadline#MaxRetriesPerTask",
"traits": {
"smithy.api#documentation": "The maximum number of retries per failed tasks."
}
},
"parameters": {
"target": "com.amazonaws.deadline#JobParameters",
"traits": {
"smithy.api#documentation": "The parameters for the job."
}
},
"attachments": {
"target": "com.amazonaws.deadline#Attachments",
"traits": {
"smithy.api#documentation": "The attachments for the job."
}
},
"description": {
"target": "com.amazonaws.deadline#JobDescription",
"traits": {
"smithy.api#documentation": "The description of the job."
}
},
"maxWorkerCount": {
"target": "com.amazonaws.deadline#MaxWorkerCount",
"traits": {
"smithy.api#documentation": "The maximum number of worker hosts that can concurrently process a job."
}
},
"sourceJobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the source job."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a job returned in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetJobItems": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetJobItem"
}
},
"com.amazonaws.deadline#BatchGetJobRequest": {
"type": "structure",
"members": {
"identifiers": {
"target": "com.amazonaws.deadline#BatchGetJobIdentifiers",
"traits": {
"smithy.api#documentation": "The list of job identifiers to retrieve. You can specify up to 100 identifiers per request.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchGetJobResponse": {
"type": "structure",
"members": {
"jobs": {
"target": "com.amazonaws.deadline#BatchGetJobItems",
"traits": {
"smithy.api#documentation": "A list of jobs that were successfully retrieved.",
"smithy.api#required": {}
}
},
"errors": {
"target": "com.amazonaws.deadline#BatchGetJobErrors",
"traits": {
"smithy.api#documentation": "A list of errors for jobs that could not be retrieved.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BatchGetSession": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#BatchGetSessionRequest"
},
"output": {
"target": "com.amazonaws.deadline#BatchGetSessionResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetSession",
"documentation": "Grants permission to get a session for a job",
"relativeDocumentation": "API_GetSession.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Retrieves multiple sessions in a single request. This is a batch version of the GetSession API.\n\nThe result of getting each session is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.\n",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Get multiple sessions in a single request",
"input": {
"identifiers": [
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"sessionId": "session-1234567890abcdef1234567890abcdef"
},
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"sessionId": "session-234567890abcdef1234567890abcdef1"
}
]
}
}
],
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/batch-get-session",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#BatchGetSessionAction": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#BatchGetSessionActionRequest"
},
"output": {
"target": "com.amazonaws.deadline#BatchGetSessionActionResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetSessionAction",
"documentation": "Grants permission to get a session action for a job",
"relativeDocumentation": "API_GetSessionAction.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Retrieves multiple session actions in a single request. This is a batch version of the GetSessionAction API.\n\nThe result of getting each session action is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.\n",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Get multiple session actions in a single request",
"input": {
"identifiers": [
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"sessionActionId": "sessionaction-1234567890abcdef1234567890abcdef-0"
},
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"sessionActionId": "sessionaction-1234567890abcdef1234567890abcdef-1"
}
]
}
}
],
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/batch-get-session-action",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#BatchGetSessionActionError": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the session action that could not be retrieved.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the session action that could not be retrieved.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the session action that could not be retrieved.",
"smithy.api#required": {}
}
},
"sessionActionId": {
"target": "com.amazonaws.deadline#SessionActionId",
"traits": {
"smithy.api#documentation": "The session action ID of the session action that could not be retrieved.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#BatchGetSessionActionErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for a session action that could not be retrieved in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetSessionActionErrorCode": {
"type": "enum",
"members": {
"InternalServerErrorException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InternalServerErrorException"
}
},
"ResourceNotFoundException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ResourceNotFoundException"
}
},
"ValidationException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ValidationException"
}
}
}
},
"com.amazonaws.deadline#BatchGetSessionActionErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetSessionActionError"
}
},
"com.amazonaws.deadline#BatchGetSessionActionIdentifier": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the session action.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the session action.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the session action.",
"smithy.api#required": {}
}
},
"sessionActionId": {
"target": "com.amazonaws.deadline#SessionActionId",
"traits": {
"smithy.api#documentation": "The session action ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The identifiers for a session action.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetSessionActionIdentifiers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetSessionActionIdentifier"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#BatchGetSessionActionItem": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the session action.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the session action.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the session action.",
"smithy.api#required": {}
}
},
"sessionActionId": {
"target": "com.amazonaws.deadline#SessionActionId",
"traits": {
"smithy.api#documentation": "The session action ID.",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.deadline#SessionActionStatus",
"traits": {
"smithy.api#documentation": "The status of the session action.",
"smithy.api#required": {}
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running."
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running."
}
},
"workerUpdatedAt": {
"target": "com.amazonaws.deadline#Timestamp",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated by a worker."
}
},
"progressPercent": {
"target": "com.amazonaws.deadline#SessionActionProgressPercent",
"traits": {
"smithy.api#documentation": "The completion percentage for the session action."
}
},
"manifests": {
"target": "com.amazonaws.deadline#TaskRunManifestPropertiesListResponse",
"traits": {
"smithy.api#documentation": "The manifests for the session action."
}
},
"sessionId": {
"target": "com.amazonaws.deadline#SessionId",
"traits": {
"smithy.api#documentation": "The session ID for the session action.",
"smithy.api#required": {}
}
},
"processExitCode": {
"target": "com.amazonaws.deadline#ProcessExitCode",
"traits": {
"smithy.api#documentation": "The exit code to apply to the session action."
}
},
"progressMessage": {
"target": "com.amazonaws.deadline#SessionActionProgressMessage",
"traits": {
"smithy.api#documentation": "The message that communicates the progress of the session action."
}
},
"acquiredLimits": {
"target": "com.amazonaws.deadline#AcquiredLimits",
"traits": {
"smithy.api#documentation": "The limits that were acquired for the session action."
}
},
"definition": {
"target": "com.amazonaws.deadline#SessionActionDefinition",
"traits": {
"smithy.api#documentation": "The session action definition.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of a session action returned in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetSessionActionItems": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetSessionActionItem"
}
},
"com.amazonaws.deadline#BatchGetSessionActionRequest": {
"type": "structure",
"members": {
"identifiers": {
"target": "com.amazonaws.deadline#BatchGetSessionActionIdentifiers",
"traits": {
"smithy.api#documentation": "The list of session action identifiers to retrieve. You can specify up to 100 identifiers per request.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchGetSessionActionResponse": {
"type": "structure",
"members": {
"sessionActions": {
"target": "com.amazonaws.deadline#BatchGetSessionActionItems",
"traits": {
"smithy.api#documentation": "A list of session actions that were successfully retrieved.",
"smithy.api#required": {}
}
},
"errors": {
"target": "com.amazonaws.deadline#BatchGetSessionActionErrors",
"traits": {
"smithy.api#documentation": "A list of errors for session actions that could not be retrieved.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BatchGetSessionError": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the session that could not be retrieved.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the session that could not be retrieved.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the session that could not be retrieved.",
"smithy.api#required": {}
}
},
"sessionId": {
"target": "com.amazonaws.deadline#SessionId",
"traits": {
"smithy.api#documentation": "The session ID of the session that could not be retrieved.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#BatchGetSessionErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for a session that could not be retrieved in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetSessionErrorCode": {
"type": "enum",
"members": {
"InternalServerErrorException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InternalServerErrorException"
}
},
"ResourceNotFoundException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ResourceNotFoundException"
}
},
"ValidationException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ValidationException"
}
}
}
},
"com.amazonaws.deadline#BatchGetSessionErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetSessionError"
}
},
"com.amazonaws.deadline#BatchGetSessionIdentifier": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the session.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the session.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the session.",
"smithy.api#required": {}
}
},
"sessionId": {
"target": "com.amazonaws.deadline#SessionId",
"traits": {
"smithy.api#documentation": "The session ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The identifiers for a session.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetSessionIdentifiers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetSessionIdentifier"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#BatchGetSessionItem": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the session.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the session.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the session.",
"smithy.api#required": {}
}
},
"sessionId": {
"target": "com.amazonaws.deadline#SessionId",
"traits": {
"smithy.api#documentation": "The session ID.",
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the session.",
"smithy.api#required": {}
}
},
"workerId": {
"target": "com.amazonaws.deadline#WorkerId",
"traits": {
"smithy.api#documentation": "The worker ID of the session.",
"smithy.api#required": {}
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running.",
"smithy.api#required": {}
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#SessionLifecycleStatus",
"traits": {
"smithy.api#documentation": "The life cycle status of the session.",
"smithy.api#required": {}
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running."
}
},
"targetLifecycleStatus": {
"target": "com.amazonaws.deadline#SessionLifecycleTargetStatus",
"traits": {
"smithy.api#documentation": "The target life cycle status for the session."
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"log": {
"target": "com.amazonaws.deadline#LogConfiguration",
"traits": {
"smithy.api#documentation": "The session log.",
"smithy.api#required": {}
}
},
"hostProperties": {
"target": "com.amazonaws.deadline#HostPropertiesResponse",
"traits": {
"smithy.api#documentation": "The host properties for the session."
}
},
"workerLog": {
"target": "com.amazonaws.deadline#LogConfiguration",
"traits": {
"smithy.api#documentation": "The worker log for the session."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a session returned in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetSessionItems": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetSessionItem"
}
},
"com.amazonaws.deadline#BatchGetSessionRequest": {
"type": "structure",
"members": {
"identifiers": {
"target": "com.amazonaws.deadline#BatchGetSessionIdentifiers",
"traits": {
"smithy.api#documentation": "The list of session identifiers to retrieve. You can specify up to 100 identifiers per request.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchGetSessionResponse": {
"type": "structure",
"members": {
"sessions": {
"target": "com.amazonaws.deadline#BatchGetSessionItems",
"traits": {
"smithy.api#documentation": "A list of sessions that were successfully retrieved.",
"smithy.api#required": {}
}
},
"errors": {
"target": "com.amazonaws.deadline#BatchGetSessionErrors",
"traits": {
"smithy.api#documentation": "A list of errors for sessions that could not be retrieved.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BatchGetStep": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#BatchGetStepRequest"
},
"output": {
"target": "com.amazonaws.deadline#BatchGetStepResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetStep",
"documentation": "Grants permission to get a step in a job",
"relativeDocumentation": "API_GetStep.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Retrieves multiple steps in a single request. This is a batch version of the GetStep API.\n\nThe result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.\n",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Get multiple steps in a single request",
"input": {
"identifiers": [
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"stepId": "step-1234567890abcdef1234567890abcdef"
},
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"stepId": "step-234567890abcdef1234567890abcdef1"
}
]
}
}
],
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/batch-get-step",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#BatchGetStepError": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the step that could not be retrieved.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the step that could not be retrieved.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the step that could not be retrieved.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID of the step that could not be retrieved.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#BatchGetStepErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for a step that could not be retrieved in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetStepErrorCode": {
"type": "enum",
"members": {
"InternalServerErrorException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InternalServerErrorException"
}
},
"ResourceNotFoundException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ResourceNotFoundException"
}
},
"ValidationException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ValidationException"
}
},
"AccessDeniedException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AccessDeniedException"
}
},
"ThrottlingException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ThrottlingException"
}
}
}
},
"com.amazonaws.deadline#BatchGetStepErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetStepError"
}
},
"com.amazonaws.deadline#BatchGetStepIdentifier": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the step.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the step.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the step.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The identifiers for a step.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetStepIdentifiers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetStepIdentifier"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#BatchGetStepItem": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the step.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the step.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the step.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.deadline#StepName",
"traits": {
"smithy.api#documentation": "The name of the step.",
"smithy.api#required": {}
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#StepLifecycleStatus",
"traits": {
"smithy.api#documentation": "The life cycle status of the step.",
"smithy.api#required": {}
}
},
"lifecycleStatusMessage": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "A message that communicates the status of the life cycle."
}
},
"taskRunStatus": {
"target": "com.amazonaws.deadline#TaskRunStatus",
"traits": {
"smithy.api#documentation": "The task run status for the step.",
"smithy.api#required": {}
}
},
"taskRunStatusCounts": {
"target": "com.amazonaws.deadline#TaskRunStatusCounts",
"traits": {
"smithy.api#documentation": "The number of tasks for each run status for the step.",
"smithy.api#required": {}
}
},
"taskFailureRetryCount": {
"target": "com.amazonaws.deadline#TaskFailureRetryCount",
"traits": {
"smithy.api#documentation": "The number of times that tasks failed and were retried."
}
},
"targetTaskRunStatus": {
"target": "com.amazonaws.deadline#StepTargetTaskRunStatus",
"traits": {
"smithy.api#documentation": "The task status to start with on the step."
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running."
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running."
}
},
"dependencyCounts": {
"target": "com.amazonaws.deadline#DependencyCounts",
"traits": {
"smithy.api#documentation": "The number of dependencies for the step."
}
},
"requiredCapabilities": {
"target": "com.amazonaws.deadline#StepRequiredCapabilities",
"traits": {
"smithy.api#documentation": "The required capabilities for the step."
}
},
"parameterSpace": {
"target": "com.amazonaws.deadline#ParameterSpace",
"traits": {
"smithy.api#documentation": "The parameter space for the step."
}
},
"description": {
"target": "com.amazonaws.deadline#StepDescription",
"traits": {
"smithy.api#documentation": "The description of the step."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a step returned in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetStepItems": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetStepItem"
}
},
"com.amazonaws.deadline#BatchGetStepRequest": {
"type": "structure",
"members": {
"identifiers": {
"target": "com.amazonaws.deadline#BatchGetStepIdentifiers",
"traits": {
"smithy.api#documentation": "The list of step identifiers to retrieve. You can specify up to 100 identifiers per request.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchGetStepResponse": {
"type": "structure",
"members": {
"steps": {
"target": "com.amazonaws.deadline#BatchGetStepItems",
"traits": {
"smithy.api#documentation": "A list of steps that were successfully retrieved.",
"smithy.api#required": {}
}
},
"errors": {
"target": "com.amazonaws.deadline#BatchGetStepErrors",
"traits": {
"smithy.api#documentation": "A list of errors for steps that could not be retrieved.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BatchGetTask": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#BatchGetTaskRequest"
},
"output": {
"target": "com.amazonaws.deadline#BatchGetTaskResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetTask",
"documentation": "Grants permission to get a job task",
"relativeDocumentation": "API_GetTask.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Retrieves multiple tasks in a single request. This is a batch version of the GetTask API.\n\nThe result of getting each task is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.\n",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Get multiple tasks in a single request",
"input": {
"identifiers": [
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"stepId": "step-1234567890abcdef1234567890abcdef",
"taskId": "task-1234567890abcdef1234567890abcdef-0"
},
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"stepId": "step-1234567890abcdef1234567890abcdef",
"taskId": "task-1234567890abcdef1234567890abcdef-1"
}
]
}
}
],
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/batch-get-task",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#BatchGetTaskError": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the task that could not be retrieved.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the task that could not be retrieved.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the task that could not be retrieved.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID of the task that could not be retrieved.",
"smithy.api#required": {}
}
},
"taskId": {
"target": "com.amazonaws.deadline#TaskId",
"traits": {
"smithy.api#documentation": "The task ID of the task that could not be retrieved.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#BatchGetTaskErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for a task that could not be retrieved in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetTaskErrorCode": {
"type": "enum",
"members": {
"InternalServerErrorException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InternalServerErrorException"
}
},
"ResourceNotFoundException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ResourceNotFoundException"
}
},
"ValidationException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ValidationException"
}
},
"AccessDeniedException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AccessDeniedException"
}
},
"ThrottlingException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ThrottlingException"
}
}
}
},
"com.amazonaws.deadline#BatchGetTaskErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetTaskError"
}
},
"com.amazonaws.deadline#BatchGetTaskIdentifier": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the task.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the task.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the task.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID of the task.",
"smithy.api#required": {}
}
},
"taskId": {
"target": "com.amazonaws.deadline#TaskId",
"traits": {
"smithy.api#documentation": "The task ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The identifiers for a task.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetTaskIdentifiers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetTaskIdentifier"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#BatchGetTaskItem": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the task.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the task.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the task.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID of the task.",
"smithy.api#required": {}
}
},
"taskId": {
"target": "com.amazonaws.deadline#TaskId",
"traits": {
"smithy.api#documentation": "The task ID.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"runStatus": {
"target": "com.amazonaws.deadline#TaskRunStatus",
"traits": {
"smithy.api#documentation": "The run status of the task.",
"smithy.api#required": {}
}
},
"targetRunStatus": {
"target": "com.amazonaws.deadline#TaskTargetRunStatus",
"traits": {
"smithy.api#documentation": "The run status with which to start the task."
}
},
"failureRetryCount": {
"target": "com.amazonaws.deadline#TaskRetryCount",
"traits": {
"smithy.api#documentation": "The number of times the task failed and was retried."
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running."
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running."
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"latestSessionActionId": {
"target": "com.amazonaws.deadline#SessionActionId",
"traits": {
"smithy.api#documentation": "The latest session action for the task."
}
},
"parameters": {
"target": "com.amazonaws.deadline#TaskParameters",
"traits": {
"smithy.api#documentation": "The parameters for the task."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a task returned in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetTaskItems": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetTaskItem"
}
},
"com.amazonaws.deadline#BatchGetTaskRequest": {
"type": "structure",
"members": {
"identifiers": {
"target": "com.amazonaws.deadline#BatchGetTaskIdentifiers",
"traits": {
"smithy.api#documentation": "The list of task identifiers to retrieve. You can specify up to 100 identifiers per request.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchGetTaskResponse": {
"type": "structure",
"members": {
"tasks": {
"target": "com.amazonaws.deadline#BatchGetTaskItems",
"traits": {
"smithy.api#documentation": "A list of tasks that were successfully retrieved.",
"smithy.api#required": {}
}
},
"errors": {
"target": "com.amazonaws.deadline#BatchGetTaskErrors",
"traits": {
"smithy.api#documentation": "A list of errors for tasks that could not be retrieved.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BatchGetWorker": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#BatchGetWorkerRequest"
},
"output": {
"target": "com.amazonaws.deadline#BatchGetWorkerResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetWorker",
"documentation": "Grants permission to get a worker",
"relativeDocumentation": "API_GetWorker.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"worker": {}
}
}
},
"smithy.api#documentation": "Retrieves multiple workers in a single request. This is a batch version of the GetWorker API.\n\nThe result of getting each worker is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.\n",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Get multiple workers in a single request",
"input": {
"identifiers": [
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"fleetId": "fleet-1234567890abcdef1234567890abcdef",
"workerId": "worker-1234567890abcdef1234567890abcdef"
},
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"fleetId": "fleet-1234567890abcdef1234567890abcdef",
"workerId": "worker-234567890abcdef1234567890abcdef1"
}
]
}
}
],
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/batch-get-worker",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#BatchGetWorkerError": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the worker that could not be retrieved.",
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the worker that could not be retrieved.",
"smithy.api#required": {}
}
},
"workerId": {
"target": "com.amazonaws.deadline#WorkerId",
"traits": {
"smithy.api#documentation": "The worker ID of the worker that could not be retrieved.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#BatchGetWorkerErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for a worker that could not be retrieved in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#WorkerResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetWorkerErrorCode": {
"type": "enum",
"members": {
"InternalServerErrorException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InternalServerErrorException"
}
},
"ResourceNotFoundException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ResourceNotFoundException"
}
},
"ValidationException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ValidationException"
}
}
}
},
"com.amazonaws.deadline#BatchGetWorkerErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetWorkerError"
}
},
"com.amazonaws.deadline#BatchGetWorkerIdentifier": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the worker.",
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the worker.",
"smithy.api#required": {}
}
},
"workerId": {
"target": "com.amazonaws.deadline#WorkerId",
"traits": {
"smithy.api#documentation": "The worker ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The identifiers for a worker.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#WorkerResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetWorkerIdentifiers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetWorkerIdentifier"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#BatchGetWorkerItem": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the worker.",
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the worker.",
"smithy.api#required": {}
}
},
"workerId": {
"target": "com.amazonaws.deadline#WorkerId",
"traits": {
"smithy.api#documentation": "The worker ID.",
"smithy.api#required": {}
}
},
"hostProperties": {
"target": "com.amazonaws.deadline#HostPropertiesResponse",
"traits": {
"smithy.api#documentation": "The host properties for the worker."
}
},
"status": {
"target": "com.amazonaws.deadline#WorkerStatus",
"traits": {
"smithy.api#documentation": "The status of the worker.",
"smithy.api#required": {}
}
},
"log": {
"target": "com.amazonaws.deadline#LogConfiguration",
"traits": {
"smithy.api#documentation": "The log configuration for the worker."
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a worker returned in a batch get operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#WorkerResource"
}
]
}
},
"com.amazonaws.deadline#BatchGetWorkerItems": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchGetWorkerItem"
}
},
"com.amazonaws.deadline#BatchGetWorkerRequest": {
"type": "structure",
"members": {
"identifiers": {
"target": "com.amazonaws.deadline#BatchGetWorkerIdentifiers",
"traits": {
"smithy.api#documentation": "The list of worker identifiers to retrieve. You can specify up to 100 identifiers per request.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchGetWorkerResponse": {
"type": "structure",
"members": {
"workers": {
"target": "com.amazonaws.deadline#BatchGetWorkerItems",
"traits": {
"smithy.api#documentation": "A list of workers that were successfully retrieved.",
"smithy.api#required": {}
}
},
"errors": {
"target": "com.amazonaws.deadline#BatchGetWorkerErrors",
"traits": {
"smithy.api#documentation": "A list of errors for workers that could not be retrieved.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BatchUpdateJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#BatchUpdateJobRequest"
},
"output": {
"target": "com.amazonaws.deadline#BatchUpdateJobResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "UpdateJob",
"documentation": "Grants permission to update a job",
"relativeDocumentation": "API_UpdateJob.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Updates multiple jobs in a single request. This is a batch version of the UpdateJob API.
The result of updating each job is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
When you change the status of a job to ARCHIVED, the job can't be scheduled or archived.
An archived job and its steps and tasks are deleted after 120 days. The job can't be recovered.
FAILED."
}
},
"maxRetriesPerTask": {
"target": "com.amazonaws.deadline#MaxRetriesPerTask",
"traits": {
"smithy.api#documentation": "The maximum number of retries per failed tasks."
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#UpdateJobLifecycleStatus",
"traits": {
"smithy.api#documentation": "The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.
An archived job and its steps and tasks are deleted after 120 days. The job can't be recovered.
UpdateTask API.\n\nThe result of updating each task is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.\n",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Update multiple tasks in a single request",
"input": {
"tasks": [
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"stepId": "step-1234567890abcdef1234567890abcdef",
"taskId": "task-1234567890abcdef1234567890abcdef-0",
"targetRunStatus": "FAILED"
},
{
"farmId": "farm-1234567890abcdef1234567890abcdef",
"queueId": "queue-1234567890abcdef1234567890abcdef",
"jobId": "job-1234567890abcdef1234567890abcdef",
"stepId": "step-1234567890abcdef1234567890abcdef",
"taskId": "task-1234567890abcdef1234567890abcdef-1",
"targetRunStatus": "FAILED"
}
]
}
}
],
"smithy.api#http": {
"method": "PATCH",
"uri": "/2023-10-12/batch-update-task",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#BatchUpdateTaskError": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the task that could not be updated.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the task that could not be updated.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the task that could not be updated.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID of the task that could not be updated.",
"smithy.api#required": {}
}
},
"taskId": {
"target": "com.amazonaws.deadline#TaskId",
"traits": {
"smithy.api#documentation": "The task ID of the task that could not be updated.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#BatchUpdateTaskErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for a task that could not be updated in a batch update operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchUpdateTaskErrorCode": {
"type": "enum",
"members": {
"ConflictException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ConflictException"
}
},
"InternalServerErrorException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InternalServerErrorException"
}
},
"ResourceNotFoundException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ResourceNotFoundException"
}
},
"ValidationException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ValidationException"
}
},
"AccessDeniedException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AccessDeniedException"
}
},
"ThrottlingException": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ThrottlingException"
}
}
}
},
"com.amazonaws.deadline#BatchUpdateTaskErrors": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchUpdateTaskError"
}
},
"com.amazonaws.deadline#BatchUpdateTaskItem": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the task to update.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the task to update.",
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID of the task to update.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID of the task to update.",
"smithy.api#required": {}
}
},
"taskId": {
"target": "com.amazonaws.deadline#TaskId",
"traits": {
"smithy.api#documentation": "The task ID of the task to update.",
"smithy.api#required": {}
}
},
"targetRunStatus": {
"target": "com.amazonaws.deadline#TaskTargetRunStatus",
"traits": {
"smithy.api#documentation": "The run status with which to start the task.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of a task to update in a batch update operation.",
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#JobResource"
}
]
}
},
"com.amazonaws.deadline#BatchUpdateTaskItems": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BatchUpdateTaskItem"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#BatchUpdateTaskRequest": {
"type": "structure",
"members": {
"clientToken": {
"target": "com.amazonaws.deadline#ClientToken",
"traits": {
"smithy.api#documentation": "The unique token which the server uses to recognize retries of the same request.",
"smithy.api#httpHeader": "X-Amz-Client-Token",
"smithy.api#idempotencyToken": {}
}
},
"tasks": {
"target": "com.amazonaws.deadline#BatchUpdateTaskItems",
"traits": {
"smithy.api#documentation": "The list of tasks to update. You can specify up to 100 tasks per request.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#BatchUpdateTaskResponse": {
"type": "structure",
"members": {
"errors": {
"target": "com.amazonaws.deadline#BatchUpdateTaskErrors",
"traits": {
"smithy.api#documentation": "A list of errors for tasks that could not be updated.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#BooleanString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 5
},
"smithy.api#pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[Yy][Ee][Ss]|[Nn][Oo]|[Oo][Nn]|[Oo][Ff][Ff]|[01])$"
}
},
"com.amazonaws.deadline#BooleanStringList": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#BooleanString"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 512
}
}
},
"com.amazonaws.deadline#BoundedString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
}
}
},
"com.amazonaws.deadline#BudgetActionToAdd": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.deadline#BudgetActionType",
"traits": {
"smithy.api#documentation": "The type of budget action to add.",
"smithy.api#required": {}
}
},
"thresholdPercentage": {
"target": "com.amazonaws.deadline#ThresholdPercentage",
"traits": {
"smithy.api#documentation": "The percentage threshold for the budget action to add.",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.deadline#Description",
"traits": {
"smithy.api#documentation": "A description for the budget action to add.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
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.
The display name of the budget summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget summary.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
JSON or YAML.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CostScaleFactor": {
"type": "float",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 100
}
}
},
"com.amazonaws.deadline#CpuArchitectureType": {
"type": "enum",
"members": {
"X86_64": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "x86_64"
}
},
"ARM64": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "arm64"
}
}
}
},
"com.amazonaws.deadline#CreateBudget": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateBudgetRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateBudgetResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"aws:RequestTag/${TagKey}",
"aws:TagKeys"
],
"aws.iam#iamAction": {
"name": "CreateBudget",
"documentation": "Grants permission to create a budget",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember",
"deadline:TagResource"
],
"resources": {
"required": {
"budget": {}
}
}
},
"smithy.api#documentation": "Creates a budget to set spending thresholds for your rendering activity.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/farms/{farmId}/budgets",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#CreateBudgetRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID to include in this budget.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display name of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.\n",
"smithy.api#required": {}
}
},
"configuration": {
"target": "com.amazonaws.deadline#FleetConfiguration",
"traits": {
"smithy.api#documentation": "The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.",
"smithy.api#required": {}
}
},
"tags": {
"target": "com.amazonaws.deadline#Tags",
"traits": {
"smithy.api#documentation": "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."
}
},
"hostConfiguration": {
"target": "com.amazonaws.deadline#HostConfiguration",
"traits": {
"smithy.api#documentation": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet."
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#CreateFleetResponse": {
"type": "structure",
"members": {
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateJobRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateJobResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"aws:RequestTag/${TagKey}",
"aws:TagKeys"
],
"aws.iam#iamAction": {
"name": "CreateJob",
"documentation": "Grants permission to create a job",
"requiredActions": [
"deadline:GetJobTemplate",
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs",
"code": 201
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#CreateJobRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm to connect to the job.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The ID of the queue that the job is submitted to.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"clientToken": {
"target": "com.amazonaws.deadline#ClientToken",
"traits": {
"smithy.api#documentation": "The unique token which the server uses to recognize retries of the same request.",
"smithy.api#httpHeader": "X-Amz-Client-Token",
"smithy.api#idempotencyToken": {}
}
},
"template": {
"target": "com.amazonaws.deadline#JobTemplate",
"traits": {
"smithy.api#documentation": "The job template to use for this job."
}
},
"templateType": {
"target": "com.amazonaws.deadline#JobTemplateType",
"traits": {
"smithy.api#documentation": "The file type for the job template."
}
},
"priority": {
"target": "com.amazonaws.deadline#JobPriority",
"traits": {
"smithy.api#documentation": "The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.",
"smithy.api#required": {}
}
},
"parameters": {
"target": "com.amazonaws.deadline#JobParameters",
"traits": {
"smithy.api#documentation": "The parameters for the job."
}
},
"attachments": {
"target": "com.amazonaws.deadline#Attachments",
"traits": {
"smithy.api#documentation": "The attachments for the job. Attach files required for the job to run to a render job."
}
},
"storageProfileId": {
"target": "com.amazonaws.deadline#StorageProfileId",
"traits": {
"smithy.api#documentation": "The storage profile ID for the storage profile to connect to the job."
}
},
"targetTaskRunStatus": {
"target": "com.amazonaws.deadline#CreateJobTargetTaskRunStatus",
"traits": {
"smithy.api#default": "READY",
"smithy.api#documentation": "The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued."
}
},
"maxFailedTasksCount": {
"target": "com.amazonaws.deadline#MaxFailedTasksCount",
"traits": {
"smithy.api#default": 20,
"smithy.api#documentation": "The number of task failures before the job stops running and is marked as FAILED."
}
},
"maxRetriesPerTask": {
"target": "com.amazonaws.deadline#MaxRetriesPerTask",
"traits": {
"smithy.api#default": 5,
"smithy.api#documentation": "The maximum number of retries for each task."
}
},
"maxWorkerCount": {
"target": "com.amazonaws.deadline#MaxWorkerCount",
"traits": {
"smithy.api#documentation": "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.\n\nYou can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.\n\nIf you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.\n"
}
},
"sourceJobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the source job."
}
},
"nameOverride": {
"target": "com.amazonaws.deadline#JobName",
"traits": {
"smithy.api#documentation": "A custom name to override the job name derived from the job template."
}
},
"descriptionOverride": {
"target": "com.amazonaws.deadline#JobDescriptionOverride",
"traits": {
"smithy.api#documentation": "A custom description to override the job description derived from the job template."
}
},
"tags": {
"target": "com.amazonaws.deadline#Tags",
"traits": {
"smithy.api#documentation": "The tags to add to your job. 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."
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#CreateJobResponse": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateJobTargetTaskRunStatus": {
"type": "enum",
"members": {
"READY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "READY"
}
},
"SUSPENDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SUSPENDED"
}
}
}
},
"com.amazonaws.deadline#CreateLicenseEndpoint": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateLicenseEndpointRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateLicenseEndpointResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#ConflictException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"aws:RequestTag/${TagKey}",
"aws:TagKeys"
],
"aws.iam#iamAction": {
"name": "CreateLicenseEndpoint",
"documentation": "Grants permission to create a license endpoint for licensed software or products",
"requiredActions": [
"deadline:TagResource",
"ec2:CreateTags",
"ec2:CreateVpcEndpoint",
"ec2:DescribeVpcEndpoints"
]
},
"smithy.api#documentation": "Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/license-endpoints",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#CreateLicenseEndpointRequest": {
"type": "structure",
"members": {
"clientToken": {
"target": "com.amazonaws.deadline#ClientToken",
"traits": {
"smithy.api#documentation": "The unique token which the server uses to recognize retries of the same request.",
"smithy.api#httpHeader": "X-Amz-Client-Token",
"smithy.api#idempotencyToken": {}
}
},
"vpcId": {
"target": "com.amazonaws.deadline#VpcId",
"traits": {
"smithy.api#documentation": "The VPC (virtual private cloud) ID to use with the license endpoint.",
"smithy.api#required": {}
}
},
"subnetIds": {
"target": "com.amazonaws.deadline#SubnetIdList",
"traits": {
"smithy.api#documentation": "The subnet IDs.",
"smithy.api#length": {
"min": 1,
"max": 10
},
"smithy.api#required": {}
}
},
"securityGroupIds": {
"target": "com.amazonaws.deadline#SecurityGroupIdList",
"traits": {
"smithy.api#documentation": "The security group IDs.",
"smithy.api#length": {
"min": 1,
"max": 10
},
"smithy.api#required": {}
}
},
"tags": {
"target": "com.amazonaws.deadline#Tags",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#CreateLicenseEndpointResponse": {
"type": "structure",
"members": {
"licenseEndpointId": {
"target": "com.amazonaws.deadline#LicenseEndpointId",
"traits": {
"smithy.api#documentation": "The license endpoint ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateLimit": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateLimitRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateLimitResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "CreateLimit",
"documentation": "Grants permission to create a limit for a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
You must add the amountRequirementName to a step in a job template to declare the limit requirement.
The display name of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.",
"smithy.api#required": {}
}
},
"maxCount": {
"target": "com.amazonaws.deadline#MaxCount",
"traits": {
"smithy.api#documentation": "The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
A description of the limit. A description helps you identify the purpose of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
CreateQueueLimitAssociation and DeleteLimit.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateMonitor": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateMonitorRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateMonitorResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"aws:RequestTag/${TagKey}",
"aws:TagKeys"
],
"aws.iam#iamAction": {
"name": "CreateMonitor",
"documentation": "Grants permission to create a monitor",
"requiredActions": [
"deadline:TagResource",
"sso:CreateApplication",
"sso:PutApplicationAssignmentConfiguration",
"sso:PutApplicationAuthenticationMethod",
"sso:PutApplicationGrant",
"sso:DeleteApplication",
"iam:PassRole"
]
},
"smithy.api#documentation": "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.
", "smithy.api#endpoint": { "hostPrefix": "management." }, "smithy.api#http": { "method": "POST", "uri": "/2023-10-12/monitors", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.deadline#CreateMonitorRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.deadline#ClientToken", "traits": { "smithy.api#documentation": "The unique token which the server uses to recognize retries of the same request.", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } }, "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { "smithy.api#documentation": "The name that you give the monitor that is displayed in the Deadline Cloud console.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
JSON or YAML.",
"smithy.api#required": {}
}
},
"template": {
"target": "com.amazonaws.deadline#EnvironmentTemplate",
"traits": {
"smithy.api#documentation": "The environment template to use in the queue.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#CreateQueueEnvironmentResponse": {
"type": "structure",
"members": {
"queueEnvironmentId": {
"target": "com.amazonaws.deadline#QueueEnvironmentId",
"traits": {
"smithy.api#documentation": "The queue environment ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateQueueFleetAssociation": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateQueueFleetAssociationRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateQueueFleetAssociationResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "CreateQueueFleetAssociation",
"documentation": "Grants permission to create a queue-fleet association",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {},
"fleet": {}
}
}
},
"smithy.api#documentation": "Creates an association between a queue and a fleet.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "PUT",
"uri": "/2023-10-12/farms/{farmId}/queue-fleet-associations",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#CreateQueueFleetAssociationRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The ID of the farm that the queue and fleet belong to.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID.",
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#CreateQueueFleetAssociationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateQueueLimitAssociation": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateQueueLimitAssociationRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateQueueLimitAssociationResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "CreateQueueLimitAssociation",
"documentation": "Grants permission to create a queue-limit association",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"farm": {},
"queue": {}
}
}
},
"smithy.api#documentation": "Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "PUT",
"uri": "/2023-10-12/farms/{farmId}/queue-limit-associations",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#CreateQueueLimitAssociationRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the queue and limit to associate.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The unique identifier of the queue to associate with the limit.",
"smithy.api#required": {}
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "The unique identifier of the limit to associate with the queue.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#CreateQueueLimitAssociationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateQueueRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm to connect to the queue.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"clientToken": {
"target": "com.amazonaws.deadline#ClientToken",
"traits": {
"smithy.api#documentation": "The unique token which the server uses to recognize retries of the same request.",
"smithy.api#httpHeader": "X-Amz-Client-Token",
"smithy.api#idempotencyToken": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display name of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
priorityFifo scheduling configuration.\n"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#CreateQueueResponse": {
"type": "structure",
"members": {
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#CreateStorageProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#CreateStorageProfileRequest"
},
"output": {
"target": "com.amazonaws.deadline#CreateStorageProfileResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "CreateStorageProfile",
"documentation": "Grants permission to create a storage profile for a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/farms/{farmId}/storage-profiles",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#CreateStorageProfileRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm to connect to the storage profile.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"clientToken": {
"target": "com.amazonaws.deadline#ClientToken",
"traits": {
"smithy.api#documentation": "The unique token which the server uses to recognize retries of the same request.",
"smithy.api#httpHeader": "X-Amz-Client-Token",
"smithy.api#idempotencyToken": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display name of the storage profile.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you'll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.
CreateMonitor operation, and is included in the response to the GetMonitor operation.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DeleteMonitorResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DeleteQueue": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DeleteQueueRequest"
},
"output": {
"target": "com.amazonaws.deadline#DeleteQueueResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#ConflictException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "DeleteQueue",
"documentation": "Grants permission to delete a queue",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {}
}
}
},
"smithy.api#documentation": "Deletes a queue.
You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.
UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/queue-limit-associations/{queueId}/{limitId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DeleteQueueLimitAssociationRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the queue and limit to disassociate.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The unique identifier of the queue to disassociate.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "The unique identifier of the limit to disassociate.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DeleteQueueLimitAssociationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DeleteQueueRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The ID of the farm from which to remove the queue.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the queue to delete.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DeleteQueueResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DeleteStorageProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DeleteStorageProfileRequest"
},
"output": {
"target": "com.amazonaws.deadline#DeleteStorageProfileResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "DeleteStorageProfile",
"documentation": "Grants permission to delete a storage profile",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Deletes a storage profile.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/storage-profiles/{storageProfileId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DeleteStorageProfileRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm from which to remove the storage profile.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"storageProfileId": {
"target": "com.amazonaws.deadline#StorageProfileId",
"traits": {
"smithy.api#documentation": "The storage profile ID of the storage profile to delete.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DeleteStorageProfileResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DeleteVolume": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DeleteVolumeRequest"
},
"output": {
"target": "com.amazonaws.deadline#DeleteVolumeResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#ConflictException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "DeleteVolume",
"documentation": "Grants permission to delete a volume",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"volume": {}
}
}
},
"smithy.api#documentation": "Deletes a persistent volume.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "Delete a volume",
"input": {
"farmId": "farm-1234567890abcdef1234567890abcdef",
"fleetId": "fleet-1234567890abcdef1234567890abcdef",
"volumeId": "volume-1234567890abcdef1234567890abcdef"
}
}
],
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/volumes/{volumeId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DeleteVolumeRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm that contains the fleet.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the fleet that contains the volume.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"volumeId": {
"target": "com.amazonaws.deadline#VolumeId",
"traits": {
"smithy.api#documentation": "The volume ID of the volume to delete.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {},
"smithy.api#references": [
{
"resource": "com.amazonaws.deadline#VolumeResource"
}
]
}
},
"com.amazonaws.deadline#DeleteVolumeResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DeleteWorker": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DeleteWorkerRequest"
},
"output": {
"target": "com.amazonaws.deadline#DeleteWorkerResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#ConflictException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "DeleteWorker",
"documentation": "Grants permission to delete a worker",
"resources": {
"required": {
"worker": {}
}
}
},
"smithy.api#documentation": "Deletes a worker.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DeleteWorkerRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the worker to delete.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the worker to delete.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"workerId": {
"target": "com.amazonaws.deadline#WorkerId",
"traits": {
"smithy.api#documentation": "The worker ID of the worker to delete.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DeleteWorkerResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DependenciesList": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#StepId"
}
},
"com.amazonaws.deadline#DependencyConsumerResolutionStatus": {
"type": "enum",
"members": {
"RESOLVED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "RESOLVED"
}
},
"UNRESOLVED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UNRESOLVED"
}
}
}
},
"com.amazonaws.deadline#DependencyCounts": {
"type": "structure",
"members": {
"dependenciesResolved": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#documentation": "The number of resolved dependencies.",
"smithy.api#required": {}
}
},
"dependenciesUnresolved": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#documentation": "The number of unresolved dependencies.",
"smithy.api#required": {}
}
},
"consumersResolved": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#documentation": "The number of consumers resolved.",
"smithy.api#required": {}
}
},
"consumersUnresolved": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#documentation": "The number of unresolved consumers.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The number of dependencies for the consumer."
}
},
"com.amazonaws.deadline#Description": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 100
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.deadline#DesiredWorkerStatus": {
"type": "enum",
"members": {
"STOPPED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "STOPPED"
}
}
}
},
"com.amazonaws.deadline#DisassociateMemberFromFarm": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DisassociateMemberFromFarmRequest"
},
"output": {
"target": "com.amazonaws.deadline#DisassociateMemberFromFarmResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:AssociatedMembershipLevel"
],
"aws.iam#iamAction": {
"name": "DisassociateMemberFromFarm",
"documentation": "Grants permission to disassociate a member from a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Disassociates a member from a farm.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/members/{principalId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromFarmRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm to disassociate from the member.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "A member's principal ID to disassociate from a farm.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"aws.api#data": "permissions",
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromFarmResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromFleet": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DisassociateMemberFromFleetRequest"
},
"output": {
"target": "com.amazonaws.deadline#DisassociateMemberFromFleetResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#ConflictException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:AssociatedMembershipLevel"
],
"aws.iam#iamAction": {
"name": "DisassociateMemberFromFleet",
"documentation": "Grants permission to disassociate a member from a fleet",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"fleet": {}
}
}
},
"smithy.api#documentation": "Disassociates a member from a fleet.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/members/{principalId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromFleetRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the fleet to disassociate a member from.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the fleet to from which to disassociate a member.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "A member's principal ID to disassociate from a fleet.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"aws.api#data": "permissions",
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromFleetResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DisassociateMemberFromJobRequest"
},
"output": {
"target": "com.amazonaws.deadline#DisassociateMemberFromJobResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:AssociatedMembershipLevel"
],
"aws.iam#iamAction": {
"name": "DisassociateMemberFromJob",
"documentation": "Grants permission to disassociate a member from a job",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Disassociates a member from a job.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/members/{principalId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromJobRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the job to disassociate from the member.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID connected to a job for which you're disassociating a member.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID to disassociate from a member in a job.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "A member's principal ID to disassociate from a job.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"aws.api#data": "permissions",
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromJobResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromQueue": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#DisassociateMemberFromQueueRequest"
},
"output": {
"target": "com.amazonaws.deadline#DisassociateMemberFromQueueResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#ConflictException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:AssociatedMembershipLevel"
],
"aws.iam#iamAction": {
"name": "DisassociateMemberFromQueue",
"documentation": "Grants permission to disassociate a member from a queue",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {}
}
}
},
"smithy.api#documentation": "Disassociates a member from a queue.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "DELETE",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/members/{principalId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromQueueRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the queue to disassociate from a member.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID of the queue in which you're disassociating from a member.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "A member's principal ID to disassociate from a queue.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"aws.api#data": "permissions",
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#DisassociateMemberFromQueueResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#DnsName": {
"type": "string"
},
"com.amazonaws.deadline#Document": {
"type": "document",
"traits": {
"smithy.api#sensitive": {}
}
},
"com.amazonaws.deadline#Double": {
"type": "double"
},
"com.amazonaws.deadline#EbsIops": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 3000,
"max": 16000
}
}
},
"com.amazonaws.deadline#EbsThroughputMiB": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 125,
"max": 1000
}
}
},
"com.amazonaws.deadline#EbsVolumeType": {
"type": "enum",
"members": {
"GP3": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "gp3"
}
}
},
"traits": {
"smithy.api#documentation": "The EBS volume type."
}
},
"com.amazonaws.deadline#Ec2EbsVolume": {
"type": "structure",
"members": {
"sizeGiB": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#default": 250,
"smithy.api#documentation": "The EBS volume size in GiB."
}
},
"iops": {
"target": "com.amazonaws.deadline#EbsIops",
"traits": {
"smithy.api#default": 3000,
"smithy.api#documentation": "The IOPS per volume."
}
},
"throughputMiB": {
"target": "com.amazonaws.deadline#EbsThroughputMiB",
"traits": {
"smithy.api#default": 125,
"smithy.api#documentation": "The throughput per volume in MiB."
}
}
},
"traits": {
"smithy.api#documentation": "Specifies the EBS volume."
}
},
"com.amazonaws.deadline#Ec2MarketType": {
"type": "enum",
"members": {
"ON_DEMAND": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "on-demand"
}
},
"SPOT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "spot"
}
},
"WAIT_AND_SAVE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "wait-and-save"
}
}
}
},
"com.amazonaws.deadline#EndedAt": {
"type": "timestamp",
"traits": {
"smithy.api#timestampFormat": "date-time"
}
},
"com.amazonaws.deadline#EndsAt": {
"type": "timestamp",
"traits": {
"smithy.api#timestampFormat": "date-time"
}
},
"com.amazonaws.deadline#EnvironmentDetailsEntity": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"environmentId": {
"target": "com.amazonaws.deadline#EnvironmentId",
"traits": {
"smithy.api#documentation": "The environment ID.",
"smithy.api#required": {}
}
},
"schemaVersion": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The schema version in the environment.",
"smithy.api#required": {}
}
},
"template": {
"target": "com.amazonaws.deadline#Document",
"traits": {
"smithy.api#documentation": "The template used for the environment.",
"smithy.api#required": {}
}
},
"extensions": {
"target": "com.amazonaws.deadline#OpenjdExtensionNameList",
"traits": {
"smithy.api#documentation": "The Open Job Description extensions that the environment uses. This value is used by the worker agent."
}
},
"resolvedSymbolTable": {
"target": "com.amazonaws.deadline#SerializedSymbolTable",
"traits": {
"smithy.api#documentation": "The resolved symbol table for the environment's expressions, serialized as JSON. This value is used by the worker agent."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a specified environment."
}
},
"com.amazonaws.deadline#EnvironmentDetailsError": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"environmentId": {
"target": "com.amazonaws.deadline#EnvironmentId",
"traits": {
"smithy.api#documentation": "The environment ID.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#JobEntityErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message detailing the error's cause.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The error details for the environment."
}
},
"com.amazonaws.deadline#EnvironmentDetailsIdentifiers": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"environmentId": {
"target": "com.amazonaws.deadline#EnvironmentId",
"traits": {
"smithy.api#documentation": "The environment ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The IDs of the job and environment."
}
},
"com.amazonaws.deadline#EnvironmentEnterSessionActionDefinition": {
"type": "structure",
"members": {
"environmentId": {
"target": "com.amazonaws.deadline#EnvironmentId",
"traits": {
"smithy.api#documentation": "The environment ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The environment ID to use to enter a session action."
}
},
"com.amazonaws.deadline#EnvironmentEnterSessionActionDefinitionSummary": {
"type": "structure",
"members": {
"environmentId": {
"target": "com.amazonaws.deadline#EnvironmentId",
"traits": {
"smithy.api#documentation": "The environment ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "Defines the environment a session action enters in."
}
},
"com.amazonaws.deadline#EnvironmentExitSessionActionDefinition": {
"type": "structure",
"members": {
"environmentId": {
"target": "com.amazonaws.deadline#EnvironmentId",
"traits": {
"smithy.api#documentation": "The environment ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "Defines the environment a session action exits from."
}
},
"com.amazonaws.deadline#EnvironmentExitSessionActionDefinitionSummary": {
"type": "structure",
"members": {
"environmentId": {
"target": "com.amazonaws.deadline#EnvironmentId",
"traits": {
"smithy.api#documentation": "The environment ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "A summary of the environment details for which a session action to exits."
}
},
"com.amazonaws.deadline#EnvironmentId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^(STEP:step-[0-9a-f]{32}:.*)|(JOB:job-[0-9a-f]{32}:.*)$"
}
},
"com.amazonaws.deadline#EnvironmentName": {
"type": "string"
},
"com.amazonaws.deadline#EnvironmentTemplate": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 15000
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.deadline#EnvironmentTemplateType": {
"type": "enum",
"members": {
"JSON": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "JSON"
}
},
"YAML": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "YAML"
}
}
}
},
"com.amazonaws.deadline#ExceptionContext": {
"type": "map",
"key": {
"target": "com.amazonaws.deadline#String"
},
"value": {
"target": "com.amazonaws.deadline#String"
}
},
"com.amazonaws.deadline#FarmId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^farm-[0-9a-f]{32}$"
}
},
"com.amazonaws.deadline#FarmMember": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm member.",
"smithy.api#required": {}
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "The principal ID of the farm member.",
"smithy.api#required": {}
}
},
"principalType": {
"target": "com.amazonaws.deadline#DeadlinePrincipalType",
"traits": {
"smithy.api#documentation": "The principal type of the farm member.",
"smithy.api#required": {}
}
},
"identityStoreId": {
"target": "com.amazonaws.deadline#IdentityStoreId",
"traits": {
"smithy.api#documentation": "The identity store ID of the farm member.",
"smithy.api#required": {}
}
},
"membershipLevel": {
"target": "com.amazonaws.deadline#MembershipLevel",
"traits": {
"smithy.api#documentation": "The farm member's membership level.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The member of a farm."
}
},
"com.amazonaws.deadline#FarmMembers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#FarmMember"
}
},
"com.amazonaws.deadline#FarmResource": {
"type": "resource",
"identifiers": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId"
}
},
"create": {
"target": "com.amazonaws.deadline#CreateFarm"
},
"read": {
"target": "com.amazonaws.deadline#GetFarm"
},
"update": {
"target": "com.amazonaws.deadline#UpdateFarm"
},
"delete": {
"target": "com.amazonaws.deadline#DeleteFarm"
},
"list": {
"target": "com.amazonaws.deadline#ListFarms"
},
"operations": [
{
"target": "com.amazonaws.deadline#AssociateMemberToFarm"
},
{
"target": "com.amazonaws.deadline#CreateLimit"
},
{
"target": "com.amazonaws.deadline#CreateStorageProfile"
},
{
"target": "com.amazonaws.deadline#DeleteLimit"
},
{
"target": "com.amazonaws.deadline#DeleteStorageProfile"
},
{
"target": "com.amazonaws.deadline#DisassociateMemberFromFarm"
},
{
"target": "com.amazonaws.deadline#GetLimit"
},
{
"target": "com.amazonaws.deadline#GetStorageProfile"
},
{
"target": "com.amazonaws.deadline#ListFarmMembers"
},
{
"target": "com.amazonaws.deadline#ListLimits"
},
{
"target": "com.amazonaws.deadline#ListStorageProfiles"
},
{
"target": "com.amazonaws.deadline#UpdateLimit"
},
{
"target": "com.amazonaws.deadline#UpdateStorageProfile"
}
],
"resources": [
{
"target": "com.amazonaws.deadline#BudgetResource"
},
{
"target": "com.amazonaws.deadline#FleetResource"
},
{
"target": "com.amazonaws.deadline#QueueResource"
}
],
"traits": {
"aws.api#arn": {
"template": "farm/{farmId}"
},
"aws.iam#conditionKeys": [
"deadline:FarmMembershipLevels",
"aws:ResourceTag/${TagKey}"
],
"aws.iam#disableConditionKeyInference": {},
"aws.iam#iamResource": {
"name": "farm",
"relativeDocumentation": "farms.html"
},
"smithy.api#documentation": "Represents a farm that contains Deadline Cloud queues and fleets"
}
},
"com.amazonaws.deadline#FarmSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#FarmSummary"
}
},
"com.amazonaws.deadline#FarmSummary": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID.",
"smithy.api#required": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display name of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
docker.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "Software that the service installs on worker hosts in a service-managed fleet."
}
},
"com.amazonaws.deadline#FleetSoftwareAddOnName": {
"type": "enum",
"members": {
"DOCKER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "docker"
}
}
}
},
"com.amazonaws.deadline#FleetSoftwareAddOns": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#FleetSoftwareAddOn"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 10
},
"smithy.api#uniqueItems": {}
}
},
"com.amazonaws.deadline#FleetStatus": {
"type": "enum",
"members": {
"ACTIVE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ACTIVE"
}
},
"CREATE_IN_PROGRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CREATE_IN_PROGRESS"
}
},
"UPDATE_IN_PROGRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UPDATE_IN_PROGRESS"
}
},
"CREATE_FAILED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CREATE_FAILED"
}
},
"UPDATE_FAILED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UPDATE_FAILED"
}
},
"SUSPENDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SUSPENDED"
}
}
}
},
"com.amazonaws.deadline#FleetSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#FleetSummary"
}
},
"com.amazonaws.deadline#FleetSummary": {
"type": "structure",
"members": {
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID.",
"smithy.api#required": {},
"smithy.api#resourceIdentifier": "fleetId"
}
},
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID.",
"smithy.api#required": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display name of the fleet summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The status of the budget.
ACTIVE - Get a budget being evaluated.
INACTIVE - Get an inactive budget. This can include expired, canceled, or deleted statuses.
The display name of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
GROWING, STEADY, or SHRINKING."
}
},
"targetWorkerCount": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#documentation": "The number of target workers in the fleet."
}
},
"workerCount": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#documentation": "The number of workers in the fleet.",
"smithy.api#required": {}
}
},
"minWorkerCount": {
"target": "com.amazonaws.deadline#MinZeroMaxInteger",
"traits": {
"smithy.api#documentation": "The minimum number of workers specified in the fleet.",
"smithy.api#required": {}
}
},
"maxWorkerCount": {
"target": "com.amazonaws.deadline#MinZeroMaxInteger",
"traits": {
"smithy.api#documentation": "The maximum number of workers specified in the fleet.",
"smithy.api#required": {}
}
},
"configuration": {
"target": "com.amazonaws.deadline#FleetConfiguration",
"traits": {
"smithy.api#documentation": "The configuration setting for the fleet.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"description": {
"target": "com.amazonaws.deadline#Description",
"traits": {
"smithy.api#documentation": "The description of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The life cycle status for the job.
", "smithy.api#required": {} } }, "lifecycleStatusMessage": { "target": "com.amazonaws.deadline#String", "traits": { "smithy.api#documentation": "A message that communicates the status of the life cycle for the job.", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.deadline#JobPriority", "traits": { "smithy.api#documentation": "The job priority.", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.deadline#CreatedAt", "traits": { "smithy.api#documentation": "The date and time the resource was created.", "smithy.api#required": {} } }, "createdBy": { "target": "com.amazonaws.deadline#CreatedBy", "traits": { "smithy.api#documentation": "The user or system that created this resource.", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.deadline#UpdatedAt", "traits": { "smithy.api#documentation": "The date and time the resource was updated. Task status changes don't update this value." } }, "updatedBy": { "target": "com.amazonaws.deadline#UpdatedBy", "traits": { "smithy.api#documentation": "The user or system that updated this resource." } }, "startedAt": { "target": "com.amazonaws.deadline#StartedAt", "traits": { "smithy.api#documentation": "The date and time the resource started running. Requeuing the job doesn't change this value." } }, "endedAt": { "target": "com.amazonaws.deadline#EndedAt", "traits": { "smithy.api#documentation": "The date and time the resource ended running. Returned only when the job has finished." } }, "taskRunStatus": { "target": "com.amazonaws.deadline#TaskRunStatus", "traits": { "smithy.api#documentation": "The task run status for the job." } }, "targetTaskRunStatus": { "target": "com.amazonaws.deadline#JobTargetTaskRunStatus", "traits": { "smithy.api#documentation": "The task status with which the job started." } }, "taskRunStatusCounts": { "target": "com.amazonaws.deadline#TaskRunStatusCounts", "traits": { "smithy.api#documentation": "The number of tasks running on the job." } }, "taskFailureRetryCount": { "target": "com.amazonaws.deadline#TaskFailureRetryCount", "traits": { "smithy.api#documentation": "The total number of times tasks from the job failed and were retried." } }, "storageProfileId": { "target": "com.amazonaws.deadline#StorageProfileId", "traits": { "smithy.api#documentation": "The storage profile ID associated with the job." } }, "maxFailedTasksCount": { "target": "com.amazonaws.deadline#MaxFailedTasksCount", "traits": { "smithy.api#documentation": "The number of task failures before the job stops running and is marked asFAILED."
}
},
"maxRetriesPerTask": {
"target": "com.amazonaws.deadline#MaxRetriesPerTask",
"traits": {
"smithy.api#documentation": "The maximum number of retries per failed tasks."
}
},
"parameters": {
"target": "com.amazonaws.deadline#JobParameters",
"traits": {
"smithy.api#documentation": "The parameters for the job."
}
},
"attachments": {
"target": "com.amazonaws.deadline#Attachments",
"traits": {
"smithy.api#documentation": "The attachments for the job."
}
},
"description": {
"target": "com.amazonaws.deadline#JobDescription",
"traits": {
"smithy.api#documentation": "The description of the job.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
maxWorkerCount 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.\n\nIf you don't set the maxWorkerCount when you create a job, this value is not returned in the response.\n"
}
},
"sourceJobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the source job."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#GetLicenseEndpoint": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#GetLicenseEndpointRequest"
},
"output": {
"target": "com.amazonaws.deadline#GetLicenseEndpointResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [],
"aws.iam#iamAction": {
"name": "GetLicenseEndpoint",
"documentation": "Grants permission to get a license endpoint"
},
"smithy.api#documentation": "Gets a licence endpoint.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/license-endpoints/{licenseEndpointId}",
"code": 200
},
"smithy.api#readonly": {},
"smithy.waiters#waitable": {
"LicenseEndpointValid": {
"minDelay": 10,
"maxDelay": 1140,
"documentation": "Wait until a LicenseEndpoint is Ready. Use this after invoking CreateLicenseEndpoint.",
"acceptors": [
{
"state": "success",
"matcher": {
"output": {
"path": "status",
"expected": "READY",
"comparator": "stringEquals"
}
}
},
{
"state": "failure",
"matcher": {
"output": {
"path": "status",
"expected": "NOT_READY",
"comparator": "stringEquals"
}
}
}
]
},
"LicenseEndpointDeleted": {
"minDelay": 10,
"maxDelay": 2340,
"documentation": "Wait until a LicenseEndpoint is Deleted. Use this after invoking DeleteLicenseEndpoint.",
"acceptors": [
{
"state": "success",
"matcher": {
"errorType": "ResourceNotFoundException"
}
},
{
"state": "failure",
"matcher": {
"output": {
"path": "status",
"expected": "NOT_READY",
"comparator": "stringEquals"
}
}
}
]
}
}
}
},
"com.amazonaws.deadline#GetLicenseEndpointRequest": {
"type": "structure",
"members": {
"licenseEndpointId": {
"target": "com.amazonaws.deadline#LicenseEndpointId",
"traits": {
"smithy.api#documentation": "The license endpoint ID.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetLicenseEndpointResponse": {
"type": "structure",
"members": {
"licenseEndpointId": {
"target": "com.amazonaws.deadline#LicenseEndpointId",
"traits": {
"smithy.api#documentation": "The license endpoint ID.",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.deadline#LicenseEndpointStatus",
"traits": {
"smithy.api#documentation": "The status of the license endpoint.",
"smithy.api#required": {}
}
},
"statusMessage": {
"target": "com.amazonaws.deadline#StatusMessage",
"traits": {
"smithy.api#documentation": "The status message of the license endpoint.",
"smithy.api#required": {}
}
},
"vpcId": {
"target": "com.amazonaws.deadline#VpcId",
"traits": {
"smithy.api#documentation": "The VPC (virtual private cloud) ID associated with the license endpoint."
}
},
"dnsName": {
"target": "com.amazonaws.deadline#DnsName",
"traits": {
"smithy.api#documentation": "The DNS name."
}
},
"subnetIds": {
"target": "com.amazonaws.deadline#SubnetIdList",
"traits": {
"smithy.api#documentation": "The subnet IDs.",
"smithy.api#length": {
"min": 1,
"max": 10
}
}
},
"securityGroupIds": {
"target": "com.amazonaws.deadline#SecurityGroupIdList",
"traits": {
"smithy.api#documentation": "The security group IDs for the license endpoint.",
"smithy.api#length": {
"min": 1,
"max": 10
}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#GetLimit": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#GetLimitRequest"
},
"output": {
"target": "com.amazonaws.deadline#GetLimitResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetLimit",
"documentation": "Grants permission to get a limit",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Gets information about a specific limit.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/limits/{limitId}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#GetLimitRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the limit.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "The unique identifier of the limit to return.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetLimitResponse": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the limit.",
"smithy.api#required": {}
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "The unique identifier of the limit.",
"smithy.api#required": {}
}
},
"currentCount": {
"target": "com.amazonaws.deadline#MinZeroMaxInteger",
"traits": {
"smithy.api#documentation": "The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The Unix timestamp of the date and time that the limit was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user identifier of the person that created the limit.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The Unix timestamp of the date and time that the limit was last updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user identifier of the person that last updated the limit."
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display name of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.",
"smithy.api#required": {}
}
},
"maxCount": {
"target": "com.amazonaws.deadline#MaxCount",
"traits": {
"smithy.api#documentation": "The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.\n\nThe maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.\n",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.deadline#Description",
"traits": {
"smithy.api#documentation": "The description of the limit that helps identify what the limit is used for.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
CreateMonitor operation.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetMonitorResponse": {
"type": "structure",
"members": {
"monitorId": {
"target": "com.amazonaws.deadline#MonitorId",
"traits": {
"smithy.api#documentation": "The unique identifier for the monitor.",
"smithy.api#required": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The name used to identify the monitor on the Deadline Cloud console.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
CreateMonitor operation, and is included in the response to the ListMonitors operation.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetMonitorSettingsResponse": {
"type": "structure",
"members": {
"settings": {
"target": "com.amazonaws.deadline#SettingsMap",
"traits": {
"smithy.api#documentation": "The monitor settings as key-value pairs.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#GetQueue": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#GetQueueRequest"
},
"output": {
"target": "com.amazonaws.deadline#GetQueueResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetQueue",
"documentation": "Grants permission to get a queue",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {}
}
}
},
"smithy.api#documentation": "Gets a queue.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}",
"code": 200
},
"smithy.api#readonly": {},
"smithy.waiters#waitable": {
"QueueSchedulingBlocked": {
"minDelay": 10,
"maxDelay": 300,
"acceptors": [
{
"state": "success",
"matcher": {
"output": {
"path": "status",
"expected": "SCHEDULING_BLOCKED",
"comparator": "stringEquals"
}
}
}
]
},
"QueueScheduling": {
"minDelay": 10,
"maxDelay": 700,
"acceptors": [
{
"state": "success",
"matcher": {
"output": {
"path": "status",
"expected": "SCHEDULING",
"comparator": "stringEquals"
}
}
}
]
}
}
}
},
"com.amazonaws.deadline#GetQueueEnvironment": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#GetQueueEnvironmentRequest"
},
"output": {
"target": "com.amazonaws.deadline#GetQueueEnvironmentResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetQueueEnvironment",
"documentation": "Grants permission to get a queue environment",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {}
}
}
},
"smithy.api#documentation": "Gets a queue environment.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/environments/{queueEnvironmentId}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#GetQueueEnvironmentRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the queue environment.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the queue environment.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueEnvironmentId": {
"target": "com.amazonaws.deadline#QueueEnvironmentId",
"traits": {
"smithy.api#documentation": "The queue environment ID.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetQueueEnvironmentResponse": {
"type": "structure",
"members": {
"queueEnvironmentId": {
"target": "com.amazonaws.deadline#QueueEnvironmentId",
"traits": {
"smithy.api#documentation": "The queue environment ID.",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.deadline#EnvironmentName",
"traits": {
"smithy.api#documentation": "The name of the queue environment.",
"smithy.api#required": {}
}
},
"priority": {
"target": "com.amazonaws.deadline#Priority",
"traits": {
"smithy.api#documentation": "The priority of the queue environment.",
"smithy.api#required": {}
}
},
"templateType": {
"target": "com.amazonaws.deadline#EnvironmentTemplateType",
"traits": {
"smithy.api#documentation": "The type of template for the queue environment.",
"smithy.api#required": {}
}
},
"template": {
"target": "com.amazonaws.deadline#EnvironmentTemplate",
"traits": {
"smithy.api#documentation": "The template for the queue environment.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.>",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#GetQueueFleetAssociation": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#GetQueueFleetAssociationRequest"
},
"output": {
"target": "com.amazonaws.deadline#GetQueueFleetAssociationResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetQueueFleetAssociation",
"documentation": "Grants permission to get a queue-fleet association",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {},
"fleet": {}
}
}
},
"smithy.api#documentation": "Gets a queue-fleet association.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queue-fleet-associations/{queueId}/{fleetId}",
"code": 200
},
"smithy.api#readonly": {},
"smithy.waiters#waitable": {
"QueueFleetAssociationStopped": {
"documentation": "Wait until a QueueFleetAssociation is stopped. Use this after setting the status to STOP_SCHEDULING_AND_COMPLETE_TASKS or STOP_SCHEDULING_AND_CANCEL_TASKS to wait for a QueueFleetAssociation to reach STOPPED",
"minDelay": 10,
"maxDelay": 600,
"acceptors": [
{
"state": "success",
"matcher": {
"output": {
"path": "status",
"expected": "STOPPED",
"comparator": "stringEquals"
}
}
}
]
}
}
}
},
"com.amazonaws.deadline#GetQueueFleetAssociationRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm that contains the queue-fleet association.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the queue-fleet association.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID for the queue-fleet association.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetQueueFleetAssociationResponse": {
"type": "structure",
"members": {
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the queue-fleet association.",
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID for the queue-fleet association.",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.deadline#QueueFleetAssociationStatus",
"traits": {
"smithy.api#documentation": "The status of the queue-fleet association.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#GetQueueLimitAssociation": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#GetQueueLimitAssociationRequest"
},
"output": {
"target": "com.amazonaws.deadline#GetQueueLimitAssociationResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetQueueLimitAssociation",
"documentation": "Grants permission to get a queue-limit association",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {},
"farm": {}
}
}
},
"smithy.api#documentation": "Gets information about a specific association between a queue and a limit.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queue-limit-associations/{queueId}/{limitId}",
"code": 200
},
"smithy.api#readonly": {},
"smithy.waiters#waitable": {
"QueueLimitAssociationStopped": {
"documentation": "Wait until a QueueLimitAssociation is stopped. Use this after setting the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS to wait for a QueueLimitAssociation to reach STOPPED",
"minDelay": 10,
"maxDelay": 600,
"acceptors": [
{
"state": "success",
"matcher": {
"output": {
"path": "status",
"expected": "STOPPED",
"comparator": "stringEquals"
}
}
}
]
}
}
}
},
"com.amazonaws.deadline#GetQueueLimitAssociationRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the associated queue and limit.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The unique identifier of the queue associated with the limit.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "The unique identifier of the limit associated with the queue.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetQueueLimitAssociationResponse": {
"type": "structure",
"members": {
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The unique identifier of the queue associated with the limit.",
"smithy.api#required": {}
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "The unique identifier of the limit associated with the queue.",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.deadline#QueueLimitAssociationStatus",
"traits": {
"smithy.api#documentation": "The current status of the limit.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The Unix timestamp of the date and time that the association was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user identifier of the person that created the association.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The Unix timestamp of the date and time that the association was last updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user identifier of the person that last updated the association."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#GetQueueRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm in the queue.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the queue to retrieve.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetQueueResponse": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the queue.",
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID.",
"smithy.api#required": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display name of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
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.
The description of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/sessions-statistics-aggregation",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "statistics"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#GetSessionsStatisticsAggregationRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "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.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"aggregationId": {
"target": "com.amazonaws.deadline#AggregationId",
"traits": {
"smithy.api#documentation": "The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.",
"smithy.api#httpQuery": "aggregationId",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetSessionsStatisticsAggregationResponse": {
"type": "structure",
"members": {
"statistics": {
"target": "com.amazonaws.deadline#StatisticsList",
"traits": {
"smithy.api#documentation": "The statistics for the specified fleets or queues."
}
},
"status": {
"target": "com.amazonaws.deadline#SessionsStatisticsAggregationStatus",
"traits": {
"smithy.api#documentation": "The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.\n\nIf you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.\n",
"smithy.api#required": {}
}
},
"statusMessage": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "A message that describes the status."
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#GetStep": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#GetStepRequest"
},
"output": {
"target": "com.amazonaws.deadline#GetStepResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "GetStep",
"documentation": "Grants permission to get a step in a job",
"relativeDocumentation": "API_GetStep.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Gets a step.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps/{stepId}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#GetStepRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the step.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the step.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the step.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#GetStepResponse": {
"type": "structure",
"members": {
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.deadline#StepName",
"traits": {
"smithy.api#documentation": "The name of the step.",
"smithy.api#required": {}
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#StepLifecycleStatus",
"traits": {
"smithy.api#documentation": "The life cycle status of the step.",
"smithy.api#required": {}
}
},
"lifecycleStatusMessage": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "A message that describes the lifecycle status of the step."
}
},
"taskRunStatus": {
"target": "com.amazonaws.deadline#TaskRunStatus",
"traits": {
"smithy.api#documentation": "The task run status for the job.",
"smithy.api#required": {}
}
},
"taskRunStatusCounts": {
"target": "com.amazonaws.deadline#TaskRunStatusCounts",
"traits": {
"smithy.api#documentation": "The number of tasks running on the job.",
"smithy.api#required": {}
}
},
"taskFailureRetryCount": {
"target": "com.amazonaws.deadline#TaskFailureRetryCount",
"traits": {
"smithy.api#documentation": "The total number of times tasks from the step failed and were retried."
}
},
"targetTaskRunStatus": {
"target": "com.amazonaws.deadline#StepTargetTaskRunStatus",
"traits": {
"smithy.api#documentation": "The task status with which the job started."
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running."
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running."
}
},
"dependencyCounts": {
"target": "com.amazonaws.deadline#DependencyCounts",
"traits": {
"smithy.api#documentation": "The number of dependencies in the step."
}
},
"requiredCapabilities": {
"target": "com.amazonaws.deadline#StepRequiredCapabilities",
"traits": {
"smithy.api#documentation": "The required capabilities of the step."
}
},
"parameterSpace": {
"target": "com.amazonaws.deadline#ParameterSpace",
"traits": {
"smithy.api#documentation": "A list of step parameters and the combination expression for the step."
}
},
"description": {
"target": "com.amazonaws.deadline#StepDescription",
"traits": {
"smithy.api#documentation": "The description of the step.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the storage profile connected to a queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the storage profile.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.
For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.
The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.
You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.
The default is 300 seconds (5 minutes).
" } } }, "traits": { "smithy.api#documentation": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string (\"\").
true, false, yes, no, on, off, 1, and 0, case-insensitive."
}
},
"rangeExpr": {
"target": "com.amazonaws.deadline#RangeExprString",
"traits": {
"smithy.api#documentation": "An Open Job Description range expression represented as a string, such as 1-10:2."
}
},
"stringList": {
"target": "com.amazonaws.deadline#ParameterStringList",
"traits": {
"smithy.api#documentation": "A list of UTF-8 strings."
}
},
"pathList": {
"target": "com.amazonaws.deadline#PathStringList",
"traits": {
"smithy.api#documentation": "A list of file system paths, each represented as a string."
}
},
"intList": {
"target": "com.amazonaws.deadline#IntStringList",
"traits": {
"smithy.api#documentation": "A list of signed integers, each represented as a string."
}
},
"floatList": {
"target": "com.amazonaws.deadline#FloatStringList",
"traits": {
"smithy.api#documentation": "A list of double precision IEEE-754 floating point numbers, each represented as a string."
}
},
"boolList": {
"target": "com.amazonaws.deadline#BooleanStringList",
"traits": {
"smithy.api#documentation": "A list of boolean values, each represented as a string."
}
},
"intListList": {
"target": "com.amazonaws.deadline#IntStringListList",
"traits": {
"smithy.api#documentation": "A list of lists of signed integers, each represented as a string."
}
}
},
"traits": {
"smithy.api#documentation": "The details of job parameters."
}
},
"com.amazonaws.deadline#JobParameterDefinition": {
"type": "document"
},
"com.amazonaws.deadline#JobParameterDefinitions": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#JobParameterDefinition"
}
},
"com.amazonaws.deadline#JobParameters": {
"type": "map",
"key": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
}
}
},
"value": {
"target": "com.amazonaws.deadline#JobParameter"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 200
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.deadline#JobPriority": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 100
}
}
},
"com.amazonaws.deadline#JobResource": {
"type": "resource",
"identifiers": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId"
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId"
},
"jobId": {
"target": "com.amazonaws.deadline#JobId"
}
},
"create": {
"target": "com.amazonaws.deadline#CreateJob"
},
"read": {
"target": "com.amazonaws.deadline#GetJob"
},
"update": {
"target": "com.amazonaws.deadline#UpdateJob"
},
"list": {
"target": "com.amazonaws.deadline#ListJobs"
},
"operations": [
{
"target": "com.amazonaws.deadline#AssociateMemberToJob"
},
{
"target": "com.amazonaws.deadline#CopyJobTemplate"
},
{
"target": "com.amazonaws.deadline#DisassociateMemberFromJob"
},
{
"target": "com.amazonaws.deadline#GetSession"
},
{
"target": "com.amazonaws.deadline#GetSessionAction"
},
{
"target": "com.amazonaws.deadline#GetStep"
},
{
"target": "com.amazonaws.deadline#GetTask"
},
{
"target": "com.amazonaws.deadline#ListJobMembers"
},
{
"target": "com.amazonaws.deadline#ListJobParameterDefinitions"
},
{
"target": "com.amazonaws.deadline#ListSessionActions"
},
{
"target": "com.amazonaws.deadline#ListSessions"
},
{
"target": "com.amazonaws.deadline#ListStepConsumers"
},
{
"target": "com.amazonaws.deadline#ListStepDependencies"
},
{
"target": "com.amazonaws.deadline#ListSteps"
},
{
"target": "com.amazonaws.deadline#ListTasks"
},
{
"target": "com.amazonaws.deadline#UpdateSession"
},
{
"target": "com.amazonaws.deadline#UpdateStep"
},
{
"target": "com.amazonaws.deadline#UpdateTask"
}
],
"traits": {
"aws.api#arn": {
"template": "farm/{farmId}/queue/{queueId}/job/{jobId}"
},
"aws.iam#conditionKeys": [
"deadline:FarmMembershipLevels",
"deadline:QueueMembershipLevels",
"deadline:JobMembershipLevels",
"aws:ResourceTag/${TagKey}"
],
"aws.iam#disableConditionKeyInference": {},
"aws.iam#iamResource": {
"disableConditionKeyInheritance": true,
"name": "job",
"relativeDocumentation": "deadline-cloud-jobs.html"
},
"smithy.api#documentation": "Represents a job that is composed of steps and tasks"
}
},
"com.amazonaws.deadline#JobRunAsUser": {
"type": "structure",
"members": {
"posix": {
"target": "com.amazonaws.deadline#PosixUser",
"traits": {
"smithy.api#documentation": "The user and group that the jobs in the queue run as."
}
},
"windows": {
"target": "com.amazonaws.deadline#WindowsUser",
"traits": {
"smithy.api#documentation": "Identifies a Microsoft Windows user."
}
},
"runAs": {
"target": "com.amazonaws.deadline#RunAs",
"traits": {
"smithy.api#documentation": "Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "Identifies the user for a job."
}
},
"com.amazonaws.deadline#JobSearchSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#JobSearchSummary"
}
},
"com.amazonaws.deadline#JobSearchSummary": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID."
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID."
}
},
"name": {
"target": "com.amazonaws.deadline#JobName",
"traits": {
"smithy.api#documentation": "The job name."
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#JobLifecycleStatus",
"traits": {
"smithy.api#documentation": "The life cycle status."
}
},
"lifecycleStatusMessage": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The life cycle status message."
}
},
"taskRunStatus": {
"target": "com.amazonaws.deadline#TaskRunStatus",
"traits": {
"smithy.api#documentation": "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.
FAILED."
}
},
"maxRetriesPerTask": {
"target": "com.amazonaws.deadline#MaxRetriesPerTask",
"traits": {
"smithy.api#documentation": "The maximum number of retries for a job."
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource."
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created."
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running."
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running."
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"jobParameters": {
"target": "com.amazonaws.deadline#JobParameters",
"traits": {
"smithy.api#documentation": "The job parameters."
}
},
"maxWorkerCount": {
"target": "com.amazonaws.deadline#MaxWorkerCount",
"traits": {
"smithy.api#documentation": "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.\n\nYou can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.\n\nIf you don't specify the maxWorkerCount, the default is -1.\n"
}
},
"sourceJobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the source job."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a job search."
}
},
"com.amazonaws.deadline#JobSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#JobSummary"
}
},
"com.amazonaws.deadline#JobSummary": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.deadline#JobName",
"traits": {
"smithy.api#documentation": "The job name.",
"smithy.api#required": {}
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#JobLifecycleStatus",
"traits": {
"smithy.api#documentation": "The life cycle status.",
"smithy.api#required": {}
}
},
"lifecycleStatusMessage": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The life cycle status message.",
"smithy.api#required": {}
}
},
"priority": {
"target": "com.amazonaws.deadline#JobPriority",
"traits": {
"smithy.api#documentation": "The job priority.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user or system that created this resource.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource was updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user or system that updated this resource."
}
},
"startedAt": {
"target": "com.amazonaws.deadline#StartedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource started running."
}
},
"endedAt": {
"target": "com.amazonaws.deadline#EndedAt",
"traits": {
"smithy.api#documentation": "The date and time the resource ended running."
}
},
"taskRunStatus": {
"target": "com.amazonaws.deadline#TaskRunStatus",
"traits": {
"smithy.api#documentation": "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.
FAILED."
}
},
"maxRetriesPerTask": {
"target": "com.amazonaws.deadline#MaxRetriesPerTask",
"traits": {
"smithy.api#documentation": "The maximum number of retries for a job."
}
},
"maxWorkerCount": {
"target": "com.amazonaws.deadline#MaxWorkerCount",
"traits": {
"smithy.api#documentation": "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.\n\nYou can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.\n\nIf you don't specify the maxWorkerCount, the default is -1.\n"
}
},
"sourceJobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the source job."
}
}
},
"traits": {
"smithy.api#documentation": "A summary of job details."
}
},
"com.amazonaws.deadline#JobTargetTaskRunStatus": {
"type": "enum",
"members": {
"READY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "READY"
}
},
"FAILED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FAILED"
}
},
"SUCCEEDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SUCCEEDED"
}
},
"CANCELED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CANCELED"
}
},
"SUSPENDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SUSPENDED"
}
},
"PENDING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PENDING"
}
}
}
},
"com.amazonaws.deadline#JobTemplate": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1000000
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.deadline#JobTemplateType": {
"type": "enum",
"members": {
"JSON": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "JSON"
}
},
"YAML": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "YAML"
}
}
}
},
"com.amazonaws.deadline#KmsKeyArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:key/[\\w-]{1,120}$"
}
},
"com.amazonaws.deadline#LicenseEndpointId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^le-[0-9a-f]{32}$"
}
},
"com.amazonaws.deadline#LicenseEndpointResource": {
"type": "resource",
"identifiers": {
"licenseEndpointId": {
"target": "com.amazonaws.deadline#LicenseEndpointId"
}
},
"create": {
"target": "com.amazonaws.deadline#CreateLicenseEndpoint"
},
"read": {
"target": "com.amazonaws.deadline#GetLicenseEndpoint"
},
"delete": {
"target": "com.amazonaws.deadline#DeleteLicenseEndpoint"
},
"list": {
"target": "com.amazonaws.deadline#ListLicenseEndpoints"
},
"operations": [
{
"target": "com.amazonaws.deadline#DeleteMeteredProduct"
},
{
"target": "com.amazonaws.deadline#ListMeteredProducts"
},
{
"target": "com.amazonaws.deadline#PutMeteredProduct"
}
],
"traits": {
"aws.api#arn": {
"template": "license-endpoint/{licenseEndpointId}"
},
"aws.iam#conditionKeys": [
"aws:ResourceTag/${TagKey}"
],
"aws.iam#disableConditionKeyInference": {},
"aws.iam#iamResource": {
"name": "license-endpoint",
"relativeDocumentation": "cmf-ubl.html"
},
"smithy.api#documentation": "Represents a license endpoint that is for licensed software or a product used within Deadline Cloud"
}
},
"com.amazonaws.deadline#LicenseEndpointStatus": {
"type": "enum",
"members": {
"CREATE_IN_PROGRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CREATE_IN_PROGRESS"
}
},
"DELETE_IN_PROGRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DELETE_IN_PROGRESS"
}
},
"READY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "READY"
}
},
"NOT_READY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "NOT_READY"
}
}
}
},
"com.amazonaws.deadline#LicenseEndpointSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#LicenseEndpointSummary"
}
},
"com.amazonaws.deadline#LicenseEndpointSummary": {
"type": "structure",
"members": {
"licenseEndpointId": {
"target": "com.amazonaws.deadline#LicenseEndpointId",
"traits": {
"smithy.api#documentation": "The license endpoint ID."
}
},
"status": {
"target": "com.amazonaws.deadline#LicenseEndpointStatus",
"traits": {
"smithy.api#documentation": "The status of the license endpoint."
}
},
"statusMessage": {
"target": "com.amazonaws.deadline#StatusMessage",
"traits": {
"smithy.api#documentation": "The status message of the license endpoint."
}
},
"vpcId": {
"target": "com.amazonaws.deadline#VpcId",
"traits": {
"smithy.api#documentation": "The VPC (virtual private cloud) ID associated with the license endpoint."
}
}
},
"traits": {
"smithy.api#documentation": "The details for a license endpoint."
}
},
"com.amazonaws.deadline#LicenseProduct": {
"type": "string"
},
"com.amazonaws.deadline#LimitId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^limit-[0-9a-f]{32}$"
}
},
"com.amazonaws.deadline#LimitSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#LimitSummary"
}
},
"com.amazonaws.deadline#LimitSummary": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the limit.",
"smithy.api#required": {}
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "The unique identifier of the limit.",
"smithy.api#required": {}
}
},
"currentCount": {
"target": "com.amazonaws.deadline#MinZeroMaxInteger",
"traits": {
"smithy.api#documentation": "The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.deadline#CreatedAt",
"traits": {
"smithy.api#documentation": "The Unix timestamp of the date and time that the limit was created.",
"smithy.api#required": {}
}
},
"createdBy": {
"target": "com.amazonaws.deadline#CreatedBy",
"traits": {
"smithy.api#documentation": "The user identifier of the person that created the limit.",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.deadline#UpdatedAt",
"traits": {
"smithy.api#documentation": "The Unix timestamp of the date and time that the limit was last updated."
}
},
"updatedBy": {
"target": "com.amazonaws.deadline#UpdatedBy",
"traits": {
"smithy.api#documentation": "The user identifier of the person that last updated the limit."
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The name of the limit used in lists to identify the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.",
"smithy.api#required": {}
}
},
"maxCount": {
"target": "com.amazonaws.deadline#MaxCount",
"traits": {
"smithy.api#documentation": "The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.\n\nThe maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.\n",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "Provides information about a specific limit."
}
},
"com.amazonaws.deadline#ListAttributeCapabilityValue": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#AttributeCapabilityValue"
}
},
"com.amazonaws.deadline#ListAvailableMeteredProducts": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListAvailableMeteredProductsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListAvailableMeteredProductsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
}
],
"traits": {
"aws.iam#conditionKeys": [],
"aws.iam#iamAction": {
"name": "ListAvailableMeteredProducts",
"documentation": "Grants permission to list all available metered products within a license endpoint"
},
"smithy.api#documentation": "A list of the available metered products.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/metered-products",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "meteredProducts"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListAvailableMeteredProductsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListAvailableMeteredProductsResponse": {
"type": "structure",
"members": {
"meteredProducts": {
"target": "com.amazonaws.deadline#MeteredProductSummaryList",
"traits": {
"smithy.api#documentation": "The metered products.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListBudgets": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListBudgetsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListBudgetsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListBudgets",
"documentation": "Grants permission to list all budgets for a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"optional": {
"budget": {}
}
}
},
"smithy.api#documentation": "A list of budgets in a farm.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/budgets",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "budgets"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListBudgetsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID associated with the budgets.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"status": {
"target": "com.amazonaws.deadline#BudgetStatus",
"traits": {
"smithy.api#documentation": "The status to list for the budgets.",
"smithy.api#httpQuery": "status"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListBudgetsResponse": {
"type": "structure",
"members": {
"budgets": {
"target": "com.amazonaws.deadline#BudgetSummaries",
"traits": {
"smithy.api#documentation": "The budgets to include on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListFarmMembers": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListFarmMembersRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListFarmMembersResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListFarmMembers",
"documentation": "Grants permission to list all members of a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Lists the members of a farm.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/members",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "members"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListFarmMembersRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListFarmMembersResponse": {
"type": "structure",
"members": {
"members": {
"target": "com.amazonaws.deadline#FarmMembers",
"traits": {
"smithy.api#documentation": "The members on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListFarms": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListFarmsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListFarmsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:RequesterPrincipalId",
"deadline:PrincipalId"
],
"aws.iam#iamAction": {
"name": "ListFarms",
"documentation": "Grants permission to list all farms",
"requiredActions": [
"identitystore:DescribeGroup",
"identitystore:DescribeUser",
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"farm": {}
}
}
},
"smithy.api#documentation": "Lists farms.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "farms"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListFarmsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "The principal ID of the member to list on the farm.",
"smithy.api#httpQuery": "principalId"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListFarmsResponse": {
"type": "structure",
"members": {
"farms": {
"target": "com.amazonaws.deadline#FarmSummaries",
"traits": {
"smithy.api#documentation": "Farms on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListFleetMembers": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListFleetMembersRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListFleetMembersResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListFleetMembers",
"documentation": "Grants permission to list all members of a fleet",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"fleet": {}
}
}
},
"smithy.api#documentation": "Lists fleet members.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/members",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "members"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListFleetMembersRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the fleet.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListFleetMembersResponse": {
"type": "structure",
"members": {
"members": {
"target": "com.amazonaws.deadline#FleetMembers",
"traits": {
"smithy.api#documentation": "The members on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListFleets": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListFleetsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListFleetsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:RequesterPrincipalId",
"deadline:PrincipalId"
],
"aws.iam#iamAction": {
"name": "ListFleets",
"documentation": "Grants permission to list all fleets",
"requiredActions": [
"identitystore:DescribeGroup",
"identitystore:DescribeUser",
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"fleet": {}
}
}
},
"smithy.api#documentation": "Lists fleets.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/fleets",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "fleets"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListFleetsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the fleets.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "The principal ID of the members to include in the fleet.",
"smithy.api#httpQuery": "principalId"
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The display names of a list of fleets.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListJobMembers": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListJobMembersRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListJobMembersResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListJobMembers",
"documentation": "Grants permission to list all members of a job",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists members on a job.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/members",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "members"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListJobMembersRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the job to list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListJobMembersResponse": {
"type": "structure",
"members": {
"members": {
"target": "com.amazonaws.deadline#JobMembers",
"traits": {
"smithy.api#documentation": "The members on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListJobParameterDefinitions": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListJobParameterDefinitionsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListJobParameterDefinitionsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListJobParameterDefinitions",
"documentation": "Grants permission to get a job's parameter definitions in the job template",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists parameter definitions of a job.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/parameter-definitions",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "jobParameterDefinitions"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListJobParameterDefinitionsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the job to list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListJobParameterDefinitionsResponse": {
"type": "structure",
"members": {
"jobParameterDefinitions": {
"target": "com.amazonaws.deadline#JobParameterDefinitions",
"traits": {
"smithy.api#documentation": "Lists parameter definitions of a job.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListJobs": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListJobsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListJobsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:RequesterPrincipalId",
"deadline:PrincipalId"
],
"aws.iam#iamAction": {
"name": "ListJobs",
"documentation": "Grants permission to list all jobs in a queue",
"requiredActions": [
"identitystore:DescribeGroup",
"identitystore:DescribeUser",
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists jobs.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs"
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "jobs"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListJobsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the jobs.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the job.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "The principal ID of the members on the jobs.",
"smithy.api#httpQuery": "principalId"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListJobsResponse": {
"type": "structure",
"members": {
"jobs": {
"target": "com.amazonaws.deadline#JobSummaries",
"traits": {
"smithy.api#documentation": "The jobs on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListLicenseEndpoints": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListLicenseEndpointsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListLicenseEndpointsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [],
"aws.iam#iamAction": {
"name": "ListLicenseEndpoints",
"documentation": "Grants permission to list all license endpoints",
"resources": {
"required": {
"license-endpoint": {}
}
}
},
"smithy.api#documentation": "Lists license endpoints.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/license-endpoints",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "licenseEndpoints"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListLicenseEndpointsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListLicenseEndpointsResponse": {
"type": "structure",
"members": {
"licenseEndpoints": {
"target": "com.amazonaws.deadline#LicenseEndpointSummaries",
"traits": {
"smithy.api#documentation": "The license endpoints.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListLimits": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListLimitsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListLimitsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListLimits",
"documentation": "Grants permission to list all limits in a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Gets a list of limits defined in the specified farm.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/limits",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "limits"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListLimitsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the limits.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of limits to return in each page of results.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListLimitsResponse": {
"type": "structure",
"members": {
"limits": {
"target": "com.amazonaws.deadline#LimitSummaries",
"traits": {
"smithy.api#documentation": "A list of limits that the farm contains.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListMemberships": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListMembershipsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListMembershipsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:RequesterPrincipalId",
"deadline:PrincipalId"
],
"aws.iam#iamAction": {
"name": "ListMemberships",
"documentation": "Grants permission to list Deadline Cloud resource memberships associated with an IAM Identity Center principal",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Lists the Deadline Cloud resource memberships associated with a specified IAM Identity Center principal, optionally filtered by the requested resource types.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "List memberships using a cross-region identity store",
"input": {
"principalId": "12345678-1234-1234-1234-123456789abc",
"identityStoreId": "d-1234567890",
"identityCenterRegion": "us-east-1",
"resourceTypes": [
"QUEUE",
"JOB"
]
}
},
{
"title": "List a Monitor user's memberships of every resource type",
"input": {
"principalId": "12345678-1234-1234-1234-123456789abc"
}
}
],
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/memberships",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "memberships"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListMembershipsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "The ID of the IAM Identity Center principal whose Deadline Cloud resource memberships you want to list.",
"smithy.api#httpQuery": "principalId",
"smithy.api#required": {}
}
},
"identityStoreId": {
"target": "com.amazonaws.deadline#IdentityStoreId",
"traits": {
"smithy.api#documentation": "The identity store ID that contains the principal. This parameter is required for callers that do not use a monitor session.",
"smithy.api#httpQuery": "identityStoreId"
}
},
"identityCenterRegion": {
"target": "com.amazonaws.deadline#Region",
"traits": {
"smithy.api#documentation": "The Region of the IAM Identity Center instance. If not provided, the service defaults to the Amazon Web Services Region in which you make the request.",
"smithy.api#httpQuery": "identityCenterRegion"
}
},
"resourceTypes": {
"target": "com.amazonaws.deadline#MembershipResourceTypes",
"traits": {
"smithy.api#documentation": "The resource types to include when listing the principal's memberships. If not specified, memberships for all supported resource types are returned.",
"smithy.api#httpQuery": "resourceTypes"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListMembershipsResponse": {
"type": "structure",
"members": {
"memberships": {
"target": "com.amazonaws.deadline#MembershipSummaries",
"traits": {
"smithy.api#documentation": "The memberships associated with the specified principal.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListMeteredProducts": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListMeteredProductsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListMeteredProductsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [],
"aws.iam#iamAction": {
"name": "ListMeteredProducts",
"documentation": "Grants permission to list all metered products in a license endpoint"
},
"smithy.api#documentation": "Lists metered products.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/license-endpoints/{licenseEndpointId}/metered-products",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "meteredProducts"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListMeteredProductsRequest": {
"type": "structure",
"members": {
"licenseEndpointId": {
"target": "com.amazonaws.deadline#LicenseEndpointId",
"traits": {
"smithy.api#documentation": "The license endpoint ID to include on the list of metered products.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListMeteredProductsResponse": {
"type": "structure",
"members": {
"meteredProducts": {
"target": "com.amazonaws.deadline#MeteredProductSummaryList",
"traits": {
"smithy.api#documentation": "The metered products to list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListMonitors": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListMonitorsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListMonitorsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [],
"aws.iam#iamAction": {
"name": "ListMonitors",
"documentation": "Grants permission to list all monitors",
"resources": {
"required": {
"monitor": {}
}
}
},
"smithy.api#documentation": "Gets a list of your monitors in Deadline Cloud.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/monitors",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "monitors"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListMonitorsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListMonitorsResponse": {
"type": "structure",
"members": {
"monitors": {
"target": "com.amazonaws.deadline#MonitorSummaries",
"traits": {
"smithy.api#documentation": "A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListQueueEnvironments": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListQueueEnvironmentsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListQueueEnvironmentsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListQueueEnvironments",
"documentation": "Grants permission to list all queue environments to which a queue is associated",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {}
}
}
},
"smithy.api#documentation": "Lists queue environments.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/environments",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "environments"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListQueueEnvironmentsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the queue environment list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the queue environment list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListQueueEnvironmentsResponse": {
"type": "structure",
"members": {
"environments": {
"target": "com.amazonaws.deadline#QueueEnvironmentSummaries",
"traits": {
"smithy.api#documentation": "The environments to include in the queue environments list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListQueueFleetAssociations": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListQueueFleetAssociationsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListQueueFleetAssociationsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListQueueFleetAssociations",
"documentation": "Grants permission to list all queue-fleet associations",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"farm": {}
},
"optional": {
"fleet": {},
"queue": {}
}
}
},
"smithy.api#documentation": "Lists queue-fleet associations.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queue-fleet-associations",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "queueFleetAssociations"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListQueueFleetAssociationsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the queue-fleet association list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the queue-fleet association list.",
"smithy.api#httpQuery": "queueId"
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID for the queue-fleet association list.",
"smithy.api#httpQuery": "fleetId"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListQueueFleetAssociationsResponse": {
"type": "structure",
"members": {
"queueFleetAssociations": {
"target": "com.amazonaws.deadline#QueueFleetAssociationSummaries",
"traits": {
"smithy.api#documentation": "The queue-fleet associations on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListQueueLimitAssociations": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListQueueLimitAssociationsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListQueueLimitAssociationsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListQueueLimitAssociations",
"documentation": "Grants permission to list all queue-limit associations",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"farm": {}
},
"optional": {
"queue": {}
}
}
},
"smithy.api#documentation": "Gets a list of the associations between queues and limits defined in a farm.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queue-limit-associations",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "queueLimitAssociations"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListQueueLimitAssociationsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The unique identifier of the farm that contains the limits and associations.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of associations to return in each page of results.",
"smithy.api#httpQuery": "maxResults"
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.",
"smithy.api#httpQuery": "queueId"
}
},
"limitId": {
"target": "com.amazonaws.deadline#LimitId",
"traits": {
"smithy.api#documentation": "Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.",
"smithy.api#httpQuery": "limitId"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListQueueLimitAssociationsResponse": {
"type": "structure",
"members": {
"queueLimitAssociations": {
"target": "com.amazonaws.deadline#QueueLimitAssociationSummaries",
"traits": {
"smithy.api#documentation": "A list of associations between limits and queues in the farm specified in the request.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListQueueMembers": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListQueueMembersRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListQueueMembersResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListQueueMembers",
"documentation": "Grants permission to list all members in a queue",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"optional": {
"queue": {}
}
}
},
"smithy.api#documentation": "Lists the members in a queue.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/members",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "members"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListQueueMembersRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the queue.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListQueueMembersResponse": {
"type": "structure",
"members": {
"members": {
"target": "com.amazonaws.deadline#QueueMemberList",
"traits": {
"smithy.api#documentation": "The members on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListQueues": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListQueuesRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListQueuesResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:RequesterPrincipalId",
"deadline:PrincipalId"
],
"aws.iam#iamAction": {
"name": "ListQueues",
"documentation": "Grants permission to list all queues on a farm",
"requiredActions": [
"identitystore:DescribeGroup",
"identitystore:DescribeUser",
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"queue": {}
}
}
},
"smithy.api#documentation": "Lists queues.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "queues"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListQueuesRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the queue.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"principalId": {
"target": "com.amazonaws.deadline#IdentityCenterPrincipalId",
"traits": {
"smithy.api#documentation": "The principal IDs to include in the list of queues.",
"smithy.api#httpQuery": "principalId"
}
},
"status": {
"target": "com.amazonaws.deadline#QueueStatus",
"traits": {
"smithy.api#documentation": "The status of the queues listed.
ACTIVE - The queues are active.
SCHEDULING - The queues are scheduling.
SCHEDULING_BLOCKED - The queue scheduling is blocked for these queues.
nextToken, 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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListSessionActions": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListSessionActionsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListSessionActionsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListSessionActions",
"documentation": "Grants permission to list all session actions for a job",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists session actions.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/session-actions"
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "sessionActions"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListSessionActionsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the session actions list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the session actions list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the session actions list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
},
"sessionId": {
"target": "com.amazonaws.deadline#SessionId",
"traits": {
"smithy.api#documentation": "The session ID to include on the sessions action list.",
"smithy.api#httpQuery": "sessionId"
}
},
"taskId": {
"target": "com.amazonaws.deadline#TaskId",
"traits": {
"smithy.api#documentation": "The task ID for the session actions list.",
"smithy.api#httpQuery": "taskId"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListSessionActionsResponse": {
"type": "structure",
"members": {
"sessionActions": {
"target": "com.amazonaws.deadline#SessionActionSummaries",
"traits": {
"smithy.api#documentation": "The session actions.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListSessions": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListSessionsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListSessionsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListSessions",
"documentation": "Grants permission to list all sessions for a job",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists sessions.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/sessions"
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "sessions"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListSessionsForWorker": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListSessionsForWorkerRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListSessionsForWorkerResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListSessionsForWorker",
"documentation": "Grants permission to list all sessions for a worker",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"optional": {
"worker": {}
}
}
},
"smithy.api#documentation": "Lists sessions for a worker.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}/sessions"
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "sessions"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListSessionsForWorkerRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the session.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID for the session.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"workerId": {
"target": "com.amazonaws.deadline#WorkerId",
"traits": {
"smithy.api#documentation": "The worker ID for the session.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListSessionsForWorkerResponse": {
"type": "structure",
"members": {
"sessions": {
"target": "com.amazonaws.deadline#ListSessionsForWorkerSummaries",
"traits": {
"smithy.api#documentation": "The sessions in the response.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListSessionsForWorkerSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#WorkerSessionSummary"
}
},
"com.amazonaws.deadline#ListSessionsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the list of sessions.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the list of sessions",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the list of sessions.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListSessionsResponse": {
"type": "structure",
"members": {
"sessions": {
"target": "com.amazonaws.deadline#SessionSummaries",
"traits": {
"smithy.api#documentation": "The sessions on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListStepConsumers": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListStepConsumersRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListStepConsumersResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListStepConsumers",
"documentation": "Grants permission to list the step consumers for a job step",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists step consumers.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps/{stepId}/consumers",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "consumers"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListStepConsumersRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the list of step consumers.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the step consumer.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the step consumer.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults",
"smithy.api#range": {
"min": 1,
"max": 1000
}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListStepConsumersResponse": {
"type": "structure",
"members": {
"consumers": {
"target": "com.amazonaws.deadline#StepConsumers",
"traits": {
"smithy.api#documentation": "The consumers on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListStepDependencies": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListStepDependenciesRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListStepDependenciesResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListStepDependencies",
"documentation": "Grants permission to list dependencies for a job step",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"optional": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists the dependencies for a step.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps/{stepId}/dependencies",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "dependencies"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListStepDependenciesRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID for the step dependencies list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the step dependencies list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the step dependencies list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID to include on the list.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults",
"smithy.api#range": {
"min": 1,
"max": 1000
}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListStepDependenciesResponse": {
"type": "structure",
"members": {
"dependencies": {
"target": "com.amazonaws.deadline#StepDependencies",
"traits": {
"smithy.api#documentation": "The dependencies on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListSteps": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListStepsRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListStepsResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListSteps",
"documentation": "Grants permission to list all steps for a job",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists steps for a job.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "steps"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListStepsRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID to include on the list of steps.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID to include on the list of steps.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID to include on the list of steps.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListStepsResponse": {
"type": "structure",
"members": {
"steps": {
"target": "com.amazonaws.deadline#StepSummaries",
"traits": {
"smithy.api#documentation": "The steps on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListStorageProfiles": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListStorageProfilesRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListStorageProfilesResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListStorageProfiles",
"documentation": "Grants permission to list all storage profiles in a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Lists storage profiles.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/storage-profiles",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "storageProfiles"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListStorageProfilesForQueue": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListStorageProfilesForQueueRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListStorageProfilesForQueueResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListStorageProfilesForQueue",
"documentation": "Grants permission to list all storage profiles in a queue",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"optional": {
"queue": {}
}
}
},
"smithy.api#documentation": "Lists storage profiles for a queue.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/storage-profiles",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "storageProfiles"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListStorageProfilesForQueueRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the queue's storage profile.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID for the storage profile.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListStorageProfilesForQueueResponse": {
"type": "structure",
"members": {
"storageProfiles": {
"target": "com.amazonaws.deadline#StorageProfileSummaries",
"traits": {
"smithy.api#documentation": "The storage profiles in the queue.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListStorageProfilesRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the storage profile.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListStorageProfilesResponse": {
"type": "structure",
"members": {
"storageProfiles": {
"target": "com.amazonaws.deadline#StorageProfileSummaries",
"traits": {
"smithy.api#documentation": "The storage profiles.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListTagsForResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListTagsForResourceRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListTagsForResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [
"deadline:CalledAction"
],
"aws.iam#iamAction": {
"name": "ListTagsForResource",
"documentation": "Grants permission to list all tags on specified Deadline Cloud resources",
"resources": {
"optional": {
"farm": {},
"fleet": {},
"license-endpoint": {},
"queue": {},
"job": {},
"worker": {},
"monitor": {},
"budget": {},
"volume": {}
}
}
},
"smithy.api#documentation": "Lists tags for a resource.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/tags/{resourceArn}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListTagsForResourceRequest": {
"type": "structure",
"members": {
"resourceArn": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The resource ARN to list tags for.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListTagsForResourceResponse": {
"type": "structure",
"members": {
"tags": {
"target": "com.amazonaws.deadline#Tags",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListTasks": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListTasksRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListTasksResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListTasks",
"documentation": "Grants permission to list all tasks for a job",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Lists tasks for a job.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps/{stepId}/tasks",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "tasks"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListTasksRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID connected to the tasks.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID connected to the tasks.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID for the tasks.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID for the tasks.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListTasksResponse": {
"type": "structure",
"members": {
"tasks": {
"target": "com.amazonaws.deadline#TaskSummaries",
"traits": {
"smithy.api#documentation": "Tasks for the job.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListVolumes": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListVolumesRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListVolumesResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListVolumes",
"documentation": "Grants permission to list volumes",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"volume": {}
}
}
},
"smithy.api#documentation": "Lists the persistent volumes in a fleet.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#examples": [
{
"title": "List volumes for a fleet",
"input": {
"farmId": "farm-1234567890abcdef1234567890abcdef",
"fleetId": "fleet-1234567890abcdef1234567890abcdef"
}
}
],
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/volumes",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "volumes"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListVolumesRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID of the farm that contains the fleet.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the fleet that contains the volumes.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListVolumesResponse": {
"type": "structure",
"members": {
"volumes": {
"target": "com.amazonaws.deadline#VolumeSummaries",
"traits": {
"smithy.api#documentation": "The volumes on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#ListWorkers": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#ListWorkersRequest"
},
"output": {
"target": "com.amazonaws.deadline#ListWorkersResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "ListWorkers",
"documentation": "Grants permission to list all workers in a fleet",
"relativeDocumentation": "API_ListWorkers.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"worker": {}
}
}
},
"smithy.api#documentation": "Lists workers.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "GET",
"uri": "/2023-10-12/farms/{farmId}/fleets/{fleetId}/workers",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "workers"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#ListWorkersRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The farm ID connected to the workers.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID of the workers.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.deadline#MaxResults",
"traits": {
"smithy.api#default": 100,
"smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#ListWorkersResponse": {
"type": "structure",
"members": {
"workers": {
"target": "com.amazonaws.deadline#WorkerSummaries",
"traits": {
"smithy.api#documentation": "The workers on the list.",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.deadline#NextToken",
"traits": {
"smithy.api#documentation": "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."
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#LogConfiguration": {
"type": "structure",
"members": {
"logDriver": {
"target": "com.amazonaws.deadline#LogDriver",
"traits": {
"smithy.api#documentation": "The log drivers for worker related logs.",
"smithy.api#required": {}
}
},
"options": {
"target": "com.amazonaws.deadline#LogOptions",
"traits": {
"smithy.api#documentation": "The options for a log driver."
}
},
"parameters": {
"target": "com.amazonaws.deadline#LogParameters",
"traits": {
"smithy.api#documentation": "The parameters for the log configuration."
}
},
"error": {
"target": "com.amazonaws.deadline#LogError",
"traits": {
"smithy.api#documentation": "The log configuration error details."
}
}
},
"traits": {
"smithy.api#documentation": "Log configuration details."
}
},
"com.amazonaws.deadline#LogDriver": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 512
}
}
},
"com.amazonaws.deadline#LogError": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 512
}
}
},
"com.amazonaws.deadline#LogOptions": {
"type": "map",
"key": {
"target": "com.amazonaws.deadline#String"
},
"value": {
"target": "com.amazonaws.deadline#String"
}
},
"com.amazonaws.deadline#LogParameters": {
"type": "map",
"key": {
"target": "com.amazonaws.deadline#String"
},
"value": {
"target": "com.amazonaws.deadline#String"
}
},
"com.amazonaws.deadline#LogicalOperator": {
"type": "enum",
"members": {
"AND": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AND"
}
},
"OR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "OR"
}
}
}
},
"com.amazonaws.deadline#ManifestProperties": {
"type": "structure",
"members": {
"fileSystemLocationName": {
"target": "com.amazonaws.deadline#FileSystemLocationName",
"traits": {
"smithy.api#documentation": "The file system location name."
}
},
"rootPath": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The file's root path.",
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#required": {}
}
},
"rootPathFormat": {
"target": "com.amazonaws.deadline#PathFormat",
"traits": {
"smithy.api#documentation": "The format of the root path.",
"smithy.api#required": {}
}
},
"outputRelativeDirectories": {
"target": "com.amazonaws.deadline#OutputRelativeDirectoriesList",
"traits": {
"smithy.api#documentation": "The file path relative to the directory."
}
},
"inputManifestPath": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The file path.",
"smithy.api#length": {
"min": 1,
"max": 512
}
}
},
"inputManifestHash": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The hash value of the file.",
"smithy.api#length": {
"min": 1,
"max": 256
}
}
}
},
"traits": {
"smithy.api#documentation": "The details of the manifest that links a job's source information.",
"smithy.api#sensitive": {}
}
},
"com.amazonaws.deadline#ManifestPropertiesList": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#ManifestProperties"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 10
},
"smithy.api#uniqueItems": {}
}
},
"com.amazonaws.deadline#MaxCount": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": -1,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#MaxFailedTasksCount": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#MaxResults": {
"type": "integer",
"traits": {
"smithy.api#default": 100,
"smithy.api#range": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.deadline#MaxRetriesPerTask": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#MaxWorkerCount": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": -1,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#MembershipLevel": {
"type": "enum",
"members": {
"VIEWER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VIEWER"
}
},
"CONTRIBUTOR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CONTRIBUTOR"
}
},
"OWNER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "OWNER"
}
},
"MANAGER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MANAGER"
}
}
}
},
"com.amazonaws.deadline#MembershipResourceType": {
"type": "enum",
"members": {
"FARM": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FARM"
}
},
"QUEUE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "QUEUE"
}
},
"FLEET": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FLEET"
}
},
"JOB": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "JOB"
}
}
}
},
"com.amazonaws.deadline#MembershipResourceTypes": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#MembershipResourceType"
},
"traits": {
"smithy.api#documentation": "The list of resource types to include when listing a principal's memberships.",
"smithy.api#length": {
"min": 1,
"max": 4
},
"smithy.api#uniqueItems": {}
}
},
"com.amazonaws.deadline#MembershipSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#MembershipSummary"
},
"traits": {
"smithy.api#documentation": "The list of membership records for the principal."
}
},
"com.amazonaws.deadline#MembershipSummary": {
"type": "union",
"members": {
"farm": {
"target": "com.amazonaws.deadline#FarmMember",
"traits": {
"smithy.api#documentation": "A membership on a farm."
}
},
"queue": {
"target": "com.amazonaws.deadline#QueueMember",
"traits": {
"smithy.api#documentation": "A membership on a queue."
}
},
"fleet": {
"target": "com.amazonaws.deadline#FleetMember",
"traits": {
"smithy.api#documentation": "A membership on a fleet."
}
},
"job": {
"target": "com.amazonaws.deadline#JobMember",
"traits": {
"smithy.api#documentation": "A membership on a job."
}
}
},
"traits": {
"smithy.api#documentation": "A membership record for a principal on a single Deadline Cloud resource. The summary identifies the resource that the principal is a member of and the principal's membership level for that resource."
}
},
"com.amazonaws.deadline#MemoryAmountMiB": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 512,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#MemoryMiBRange": {
"type": "structure",
"members": {
"min": {
"target": "com.amazonaws.deadline#MemoryAmountMiB",
"traits": {
"smithy.api#documentation": "The minimum amount of memory (in MiB).",
"smithy.api#required": {}
}
},
"max": {
"target": "com.amazonaws.deadline#MemoryAmountMiB",
"traits": {
"smithy.api#documentation": "The maximum amount of memory (in MiB)."
}
}
},
"traits": {
"smithy.api#documentation": "The range of memory in MiB."
}
},
"com.amazonaws.deadline#MeteredProductId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[0-9a-z]{1,32}-[.0-9a-z]{1,32}$"
}
},
"com.amazonaws.deadline#MeteredProductSummary": {
"type": "structure",
"members": {
"productId": {
"target": "com.amazonaws.deadline#MeteredProductId",
"traits": {
"smithy.api#documentation": "The product ID.",
"smithy.api#required": {},
"smithy.api#resourceIdentifier": "productId"
}
},
"family": {
"target": "com.amazonaws.deadline#BoundedString",
"traits": {
"smithy.api#documentation": "The family to which the metered product belongs.",
"smithy.api#required": {}
}
},
"vendor": {
"target": "com.amazonaws.deadline#BoundedString",
"traits": {
"smithy.api#documentation": "The vendor.",
"smithy.api#required": {}
}
},
"port": {
"target": "com.amazonaws.deadline#PortNumber",
"traits": {
"smithy.api#documentation": "The port on which the metered product should run.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of a metered product."
}
},
"com.amazonaws.deadline#MeteredProductSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#MeteredProductSummary"
}
},
"com.amazonaws.deadline#MinOneMaxInteger": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#MinOneMaxTenThousand": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 10000
}
}
},
"com.amazonaws.deadline#MinZeroMaxInteger": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#MonitorId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^monitor-[0-9a-f]{32}$"
}
},
"com.amazonaws.deadline#MonitorResource": {
"type": "resource",
"identifiers": {
"monitorId": {
"target": "com.amazonaws.deadline#MonitorId"
}
},
"create": {
"target": "com.amazonaws.deadline#CreateMonitor"
},
"read": {
"target": "com.amazonaws.deadline#GetMonitor"
},
"update": {
"target": "com.amazonaws.deadline#UpdateMonitor"
},
"delete": {
"target": "com.amazonaws.deadline#DeleteMonitor"
},
"list": {
"target": "com.amazonaws.deadline#ListMonitors"
},
"operations": [
{
"target": "com.amazonaws.deadline#GetMonitorSettings"
},
{
"target": "com.amazonaws.deadline#UpdateMonitorSettings"
}
],
"traits": {
"aws.api#arn": {
"template": "monitor/{monitorId}"
},
"aws.iam#conditionKeys": [
"aws:ResourceTag/${TagKey}"
],
"aws.iam#disableConditionKeyInference": {},
"aws.iam#iamResource": {
"name": "monitor",
"relativeDocumentation": "working-with-deadline-monitor.html"
},
"smithy.api#documentation": "Represents a monitor that is used to manage Deadline Cloud resources"
}
},
"com.amazonaws.deadline#MonitorSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#MonitorSummary"
}
},
"com.amazonaws.deadline#MonitorSummary": {
"type": "structure",
"members": {
"monitorId": {
"target": "com.amazonaws.deadline#MonitorId",
"traits": {
"smithy.api#documentation": "The unique identifier for the monitor.",
"smithy.api#required": {}
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The name of the monitor that displays on the Deadline Cloud console.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
1."
}
}
},
"traits": {
"smithy.api#documentation": "Configuration for priority balanced scheduling. Workers are distributed evenly across all jobs at the highest priority level."
}
},
"com.amazonaws.deadline#PriorityFifoSchedulingConfiguration": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "Configuration for priority first-in, first-out (FIFO) scheduling. Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first."
}
},
"com.amazonaws.deadline#ProcessExitCode": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": -2147483648,
"max": 2147483647
}
}
},
"com.amazonaws.deadline#PutMeteredProduct": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#PutMeteredProductRequest"
},
"output": {
"target": "com.amazonaws.deadline#PutMeteredProductResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [],
"aws.iam#iamAction": {
"name": "PutMeteredProduct",
"documentation": "Grants permission to add a metered product to a license endpoint"
},
"smithy.api#documentation": "Adds a metered product.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "PUT",
"uri": "/2023-10-12/license-endpoints/{licenseEndpointId}/metered-products/{productId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#PutMeteredProductRequest": {
"type": "structure",
"members": {
"licenseEndpointId": {
"target": "com.amazonaws.deadline#LicenseEndpointId",
"traits": {
"smithy.api#documentation": "The license endpoint ID to add to the metered product.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"productId": {
"target": "com.amazonaws.deadline#MeteredProductId",
"traits": {
"smithy.api#documentation": "The product ID to add to the metered product.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#PutMeteredProductResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#QueueBlockedReason": {
"type": "enum",
"members": {
"NO_BUDGET_CONFIGURED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "NO_BUDGET_CONFIGURED"
}
},
"BUDGET_THRESHOLD_REACHED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BUDGET_THRESHOLD_REACHED"
}
}
}
},
"com.amazonaws.deadline#QueueEnvironmentId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^queueenv-[0-9a-f]{32}$"
}
},
"com.amazonaws.deadline#QueueEnvironmentSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#QueueEnvironmentSummary"
}
},
"com.amazonaws.deadline#QueueEnvironmentSummary": {
"type": "structure",
"members": {
"queueEnvironmentId": {
"target": "com.amazonaws.deadline#QueueEnvironmentId",
"traits": {
"smithy.api#documentation": "The queue environment ID.",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.deadline#EnvironmentName",
"traits": {
"smithy.api#documentation": "The name of the queue environment.",
"smithy.api#required": {}
}
},
"priority": {
"target": "com.amazonaws.deadline#Priority",
"traits": {
"smithy.api#documentation": "The queue environment's priority.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The summary of a queue environment."
}
},
"com.amazonaws.deadline#QueueFleetAssociationStatus": {
"type": "enum",
"members": {
"ACTIVE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ACTIVE"
}
},
"STOP_SCHEDULING_AND_COMPLETE_TASKS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "STOP_SCHEDULING_AND_COMPLETE_TASKS"
}
},
"STOP_SCHEDULING_AND_CANCEL_TASKS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "STOP_SCHEDULING_AND_CANCEL_TASKS"
}
},
"STOPPED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "STOPPED"
}
}
}
},
"com.amazonaws.deadline#QueueFleetAssociationSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#QueueFleetAssociationSummary"
}
},
"com.amazonaws.deadline#QueueFleetAssociationSummary": {
"type": "structure",
"members": {
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID.",
"smithy.api#required": {}
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID.",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.deadline#QueueFleetAssociationStatus",
"traits": {
"smithy.api#documentation": "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.
The status of task scheduling in the queue-limit association.
ACTIVE - Association is active.
STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped scheduling new tasks and is completing current tasks.
STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped scheduling new tasks and is canceling current tasks.
STOPPED - Association has been stopped.
The display name of the queue summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The budget action description.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
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.
The allowable Amazon EC2 instance types.
If you specify allowedInstanceTypes, you can't specify excludedInstanceTypes.
The instance types to exclude from the fleet.
If you specify excludedInstanceTypes, you can't specify allowedInstanceTypes.
queueIds field, you can't specify the fleetIds field.",
"smithy.api#length": {
"min": 1,
"max": 10
}
}
},
"fleetIds": {
"target": "com.amazonaws.deadline#FleetIds",
"traits": {
"smithy.api#documentation": "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.",
"smithy.api#length": {
"min": 1,
"max": 10
}
}
}
},
"traits": {
"smithy.api#documentation": "Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both."
}
},
"com.amazonaws.deadline#SettingKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 128
},
"smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_.:-]*$"
}
},
"com.amazonaws.deadline#SettingValue": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 8192
}
}
},
"com.amazonaws.deadline#SettingsMap": {
"type": "map",
"key": {
"target": "com.amazonaws.deadline#SettingKey"
},
"value": {
"target": "com.amazonaws.deadline#SettingValue"
},
"traits": {
"smithy.api#length": {
"max": 64
}
}
},
"com.amazonaws.deadline#SortOrder": {
"type": "enum",
"members": {
"ASCENDING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ASCENDING"
}
},
"DESCENDING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DESCENDING"
}
}
}
},
"com.amazonaws.deadline#StartSessionsStatisticsAggregation": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#StartSessionsStatisticsAggregationRequest"
},
"output": {
"target": "com.amazonaws.deadline#StartSessionsStatisticsAggregationResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "StartSessionsStatisticsAggregation",
"documentation": "Grants permission to get all collected statistics for sessions",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"optional": {
"queue": {},
"fleet": {}
}
}
},
"smithy.api#documentation": "Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "POST",
"uri": "/2023-10-12/farms/{farmId}/sessions-statistics-aggregation",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.deadline#StartSessionsStatisticsAggregationRequest": {
"type": "structure",
"members": {
"farmId": {
"target": "com.amazonaws.deadline#FarmId",
"traits": {
"smithy.api#documentation": "The identifier of the farm that contains queues or fleets to return statistics for.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"resourceIds": {
"target": "com.amazonaws.deadline#SessionsStatisticsResources",
"traits": {
"smithy.api#documentation": "A list of fleet IDs or queue IDs to gather statistics for.",
"smithy.api#required": {}
}
},
"startTime": {
"target": "com.amazonaws.deadline#Timestamp",
"traits": {
"smithy.api#documentation": "The Linux timestamp of the date and time that the statistics start.",
"smithy.api#required": {},
"smithy.api#timestampFormat": "date-time"
}
},
"endTime": {
"target": "com.amazonaws.deadline#Timestamp",
"traits": {
"smithy.api#documentation": "The Linux timestamp of the date and time that the statistics end.",
"smithy.api#required": {},
"smithy.api#timestampFormat": "date-time"
}
},
"timezone": {
"target": "com.amazonaws.deadline#Timezone",
"traits": {
"smithy.api#documentation": "The time zone to use for the statistics. Use UTC notation such as \"UTC+8.\"
" } }, "period": { "target": "com.amazonaws.deadline#Period", "traits": { "smithy.api#documentation": "The period to aggregate the statistics." } }, "groupBy": { "target": "com.amazonaws.deadline#UsageGroupBy", "traits": { "smithy.api#documentation": "The field to use to group the statistics.", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.deadline#UsageStatistics", "traits": { "smithy.api#documentation": "One to four statistics to return.", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.deadline#StartSessionsStatisticsAggregationResponse": { "type": "structure", "members": { "aggregationId": { "target": "com.amazonaws.deadline#AggregationId", "traits": { "smithy.api#documentation": "A unique identifier for the aggregated statistics. Use this identifier with theGetAggregatedStatisticsForSessions operation to return the statistics.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#StartedAt": {
"type": "timestamp",
"traits": {
"smithy.api#timestampFormat": "date-time"
}
},
"com.amazonaws.deadline#StartsAt": {
"type": "timestamp",
"traits": {
"smithy.api#timestampFormat": "date-time"
}
},
"com.amazonaws.deadline#Statistics": {
"type": "structure",
"members": {
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID."
}
},
"fleetId": {
"target": "com.amazonaws.deadline#FleetId",
"traits": {
"smithy.api#documentation": "The fleet ID."
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID."
}
},
"jobName": {
"target": "com.amazonaws.deadline#JobName",
"traits": {
"smithy.api#documentation": "The job name."
}
},
"userId": {
"target": "com.amazonaws.deadline#UserId",
"traits": {
"smithy.api#documentation": "The user ID."
}
},
"usageType": {
"target": "com.amazonaws.deadline#UsageType",
"traits": {
"smithy.api#documentation": "The type of usage for the statistics."
}
},
"licenseProduct": {
"target": "com.amazonaws.deadline#LicenseProduct",
"traits": {
"smithy.api#documentation": "The licensed product."
}
},
"instanceType": {
"target": "com.amazonaws.deadline#InstanceType",
"traits": {
"smithy.api#documentation": "The type of instance."
}
},
"count": {
"target": "com.amazonaws.deadline#Integer",
"traits": {
"smithy.api#documentation": "The number of instances in a list of statistics.",
"smithy.api#required": {}
}
},
"costInUsd": {
"target": "com.amazonaws.deadline#Stats",
"traits": {
"smithy.api#documentation": "How the statistics should appear in USD. Options include: minimum, maximum, average or sum.",
"smithy.api#required": {}
}
},
"runtimeInSeconds": {
"target": "com.amazonaws.deadline#Stats",
"traits": {
"smithy.api#documentation": "The total aggregated runtime.",
"smithy.api#required": {}
}
},
"aggregationStartTime": {
"target": "com.amazonaws.deadline#Timestamp",
"traits": {
"smithy.api#documentation": "The start time for the aggregation.",
"smithy.api#timestampFormat": "date-time"
}
},
"aggregationEndTime": {
"target": "com.amazonaws.deadline#Timestamp",
"traits": {
"smithy.api#documentation": "The end time for the aggregation.",
"smithy.api#timestampFormat": "date-time"
}
}
},
"traits": {
"smithy.api#documentation": "A list of statistics for a session."
}
},
"com.amazonaws.deadline#StatisticsList": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#Statistics"
}
},
"com.amazonaws.deadline#Stats": {
"type": "structure",
"members": {
"min": {
"target": "com.amazonaws.deadline#Double",
"traits": {
"smithy.api#documentation": "The minimum of the usage statistics."
}
},
"max": {
"target": "com.amazonaws.deadline#Double",
"traits": {
"smithy.api#documentation": "The maximum among the usage statistics."
}
},
"avg": {
"target": "com.amazonaws.deadline#Double",
"traits": {
"smithy.api#documentation": "The average of the usage statistics."
}
},
"sum": {
"target": "com.amazonaws.deadline#Double",
"traits": {
"smithy.api#documentation": "The sum of the usage statistics."
}
}
},
"traits": {
"smithy.api#documentation": "The minimum, maximum, average, and sum."
}
},
"com.amazonaws.deadline#StatusMessage": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 1024
}
}
},
"com.amazonaws.deadline#StepAmountCapabilities": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#StepAmountCapability"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 25
}
}
},
"com.amazonaws.deadline#StepAmountCapability": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.deadline#AmountCapabilityName",
"traits": {
"smithy.api#documentation": "The name of the step.",
"smithy.api#required": {}
}
},
"min": {
"target": "com.amazonaws.deadline#Double",
"traits": {
"smithy.api#documentation": "The minimum amount."
}
},
"max": {
"target": "com.amazonaws.deadline#Double",
"traits": {
"smithy.api#documentation": "The maximum amount."
}
},
"value": {
"target": "com.amazonaws.deadline#Double",
"traits": {
"smithy.api#documentation": "The amount value."
}
}
},
"traits": {
"smithy.api#documentation": "The details outlining the minimum and maximum capability of a step."
}
},
"com.amazonaws.deadline#StepAttributeCapabilities": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#StepAttributeCapability"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 25
}
}
},
"com.amazonaws.deadline#StepAttributeCapability": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.deadline#AttributeCapabilityName",
"traits": {
"smithy.api#documentation": "The name of the step attribute.",
"smithy.api#required": {}
}
},
"anyOf": {
"target": "com.amazonaws.deadline#ListAttributeCapabilityValue",
"traits": {
"smithy.api#documentation": "Requires any of the step attributes in a given list."
}
},
"allOf": {
"target": "com.amazonaws.deadline#ListAttributeCapabilityValue",
"traits": {
"smithy.api#documentation": "Requires all of the step attribute values."
}
}
},
"traits": {
"smithy.api#documentation": "The list of step attributes."
}
},
"com.amazonaws.deadline#StepConsumer": {
"type": "structure",
"members": {
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.deadline#DependencyConsumerResolutionStatus",
"traits": {
"smithy.api#documentation": "The step consumer status.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of a step consumer."
}
},
"com.amazonaws.deadline#StepConsumers": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#StepConsumer"
}
},
"com.amazonaws.deadline#StepDependencies": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#StepDependency"
}
},
"com.amazonaws.deadline#StepDependency": {
"type": "structure",
"members": {
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.deadline#DependencyConsumerResolutionStatus",
"traits": {
"smithy.api#documentation": "The step dependency status.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of step dependency."
}
},
"com.amazonaws.deadline#StepDescription": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2048
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.deadline#StepDetailsEntity": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
},
"schemaVersion": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The schema version for a step template.",
"smithy.api#required": {}
}
},
"template": {
"target": "com.amazonaws.deadline#Document",
"traits": {
"smithy.api#documentation": "The template for a step.",
"smithy.api#required": {}
}
},
"dependencies": {
"target": "com.amazonaws.deadline#DependenciesList",
"traits": {
"smithy.api#documentation": "The dependencies for a step.",
"smithy.api#required": {}
}
},
"extensions": {
"target": "com.amazonaws.deadline#OpenjdExtensionNameList",
"traits": {
"smithy.api#documentation": "The Open Job Description extensions that the step uses. This value is used by the worker agent."
}
},
"resolvedSymbolTable": {
"target": "com.amazonaws.deadline#SerializedSymbolTable",
"traits": {
"smithy.api#documentation": "The resolved symbol table for the step's expressions, serialized as JSON. This value is used by the worker agent."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a step entity."
}
},
"com.amazonaws.deadline#StepDetailsError": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
},
"code": {
"target": "com.amazonaws.deadline#JobEntityErrorCode",
"traits": {
"smithy.api#documentation": "The error code.",
"smithy.api#required": {}
}
},
"message": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The error message detailing the error's cause.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of the step error."
}
},
"com.amazonaws.deadline#StepDetailsIdentifiers": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID.",
"smithy.api#required": {}
}
},
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of identifiers for a step."
}
},
"com.amazonaws.deadline#StepId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^step-[0-9a-f]{32}$"
}
},
"com.amazonaws.deadline#StepLifecycleStatus": {
"type": "enum",
"members": {
"CREATE_COMPLETE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CREATE_COMPLETE"
}
},
"UPDATE_IN_PROGRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UPDATE_IN_PROGRESS"
}
},
"UPDATE_FAILED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UPDATE_FAILED"
}
},
"UPDATE_SUCCEEDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UPDATE_SUCCEEDED"
}
}
}
},
"com.amazonaws.deadline#StepName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 512
}
}
},
"com.amazonaws.deadline#StepParameter": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.deadline#StepParameterName",
"traits": {
"smithy.api#documentation": "The name of the parameter.",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.deadline#StepParameterType",
"traits": {
"smithy.api#documentation": "The data type of the parameter.",
"smithy.api#required": {}
}
},
"chunks": {
"target": "com.amazonaws.deadline#StepParameterChunks",
"traits": {
"smithy.api#documentation": "The configuration for task chunking."
}
}
},
"traits": {
"smithy.api#documentation": "The details of a step parameter."
}
},
"com.amazonaws.deadline#StepParameterChunks": {
"type": "structure",
"members": {
"defaultTaskCount": {
"target": "com.amazonaws.deadline#DefaultTaskCount",
"traits": {
"smithy.api#documentation": "The number of tasks to combine into a single chunk by default.",
"smithy.api#required": {}
}
},
"targetRuntimeSeconds": {
"target": "com.amazonaws.deadline#TargetRuntimeSeconds",
"traits": {
"smithy.api#documentation": "The number of seconds to aim for when forming chunks."
}
},
"rangeConstraint": {
"target": "com.amazonaws.deadline#RangeConstraint",
"traits": {
"smithy.api#documentation": "Specifies whether the chunked ranges must be contiguous or can have gaps between them.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "Defines how a step parameter range should be divided into chunks."
}
},
"com.amazonaws.deadline#StepParameterList": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#StepParameter"
}
},
"com.amazonaws.deadline#StepParameterName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 512
}
}
},
"com.amazonaws.deadline#StepParameterType": {
"type": "enum",
"members": {
"INT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "INT"
}
},
"FLOAT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FLOAT"
}
},
"STRING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "STRING"
}
},
"PATH": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PATH"
}
},
"CHUNK_INT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CHUNK_INT"
}
}
}
},
"com.amazonaws.deadline#StepRequiredCapabilities": {
"type": "structure",
"members": {
"attributes": {
"target": "com.amazonaws.deadline#StepAttributeCapabilities",
"traits": {
"smithy.api#documentation": "The capability attributes that the step requires.",
"smithy.api#required": {}
}
},
"amounts": {
"target": "com.amazonaws.deadline#StepAmountCapabilities",
"traits": {
"smithy.api#documentation": "The capability amounts that the step requires.",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "The details of required step capabilities."
}
},
"com.amazonaws.deadline#StepSearchSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.deadline#StepSearchSummary"
}
},
"com.amazonaws.deadline#StepSearchSummary": {
"type": "structure",
"members": {
"stepId": {
"target": "com.amazonaws.deadline#StepId",
"traits": {
"smithy.api#documentation": "The step ID."
}
},
"jobId": {
"target": "com.amazonaws.deadline#JobId",
"traits": {
"smithy.api#documentation": "The job ID."
}
},
"queueId": {
"target": "com.amazonaws.deadline#QueueId",
"traits": {
"smithy.api#documentation": "The queue ID."
}
},
"name": {
"target": "com.amazonaws.deadline#StepName",
"traits": {
"smithy.api#documentation": "The step name."
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#StepLifecycleStatus",
"traits": {
"smithy.api#documentation": "The life cycle status."
}
},
"lifecycleStatusMessage": {
"target": "com.amazonaws.deadline#String",
"traits": {
"smithy.api#documentation": "The life cycle status message."
}
},
"taskRunStatus": {
"target": "com.amazonaws.deadline#TaskRunStatus",
"traits": {
"smithy.api#documentation": "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.
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.
The display name of the storage profile summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the budget to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
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.
The display name of the farm to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the farm to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Updates a fleet.
Workers that are running when you call UpdateFleet keep the instance type and capabilities that they launched with until they scale in. Deadline Cloud can schedule jobs that you submit after the update on these existing workers, so the new configuration might not take effect immediately. To make sure that all workers use the new configuration, set maxWorkerCount to 0, use the ListWorkers operation to confirm that the fleet has no workers, and then restore maxWorkerCount.
The display name of the fleet to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the fleet to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.\n"
}
},
"configuration": {
"target": "com.amazonaws.deadline#FleetConfiguration",
"traits": {
"smithy.api#documentation": "The fleet configuration to update. The new configuration replaces the existing one, so include every setting you want to keep. Settings that you omit revert to their defaults."
}
},
"hostConfiguration": {
"target": "com.amazonaws.deadline#HostConfiguration",
"traits": {
"smithy.api#documentation": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet."
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#UpdateFleetResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#UpdateJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#UpdateJobRequest"
},
"output": {
"target": "com.amazonaws.deadline#UpdateJobResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#ConflictException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "UpdateJob",
"documentation": "Grants permission to update a job",
"relativeDocumentation": "API_UpdateJob.html",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
],
"resources": {
"required": {
"job": {}
}
}
},
"smithy.api#documentation": "Updates a job.
When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.
FAILED."
}
},
"maxRetriesPerTask": {
"target": "com.amazonaws.deadline#MaxRetriesPerTask",
"traits": {
"smithy.api#documentation": "The maximum number of retries for a job."
}
},
"lifecycleStatus": {
"target": "com.amazonaws.deadline#UpdateJobLifecycleStatus",
"traits": {
"smithy.api#documentation": "The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.
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.\n\nYou can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.\n\nIf you don't specify the maxWorkerCount, the default is -1.\n\nThe maximum number of workers that can process tasks in the job.\n"
}
},
"name": {
"target": "com.amazonaws.deadline#JobName",
"traits": {
"smithy.api#documentation": "The updated job name."
}
},
"description": {
"target": "com.amazonaws.deadline#JobDescriptionOverride",
"traits": {
"smithy.api#documentation": "The updated job description."
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#UpdateJobResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#UpdateLimit": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#UpdateLimitRequest"
},
"output": {
"target": "com.amazonaws.deadline#UpdateLimitResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#iamAction": {
"name": "UpdateLimit",
"documentation": "Grants permission to update a limit for a farm",
"requiredActions": [
"identitystore:ListGroupMembershipsForMember"
]
},
"smithy.api#documentation": "Updates the properties of the specified limit.
", "smithy.api#endpoint": { "hostPrefix": "management." }, "smithy.api#http": { "method": "PATCH", "uri": "/2023-10-12/farms/{farmId}/limits/{limitId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.deadline#UpdateLimitRequest": { "type": "structure", "members": { "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { "smithy.api#documentation": "The unique identifier of the farm that contains the limit.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "limitId": { "target": "com.amazonaws.deadline#LimitId", "traits": { "smithy.api#documentation": "The unique identifier of the limit to update.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { "smithy.api#documentation": "The new display name of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The new description of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.\n"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.deadline#UpdateLimitResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.deadline#UpdateMonitor": {
"type": "operation",
"input": {
"target": "com.amazonaws.deadline#UpdateMonitorRequest"
},
"output": {
"target": "com.amazonaws.deadline#UpdateMonitorResponse"
},
"errors": [
{
"target": "com.amazonaws.deadline#AccessDeniedException"
},
{
"target": "com.amazonaws.deadline#InternalServerErrorException"
},
{
"target": "com.amazonaws.deadline#ResourceNotFoundException"
},
{
"target": "com.amazonaws.deadline#ThrottlingException"
},
{
"target": "com.amazonaws.deadline#ValidationException"
}
],
"traits": {
"aws.iam#conditionKeys": [],
"aws.iam#iamAction": {
"name": "UpdateMonitor",
"documentation": "Grants permission to update a monitor",
"requiredActions": [
"sso:UpdateApplication",
"sso:PutApplicationGrant",
"iam:PassRole"
]
},
"smithy.api#documentation": "Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.",
"smithy.api#endpoint": {
"hostPrefix": "management."
},
"smithy.api#http": {
"method": "PATCH",
"uri": "/2023-10-12/monitors/{monitorId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.deadline#UpdateMonitorRequest": {
"type": "structure",
"members": {
"monitorId": {
"target": "com.amazonaws.deadline#MonitorId",
"traits": {
"smithy.api#documentation": "The unique identifier of the monitor to update.",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"subdomain": {
"target": "com.amazonaws.deadline#Subdomain",
"traits": {
"smithy.api#documentation": "The new value of the subdomain to use when forming the monitor URL."
}
},
"displayName": {
"target": "com.amazonaws.deadline#ResourceName",
"traits": {
"smithy.api#documentation": "The new value to use for the monitor's display name.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.
Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.deadline#UpdateQueueLimitAssociationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.deadline#UpdateQueueLimitAssociationStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS" } }, "STOP_LIMIT_USAGE_AND_CANCEL_TASKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOP_LIMIT_USAGE_AND_CANCEL_TASKS" } } } }, "com.amazonaws.deadline#UpdateQueueRequest": { "type": "structure", "members": { "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { "smithy.api#documentation": "The farm ID to update in the queue.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queueId": { "target": "com.amazonaws.deadline#QueueId", "traits": { "smithy.api#documentation": "The queue ID to update.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.deadline#ClientToken", "traits": { "smithy.api#documentation": "The idempotency token to update in the queue.", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } }, "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { "smithy.api#documentation": "The display name of the queue to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the queue to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the storage profile to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
0 means priority is ignored. The default value is 100.0."
}
},
"errorWeight": {
"target": "com.amazonaws.deadline#SchedulingErrorWeight",
"traits": {
"smithy.api#default": -10.0,
"smithy.api#documentation": "The weight applied to the number of errors on a job. A negative value means jobs without errors are scheduled first. A value of 0 means errors are ignored. The default value is -10.0."
}
},
"submissionTimeWeight": {
"target": "com.amazonaws.deadline#SchedulingSubmissionTimeWeight",
"traits": {
"smithy.api#default": 3.0,
"smithy.api#documentation": "The weight applied to job submission time. A positive value means earlier jobs are scheduled first. A value of 0 means submission time is ignored. The default value is 3.0."
}
},
"renderingTaskWeight": {
"target": "com.amazonaws.deadline#SchedulingRenderingTaskWeight",
"traits": {
"smithy.api#default": -100.0,
"smithy.api#documentation": "The weight applied to the number of tasks currently rendering on a job. A negative value means jobs that are not already rendering are scheduled next. A value of 0 means the rendering state is ignored. The default value is -100.0."
}
},
"renderingTaskBuffer": {
"target": "com.amazonaws.deadline#SchedulingRenderingTaskBuffer",
"traits": {
"smithy.api#default": 1,
"smithy.api#documentation": "The rendering task buffer is subtracted from the number of rendering tasks before applying the rendering task weight. This creates a stickiness effect where workers prefer to stay with their current job. Higher values make workers stickier. The default value is 1. The buffer is only applied in the weight calculation for a job if the worker is currently assigned to that job."
}
},
"maxPriorityOverride": {
"target": "com.amazonaws.deadline#SchedulingMaxPriorityOverride",
"traits": {
"smithy.api#documentation": "Overrides the weighted scheduling formula for jobs at the maximum priority (100). When set, jobs with priority 100 are always scheduled first regardless of their calculated weight. When absent, maximum priority jobs use the standard weighted formula."
}
},
"minPriorityOverride": {
"target": "com.amazonaws.deadline#SchedulingMinPriorityOverride",
"traits": {
"smithy.api#documentation": "Overrides the weighted scheduling formula for jobs at the minimum priority (0). When set, jobs with priority 0 are always scheduled last regardless of their calculated weight. When absent, minimum priority jobs use the standard weighted formula."
}
}
},
"traits": {
"smithy.api#documentation": "Configuration for weighted balanced scheduling. Workers are assigned to jobs based on a weighted formula:
weight = (priority * priorityWeight) + (errors * errorWeight) + ((currentTime - submissionTime) * submissionTimeWeight) + ((renderingTasks - renderingTaskBuffer) * renderingTaskWeight)
The job with the highest calculated weight is scheduled first. Workers are distributed evenly amongst jobs with the same weight.
" } }, "com.amazonaws.deadline#WindowsUser": { "type": "structure", "members": { "user": { "target": "com.amazonaws.deadline#String", "traits": { "smithy.api#documentation": "The user.", "smithy.api#length": { "min": 0, "max": 111 }, "smithy.api#pattern": "^[^\"'/\\[\\]:;|=,+*?<>\\s]*$", "smithy.api#required": {} } }, "passwordArn": { "target": "com.amazonaws.deadline#String", "traits": { "smithy.api#documentation": "The password ARN for the Windows user.", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):secretsmanager:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:secret:[a-zA-Z0-9-/_+=.@]{1,2028}$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Windows user details." } }, "com.amazonaws.deadline#WorkerAmountCapability": { "type": "structure", "members": { "name": { "target": "com.amazonaws.deadline#AmountCapabilityName", "traits": { "smithy.api#documentation": "The name of the worker amount capability.", "smithy.api#required": {} } }, "value": { "target": "smithy.api#Float", "traits": { "smithy.api#documentation": "The value of the worker amount capability.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details of the worker amount capability." } }, "com.amazonaws.deadline#WorkerAmountCapabilityList": { "type": "list", "member": { "target": "com.amazonaws.deadline#WorkerAmountCapability" }, "traits": { "smithy.api#length": { "min": 2, "max": 17 } } }, "com.amazonaws.deadline#WorkerAttributeCapability": { "type": "structure", "members": { "name": { "target": "com.amazonaws.deadline#AttributeCapabilityName", "traits": { "smithy.api#documentation": "The name of the worker attribute capability.", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.deadline#AttributeCapabilityValuesList", "traits": { "smithy.api#documentation": "The values of the worker amount capability.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details of the worker attribute capability." } }, "com.amazonaws.deadline#WorkerAttributeCapabilityList": { "type": "list", "member": { "target": "com.amazonaws.deadline#WorkerAttributeCapability" }, "traits": { "smithy.api#length": { "min": 2, "max": 17 } } }, "com.amazonaws.deadline#WorkerCapabilities": { "type": "structure", "members": { "amounts": { "target": "com.amazonaws.deadline#WorkerAmountCapabilityList", "traits": { "smithy.api#documentation": "The worker capabilities amounts on a list of worker capabilities.", "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.deadline#WorkerAttributeCapabilityList", "traits": { "smithy.api#documentation": "The worker attribute capabilities in the list of attribute capabilities.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details for worker capabilities." } }, "com.amazonaws.deadline#WorkerId": { "type": "string", "traits": { "smithy.api#pattern": "^worker-[0-9a-f]{32}$" } }, "com.amazonaws.deadline#WorkerResource": { "type": "resource", "identifiers": { "farmId": { "target": "com.amazonaws.deadline#FarmId" }, "fleetId": { "target": "com.amazonaws.deadline#FleetId" }, "workerId": { "target": "com.amazonaws.deadline#WorkerId" } }, "create": { "target": "com.amazonaws.deadline#CreateWorker" }, "read": { "target": "com.amazonaws.deadline#GetWorker" }, "update": { "target": "com.amazonaws.deadline#UpdateWorker" }, "delete": { "target": "com.amazonaws.deadline#DeleteWorker" }, "list": { "target": "com.amazonaws.deadline#ListWorkers" }, "operations": [ { "target": "com.amazonaws.deadline#AssumeFleetRoleForWorker" }, { "target": "com.amazonaws.deadline#AssumeQueueRoleForWorker" }, { "target": "com.amazonaws.deadline#BatchGetJobEntity" }, { "target": "com.amazonaws.deadline#ListSessionsForWorker" }, { "target": "com.amazonaws.deadline#UpdateWorkerSchedule" } ], "traits": { "aws.api#arn": { "template": "farm/{farmId}/fleet/{fleetId}/worker/{workerId}" }, "aws.iam#conditionKeys": [ "deadline:FarmMembershipLevels", "deadline:FleetMembershipLevels", "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "worker", "relativeDocumentation": "security-iam.html" }, "smithy.api#documentation": "Represents a worker that is part of a fleet on a farm" } }, "com.amazonaws.deadline#WorkerSearchSummaries": { "type": "list", "member": { "target": "com.amazonaws.deadline#WorkerSearchSummary" } }, "com.amazonaws.deadline#WorkerSearchSummary": { "type": "structure", "members": { "fleetId": { "target": "com.amazonaws.deadline#FleetId", "traits": { "smithy.api#documentation": "The fleet ID." } }, "workerId": { "target": "com.amazonaws.deadline#WorkerId", "traits": { "smithy.api#documentation": "The worker ID." } }, "status": { "target": "com.amazonaws.deadline#WorkerStatus", "traits": { "smithy.api#documentation": "The status of the worker search." } }, "hostProperties": { "target": "com.amazonaws.deadline#HostPropertiesResponse", "traits": { "smithy.api#documentation": "Provides the Amazon EC2 instance properties of the worker host." } }, "createdBy": { "target": "com.amazonaws.deadline#CreatedBy", "traits": { "smithy.api#documentation": "The user or system that created this resource." } }, "createdAt": { "target": "com.amazonaws.deadline#CreatedAt", "traits": { "smithy.api#documentation": "The date and time the resource was created." } }, "updatedBy": { "target": "com.amazonaws.deadline#UpdatedBy", "traits": { "smithy.api#documentation": "The user or system that updated this resource." } }, "updatedAt": { "target": "com.amazonaws.deadline#UpdatedAt", "traits": { "smithy.api#documentation": "The date and time the resource was updated." } } }, "traits": { "smithy.api#documentation": "The details of a worker search." } }, "com.amazonaws.deadline#WorkerSessionSummary": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.deadline#SessionId", "traits": { "smithy.api#documentation": "The session ID for the session action.", "smithy.api#required": {} } }, "queueId": { "target": "com.amazonaws.deadline#QueueId", "traits": { "smithy.api#documentation": "The queue ID for the queue associated to the worker.", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.deadline#JobId", "traits": { "smithy.api#documentation": "The job ID for the job associated with the worker's session.", "smithy.api#required": {} } }, "startedAt": { "target": "com.amazonaws.deadline#StartedAt", "traits": { "smithy.api#documentation": "The date and time the resource started running.", "smithy.api#required": {} } }, "lifecycleStatus": { "target": "com.amazonaws.deadline#SessionLifecycleStatus", "traits": { "smithy.api#documentation": "The life cycle status for the worker's session.", "smithy.api#required": {} } }, "endedAt": { "target": "com.amazonaws.deadline#EndedAt", "traits": { "smithy.api#documentation": "The date and time the resource ended running." } }, "targetLifecycleStatus": { "target": "com.amazonaws.deadline#SessionLifecycleTargetStatus", "traits": { "smithy.api#documentation": "The life cycle status
" } } }, "traits": { "smithy.api#documentation": "Summarizes the session for a particular worker." } }, "com.amazonaws.deadline#WorkerStatus": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTED" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } }, "NOT_RESPONDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_RESPONDING" } }, "NOT_COMPATIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_COMPATIBLE" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "IDLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDLE" } } } }, "com.amazonaws.deadline#WorkerSummaries": { "type": "list", "member": { "target": "com.amazonaws.deadline#WorkerSummary" } }, "com.amazonaws.deadline#WorkerSummary": { "type": "structure", "members": { "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { "smithy.api#documentation": "The farm ID.", "smithy.api#required": {} } }, "fleetId": { "target": "com.amazonaws.deadline#FleetId", "traits": { "smithy.api#documentation": "The fleet ID.", "smithy.api#required": {} } }, "workerId": { "target": "com.amazonaws.deadline#WorkerId", "traits": { "smithy.api#documentation": "The worker ID.", "smithy.api#required": {} } }, "hostProperties": { "target": "com.amazonaws.deadline#HostPropertiesResponse", "traits": { "smithy.api#documentation": "The host properties of the worker." } }, "status": { "target": "com.amazonaws.deadline#WorkerStatus", "traits": { "smithy.api#documentation": "The status of the worker.", "smithy.api#required": {} } }, "log": { "target": "com.amazonaws.deadline#LogConfiguration", "traits": { "smithy.api#documentation": "The log configuration for the worker." } }, "createdAt": { "target": "com.amazonaws.deadline#CreatedAt", "traits": { "smithy.api#documentation": "The date and time the resource was created.", "smithy.api#required": {} } }, "createdBy": { "target": "com.amazonaws.deadline#CreatedBy", "traits": { "smithy.api#documentation": "The user or system that created this resource.", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.deadline#UpdatedAt", "traits": { "smithy.api#documentation": "The date and time the resource was updated." } }, "updatedBy": { "target": "com.amazonaws.deadline#UpdatedBy", "traits": { "smithy.api#documentation": "The user or system that updated this resource." } } }, "traits": { "smithy.api#documentation": "The summary of details for a worker." } } } }