The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.
With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.
", "operations": { "AssociateMemberToFarm": "Assigns a farm membership level to a member.
", "AssociateMemberToFleet": "Assigns a fleet membership level to a member.
", "AssociateMemberToJob": "Assigns a job membership level to a member
", "AssociateMemberToQueue": "Assigns a queue membership level to a member
", "AssumeFleetRoleForRead": "Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
", "AssumeFleetRoleForWorker": "Get credentials from the fleet role for a worker.
", "AssumeQueueRoleForRead": "Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
", "AssumeQueueRoleForUser": "Allows a user to assume a role for a queue.
", "AssumeQueueRoleForWorker": "Allows a worker to assume a queue role.
", "BatchGetJobEntity": "Get batched job details for a worker.
", "CopyJobTemplate": "Copies a job template to an Amazon S3 bucket.
", "CreateBudget": "Creates a budget to set spending thresholds for your rendering activity.
", "CreateFarm": "Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.
", "CreateFleet": "Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
", "CreateJob": "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.
", "CreateLicenseEndpoint": "Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
", "CreateLimit": "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.
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.
", "CreateQueue": "Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.
", "CreateQueueEnvironment": "Creates an environment for a queue that defines how jobs in the queue run.
", "CreateQueueFleetAssociation": "Creates an association between a queue and a fleet.
", "CreateQueueLimitAssociation": "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.
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
", "CreateWorker": "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.
Deletes a budget.
", "DeleteFarm": "Deletes a farm.
", "DeleteFleet": "Deletes a fleet.
", "DeleteLicenseEndpoint": "Deletes a license endpoint.
", "DeleteLimit": "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.
Deletes a metered product.
", "DeleteMonitor": "Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
", "DeleteQueue": "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.
Deletes a queue environment.
", "DeleteQueueFleetAssociation": "Deletes a queue-fleet association.
", "DeleteQueueLimitAssociation": "Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.
Deletes a storage profile.
", "DeleteWorker": "Deletes a worker.
", "DisassociateMemberFromFarm": "Disassociates a member from a farm.
", "DisassociateMemberFromFleet": "Disassociates a member from a fleet.
", "DisassociateMemberFromJob": "Disassociates a member from a job.
", "DisassociateMemberFromQueue": "Disassociates a member from a queue.
", "GetBudget": "Get a budget.
", "GetFarm": "Get a farm.
", "GetFleet": "Get a fleet.
", "GetJob": "Gets a Deadline Cloud job.
", "GetLicenseEndpoint": "Gets a licence endpoint.
", "GetLimit": "Gets information about a specific limit.
", "GetMonitor": "Gets information about the specified monitor.
", "GetQueue": "Gets a queue.
", "GetQueueEnvironment": "Gets a queue environment.
", "GetQueueFleetAssociation": "Gets a queue-fleet association.
", "GetQueueLimitAssociation": "Gets information about a specific association between a queue and a limit.
", "GetSession": "Gets a session.
", "GetSessionAction": "Gets a session action for the job.
", "GetSessionsStatisticsAggregation": "Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
Gets a step.
", "GetStorageProfile": "Gets a storage profile.
", "GetStorageProfileForQueue": "Gets a storage profile for a queue.
", "GetTask": "Gets a task.
", "GetWorker": "Gets a worker.
", "ListAvailableMeteredProducts": "A list of the available metered products.
", "ListBudgets": "A list of budgets in a farm.
", "ListFarmMembers": "Lists the members of a farm.
", "ListFarms": "Lists farms.
", "ListFleetMembers": "Lists fleet members.
", "ListFleets": "Lists fleets.
", "ListJobMembers": "Lists members on a job.
", "ListJobParameterDefinitions": "Lists parameter definitions of a job.
", "ListJobs": "Lists jobs.
", "ListLicenseEndpoints": "Lists license endpoints.
", "ListLimits": "Gets a list of limits defined in the specified farm.
", "ListMeteredProducts": "Lists metered products.
", "ListMonitors": "Gets a list of your monitors in Deadline Cloud.
", "ListQueueEnvironments": "Lists queue environments.
", "ListQueueFleetAssociations": "Lists queue-fleet associations.
", "ListQueueLimitAssociations": "Gets a list of the associations between queues and limits defined in a farm.
", "ListQueueMembers": "Lists the members in a queue.
", "ListQueues": "Lists queues.
", "ListSessionActions": "Lists session actions.
", "ListSessions": "Lists sessions.
", "ListSessionsForWorker": "Lists sessions for a worker.
", "ListStepConsumers": "Lists step consumers.
", "ListStepDependencies": "Lists the dependencies for a step.
", "ListSteps": "Lists steps for a job.
", "ListStorageProfiles": "Lists storage profiles.
", "ListStorageProfilesForQueue": "Lists storage profiles for a queue.
", "ListTagsForResource": "Lists tags for a resource.
", "ListTasks": "Lists tasks for a job.
", "ListWorkers": "Lists workers.
", "PutMeteredProduct": "Adds a metered product.
", "SearchJobs": "Searches for jobs.
", "SearchSteps": "Searches for steps.
", "SearchTasks": "Searches for tasks.
", "SearchWorkers": "Searches for workers.
", "StartSessionsStatisticsAggregation": "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.
Tags a resource using the resource's ARN and desired tags.
", "UntagResource": "Removes a tag from a resource using the resource's ARN and tag to remove.
", "UpdateBudget": "Updates a budget that sets spending thresholds for rendering activity.
", "UpdateFarm": "Updates a farm.
", "UpdateFleet": "Updates a fleet.
", "UpdateJob": "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.
Updates the properties of the specified limit.
", "UpdateMonitor": "Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.
Updates a queue.
", "UpdateQueueEnvironment": "Updates the queue environment.
", "UpdateQueueFleetAssociation": "Updates a queue-fleet association.
", "UpdateQueueLimitAssociation": "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.
Updates a session.
", "UpdateStep": "Updates a step.
", "UpdateStorageProfile": "Updates a storage profile.
", "UpdateTask": "Updates a task.
", "UpdateWorker": "Updates a worker.
", "UpdateWorkerSchedule": "Updates the schedule for a worker.
" }, "shapes": { "AcceleratorCapabilities": { "base": "Provides information about the GPU accelerators used for jobs processed by a fleet.
", "refs": { "ServiceManagedEc2InstanceCapabilities$acceleratorCapabilities": "Describes the GPU accelerator capabilities required for worker host instances in this fleet.
" } }, "AcceleratorCountRange": { "base": "Defines the maximum and minimum number of GPU accelerators required for a worker instance..
", "refs": { "AcceleratorCapabilities$count": "The number of GPU accelerators specified for worker hosts in this fleet.
", "CustomerManagedWorkerCapabilities$acceleratorCount": "The range of the accelerator.
" } }, "AcceleratorName": { "base": null, "refs": { "AcceleratorSelection$name": "The name of the chip used by the GPU accelerator.
If you specify l4 as the name of the accelerator, you must specify latest or grid:r570 as the runtime.
The available GPU accelerators are:
t4 - NVIDIA T4 Tensor Core GPU
a10g - NVIDIA A10G Tensor Core GPU
l4 - NVIDIA L4 Tensor Core GPU
l40s - NVIDIA L40S Tensor Core GPU
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs.
You can choose from the following runtimes:
latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.
grid:r570 - NVIDIA vGPU software 18
grid:r535 - NVIDIA vGPU software 16
If you don't specify a runtime, Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Deadline Cloud raises an exception.
Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.
", "refs": { "AcceleratorSelections$member": null } }, "AcceleratorSelections": { "base": null, "refs": { "AcceleratorCapabilities$selections": "A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.
" } }, "AcceleratorTotalMemoryMiBRange": { "base": "Defines the maximum and minimum amount of memory, in MiB, to use for the accelerator.
", "refs": { "CustomerManagedWorkerCapabilities$acceleratorTotalMemoryMiB": "The total memory (MiB) for the customer managed worker capabilities.
" } }, "AcceleratorType": { "base": null, "refs": { "AcceleratorTypes$member": null } }, "AcceleratorTypes": { "base": null, "refs": { "CustomerManagedWorkerCapabilities$acceleratorTypes": "The accelerator types for the customer managed worker capabilities.
" } }, "AccessDeniedException": { "base": "You don't have permission to perform the action.
", "refs": { } }, "AccessKeyId": { "base": null, "refs": { "AwsCredentials$accessKeyId": "The IAM access key ID.
" } }, "AcquiredLimit": { "base": "Provides information about the number of resources used.
", "refs": { "AcquiredLimits$member": null } }, "AcquiredLimits": { "base": null, "refs": { "GetSessionActionResponse$acquiredLimits": "The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.
" } }, "AggregationId": { "base": null, "refs": { "GetSessionsStatisticsAggregationRequest$aggregationId": "The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.
A unique identifier for the aggregated statistics. Use this identifier with the GetAggregatedStatisticsForSessions operation to return the statistics.
The storage profile IDs to include in the queue.
", "GetQueueResponse$allowedStorageProfileIds": "The storage profile IDs for the queue.
", "UpdateQueueRequest$allowedStorageProfileIdsToAdd": "The storage profile IDs to add.
", "UpdateQueueRequest$allowedStorageProfileIdsToRemove": "The storage profile ID to remove.
" } }, "AmountCapabilityName": { "base": null, "refs": { "FleetAmountCapability$name": "The name of the fleet capability.
", "StepAmountCapability$name": "The name of the step.
", "WorkerAmountCapability$name": "The name of the worker amount capability.
" } }, "AmountRequirementName": { "base": null, "refs": { "CreateLimitRequest$amountRequirementName": "The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
The assigned starting environment for a worker during session.
", "refs": { "AssignedSessionActionDefinition$envEnter": "The environment a session starts on.
" } }, "AssignedEnvironmentExitSessionActionDefinition": { "base": "The assigned environment when a worker exits a session.
", "refs": { "AssignedSessionActionDefinition$envExit": "The environment a session exits from.
" } }, "AssignedSession": { "base": "The assigned session for the worker.
", "refs": { "AssignedSessions$value": null } }, "AssignedSessionAction": { "base": "The action for a session defined by the session action ID.
", "refs": { "AssignedSessionActions$member": null } }, "AssignedSessionActionDefinition": { "base": "The definition of the assigned session action.
", "refs": { "AssignedSessionAction$definition": "The definition of the assigned session action.
" } }, "AssignedSessionActions": { "base": null, "refs": { "AssignedSession$sessionActions": "The session actions to apply to the assigned session.
" } }, "AssignedSessions": { "base": null, "refs": { "UpdateWorkerScheduleResponse$assignedSessions": "The assigned sessions to update.
" } }, "AssignedSyncInputJobAttachmentsSessionActionDefinition": { "base": "The details for an assigned session action as it relates to a job attachment.
", "refs": { "AssignedSessionActionDefinition$syncInputJobAttachments": "The job attachment to sync with an assigned session action.
" } }, "AssignedTaskRunSessionActionDefinition": { "base": "The specific task, step, and parameters to include.
", "refs": { "AssignedSessionActionDefinition$taskRun": "The task run.
" } }, "AssociateMemberToFarmRequest": { "base": null, "refs": { } }, "AssociateMemberToFarmResponse": { "base": null, "refs": { } }, "AssociateMemberToFleetRequest": { "base": null, "refs": { } }, "AssociateMemberToFleetResponse": { "base": null, "refs": { } }, "AssociateMemberToJobRequest": { "base": null, "refs": { } }, "AssociateMemberToJobResponse": { "base": null, "refs": { } }, "AssociateMemberToQueueRequest": { "base": null, "refs": { } }, "AssociateMemberToQueueResponse": { "base": null, "refs": { } }, "AssumeFleetRoleForReadRequest": { "base": null, "refs": { } }, "AssumeFleetRoleForReadResponse": { "base": null, "refs": { } }, "AssumeFleetRoleForWorkerRequest": { "base": null, "refs": { } }, "AssumeFleetRoleForWorkerResponse": { "base": null, "refs": { } }, "AssumeQueueRoleForReadRequest": { "base": null, "refs": { } }, "AssumeQueueRoleForReadResponse": { "base": null, "refs": { } }, "AssumeQueueRoleForUserRequest": { "base": null, "refs": { } }, "AssumeQueueRoleForUserResponse": { "base": null, "refs": { } }, "AssumeQueueRoleForWorkerRequest": { "base": null, "refs": { } }, "AssumeQueueRoleForWorkerResponse": { "base": null, "refs": { } }, "Attachments": { "base": "The attachments for jobs.
", "refs": { "CreateJobRequest$attachments": "The attachments for the job. Attach files required for the job to run to a render job.
", "GetJobResponse$attachments": "The attachments for the job.
", "JobAttachmentDetailsEntity$attachments": "The job attachments.
" } }, "AttributeCapabilityName": { "base": null, "refs": { "FleetAttributeCapability$name": "The name of the fleet attribute capability for the worker.
", "StepAttributeCapability$name": "The name of the step attribute.
", "WorkerAttributeCapability$name": "The name of the worker attribute capability.
" } }, "AttributeCapabilityValue": { "base": null, "refs": { "AttributeCapabilityValuesList$member": null, "ListAttributeCapabilityValue$member": null } }, "AttributeCapabilityValuesList": { "base": null, "refs": { "FleetAttributeCapability$values": "The number of fleet attribute capabilities.
", "WorkerAttributeCapability$values": "The values of the worker amount capability.
" } }, "AutoScalingMode": { "base": null, "refs": { "CustomerManagedFleetConfiguration$mode": "The Auto Scaling mode for the customer managed fleet configuration.
" } }, "AutoScalingStatus": { "base": null, "refs": { "FleetSummary$autoScalingStatus": "The Auto Scaling status of a fleet.
", "GetFleetResponse$autoScalingStatus": "The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.
The Identity and Access Management credentials.
", "refs": { "AssumeFleetRoleForReadResponse$credentials": "The credentials for the fleet role.
", "AssumeFleetRoleForWorkerResponse$credentials": "The credentials for the worker.
", "AssumeQueueRoleForReadResponse$credentials": "The credentials for the queue role.
", "AssumeQueueRoleForUserResponse$credentials": "The credentials for the queue role that a user has access to.
", "AssumeQueueRoleForWorkerResponse$credentials": "The Amazon Web Services credentials for the role that the worker is assuming.
" } }, "BatchGetJobEntityErrors": { "base": null, "refs": { "BatchGetJobEntityResponse$errors": "A list of errors from the job error logs for the batch.
" } }, "BatchGetJobEntityList": { "base": null, "refs": { "BatchGetJobEntityResponse$entities": "A list of the job entities, or details, in the batch.
" } }, "BatchGetJobEntityRequest": { "base": null, "refs": { } }, "BatchGetJobEntityResponse": { "base": null, "refs": { } }, "BoundedString": { "base": null, "refs": { "MeteredProductSummary$family": "The family to which the metered product belongs.
", "MeteredProductSummary$vendor": "The vendor.
" } }, "BudgetActionToAdd": { "base": "The budget action to add.
", "refs": { "BudgetActionsToAdd$member": null } }, "BudgetActionToRemove": { "base": "The budget action to remove.
", "refs": { "BudgetActionsToRemove$member": null } }, "BudgetActionType": { "base": null, "refs": { "BudgetActionToAdd$type": "The type of budget action to add.
", "BudgetActionToRemove$type": "The type of budget action to remove.
", "ResponseBudgetAction$type": "The action taken on the budget once scheduling stops.
" } }, "BudgetActionsToAdd": { "base": null, "refs": { "CreateBudgetRequest$actions": "The budget actions to specify what happens when the budget runs out.
", "UpdateBudgetRequest$actionsToAdd": "The budget actions to add. Budget actions specify what happens when the budget runs out.
" } }, "BudgetActionsToRemove": { "base": null, "refs": { "UpdateBudgetRequest$actionsToRemove": "The budget actions to remove from the budget.
" } }, "BudgetId": { "base": null, "refs": { "BudgetSummary$budgetId": "The budget ID.
", "CreateBudgetResponse$budgetId": "The budget ID.
", "DeleteBudgetRequest$budgetId": "The budget ID of the budget to delete.
", "GetBudgetRequest$budgetId": "The budget ID.
", "GetBudgetResponse$budgetId": "The budget ID.
", "UpdateBudgetRequest$budgetId": "The budget ID to update.
" } }, "BudgetSchedule": { "base": "The start and end time of the budget.
", "refs": { "CreateBudgetRequest$schedule": "The schedule to associate with this budget.
", "GetBudgetResponse$schedule": "The budget schedule.
", "UpdateBudgetRequest$schedule": "The schedule to update.
" } }, "BudgetStatus": { "base": null, "refs": { "BudgetSummary$status": "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 status of the budget.
ACTIVE–Get a budget being evaluated.
INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.
The status to list for the budgets.
", "UpdateBudgetRequest$status": "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 budgets to include on the list.
" } }, "BudgetSummary": { "base": "The budget summary.
", "refs": { "BudgetSummaries$member": null } }, "CancelSessionActions": { "base": null, "refs": { "UpdateWorkerScheduleResponse$cancelSessionActions": "The session actions associated with the worker schedule to cancel.
" } }, "ClientToken": { "base": null, "refs": { "CreateBudgetRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateFarmRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateFleetRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateJobRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateLicenseEndpointRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateLimitRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateMonitorRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateQueueEnvironmentRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateQueueRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateStorageProfileRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "CreateWorkerRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "DeleteFleetRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateBudgetRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateFleetRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateJobRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateQueueEnvironmentRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateQueueRequest$clientToken": "The idempotency token to update in the queue.
", "UpdateSessionRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateStepRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateStorageProfileRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
", "UpdateTaskRequest$clientToken": "The unique token which the server uses to recognize retries of the same request.
" } }, "CombinationExpression": { "base": null, "refs": { "ParameterSpace$combination": "The combination expression to use in the search.
" } }, "ComparisonOperator": { "base": null, "refs": { "DateTimeFilterExpression$operator": "The type of comparison to use to filter the results.
", "ParameterFilterExpression$operator": "The type of comparison to use to filter results.
", "StringFilterExpression$operator": "The type of comparison to use for this search.
" } }, "CompletedStatus": { "base": null, "refs": { "UpdatedSessionActionInfo$completedStatus": "The status of the session upon completion.
" } }, "ConflictException": { "base": "Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
", "refs": { } }, "ConflictExceptionReason": { "base": null, "refs": { "ConflictException$reason": "A description of the error.
" } }, "ConsumedUsageLimit": { "base": null, "refs": { "BudgetSummary$approximateDollarLimit": "The approximate dollar limit of the budget.
", "CreateBudgetRequest$approximateDollarLimit": "The dollar limit based on consumed usage.
", "GetBudgetResponse$approximateDollarLimit": "The consumed usage limit for the budget.
", "UpdateBudgetRequest$approximateDollarLimit": "The dollar limit to update on the budget. Based on consumed usage.
" } }, "ConsumedUsages": { "base": "The consumed usage for the resource.
", "refs": { "BudgetSummary$usages": "The consumed usage for the budget.
", "GetBudgetResponse$usages": "The usages of the budget.
" } }, "CopyJobTemplateRequest": { "base": null, "refs": { } }, "CopyJobTemplateResponse": { "base": null, "refs": { } }, "CpuArchitectureType": { "base": null, "refs": { "CustomerManagedWorkerCapabilities$cpuArchitectureType": "The CPU architecture type for the customer managed worker capabilities.
", "ServiceManagedEc2InstanceCapabilities$cpuArchitectureType": "The CPU architecture type.
" } }, "CreateBudgetRequest": { "base": null, "refs": { } }, "CreateBudgetResponse": { "base": null, "refs": { } }, "CreateFarmRequest": { "base": null, "refs": { } }, "CreateFarmResponse": { "base": null, "refs": { } }, "CreateFleetRequest": { "base": null, "refs": { } }, "CreateFleetResponse": { "base": null, "refs": { } }, "CreateJobRequest": { "base": null, "refs": { } }, "CreateJobResponse": { "base": null, "refs": { } }, "CreateJobTargetTaskRunStatus": { "base": null, "refs": { "CreateJobRequest$targetTaskRunStatus": "The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
The security group IDs.
" } }, "CreateLicenseEndpointRequestSubnetIdsList": { "base": null, "refs": { "CreateLicenseEndpointRequest$subnetIds": "The subnet IDs.
" } }, "CreateLicenseEndpointResponse": { "base": null, "refs": { } }, "CreateLimitRequest": { "base": null, "refs": { } }, "CreateLimitResponse": { "base": null, "refs": { } }, "CreateMonitorRequest": { "base": null, "refs": { } }, "CreateMonitorResponse": { "base": null, "refs": { } }, "CreateQueueEnvironmentRequest": { "base": null, "refs": { } }, "CreateQueueEnvironmentResponse": { "base": null, "refs": { } }, "CreateQueueFleetAssociationRequest": { "base": null, "refs": { } }, "CreateQueueFleetAssociationResponse": { "base": null, "refs": { } }, "CreateQueueLimitAssociationRequest": { "base": null, "refs": { } }, "CreateQueueLimitAssociationResponse": { "base": null, "refs": { } }, "CreateQueueRequest": { "base": null, "refs": { } }, "CreateQueueResponse": { "base": null, "refs": { } }, "CreateStorageProfileRequest": { "base": null, "refs": { } }, "CreateStorageProfileResponse": { "base": null, "refs": { } }, "CreateWorkerRequest": { "base": null, "refs": { } }, "CreateWorkerResponse": { "base": null, "refs": { } }, "CreatedAt": { "base": null, "refs": { "BudgetSummary$createdAt": "The date and time the resource was created.
", "FarmSummary$createdAt": "The date and time the resource was created.
", "FleetSummary$createdAt": "The date and time the resource was created.
", "GetBudgetResponse$createdAt": "The date and time the resource was created.
", "GetFarmResponse$createdAt": "The date and time the resource was created.
", "GetFleetResponse$createdAt": "The date and time the resource was created.
", "GetJobResponse$createdAt": "The date and time the resource was created.
", "GetLimitResponse$createdAt": "The Unix timestamp of the date and time that the limit was created.
", "GetMonitorResponse$createdAt": "The UNIX timestamp of the date and time that the monitor was created.
", "GetQueueEnvironmentResponse$createdAt": "The date and time the resource was created.
", "GetQueueFleetAssociationResponse$createdAt": "The date and time the resource was created.
", "GetQueueLimitAssociationResponse$createdAt": "The Unix timestamp of the date and time that the association was created.
", "GetQueueResponse$createdAt": "The date and time the resource was created.
", "GetStepResponse$createdAt": "The date and time the resource was created.
", "GetStorageProfileResponse$createdAt": "The date and time the resource was created.
", "GetTaskResponse$createdAt": "The date and time the resource was created.
", "GetWorkerResponse$createdAt": "The date and time the resource was created.
", "JobSearchSummary$createdAt": "The date and time the resource was created.
", "JobSummary$createdAt": "The date and time the resource was created.
", "LimitSummary$createdAt": "The Unix timestamp of the date and time that the limit was created.
", "MonitorSummary$createdAt": "The UNIX timestamp of the date and time that the monitor was created.
", "QueueFleetAssociationSummary$createdAt": "The date and time the resource was created.
", "QueueLimitAssociationSummary$createdAt": "The Unix timestamp of the date and time that the association was created.
", "QueueSummary$createdAt": "The date and time the resource was created.
", "StepSearchSummary$createdAt": "The date and time the resource was created.
", "StepSummary$createdAt": "The date and time the resource was created.
", "TaskSummary$createdAt": "The date and time the resource was created.
", "WorkerSearchSummary$createdAt": "The date and time the resource was created.
", "WorkerSummary$createdAt": "The date and time the resource was created.
" } }, "CreatedBy": { "base": null, "refs": { "BudgetSummary$createdBy": "The user or system that created this resource.
", "FarmSummary$createdBy": "The user or system that created this resource.
", "FleetSummary$createdBy": "The user or system that created this resource.
", "GetBudgetResponse$createdBy": "The user or system that created this resource.
", "GetFarmResponse$createdBy": "The user or system that created this resource.
", "GetFleetResponse$createdBy": "The user or system that created this resource.
", "GetJobResponse$createdBy": "The user or system that created this resource.
", "GetLimitResponse$createdBy": "The user identifier of the person that created the limit.
", "GetMonitorResponse$createdBy": "The user name of the person that created the monitor.
", "GetQueueEnvironmentResponse$createdBy": "The user or system that created this resource.>
", "GetQueueFleetAssociationResponse$createdBy": "The user or system that created this resource.
", "GetQueueLimitAssociationResponse$createdBy": "The user identifier of the person that created the association.
", "GetQueueResponse$createdBy": "The user or system that created this resource.
", "GetStepResponse$createdBy": "The user or system that created this resource.
", "GetStorageProfileResponse$createdBy": "The user or system that created this resource.
", "GetTaskResponse$createdBy": "The user or system that created this resource.
", "GetWorkerResponse$createdBy": "The user or system that created this resource.
", "JobSearchSummary$createdBy": "The user or system that created this resource.
", "JobSummary$createdBy": "The user or system that created this resource.
", "LimitSummary$createdBy": "The user identifier of the person that created the limit.
", "MonitorSummary$createdBy": "The user name of the person that created the monitor.
", "QueueFleetAssociationSummary$createdBy": "The user or system that created this resource.
", "QueueLimitAssociationSummary$createdBy": "The user identifier of the person that created the association.
", "QueueSummary$createdBy": "The user or system that created this resource.
", "StepSearchSummary$createdBy": "The user or system that created this resource.
", "StepSummary$createdBy": "The user or system that created this resource.
", "TaskSummary$createdBy": "The user or system that created this resource.
", "WorkerSearchSummary$createdBy": "The user or system that created this resource.
", "WorkerSummary$createdBy": "The user or system that created this resource.
" } }, "CustomFleetAmountCapabilities": { "base": null, "refs": { "CustomerManagedWorkerCapabilities$customAmounts": "Custom requirement ranges for customer managed worker capabilities.
", "ServiceManagedEc2InstanceCapabilities$customAmounts": "The custom capability amounts to require for instances in this fleet.
" } }, "CustomFleetAttributeCapabilities": { "base": null, "refs": { "CustomerManagedWorkerCapabilities$customAttributes": "Custom attributes for the customer manged worker capabilities.
", "ServiceManagedEc2InstanceCapabilities$customAttributes": "The custom capability attributes to require for instances in this fleet.
" } }, "CustomerManagedFleetConfiguration": { "base": "The details of a customer managed fleet configuration.
", "refs": { "FleetConfiguration$customerManaged": "The customer managed fleets within a fleet configuration.
" } }, "CustomerManagedFleetOperatingSystemFamily": { "base": null, "refs": { "CustomerManagedWorkerCapabilities$osFamily": "The operating system (OS) family.
" } }, "CustomerManagedWorkerCapabilities": { "base": "The worker capabilities for a customer managed workflow.
", "refs": { "CustomerManagedFleetConfiguration$workerCapabilities": "The worker capabilities for a customer managed fleet configuration.
" } }, "DateTimeFilterExpression": { "base": "The time stamp in date-time format.
", "refs": { "SearchFilterExpression$dateTimeFilter": "Filters based on date and time.
" } }, "DefaultQueueBudgetAction": { "base": null, "refs": { "CreateQueueRequest$defaultBudgetAction": "The default action to take on a queue if a budget isn't configured.
", "GetQueueResponse$defaultBudgetAction": "The default action taken on a queue if a budget wasn't configured.
", "QueueSummary$defaultBudgetAction": "The default action taken on a queue summary if a budget wasn't configured.
", "UpdateQueueRequest$defaultBudgetAction": "The default action to take for a queue update if a budget isn't configured.
" } }, "DeleteBudgetRequest": { "base": null, "refs": { } }, "DeleteBudgetResponse": { "base": null, "refs": { } }, "DeleteFarmRequest": { "base": null, "refs": { } }, "DeleteFarmResponse": { "base": null, "refs": { } }, "DeleteFleetRequest": { "base": null, "refs": { } }, "DeleteFleetResponse": { "base": null, "refs": { } }, "DeleteLicenseEndpointRequest": { "base": null, "refs": { } }, "DeleteLicenseEndpointResponse": { "base": null, "refs": { } }, "DeleteLimitRequest": { "base": null, "refs": { } }, "DeleteLimitResponse": { "base": null, "refs": { } }, "DeleteMeteredProductRequest": { "base": null, "refs": { } }, "DeleteMeteredProductResponse": { "base": null, "refs": { } }, "DeleteMonitorRequest": { "base": null, "refs": { } }, "DeleteMonitorResponse": { "base": null, "refs": { } }, "DeleteQueueEnvironmentRequest": { "base": null, "refs": { } }, "DeleteQueueEnvironmentResponse": { "base": null, "refs": { } }, "DeleteQueueFleetAssociationRequest": { "base": null, "refs": { } }, "DeleteQueueFleetAssociationResponse": { "base": null, "refs": { } }, "DeleteQueueLimitAssociationRequest": { "base": null, "refs": { } }, "DeleteQueueLimitAssociationResponse": { "base": null, "refs": { } }, "DeleteQueueRequest": { "base": null, "refs": { } }, "DeleteQueueResponse": { "base": null, "refs": { } }, "DeleteStorageProfileRequest": { "base": null, "refs": { } }, "DeleteStorageProfileResponse": { "base": null, "refs": { } }, "DeleteWorkerRequest": { "base": null, "refs": { } }, "DeleteWorkerResponse": { "base": null, "refs": { } }, "DependenciesList": { "base": null, "refs": { "StepDetailsEntity$dependencies": "The dependencies for a step.
" } }, "DependencyConsumerResolutionStatus": { "base": null, "refs": { "StepConsumer$status": "The step consumer status.
", "StepDependency$status": "The step dependency status.
" } }, "DependencyCounts": { "base": "The number of dependencies for the consumer.
", "refs": { "GetStepResponse$dependencyCounts": "The number of dependencies in the step.
", "StepSummary$dependencyCounts": "The number of dependencies for the step.
" } }, "Description": { "base": null, "refs": { "BudgetActionToAdd$description": "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 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.
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 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 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.
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.
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.
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 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 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 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.
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.
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.
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.
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.
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.
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.
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 status to update the worker to.
" } }, "DisassociateMemberFromFarmRequest": { "base": null, "refs": { } }, "DisassociateMemberFromFarmResponse": { "base": null, "refs": { } }, "DisassociateMemberFromFleetRequest": { "base": null, "refs": { } }, "DisassociateMemberFromFleetResponse": { "base": null, "refs": { } }, "DisassociateMemberFromJobRequest": { "base": null, "refs": { } }, "DisassociateMemberFromJobResponse": { "base": null, "refs": { } }, "DisassociateMemberFromQueueRequest": { "base": null, "refs": { } }, "DisassociateMemberFromQueueResponse": { "base": null, "refs": { } }, "DnsName": { "base": null, "refs": { "GetLicenseEndpointResponse$dnsName": "The DNS name.
" } }, "Document": { "base": null, "refs": { "EnvironmentDetailsEntity$template": "The template used for the environment.
", "StepDetailsEntity$template": "The template for a step.
" } }, "Double": { "base": null, "refs": { "Stats$min": "The minimum of the usage statistics.
", "Stats$max": "The maximum among the usage statistics.
", "Stats$avg": "The average of the usage statistics.
", "Stats$sum": "The sum of the usage statistics.
", "StepAmountCapability$min": "The minimum amount.
", "StepAmountCapability$max": "The maximum amount.
", "StepAmountCapability$value": "The amount value.
" } }, "EbsIops": { "base": null, "refs": { "Ec2EbsVolume$iops": "The IOPS per volume.
" } }, "EbsThroughputMiB": { "base": null, "refs": { "Ec2EbsVolume$throughputMiB": "The throughput per volume in MiB.
" } }, "Ec2EbsVolume": { "base": "Specifies the EBS volume.
", "refs": { "ServiceManagedEc2InstanceCapabilities$rootEbsVolume": "The root EBS volume.
" } }, "Ec2MarketType": { "base": null, "refs": { "ServiceManagedEc2InstanceMarketOptions$type": "The Amazon EC2 instance type.
" } }, "EndedAt": { "base": null, "refs": { "GetJobResponse$endedAt": "The date and time the resource ended running.
", "GetSessionActionResponse$endedAt": "The date and time the resource ended running.
", "GetSessionResponse$endedAt": "The date and time the resource ended running.
", "GetStepResponse$endedAt": "The date and time the resource ended running.
", "GetTaskResponse$endedAt": "The date and time the resource ended running.
", "JobSearchSummary$endedAt": "The date and time the resource ended running.
", "JobSummary$endedAt": "The date and time the resource ended running.
", "SessionActionSummary$endedAt": "The date and time the resource ended running.
", "SessionSummary$endedAt": "The date and time the resource ended running.
", "StepSearchSummary$endedAt": "The date and time the resource ended running.
", "StepSummary$endedAt": "The date and time the resource ended running.
", "TaskSearchSummary$endedAt": "The date and time the resource ended running.
", "TaskSummary$endedAt": "The date and time the resource ended running.
", "WorkerSessionSummary$endedAt": "The date and time the resource ended running.
" } }, "EndsAt": { "base": null, "refs": { "FixedBudgetSchedule$endTime": "When the budget ends.
" } }, "EnvironmentDetailsEntity": { "base": "The details of a specified environment.
", "refs": { "JobEntity$environmentDetails": "The environment details for the job entity.
" } }, "EnvironmentDetailsError": { "base": "The error details for the environment.
", "refs": { "GetJobEntityError$environmentDetails": "The environment details for the failed job entity.
" } }, "EnvironmentDetailsIdentifiers": { "base": "The IDs of the job and environment.
", "refs": { "JobEntityIdentifiersUnion$environmentDetails": "The environment details.
" } }, "EnvironmentEnterSessionActionDefinition": { "base": "The environment ID to use to enter a session action.
", "refs": { "SessionActionDefinition$envEnter": "The environment to enter into.
" } }, "EnvironmentEnterSessionActionDefinitionSummary": { "base": "Defines the environment a session action enters in.
", "refs": { "SessionActionDefinitionSummary$envEnter": "The environment to enter into.
" } }, "EnvironmentExitSessionActionDefinition": { "base": "Defines the environment a session action exits from.
", "refs": { "SessionActionDefinition$envExit": "The environment to exit from.
" } }, "EnvironmentExitSessionActionDefinitionSummary": { "base": "A summary of the environment details for which a session action to exits.
", "refs": { "SessionActionDefinitionSummary$envExit": "The environment to exit from.
" } }, "EnvironmentId": { "base": null, "refs": { "AssignedEnvironmentEnterSessionActionDefinition$environmentId": "The environment ID of the assigned environment at the start of a session.
", "AssignedEnvironmentExitSessionActionDefinition$environmentId": "The environment ID of the assigned environment when exiting a session.
", "EnvironmentDetailsEntity$environmentId": "The environment ID.
", "EnvironmentDetailsError$environmentId": "The environment ID.
", "EnvironmentDetailsIdentifiers$environmentId": "The environment ID.
", "EnvironmentEnterSessionActionDefinition$environmentId": "The environment ID.
", "EnvironmentEnterSessionActionDefinitionSummary$environmentId": "The environment ID.
", "EnvironmentExitSessionActionDefinition$environmentId": "The environment ID.
", "EnvironmentExitSessionActionDefinitionSummary$environmentId": "The environment ID.
" } }, "EnvironmentName": { "base": null, "refs": { "GetQueueEnvironmentResponse$name": "The name of the queue environment.
", "QueueEnvironmentSummary$name": "The name of the queue environment.
" } }, "EnvironmentTemplate": { "base": null, "refs": { "CreateQueueEnvironmentRequest$template": "The environment template to use in the queue.
", "GetQueueEnvironmentResponse$template": "The template for the queue environment.
", "UpdateQueueEnvironmentRequest$template": "The template to update.
" } }, "EnvironmentTemplateType": { "base": null, "refs": { "CreateQueueEnvironmentRequest$templateType": "The template's file type, JSON or YAML.
The type of template for the queue environment.
", "UpdateQueueEnvironmentRequest$templateType": "The template type to update.
" } }, "ExceptionContext": { "base": null, "refs": { "AccessDeniedException$context": "Information about the resources in use when the exception was thrown.
", "ConflictException$context": "Information about the resources in use when the exception was thrown.
", "ResourceNotFoundException$context": "Information about the resources in use when the exception was thrown.
", "ServiceQuotaExceededException$context": "Information about the resources in use when the exception was thrown.
", "ThrottlingException$context": "Information about the resources in use when the exception was thrown.
", "ValidationException$context": "Information about the resources in use when the exception was thrown.
" } }, "FarmId": { "base": null, "refs": { "AssociateMemberToFarmRequest$farmId": "The ID of the farm to associate with the member.
", "AssociateMemberToFleetRequest$farmId": "The farm ID of the fleet to associate with the member.
", "AssociateMemberToJobRequest$farmId": "The farm ID of the job to associate with the member.
", "AssociateMemberToQueueRequest$farmId": "The farm ID of the queue to associate with the member.
", "AssumeFleetRoleForReadRequest$farmId": "The farm ID for the fleet's farm.
", "AssumeFleetRoleForWorkerRequest$farmId": "The farm ID for the fleet's farm.
", "AssumeQueueRoleForReadRequest$farmId": "The farm ID of the farm containing the queue.
", "AssumeQueueRoleForUserRequest$farmId": "The farm ID of the queue that the user assumes the role for.
", "AssumeQueueRoleForWorkerRequest$farmId": "The farm ID of the worker assuming the queue role.
", "BatchGetJobEntityRequest$farmId": "The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
", "CopyJobTemplateRequest$farmId": "The farm ID to copy.
", "CreateBudgetRequest$farmId": "The farm ID to include in this budget.
", "CreateFarmResponse$farmId": "The farm ID.
", "CreateFleetRequest$farmId": "The farm ID of the farm to connect to the fleet.
", "CreateJobRequest$farmId": "The farm ID of the farm to connect to the job.
", "CreateLimitRequest$farmId": "The farm ID of the farm that contains the limit.
", "CreateQueueEnvironmentRequest$farmId": "The farm ID of the farm to connect to the environment.
", "CreateQueueFleetAssociationRequest$farmId": "The ID of the farm that the queue and fleet belong to.
", "CreateQueueLimitAssociationRequest$farmId": "The unique identifier of the farm that contains the queue and limit to associate.
", "CreateQueueRequest$farmId": "The farm ID of the farm to connect to the queue.
", "CreateStorageProfileRequest$farmId": "The farm ID of the farm to connect to the storage profile.
", "CreateWorkerRequest$farmId": "The farm ID of the farm to connect to the worker.
", "DeleteBudgetRequest$farmId": "The farm ID of the farm to remove from the budget.
", "DeleteFarmRequest$farmId": "The farm ID of the farm to delete.
", "DeleteFleetRequest$farmId": "The farm ID of the farm to remove from the fleet.
", "DeleteLimitRequest$farmId": "The unique identifier of the farm that contains the limit to delete.
", "DeleteQueueEnvironmentRequest$farmId": "The farm ID of the farm from which to remove the queue environment.
", "DeleteQueueFleetAssociationRequest$farmId": "The farm ID of the farm that holds the queue-fleet association.
", "DeleteQueueLimitAssociationRequest$farmId": "The unique identifier of the farm that contains the queue and limit to disassociate.
", "DeleteQueueRequest$farmId": "The ID of the farm from which to remove the queue.
", "DeleteStorageProfileRequest$farmId": "The farm ID of the farm from which to remove the storage profile.
", "DeleteWorkerRequest$farmId": "The farm ID of the worker to delete.
", "DisassociateMemberFromFarmRequest$farmId": "The farm ID of the farm to disassociate from the member.
", "DisassociateMemberFromFleetRequest$farmId": "The farm ID of the fleet to disassociate a member from.
", "DisassociateMemberFromJobRequest$farmId": "The farm ID for the job to disassociate from the member.
", "DisassociateMemberFromQueueRequest$farmId": "The farm ID for the queue to disassociate from a member.
", "FarmMember$farmId": "The farm ID of the farm member.
", "FarmSummary$farmId": "The farm ID.
", "FleetMember$farmId": "The farm ID.
", "FleetSummary$farmId": "The farm ID.
", "GetBudgetRequest$farmId": "The farm ID of the farm connected to the budget.
", "GetFarmRequest$farmId": "The farm ID of the farm.
", "GetFarmResponse$farmId": "The farm ID of the farm to get.
", "GetFleetRequest$farmId": "The farm ID of the farm in the fleet.
", "GetFleetResponse$farmId": "The farm ID of the farm in the fleet.
", "GetJobRequest$farmId": "The farm ID of the farm in the job.
", "GetLimitRequest$farmId": "The unique identifier of the farm that contains the limit.
", "GetLimitResponse$farmId": "The unique identifier of the farm that contains the limit.
", "GetQueueEnvironmentRequest$farmId": "The farm ID for the queue environment.
", "GetQueueFleetAssociationRequest$farmId": "The farm ID of the farm that contains the queue-fleet association.
", "GetQueueLimitAssociationRequest$farmId": "The unique identifier of the farm that contains the associated queue and limit.
", "GetQueueRequest$farmId": "The farm ID of the farm in the queue.
", "GetQueueResponse$farmId": "The farm ID for the queue.
", "GetSessionActionRequest$farmId": "The farm ID for the session action.
", "GetSessionRequest$farmId": "The farm ID for the session.
", "GetSessionsStatisticsAggregationRequest$farmId": "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.
The farm ID for the step.
", "GetStorageProfileForQueueRequest$farmId": "The farm ID for the queue in storage profile.
", "GetStorageProfileRequest$farmId": "The farm ID for the storage profile.
", "GetTaskRequest$farmId": "The farm ID of the farm connected to the task.
", "GetWorkerRequest$farmId": "The farm ID for the worker.
", "GetWorkerResponse$farmId": "The farm ID.
", "JobMember$farmId": "The farm ID.
", "LimitSummary$farmId": "The unique identifier of the farm that contains the limit.
", "ListBudgetsRequest$farmId": "The farm ID associated with the budgets.
", "ListFarmMembersRequest$farmId": "The farm ID.
", "ListFleetMembersRequest$farmId": "The farm ID of the fleet.
", "ListFleetsRequest$farmId": "The farm ID of the fleets.
", "ListJobMembersRequest$farmId": "The farm ID of the job to list.
", "ListJobParameterDefinitionsRequest$farmId": "The farm ID of the job to list.
", "ListJobsRequest$farmId": "The farm ID for the jobs.
", "ListLimitsRequest$farmId": "The unique identifier of the farm that contains the limits.
", "ListQueueEnvironmentsRequest$farmId": "The farm ID for the queue environment list.
", "ListQueueFleetAssociationsRequest$farmId": "The farm ID for the queue-fleet association list.
", "ListQueueLimitAssociationsRequest$farmId": "The unique identifier of the farm that contains the limits and associations.
", "ListQueueMembersRequest$farmId": "The farm ID for the queue.
", "ListQueuesRequest$farmId": "The farm ID of the queue.
", "ListSessionActionsRequest$farmId": "The farm ID for the session actions list.
", "ListSessionsForWorkerRequest$farmId": "The farm ID for the session.
", "ListSessionsRequest$farmId": "The farm ID for the list of sessions.
", "ListStepConsumersRequest$farmId": "The farm ID for the list of step consumers.
", "ListStepDependenciesRequest$farmId": "The farm ID for the step dependencies list.
", "ListStepsRequest$farmId": "The farm ID to include on the list of steps.
", "ListStorageProfilesForQueueRequest$farmId": "The farm ID of the queue's storage profile.
", "ListStorageProfilesRequest$farmId": "The farm ID of the storage profile.
", "ListTasksRequest$farmId": "The farm ID connected to the tasks.
", "ListWorkersRequest$farmId": "The farm ID connected to the workers.
", "QueueMember$farmId": "The farm ID.
", "QueueSummary$farmId": "The farm ID.
", "SearchJobsRequest$farmId": "The farm ID of the job.
", "SearchStepsRequest$farmId": "The farm ID to use for the step search.
", "SearchTasksRequest$farmId": "The farm ID of the task.
", "SearchWorkersRequest$farmId": "The farm ID in the workers search.
", "StartSessionsStatisticsAggregationRequest$farmId": "The identifier of the farm that contains queues or fleets to return statistics for.
", "UpdateBudgetRequest$farmId": "The farm ID of the budget to update.
", "UpdateFarmRequest$farmId": "The farm ID to update.
", "UpdateFleetRequest$farmId": "The farm ID to update.
", "UpdateJobRequest$farmId": "The farm ID of the job to update.
", "UpdateLimitRequest$farmId": "The unique identifier of the farm that contains the limit.
", "UpdateQueueEnvironmentRequest$farmId": "The farm ID of the queue environment to update.
", "UpdateQueueFleetAssociationRequest$farmId": "The farm ID to update.
", "UpdateQueueLimitAssociationRequest$farmId": "The unique identifier of the farm that contains the associated queues and limits.
", "UpdateQueueRequest$farmId": "The farm ID to update in the queue.
", "UpdateSessionRequest$farmId": "The farm ID to update in the session.
", "UpdateStepRequest$farmId": "The farm ID to update.
", "UpdateStorageProfileRequest$farmId": "The farm ID to update.
", "UpdateTaskRequest$farmId": "The farm ID to update.
", "UpdateWorkerRequest$farmId": "The farm ID to update.
", "UpdateWorkerScheduleRequest$farmId": "The farm ID to update.
", "WorkerSummary$farmId": "The farm ID.
" } }, "FarmMember": { "base": "The member of a farm.
", "refs": { "FarmMembers$member": null } }, "FarmMembers": { "base": null, "refs": { "ListFarmMembersResponse$members": "The members on the list.
" } }, "FarmSummaries": { "base": null, "refs": { "ListFarmsResponse$farms": "Farms on the list.
" } }, "FarmSummary": { "base": "The summary of details for a farm.
", "refs": { "FarmSummaries$member": null } }, "FieldSortExpression": { "base": "The field sorting order and name of the field.
", "refs": { "SearchSortExpression$fieldSort": "Options for sorting by a field.
" } }, "FileSystemLocation": { "base": "The details of the file system location for the resource.
", "refs": { "FileSystemLocationsList$member": null } }, "FileSystemLocationName": { "base": null, "refs": { "FileSystemLocation$name": "The location name.
", "ManifestProperties$fileSystemLocationName": "The file system location name.
", "RequiredFileSystemLocationNames$member": null } }, "FileSystemLocationType": { "base": null, "refs": { "FileSystemLocation$type": "The type of file.
" } }, "FileSystemLocationsList": { "base": null, "refs": { "CreateStorageProfileRequest$fileSystemLocations": "File system paths to include in the storage profile.
", "GetStorageProfileForQueueResponse$fileSystemLocations": "The location of the files for the storage profile within the queue.
", "GetStorageProfileResponse$fileSystemLocations": "The location of the files for the storage profile.
", "UpdateStorageProfileRequest$fileSystemLocationsToAdd": "The file system location names to add.
", "UpdateStorageProfileRequest$fileSystemLocationsToRemove": "The file system location names to remove.
" } }, "FixedBudgetSchedule": { "base": "The details of a fixed budget schedule.
", "refs": { "BudgetSchedule$fixed": "The fixed start and end time of the budget's schedule.
" } }, "FleetAmountCapabilities": { "base": null, "refs": { "FleetCapabilities$amounts": "Amount capabilities of the fleet.
" } }, "FleetAmountCapability": { "base": "The fleet amount and attribute capabilities.
", "refs": { "CustomFleetAmountCapabilities$member": null, "FleetAmountCapabilities$member": null } }, "FleetAttributeCapabilities": { "base": null, "refs": { "FleetCapabilities$attributes": "Attribute capabilities of the fleet.
" } }, "FleetAttributeCapability": { "base": "Defines the fleet's capability name, minimum, and maximum.
", "refs": { "CustomFleetAttributeCapabilities$member": null, "FleetAttributeCapabilities$member": null } }, "FleetCapabilities": { "base": "The amounts and attributes of fleets.
", "refs": { "GetFleetResponse$capabilities": "Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
" } }, "FleetConfiguration": { "base": "Fleet configuration details.
", "refs": { "CreateFleetRequest$configuration": "The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
", "FleetSummary$configuration": "The configuration details for the fleet.
", "GetFleetResponse$configuration": "The configuration setting for the fleet.
", "UpdateFleetRequest$configuration": "The fleet configuration to update.
" } }, "FleetId": { "base": null, "refs": { "AssociateMemberToFleetRequest$fleetId": "The ID of the fleet to associate with a member.
", "AssumeFleetRoleForReadRequest$fleetId": "The fleet ID.
", "AssumeFleetRoleForWorkerRequest$fleetId": "The fleet ID that contains the worker.
", "AssumeQueueRoleForWorkerRequest$fleetId": "The fleet ID of the worker assuming the queue role.
", "BatchGetJobEntityRequest$fleetId": "The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
", "CreateFleetResponse$fleetId": "The fleet ID.
", "CreateQueueFleetAssociationRequest$fleetId": "The fleet ID.
", "CreateWorkerRequest$fleetId": "The fleet ID to connect to the worker.
", "DeleteFleetRequest$fleetId": "The fleet ID of the fleet to delete.
", "DeleteQueueFleetAssociationRequest$fleetId": "The fleet ID of the queue-fleet association.
", "DeleteWorkerRequest$fleetId": "The fleet ID of the worker to delete.
", "DisassociateMemberFromFleetRequest$fleetId": "The fleet ID of the fleet to from which to disassociate a member.
", "FleetMember$fleetId": "The fleet ID.
", "FleetSummary$fleetId": "The fleet ID.
", "GetFleetRequest$fleetId": "The fleet ID of the fleet to get.
", "GetFleetResponse$fleetId": "The fleet ID.
", "GetQueueFleetAssociationRequest$fleetId": "The fleet ID for the queue-fleet association.
", "GetQueueFleetAssociationResponse$fleetId": "The fleet ID for the queue-fleet association.
", "GetSessionResponse$fleetId": "The fleet ID for the session.
", "GetWorkerRequest$fleetId": "The fleet ID of the worker.
", "GetWorkerResponse$fleetId": "The fleet ID.
", "ListFleetMembersRequest$fleetId": "The fleet ID to include on the list.
", "ListQueueFleetAssociationsRequest$fleetId": "The fleet ID for the queue-fleet association list.
", "ListSessionsForWorkerRequest$fleetId": "The fleet ID for the session.
", "ListWorkersRequest$fleetId": "The fleet ID of the workers.
", "QueueFleetAssociationSummary$fleetId": "The fleet ID.
", "SearchWorkersRequestFleetIdsList$member": null, "SessionSummary$fleetId": "The fleet ID.
", "SessionsStatisticsResourcesFleetIdsList$member": null, "Statistics$fleetId": "The fleet ID.
", "UpdateFleetRequest$fleetId": "The fleet ID to update.
", "UpdateQueueFleetAssociationRequest$fleetId": "The fleet ID to update.
", "UpdateWorkerRequest$fleetId": "The fleet ID to update.
", "UpdateWorkerScheduleRequest$fleetId": "The fleet ID to update.
", "WorkerSearchSummary$fleetId": "The fleet ID.
", "WorkerSummary$fleetId": "The fleet ID.
" } }, "FleetMember": { "base": "The fleet member.
", "refs": { "FleetMembers$member": null } }, "FleetMembers": { "base": null, "refs": { "ListFleetMembersResponse$members": "The members on the list.
" } }, "FleetStatus": { "base": null, "refs": { "FleetSummary$status": "The status of the fleet.
", "GetFleetResponse$status": "The status of the fleet.
", "ListFleetsRequest$status": "The status of the fleet.
" } }, "FleetSummaries": { "base": null, "refs": { "ListFleetsResponse$fleets": "The fleets on the list.
" } }, "FleetSummary": { "base": "The details of a fleet.
", "refs": { "FleetSummaries$member": null } }, "Float": { "base": null, "refs": { "ConsumedUsages$approximateDollarUsage": "The amount of the budget consumed.
", "FleetAmountCapability$min": "The minimum amount of fleet worker capability.
", "FleetAmountCapability$max": "The maximum amount of the fleet worker capability.
", "WorkerAmountCapability$value": "The value of the worker amount capability.
" } }, "FloatString": { "base": null, "refs": { "JobParameter$float": "A double precision IEEE-754 floating point number represented as a string.
", "TaskParameterValue$float": "A double precision IEEE-754 floating point number represented as a string.
" } }, "GetBudgetRequest": { "base": null, "refs": { } }, "GetBudgetResponse": { "base": null, "refs": { } }, "GetFarmRequest": { "base": null, "refs": { } }, "GetFarmResponse": { "base": null, "refs": { } }, "GetFleetRequest": { "base": null, "refs": { } }, "GetFleetResponse": { "base": null, "refs": { } }, "GetJobEntityError": { "base": "The error for the job entity.
", "refs": { "BatchGetJobEntityErrors$member": null } }, "GetJobRequest": { "base": null, "refs": { } }, "GetJobResponse": { "base": null, "refs": { } }, "GetLicenseEndpointRequest": { "base": null, "refs": { } }, "GetLicenseEndpointResponse": { "base": null, "refs": { } }, "GetLicenseEndpointResponseSecurityGroupIdsList": { "base": null, "refs": { "GetLicenseEndpointResponse$securityGroupIds": "The security group IDs for the license endpoint.
" } }, "GetLicenseEndpointResponseSubnetIdsList": { "base": null, "refs": { "GetLicenseEndpointResponse$subnetIds": "The subnet IDs.
" } }, "GetLimitRequest": { "base": null, "refs": { } }, "GetLimitResponse": { "base": null, "refs": { } }, "GetMonitorRequest": { "base": null, "refs": { } }, "GetMonitorResponse": { "base": null, "refs": { } }, "GetQueueEnvironmentRequest": { "base": null, "refs": { } }, "GetQueueEnvironmentResponse": { "base": null, "refs": { } }, "GetQueueFleetAssociationRequest": { "base": null, "refs": { } }, "GetQueueFleetAssociationResponse": { "base": null, "refs": { } }, "GetQueueLimitAssociationRequest": { "base": null, "refs": { } }, "GetQueueLimitAssociationResponse": { "base": null, "refs": { } }, "GetQueueRequest": { "base": null, "refs": { } }, "GetQueueResponse": { "base": null, "refs": { } }, "GetSessionActionRequest": { "base": null, "refs": { } }, "GetSessionActionResponse": { "base": null, "refs": { } }, "GetSessionRequest": { "base": null, "refs": { } }, "GetSessionResponse": { "base": null, "refs": { } }, "GetSessionsStatisticsAggregationRequest": { "base": null, "refs": { } }, "GetSessionsStatisticsAggregationResponse": { "base": null, "refs": { } }, "GetStepRequest": { "base": null, "refs": { } }, "GetStepResponse": { "base": null, "refs": { } }, "GetStorageProfileForQueueRequest": { "base": null, "refs": { } }, "GetStorageProfileForQueueResponse": { "base": null, "refs": { } }, "GetStorageProfileRequest": { "base": null, "refs": { } }, "GetStorageProfileResponse": { "base": null, "refs": { } }, "GetTaskRequest": { "base": null, "refs": { } }, "GetTaskResponse": { "base": null, "refs": { } }, "GetWorkerRequest": { "base": null, "refs": { } }, "GetWorkerResponse": { "base": null, "refs": { } }, "HostConfiguration": { "base": "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 (\"\").
Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
", "GetFleetResponse$hostConfiguration": "The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
", "UpdateFleetRequest$hostConfiguration": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
", "UpdateWorkerResponse$hostConfiguration": "The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" } }, "HostConfigurationScript": { "base": null, "refs": { "HostConfiguration$scriptBody": "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).
" } }, "HostName": { "base": null, "refs": { "HostPropertiesRequest$hostName": "The host name.
", "HostPropertiesResponse$hostName": "The host name.
" } }, "HostPropertiesRequest": { "base": "The host property details.
", "refs": { "CreateWorkerRequest$hostProperties": "The IP address and host name of the worker.
", "UpdateWorkerRequest$hostProperties": "The host properties to update.
" } }, "HostPropertiesResponse": { "base": "The host property details.
", "refs": { "GetSessionResponse$hostProperties": "Provides the Amazon EC2 properties of the host.
", "GetWorkerResponse$hostProperties": "The host properties for the worker.
", "WorkerSearchSummary$hostProperties": "Provides the Amazon EC2 instance properties of the worker host.
", "WorkerSummary$hostProperties": "The host properties of the worker.
" } }, "IamRoleArn": { "base": null, "refs": { "CreateFleetRequest$roleArn": "The IAM role ARN for the role that the fleet's workers will use.
", "CreateMonitorRequest$roleArn": "The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.
", "CreateQueueRequest$roleArn": "The IAM role ARN that workers will use while running jobs for this queue.
", "GetFleetResponse$roleArn": "The IAM role ARN.
", "GetMonitorResponse$roleArn": "The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
", "GetQueueResponse$roleArn": "The IAM role ARN.
", "JobDetailsEntity$queueRoleArn": "The queue role ARN.
", "MonitorSummary$roleArn": "The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
", "UpdateFleetRequest$roleArn": "The IAM role ARN that the fleet's workers assume while running jobs.
", "UpdateMonitorRequest$roleArn": "The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
", "UpdateQueueRequest$roleArn": "The IAM role ARN that's used to run jobs from this queue.
" } }, "IdentityCenterApplicationArn": { "base": null, "refs": { "CreateMonitorResponse$identityCenterApplicationArn": "The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.
", "GetMonitorResponse$identityCenterApplicationArn": "The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
", "MonitorSummary$identityCenterApplicationArn": "The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
" } }, "IdentityCenterInstanceArn": { "base": null, "refs": { "CreateMonitorRequest$identityCenterInstanceArn": "The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.
", "GetMonitorResponse$identityCenterInstanceArn": "The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
", "MonitorSummary$identityCenterInstanceArn": "The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
" } }, "IdentityCenterPrincipalId": { "base": null, "refs": { "AssociateMemberToFarmRequest$principalId": "The member's principal ID to associate with the farm.
", "AssociateMemberToFleetRequest$principalId": "The member's principal ID to associate with a fleet.
", "AssociateMemberToJobRequest$principalId": "The member's principal ID to associate with the job.
", "AssociateMemberToQueueRequest$principalId": "The member's principal ID to associate with the queue.
", "DisassociateMemberFromFarmRequest$principalId": "A member's principal ID to disassociate from a farm.
", "DisassociateMemberFromFleetRequest$principalId": "A member's principal ID to disassociate from a fleet.
", "DisassociateMemberFromJobRequest$principalId": "A member's principal ID to disassociate from a job.
", "DisassociateMemberFromQueueRequest$principalId": "A member's principal ID to disassociate from a queue.
", "FarmMember$principalId": "The principal ID of the farm member.
", "FleetMember$principalId": "The principal ID of the fleet member.
", "JobMember$principalId": "The principal ID of the job member.
", "ListFarmsRequest$principalId": "The principal ID of the member to list on the farm.
", "ListFleetsRequest$principalId": "The principal ID of the members to include in the fleet.
", "ListJobsRequest$principalId": "The principal ID of the members on the jobs.
", "ListQueuesRequest$principalId": "The principal IDs to include in the list of queues.
", "QueueMember$principalId": "The principal ID of the queue member.
" } }, "IdentityStoreId": { "base": null, "refs": { "AssociateMemberToFarmRequest$identityStoreId": "The identity store ID of the member to associate with the farm.
", "AssociateMemberToFleetRequest$identityStoreId": "The member's identity store ID to associate with the fleet.
", "AssociateMemberToJobRequest$identityStoreId": "The member's identity store ID to associate with the job.
", "AssociateMemberToQueueRequest$identityStoreId": "The member's identity store ID to associate with the queue.
", "FarmMember$identityStoreId": "The identity store ID of the farm member.
", "FleetMember$identityStoreId": "The identity store ID.
", "JobMember$identityStoreId": "The identity store ID.
", "QueueMember$identityStoreId": "The identity store ID.
" } }, "InstanceType": { "base": null, "refs": { "HostPropertiesResponse$ec2InstanceType": "The instance type of the host EC2 instance.
", "InstanceTypes$member": null, "Statistics$instanceType": "The type of instance.
" } }, "InstanceTypes": { "base": null, "refs": { "ServiceManagedEc2InstanceCapabilities$allowedInstanceTypes": "The allowable Amazon EC2 instance types.
", "ServiceManagedEc2InstanceCapabilities$excludedInstanceTypes": "The instance types to exclude from the fleet.
" } }, "IntString": { "base": null, "refs": { "JobParameter$int": "A signed integer represented as a string.
", "TaskParameterValue$int": "A signed integer represented as a string.
" } }, "Integer": { "base": null, "refs": { "DependencyCounts$dependenciesResolved": "The number of resolved dependencies.
", "DependencyCounts$dependenciesUnresolved": "The number of unresolved dependencies.
", "DependencyCounts$consumersResolved": "The number of consumers resolved.
", "DependencyCounts$consumersUnresolved": "The number of unresolved consumers.
", "Ec2EbsVolume$sizeGiB": "The EBS volume size in GiB.
", "FleetSummary$targetWorkerCount": "The target number of workers in a fleet.
", "FleetSummary$workerCount": "The number of workers in the fleet summary.
", "GetFleetResponse$targetWorkerCount": "The number of target workers in the fleet.
", "GetFleetResponse$workerCount": "The number of workers in the fleet.
", "InternalServerErrorException$retryAfterSeconds": "The number of seconds a client should wait before retrying the request.
", "Statistics$count": "The number of instances in a list of statistics.
", "TaskRunStatusCounts$value": null, "ThrottlingException$retryAfterSeconds": "The number of seconds a client should wait before retrying the request.
" } }, "InternalServerErrorException": { "base": "Deadline Cloud can't process your request right now. Try again later.
", "refs": { } }, "IpAddresses": { "base": "The IP addresses for a host.
", "refs": { "HostPropertiesRequest$ipAddresses": "The IP address of the host.
", "HostPropertiesResponse$ipAddresses": "The IP address of the host.
" } }, "IpV4Address": { "base": null, "refs": { "IpV4Addresses$member": null } }, "IpV4Addresses": { "base": null, "refs": { "IpAddresses$ipV4Addresses": "The IpV4 address of the network.
" } }, "IpV6Address": { "base": null, "refs": { "IpV6Addresses$member": null } }, "IpV6Addresses": { "base": null, "refs": { "IpAddresses$ipV6Addresses": "The IpV6 address for the network and node component.
" } }, "JobAttachmentDetailsEntity": { "base": "The job attachments.
", "refs": { "JobEntity$jobAttachmentDetails": "The job attachment details.
" } }, "JobAttachmentDetailsError": { "base": "The error details for job attachments.
", "refs": { "GetJobEntityError$jobAttachmentDetails": "The job attachment details for the failed job entity.
" } }, "JobAttachmentDetailsIdentifiers": { "base": "Identifier details for job attachments.
", "refs": { "JobEntityIdentifiersUnion$jobAttachmentDetails": "The job attachment details.
" } }, "JobAttachmentSettings": { "base": "The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
", "refs": { "CreateQueueRequest$jobAttachmentSettings": "The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
", "GetQueueResponse$jobAttachmentSettings": "The job attachment settings for the queue.
", "JobDetailsEntity$jobAttachmentSettings": "The job attachment settings.
", "UpdateQueueRequest$jobAttachmentSettings": "The job attachment settings to update for the queue.
" } }, "JobAttachmentsFileSystem": { "base": null, "refs": { "Attachments$fileSystem": "The file system.
" } }, "JobDescription": { "base": null, "refs": { "GetJobResponse$description": "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.
The job details for a specific job.
", "refs": { "JobEntity$jobDetails": "The job details.
" } }, "JobDetailsError": { "base": "The details of a job error.
", "refs": { "GetJobEntityError$jobDetails": "The job details for the failed job entity.
" } }, "JobDetailsIdentifiers": { "base": "The identifiers for a job.
", "refs": { "JobEntityIdentifiersUnion$jobDetails": "The job details.
" } }, "JobEntity": { "base": "The details of a job entity.
", "refs": { "BatchGetJobEntityList$member": null } }, "JobEntityErrorCode": { "base": null, "refs": { "EnvironmentDetailsError$code": "The error code.
", "JobAttachmentDetailsError$code": "The error code.
", "JobDetailsError$code": "The error code.
", "StepDetailsError$code": "The error code.
" } }, "JobEntityIdentifiers": { "base": null, "refs": { "BatchGetJobEntityRequest$identifiers": "The job identifiers to include within the job entity batch details.
" } }, "JobEntityIdentifiersUnion": { "base": "The details of a job entity identifier.
", "refs": { "JobEntityIdentifiers$member": null } }, "JobId": { "base": null, "refs": { "AssignedSession$jobId": "The job ID for the assigned session.
", "AssociateMemberToJobRequest$jobId": "The job ID to associate with the member.
", "CopyJobTemplateRequest$jobId": "The job ID to copy.
", "CreateJobRequest$sourceJobId": "The job ID for the source job.
", "CreateJobResponse$jobId": "The job ID.
", "DisassociateMemberFromJobRequest$jobId": "The job ID to disassociate from a member in a job.
", "EnvironmentDetailsEntity$jobId": "The job ID.
", "EnvironmentDetailsError$jobId": "The job ID.
", "EnvironmentDetailsIdentifiers$jobId": "The job ID.
", "GetJobRequest$jobId": "The job ID.
", "GetJobResponse$jobId": "The job ID.
", "GetJobResponse$sourceJobId": "The job ID for the source job.
", "GetSessionActionRequest$jobId": "The job ID for the session.
", "GetSessionRequest$jobId": "The job ID for the session.
", "GetStepRequest$jobId": "The job ID for the step.
", "GetTaskRequest$jobId": "The job ID of the job connected to the task.
", "JobAttachmentDetailsEntity$jobId": "The job ID.
", "JobAttachmentDetailsError$jobId": "The job ID.
", "JobAttachmentDetailsIdentifiers$jobId": "The job ID.
", "JobDetailsEntity$jobId": "The job ID.
", "JobDetailsError$jobId": "The job ID.
", "JobDetailsIdentifiers$jobId": "The job ID.
", "JobMember$jobId": "The job ID.
", "JobSearchSummary$jobId": "The job ID.
", "JobSearchSummary$sourceJobId": "The job ID for the source job.
", "JobSummary$jobId": "The job ID.
", "JobSummary$sourceJobId": "The job ID for the source job.
", "ListJobMembersRequest$jobId": "The job ID to include on the list.
", "ListJobParameterDefinitionsRequest$jobId": "The job ID to include on the list.
", "ListSessionActionsRequest$jobId": "The job ID for the session actions list.
", "ListSessionsRequest$jobId": "The job ID for the list of sessions.
", "ListStepConsumersRequest$jobId": "The job ID for the step consumer.
", "ListStepDependenciesRequest$jobId": "The job ID for the step dependencies list.
", "ListStepsRequest$jobId": "The job ID to include on the list of steps.
", "ListTasksRequest$jobId": "The job ID for the tasks.
", "SearchStepsRequest$jobId": "The job ID to use in the step search.
", "SearchTasksRequest$jobId": "The job ID for the task search.
", "Statistics$jobId": "The job ID.
", "StepDetailsEntity$jobId": "The job ID.
", "StepDetailsError$jobId": "The job ID.
", "StepDetailsIdentifiers$jobId": "The job ID.
", "StepSearchSummary$jobId": "The job ID.
", "TaskSearchSummary$jobId": "The job ID.
", "UpdateJobRequest$jobId": "The job ID to update.
", "UpdateSessionRequest$jobId": "The job ID to update in the session.
", "UpdateStepRequest$jobId": "The job ID to update.
", "UpdateTaskRequest$jobId": "The job ID to update.
", "WorkerSessionSummary$jobId": "The job ID for the job associated with the worker's session.
" } }, "JobLifecycleStatus": { "base": null, "refs": { "GetJobResponse$lifecycleStatus": "The life cycle status for the job.
", "JobSearchSummary$lifecycleStatus": "The life cycle status.
", "JobSummary$lifecycleStatus": "The life cycle status.
" } }, "JobMember": { "base": "The details for a job member.
", "refs": { "JobMembers$member": null } }, "JobMembers": { "base": null, "refs": { "ListJobMembersResponse$members": "The members on the list.
" } }, "JobName": { "base": null, "refs": { "GetJobResponse$name": "The name of the job.
", "JobSearchSummary$name": "The job name.
", "JobSummary$name": "The job name.
", "Statistics$jobName": "The job name.
" } }, "JobParameter": { "base": "The details of job parameters.
", "refs": { "JobParameters$value": null } }, "JobParameterDefinition": { "base": null, "refs": { "JobParameterDefinitions$member": null } }, "JobParameterDefinitions": { "base": null, "refs": { "ListJobParameterDefinitionsResponse$jobParameterDefinitions": "Lists parameter definitions of a job.
" } }, "JobParameters": { "base": null, "refs": { "CreateJobRequest$parameters": "The parameters for the job.
", "GetJobResponse$parameters": "The parameters for the job.
", "JobDetailsEntity$parameters": "The parameters.
", "JobSearchSummary$jobParameters": "The job parameters.
" } }, "JobParametersKeyString": { "base": null, "refs": { "JobParameters$key": null } }, "JobPriority": { "base": null, "refs": { "CreateJobRequest$priority": "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.
", "GetJobResponse$priority": "The job priority.
", "JobSearchSummary$priority": "The job priority.
", "JobSummary$priority": "The job priority.
", "UpdateJobRequest$priority": "The job priority to update.
" } }, "JobRunAsUser": { "base": "Identifies the user for a job.
", "refs": { "CreateQueueRequest$jobRunAsUser": "The jobs in the queue run as the specified POSIX user.
", "GetQueueResponse$jobRunAsUser": "The jobs in the queue ran as this specified POSIX user.
", "JobDetailsEntity$jobRunAsUser": "The user name and group that the job uses when run.
", "UpdateQueueRequest$jobRunAsUser": "Update the jobs in the queue to run as a specified POSIX user.
" } }, "JobSearchSummaries": { "base": null, "refs": { "SearchJobsResponse$jobs": "The jobs in the search.
" } }, "JobSearchSummary": { "base": "The details of a job search.
", "refs": { "JobSearchSummaries$member": null } }, "JobSummaries": { "base": null, "refs": { "ListJobsResponse$jobs": "The jobs on the list.
" } }, "JobSummary": { "base": "A summary of job details.
", "refs": { "JobSummaries$member": null } }, "JobTargetTaskRunStatus": { "base": null, "refs": { "GetJobResponse$targetTaskRunStatus": "The task status with which the job started.
", "JobSearchSummary$targetTaskRunStatus": "The task status to start with on the job.
", "JobSummary$targetTaskRunStatus": "The task status to start with on the job.
", "UpdateJobRequest$targetTaskRunStatus": "The task status to update the job's tasks to.
" } }, "JobTemplate": { "base": null, "refs": { "CreateJobRequest$template": "The job template to use for this job.
" } }, "JobTemplateType": { "base": null, "refs": { "CopyJobTemplateResponse$templateType": "The format of the job template, either JSON or YAML.
The file type for the job template.
" } }, "KmsKeyArn": { "base": null, "refs": { "CreateFarmRequest$kmsKeyArn": "The ARN of the KMS key to use on the farm.
", "FarmSummary$kmsKeyArn": "The ARN for the KMS key.
", "GetFarmResponse$kmsKeyArn": "The ARN of the KMS key used on the farm.
" } }, "LicenseEndpointId": { "base": null, "refs": { "CreateLicenseEndpointResponse$licenseEndpointId": "The license endpoint ID.
", "DeleteLicenseEndpointRequest$licenseEndpointId": "The license endpoint ID of the license endpoint to delete.
", "DeleteMeteredProductRequest$licenseEndpointId": "The ID of the license endpoint from which to remove the metered product.
", "GetLicenseEndpointRequest$licenseEndpointId": "The license endpoint ID.
", "GetLicenseEndpointResponse$licenseEndpointId": "The license endpoint ID.
", "LicenseEndpointSummary$licenseEndpointId": "The license endpoint ID.
", "ListMeteredProductsRequest$licenseEndpointId": "The license endpoint ID to include on the list of metered products.
", "PutMeteredProductRequest$licenseEndpointId": "The license endpoint ID to add to the metered product.
" } }, "LicenseEndpointStatus": { "base": null, "refs": { "GetLicenseEndpointResponse$status": "The status of the license endpoint.
", "LicenseEndpointSummary$status": "The status of the license endpoint.
" } }, "LicenseEndpointSummaries": { "base": null, "refs": { "ListLicenseEndpointsResponse$licenseEndpoints": "The license endpoints.
" } }, "LicenseEndpointSummary": { "base": "The details for a license endpoint.
", "refs": { "LicenseEndpointSummaries$member": null } }, "LicenseProduct": { "base": null, "refs": { "Statistics$licenseProduct": "The licensed product.
" } }, "LimitId": { "base": null, "refs": { "AcquiredLimit$limitId": "The unique identifier of the limit.
", "CreateLimitResponse$limitId": "A unique identifier for the limit. Use this identifier in other operations, such as CreateQueueLimitAssociation and DeleteLimit.
The unique identifier of the limit to associate with the queue.
", "DeleteLimitRequest$limitId": "The unique identifier of the limit to delete.
", "DeleteQueueLimitAssociationRequest$limitId": "The unique identifier of the limit to disassociate.
", "GetLimitRequest$limitId": "The unique identifier of the limit to return.
", "GetLimitResponse$limitId": "The unique identifier of the limit.
", "GetQueueLimitAssociationRequest$limitId": "The unique identifier of the limit associated with the queue.
", "GetQueueLimitAssociationResponse$limitId": "The unique identifier of the limit associated with the queue.
", "LimitSummary$limitId": "The unique identifier of the limit.
", "ListQueueLimitAssociationsRequest$limitId": "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.
The unique identifier of the limit in the association.
", "UpdateLimitRequest$limitId": "The unique identifier of the limit to update.
", "UpdateQueueLimitAssociationRequest$limitId": "The unique identifier of the limit associated to the queue.
" } }, "LimitSummaries": { "base": null, "refs": { "ListLimitsResponse$limits": "A list of limits that the farm contains.
" } }, "LimitSummary": { "base": "Provides information about a specific limit.
", "refs": { "LimitSummaries$member": null } }, "ListAttributeCapabilityValue": { "base": null, "refs": { "StepAttributeCapability$anyOf": "Requires any of the step attributes in a given list.
", "StepAttributeCapability$allOf": "Requires all of the step attribute values.
" } }, "ListAvailableMeteredProductsRequest": { "base": null, "refs": { } }, "ListAvailableMeteredProductsResponse": { "base": null, "refs": { } }, "ListBudgetsRequest": { "base": null, "refs": { } }, "ListBudgetsResponse": { "base": null, "refs": { } }, "ListFarmMembersRequest": { "base": null, "refs": { } }, "ListFarmMembersResponse": { "base": null, "refs": { } }, "ListFarmsRequest": { "base": null, "refs": { } }, "ListFarmsResponse": { "base": null, "refs": { } }, "ListFleetMembersRequest": { "base": null, "refs": { } }, "ListFleetMembersResponse": { "base": null, "refs": { } }, "ListFleetsRequest": { "base": null, "refs": { } }, "ListFleetsResponse": { "base": null, "refs": { } }, "ListJobMembersRequest": { "base": null, "refs": { } }, "ListJobMembersResponse": { "base": null, "refs": { } }, "ListJobParameterDefinitionsRequest": { "base": null, "refs": { } }, "ListJobParameterDefinitionsResponse": { "base": null, "refs": { } }, "ListJobsRequest": { "base": null, "refs": { } }, "ListJobsResponse": { "base": null, "refs": { } }, "ListLicenseEndpointsRequest": { "base": null, "refs": { } }, "ListLicenseEndpointsResponse": { "base": null, "refs": { } }, "ListLimitsRequest": { "base": null, "refs": { } }, "ListLimitsResponse": { "base": null, "refs": { } }, "ListMeteredProductsRequest": { "base": null, "refs": { } }, "ListMeteredProductsResponse": { "base": null, "refs": { } }, "ListMonitorsRequest": { "base": null, "refs": { } }, "ListMonitorsResponse": { "base": null, "refs": { } }, "ListQueueEnvironmentsRequest": { "base": null, "refs": { } }, "ListQueueEnvironmentsResponse": { "base": null, "refs": { } }, "ListQueueFleetAssociationsRequest": { "base": null, "refs": { } }, "ListQueueFleetAssociationsResponse": { "base": null, "refs": { } }, "ListQueueLimitAssociationsRequest": { "base": null, "refs": { } }, "ListQueueLimitAssociationsResponse": { "base": null, "refs": { } }, "ListQueueMembersRequest": { "base": null, "refs": { } }, "ListQueueMembersResponse": { "base": null, "refs": { } }, "ListQueuesRequest": { "base": null, "refs": { } }, "ListQueuesResponse": { "base": null, "refs": { } }, "ListSessionActionsRequest": { "base": null, "refs": { } }, "ListSessionActionsResponse": { "base": null, "refs": { } }, "ListSessionsForWorkerRequest": { "base": null, "refs": { } }, "ListSessionsForWorkerResponse": { "base": null, "refs": { } }, "ListSessionsForWorkerSummaries": { "base": null, "refs": { "ListSessionsForWorkerResponse$sessions": "The sessions in the response.
" } }, "ListSessionsRequest": { "base": null, "refs": { } }, "ListSessionsResponse": { "base": null, "refs": { } }, "ListStepConsumersRequest": { "base": null, "refs": { } }, "ListStepConsumersRequestMaxResultsInteger": { "base": null, "refs": { "ListStepConsumersRequest$maxResults": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Log configuration details.
", "refs": { "AssignedSession$logConfiguration": "The log configuration for the worker's assigned session.
", "GetSessionResponse$log": "The session log.
", "GetSessionResponse$workerLog": "The worker log for the session.
", "GetWorkerResponse$log": "The logs for the associated worker.
", "UpdateWorkerResponse$log": "The worker log to update.
", "WorkerSummary$log": "The log configuration for the worker.
" } }, "LogDriver": { "base": null, "refs": { "LogConfiguration$logDriver": "The log drivers for worker related logs.
" } }, "LogError": { "base": null, "refs": { "LogConfiguration$error": "The log configuration error details.
" } }, "LogOptions": { "base": null, "refs": { "LogConfiguration$options": "The options for a log driver.
" } }, "LogParameters": { "base": null, "refs": { "LogConfiguration$parameters": "The parameters for the log configuration.
" } }, "LogicalOperator": { "base": null, "refs": { "SearchGroupedFilterExpressions$operator": "The operators to include in the search.
" } }, "ManifestProperties": { "base": "The details of the manifest that links a job's source information.
", "refs": { "ManifestPropertiesList$member": null } }, "ManifestPropertiesInputManifestHashString": { "base": null, "refs": { "ManifestProperties$inputManifestHash": "The hash value of the file.
" } }, "ManifestPropertiesInputManifestPathString": { "base": null, "refs": { "ManifestProperties$inputManifestPath": "The file path.
" } }, "ManifestPropertiesList": { "base": null, "refs": { "Attachments$manifests": "A list of manifests which describe job attachment configurations.
" } }, "ManifestPropertiesRootPathString": { "base": null, "refs": { "ManifestProperties$rootPath": "The file's root path.
" } }, "MaxCount": { "base": null, "refs": { "CreateLimitRequest$maxCount": "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.
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.
The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
The number of task failures before the job stops running and is marked as FAILED.
The number of task failures before the job stops running and is marked as FAILED.
The number of task failures before the job stops running and is marked as FAILED.
The number of task failures before the job stops running and is marked as FAILED.
The number of task failures before the job stops running and is marked as FAILED.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of limits to return in each page of results.
", "ListMeteredProductsRequest$maxResults": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of associations to return in each page of results.
", "ListQueueMembersRequest$maxResults": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of retries for each task.
", "GetJobResponse$maxRetriesPerTask": "The maximum number of retries per failed tasks.
", "JobSearchSummary$maxRetriesPerTask": "The maximum number of retries for a job.
", "JobSummary$maxRetriesPerTask": "The maximum number of retries for a job.
", "UpdateJobRequest$maxRetriesPerTask": "The maximum number of retries for a job.
" } }, "MaxWorkerCount": { "base": null, "refs": { "CreateJobRequest$maxWorkerCount": "The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of workers that can process tasks in the job.
" } }, "MembershipLevel": { "base": null, "refs": { "AssociateMemberToFarmRequest$membershipLevel": "The principal's membership level for the associated farm.
", "AssociateMemberToFleetRequest$membershipLevel": "The principal's membership level for the associated fleet.
", "AssociateMemberToJobRequest$membershipLevel": "The principal's membership level for the associated job.
", "AssociateMemberToQueueRequest$membershipLevel": "The principal's membership level for the associated queue.
", "FarmMember$membershipLevel": "The farm member's membership level.
", "FleetMember$membershipLevel": "The fleet member's membership level.
", "JobMember$membershipLevel": "The job member's membership level.
", "QueueMember$membershipLevel": "The queue member's membership level.
" } }, "MemoryAmountMiB": { "base": null, "refs": { "MemoryMiBRange$min": "The minimum amount of memory (in MiB).
", "MemoryMiBRange$max": "The maximum amount of memory (in MiB).
" } }, "MemoryMiBRange": { "base": "The range of memory in MiB.
", "refs": { "CustomerManagedWorkerCapabilities$memoryMiB": "The memory (MiB).
", "ServiceManagedEc2InstanceCapabilities$memoryMiB": "The memory, as MiB, for the Amazon EC2 instance type.
" } }, "MeteredProductId": { "base": null, "refs": { "DeleteMeteredProductRequest$productId": "The product ID to remove from the license endpoint.
", "MeteredProductSummary$productId": "The product ID.
", "PutMeteredProductRequest$productId": "The product ID to add to the metered product.
" } }, "MeteredProductSummary": { "base": "The details of a metered product.
", "refs": { "MeteredProductSummaryList$member": null } }, "MeteredProductSummaryList": { "base": null, "refs": { "ListAvailableMeteredProductsResponse$meteredProducts": "The metered products.
", "ListMeteredProductsResponse$meteredProducts": "The metered products to list.
" } }, "MinOneMaxInteger": { "base": null, "refs": { "AcquiredLimit$count": "The number of limit resources used.
" } }, "MinOneMaxTenThousand": { "base": null, "refs": { "VCpuCountRange$min": "The minimum amount of vCPU.
", "VCpuCountRange$max": "The maximum amount of vCPU.
" } }, "MinZeroMaxInteger": { "base": null, "refs": { "AcceleratorCountRange$min": "The minimum number of GPU accelerators in the worker host.
", "AcceleratorCountRange$max": "The maximum number of GPU accelerators in the worker host.
", "AcceleratorTotalMemoryMiBRange$min": "The minimum amount of memory to use for the accelerator, measured in MiB.
", "AcceleratorTotalMemoryMiBRange$max": "The maximum amount of memory to use for the accelerator, measured in MiB.
", "CreateFleetRequest$minWorkerCount": "The minimum number of workers for the fleet.
", "CreateFleetRequest$maxWorkerCount": "The maximum number of workers for the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The minimum number of workers in the fleet.
", "FleetSummary$maxWorkerCount": "The maximum number of workers specified in the fleet.
", "GetFleetResponse$minWorkerCount": "The minimum number of workers specified in the fleet.
", "GetFleetResponse$maxWorkerCount": "The maximum number of workers specified in the fleet.
", "GetLimitResponse$currentCount": "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.
", "LimitSummary$currentCount": "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.
", "UpdateFleetRequest$minWorkerCount": "The minimum number of workers in the fleet.
", "UpdateFleetRequest$maxWorkerCount": "The maximum number of workers in the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The unique identifier of the monitor.
", "DeleteMonitorRequest$monitorId": "The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.
The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.
The unique identifier for the monitor.
", "MonitorSummary$monitorId": "The unique identifier for the monitor.
", "UpdateMonitorRequest$monitorId": "The unique identifier of the monitor to update.
" } }, "MonitorSummaries": { "base": null, "refs": { "ListMonitorsResponse$monitors": "A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.
Provides information about a monitor in Deadline Cloud.
", "refs": { "MonitorSummaries$member": null } }, "NextItemOffset": { "base": null, "refs": { "SearchJobsResponse$nextItemOffset": "The next incremental starting point after the defined itemOffset.
The next incremental starting point after the defined itemOffset.
The next incremental starting point after the defined itemOffset.
The next incremental starting point after the defined itemOffset.
The file path relative to the directory.
" } }, "OutputRelativeDirectoriesListMemberString": { "base": null, "refs": { "OutputRelativeDirectoriesList$member": null } }, "ParameterFilterExpression": { "base": "The details of a filtered search for parameters.
", "refs": { "SearchFilterExpression$parameterFilter": "Filters by parameter.
" } }, "ParameterSortExpression": { "base": "Organizes parameters according to your specifications.
", "refs": { "SearchSortExpression$parameterSort": "Options for sorting by a parameter.
" } }, "ParameterSpace": { "base": "The details of a search for two or more step parameters.
", "refs": { "GetStepResponse$parameterSpace": "A list of step parameters and the combination expression for the step.
", "StepSearchSummary$parameterSpace": "The parameters and combination expressions for the search.
" } }, "ParameterString": { "base": null, "refs": { "JobParameter$string": "A UTF-8 string.
", "TaskParameterValue$string": "A UTF-8 string.
" } }, "ParameterValue": { "base": null, "refs": { "ParameterFilterExpression$value": "The parameter's value.
" } }, "PathFormat": { "base": null, "refs": { "ManifestProperties$rootPathFormat": "The format of the root path.
", "PathMappingRule$sourcePathFormat": "The source path format.
" } }, "PathMappingRule": { "base": "The details of a source and destination path.
", "refs": { "PathMappingRules$member": null } }, "PathMappingRules": { "base": null, "refs": { "JobDetailsEntity$pathMappingRules": "The path mapping rules.
" } }, "PathString": { "base": null, "refs": { "FileSystemLocation$path": "The file path.
", "JobParameter$path": "A file system path represented as a string.
", "TaskParameterValue$path": "A file system path represented as a string.
" } }, "Period": { "base": null, "refs": { "StartSessionsStatisticsAggregationRequest$period": "The period to aggregate the statistics.
" } }, "PortNumber": { "base": null, "refs": { "MeteredProductSummary$port": "The port on which the metered product should run.
" } }, "PosixUser": { "base": "The POSIX user.
", "refs": { "JobRunAsUser$posix": "The user and group that the jobs in the queue run as.
" } }, "PosixUserGroupString": { "base": null, "refs": { "PosixUser$group": "The name of the POSIX user's group.
" } }, "PosixUserUserString": { "base": null, "refs": { "PosixUser$user": "The name of the POSIX user.
" } }, "PrincipalType": { "base": null, "refs": { "AssociateMemberToFarmRequest$principalType": "The principal type of the member to associate with the farm.
", "AssociateMemberToFleetRequest$principalType": "The member's principal type to associate with the fleet.
", "AssociateMemberToJobRequest$principalType": "The member's principal type to associate with the job.
", "AssociateMemberToQueueRequest$principalType": "The member's principal type to associate with the queue.
", "FarmMember$principalType": "The principal type of the farm member.
", "FleetMember$principalType": "The principal type of the fleet member.
", "JobMember$principalType": "The principal type of the job member.
", "QueueMember$principalType": "The principal type of the queue member.
" } }, "Priority": { "base": null, "refs": { "CreateQueueEnvironmentRequest$priority": "Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.
", "GetQueueEnvironmentResponse$priority": "The priority of the queue environment.
", "QueueEnvironmentSummary$priority": "The queue environment's priority.
", "UpdateQueueEnvironmentRequest$priority": "The priority to update.
" } }, "ProcessExitCode": { "base": null, "refs": { "GetSessionActionResponse$processExitCode": "The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
", "UpdatedSessionActionInfo$processExitCode": "The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
" } }, "PutMeteredProductRequest": { "base": null, "refs": { } }, "PutMeteredProductResponse": { "base": null, "refs": { } }, "QueueBlockedReason": { "base": null, "refs": { "GetQueueResponse$blockedReason": "The reason the queue was blocked.
", "QueueSummary$blockedReason": "The reason the queue is blocked, if applicable.
" } }, "QueueEnvironmentId": { "base": null, "refs": { "CreateQueueEnvironmentResponse$queueEnvironmentId": "The queue environment ID.
", "DeleteQueueEnvironmentRequest$queueEnvironmentId": "The queue environment ID of the queue environment to delete.
", "GetQueueEnvironmentRequest$queueEnvironmentId": "The queue environment ID.
", "GetQueueEnvironmentResponse$queueEnvironmentId": "The queue environment ID.
", "QueueEnvironmentSummary$queueEnvironmentId": "The queue environment ID.
", "UpdateQueueEnvironmentRequest$queueEnvironmentId": "The queue environment ID to update.
" } }, "QueueEnvironmentSummaries": { "base": null, "refs": { "ListQueueEnvironmentsResponse$environments": "The environments to include in the queue environments list.
" } }, "QueueEnvironmentSummary": { "base": "The summary of a queue environment.
", "refs": { "QueueEnvironmentSummaries$member": null } }, "QueueFleetAssociationStatus": { "base": null, "refs": { "GetQueueFleetAssociationResponse$status": "The status of the queue-fleet association.
", "QueueFleetAssociationSummary$status": "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 queue-fleet associations on the list.
" } }, "QueueFleetAssociationSummary": { "base": "The details of a queue-fleet association.
", "refs": { "QueueFleetAssociationSummaries$member": null } }, "QueueId": { "base": null, "refs": { "AssignedSession$queueId": "The queue ID of the assigned session.
", "AssociateMemberToJobRequest$queueId": "The queue ID to associate to the member.
", "AssociateMemberToQueueRequest$queueId": "The ID of the queue to associate to the member.
", "AssumeQueueRoleForReadRequest$queueId": "The queue ID.
", "AssumeQueueRoleForUserRequest$queueId": "The queue ID of the queue that the user assumes the role for.
", "AssumeQueueRoleForWorkerRequest$queueId": "The queue ID of the worker assuming the queue role.
", "CopyJobTemplateRequest$queueId": "The queue ID to copy.
", "CreateJobRequest$queueId": "The ID of the queue that the job is submitted to.
", "CreateQueueEnvironmentRequest$queueId": "The queue ID to connect the queue and environment.
", "CreateQueueFleetAssociationRequest$queueId": "The queue ID.
", "CreateQueueLimitAssociationRequest$queueId": "The unique identifier of the queue to associate with the limit.
", "CreateQueueResponse$queueId": "The queue ID.
", "DeleteQueueEnvironmentRequest$queueId": "The queue ID of the queue environment to delete.
", "DeleteQueueFleetAssociationRequest$queueId": "The queue ID of the queue-fleet association.
", "DeleteQueueLimitAssociationRequest$queueId": "The unique identifier of the queue to disassociate.
", "DeleteQueueRequest$queueId": "The queue ID of the queue to delete.
", "DisassociateMemberFromJobRequest$queueId": "The queue ID connected to a job for which you're disassociating a member.
", "DisassociateMemberFromQueueRequest$queueId": "The queue ID of the queue in which you're disassociating from a member.
", "GetJobRequest$queueId": "The queue ID associated with the job.
", "GetQueueEnvironmentRequest$queueId": "The queue ID for the queue environment.
", "GetQueueFleetAssociationRequest$queueId": "The queue ID for the queue-fleet association.
", "GetQueueFleetAssociationResponse$queueId": "The queue ID for the queue-fleet association.
", "GetQueueLimitAssociationRequest$queueId": "The unique identifier of the queue associated with the limit.
", "GetQueueLimitAssociationResponse$queueId": "The unique identifier of the queue associated with the limit.
", "GetQueueRequest$queueId": "The queue ID for the queue to retrieve.
", "GetQueueResponse$queueId": "The queue ID.
", "GetSessionActionRequest$queueId": "The queue ID for the session action.
", "GetSessionRequest$queueId": "The queue ID for the session.
", "GetStepRequest$queueId": "The queue ID for the step.
", "GetStorageProfileForQueueRequest$queueId": "The queue ID the queue in the storage profile.
", "GetTaskRequest$queueId": "The queue ID for the queue connected to the task.
", "JobMember$queueId": "The queue ID.
", "JobSearchSummary$queueId": "The queue ID.
", "ListJobMembersRequest$queueId": "The queue ID to include on the list.
", "ListJobParameterDefinitionsRequest$queueId": "The queue ID to include on the list.
", "ListJobsRequest$queueId": "The queue ID for the job.
", "ListQueueEnvironmentsRequest$queueId": "The queue ID for the queue environment list.
", "ListQueueFleetAssociationsRequest$queueId": "The queue ID for the queue-fleet association list.
", "ListQueueLimitAssociationsRequest$queueId": "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.
The queue ID to include on the list.
", "ListSessionActionsRequest$queueId": "The queue ID for the session actions list.
", "ListSessionsRequest$queueId": "The queue ID for the list of sessions
", "ListStepConsumersRequest$queueId": "The queue ID for the step consumer.
", "ListStepDependenciesRequest$queueId": "The queue ID for the step dependencies list.
", "ListStepsRequest$queueId": "The queue ID to include on the list of steps.
", "ListStorageProfilesForQueueRequest$queueId": "The queue ID for the storage profile.
", "ListTasksRequest$queueId": "The queue ID connected to the tasks.
", "QueueFleetAssociationSummary$queueId": "The queue ID.
", "QueueLimitAssociationSummary$queueId": "The unique identifier of the queue in the association.
", "QueueMember$queueId": "The queue ID.
", "QueueSummary$queueId": "The queue ID.
", "SearchJobsRequestQueueIdsList$member": null, "SearchStepsRequestQueueIdsList$member": null, "SearchTasksRequestQueueIdsList$member": null, "SessionsStatisticsResourcesQueueIdsList$member": null, "Statistics$queueId": "The queue ID.
", "StepSearchSummary$queueId": "The queue ID.
", "TaskSearchSummary$queueId": "The queue ID.
", "UpdateJobRequest$queueId": "The queue ID of the job to update.
", "UpdateQueueEnvironmentRequest$queueId": "The queue ID of the queue environment to update.
", "UpdateQueueFleetAssociationRequest$queueId": "The queue ID to update.
", "UpdateQueueLimitAssociationRequest$queueId": "The unique identifier of the queue associated to the limit.
", "UpdateQueueRequest$queueId": "The queue ID to update.
", "UpdateSessionRequest$queueId": "The queue ID to update in the session.
", "UpdateStepRequest$queueId": "The queue ID to update.
", "UpdateTaskRequest$queueId": "The queue ID to update.
", "UsageTrackingResource$queueId": "The queue ID.
", "WorkerSessionSummary$queueId": "The queue ID for the queue associated to the worker.
" } }, "QueueLimitAssociationStatus": { "base": null, "refs": { "GetQueueLimitAssociationResponse$status": "The current status of the limit.
", "QueueLimitAssociationSummary$status": "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.
A list of associations between limits and queues in the farm specified in the request.
" } }, "QueueLimitAssociationSummary": { "base": "Provides information about the association between a queue and a limit.
", "refs": { "QueueLimitAssociationSummaries$member": null } }, "QueueMember": { "base": "The details of a queue member.
", "refs": { "QueueMemberList$member": null } }, "QueueMemberList": { "base": null, "refs": { "ListQueueMembersResponse$members": "The members on the list.
" } }, "QueueStatus": { "base": null, "refs": { "GetQueueResponse$status": "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 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.
That status of the queue.
" } }, "QueueSummaries": { "base": null, "refs": { "ListQueuesResponse$queues": "The queues on the list.
" } }, "QueueSummary": { "base": "The details of a queue summary.
", "refs": { "QueueSummaries$member": null } }, "RequiredFileSystemLocationNames": { "base": null, "refs": { "CreateQueueRequest$requiredFileSystemLocationNames": "The file system location name to include in the queue.
", "GetQueueResponse$requiredFileSystemLocationNames": "A list of the required file system location names in the queue.
", "UpdateQueueRequest$requiredFileSystemLocationNamesToAdd": "The required file system location names to add to the queue.
", "UpdateQueueRequest$requiredFileSystemLocationNamesToRemove": "The required file system location names to remove from the queue.
" } }, "ResourceName": { "base": null, "refs": { "BudgetSummary$displayName": "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 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 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 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 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 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.
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 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 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 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 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 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 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 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 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.
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 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 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.
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.
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.
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 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 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 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 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 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.
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 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.
The requested resource can't be found.
", "refs": { } }, "ResponseBudgetAction": { "base": "The details of a budget action.
", "refs": { "ResponseBudgetActionList$member": null } }, "ResponseBudgetActionList": { "base": null, "refs": { "GetBudgetResponse$actions": "The budget actions for the budget.
" } }, "RunAs": { "base": null, "refs": { "JobRunAsUser$runAs": "Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
" } }, "S3BucketName": { "base": null, "refs": { "JobAttachmentSettings$s3BucketName": "The Amazon S3 bucket name.
", "S3Location$bucketName": "The name of the Amazon S3 bucket.
" } }, "S3Key": { "base": null, "refs": { "S3Location$key": "The Amazon S3 object key that uniquely identifies the Amazon S3 bucket.
" } }, "S3Location": { "base": "The Amazon S3 location information.
", "refs": { "CopyJobTemplateRequest$targetS3Location": "The Amazon S3 bucket name and key where you would like to add a copy of the job template.
" } }, "S3Prefix": { "base": null, "refs": { "JobAttachmentSettings$rootPrefix": "The root prefix.
" } }, "SearchFilterExpression": { "base": "The type of search filter to apply.
", "refs": { "SearchFilterExpressions$member": null } }, "SearchFilterExpressions": { "base": null, "refs": { "SearchGroupedFilterExpressions$filters": "The filters to use for the search.
" } }, "SearchGroupedFilterExpressions": { "base": "The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
Filters by group.
", "SearchJobsRequest$filterExpressions": "The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
Defines how far into the scrollable list to start the return of results.
" } }, "SearchJobsRequestPageSizeInteger": { "base": null, "refs": { "SearchJobsRequest$pageSize": "Specifies the number of items per page for the resource.
" } }, "SearchJobsRequestQueueIdsList": { "base": null, "refs": { "SearchJobsRequest$queueIds": "The queue ID to use in the job search.
" } }, "SearchJobsResponse": { "base": null, "refs": { } }, "SearchSortExpression": { "base": "The resources to search.
", "refs": { "SearchSortExpressions$member": null } }, "SearchSortExpressions": { "base": null, "refs": { "SearchJobsRequest$sortExpressions": "The search terms for a resource.
", "SearchStepsRequest$sortExpressions": "The search terms for a resource.
", "SearchTasksRequest$sortExpressions": "The search terms for a resource.
", "SearchWorkersRequest$sortExpressions": "The search terms for a resource.
" } }, "SearchStepsRequest": { "base": null, "refs": { } }, "SearchStepsRequestItemOffsetInteger": { "base": null, "refs": { "SearchStepsRequest$itemOffset": "Defines how far into the scrollable list to start the return of results.
" } }, "SearchStepsRequestPageSizeInteger": { "base": null, "refs": { "SearchStepsRequest$pageSize": "Specifies the number of items per page for the resource.
" } }, "SearchStepsRequestQueueIdsList": { "base": null, "refs": { "SearchStepsRequest$queueIds": "The queue IDs in the step search.
" } }, "SearchStepsResponse": { "base": null, "refs": { } }, "SearchTasksRequest": { "base": null, "refs": { } }, "SearchTasksRequestItemOffsetInteger": { "base": null, "refs": { "SearchTasksRequest$itemOffset": "Defines how far into the scrollable list to start the return of results.
" } }, "SearchTasksRequestPageSizeInteger": { "base": null, "refs": { "SearchTasksRequest$pageSize": "Specifies the number of items per page for the resource.
" } }, "SearchTasksRequestQueueIdsList": { "base": null, "refs": { "SearchTasksRequest$queueIds": "The queue IDs to include in the search.
" } }, "SearchTasksResponse": { "base": null, "refs": { } }, "SearchTerm": { "base": null, "refs": { "SearchTermFilterExpression$searchTerm": "The term to search for.
" } }, "SearchTermFilterExpression": { "base": "Searches for a particular search term.
", "refs": { "SearchFilterExpression$searchTermFilter": "Filters by a specified search term.
" } }, "SearchTermMatchingType": { "base": null, "refs": { "SearchTermFilterExpression$matchType": "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 fleet ID of the workers to search for.
" } }, "SearchWorkersRequestItemOffsetInteger": { "base": null, "refs": { "SearchWorkersRequest$itemOffset": "Defines how far into the scrollable list to start the return of results.
" } }, "SearchWorkersRequestPageSizeInteger": { "base": null, "refs": { "SearchWorkersRequest$pageSize": "Specifies the number of items per page for the resource.
" } }, "SearchWorkersResponse": { "base": null, "refs": { } }, "SecretAccessKey": { "base": null, "refs": { "AwsCredentials$secretAccessKey": "The IAM secret access key.
" } }, "SecurityGroupId": { "base": null, "refs": { "CreateLicenseEndpointRequestSecurityGroupIdsList$member": null, "GetLicenseEndpointResponseSecurityGroupIdsList$member": null } }, "ServiceManagedEc2FleetConfiguration": { "base": "The configuration details for a service managed Amazon EC2 fleet.
", "refs": { "FleetConfiguration$serviceManagedEc2": "The service managed Amazon EC2 instances for a fleet configuration.
" } }, "ServiceManagedEc2InstanceCapabilities": { "base": "The Amazon EC2 instance capabilities.
", "refs": { "ServiceManagedEc2FleetConfiguration$instanceCapabilities": "The Amazon EC2 instance capabilities.
" } }, "ServiceManagedEc2InstanceMarketOptions": { "base": "The details of the Amazon EC2 instance market options for a service managed fleet.
", "refs": { "ServiceManagedEc2FleetConfiguration$instanceMarketOptions": "The Amazon EC2 market type.
" } }, "ServiceManagedFleetOperatingSystemFamily": { "base": null, "refs": { "ServiceManagedEc2InstanceCapabilities$osFamily": "The operating system (OS) family.
" } }, "ServiceQuotaExceededException": { "base": "You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
", "refs": { } }, "ServiceQuotaExceededExceptionReason": { "base": null, "refs": { "ServiceQuotaExceededException$reason": "A string that describes the reason the quota was exceeded.
" } }, "SessionActionDefinition": { "base": "The definition of the session action.
", "refs": { "GetSessionActionResponse$definition": "The session action definition.
" } }, "SessionActionDefinitionSummary": { "base": "The details of a session action definition.
", "refs": { "SessionActionSummary$definition": "The session action definition.
" } }, "SessionActionId": { "base": null, "refs": { "AssignedSessionAction$sessionActionId": "The session action ID for the assigned session.
", "GetSessionActionRequest$sessionActionId": "The session action ID for the session.
", "GetSessionActionResponse$sessionActionId": "The session action ID.
", "GetTaskResponse$latestSessionActionId": "The latest session ID for the task.
", "SessionActionIdList$member": null, "SessionActionSummary$sessionActionId": "The session action ID.
", "TaskSummary$latestSessionActionId": "The latest session action for the task.
", "UpdatedSessionActions$key": null } }, "SessionActionIdList": { "base": null, "refs": { "CancelSessionActions$value": null } }, "SessionActionProgressMessage": { "base": null, "refs": { "GetSessionActionResponse$progressMessage": "The message that communicates the progress of the session action.
", "UpdatedSessionActionInfo$progressMessage": "A message to indicate the progress of the updated session action.
" } }, "SessionActionProgressPercent": { "base": null, "refs": { "GetSessionActionResponse$progressPercent": "The percentage completed for a session action.
", "SessionActionSummary$progressPercent": "The completion percentage for the session action.
", "UpdatedSessionActionInfo$progressPercent": "The percentage completed.
" } }, "SessionActionStatus": { "base": null, "refs": { "GetSessionActionResponse$status": "The status of the session action.
", "SessionActionSummary$status": "The status of the session action.
" } }, "SessionActionSummaries": { "base": null, "refs": { "ListSessionActionsResponse$sessionActions": "The session actions.
" } }, "SessionActionSummary": { "base": "The details of a session action.
", "refs": { "SessionActionSummaries$member": null } }, "SessionId": { "base": null, "refs": { "AssignedSessions$key": null, "CancelSessionActions$key": null, "GetSessionActionResponse$sessionId": "The session ID for the session action.
", "GetSessionRequest$sessionId": "The session ID.
", "GetSessionResponse$sessionId": "The session ID.
", "ListSessionActionsRequest$sessionId": "The session ID to include on the sessions action list.
", "SessionSummary$sessionId": "The session ID.
", "UpdateSessionRequest$sessionId": "The session ID to update.
", "WorkerSessionSummary$sessionId": "The session ID for the session action.
" } }, "SessionLifecycleStatus": { "base": null, "refs": { "GetSessionResponse$lifecycleStatus": "The life cycle status of the session.
", "SessionSummary$lifecycleStatus": "The life cycle status for the session.
", "WorkerSessionSummary$lifecycleStatus": "The life cycle status for the worker's session.
" } }, "SessionLifecycleTargetStatus": { "base": null, "refs": { "GetSessionResponse$targetLifecycleStatus": "The life cycle status with which the session started.
", "SessionSummary$targetLifecycleStatus": "The target life cycle status for the session.
", "UpdateSessionRequest$targetLifecycleStatus": "The life cycle status to update in the session.
", "WorkerSessionSummary$targetLifecycleStatus": "The life cycle status
" } }, "SessionSummaries": { "base": null, "refs": { "ListSessionsResponse$sessions": "The sessions on the list.
" } }, "SessionSummary": { "base": "The summary of a session.
", "refs": { "SessionSummaries$member": null } }, "SessionToken": { "base": null, "refs": { "AwsCredentials$sessionToken": "The IAM session token
" } }, "SessionsStatisticsAggregationStatus": { "base": null, "refs": { "GetSessionsStatisticsAggregationResponse$status": "The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.
If you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.
Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both.
", "refs": { "StartSessionsStatisticsAggregationRequest$resourceIds": "A list of fleet IDs or queue IDs to gather statistics for.
" } }, "SessionsStatisticsResourcesFleetIdsList": { "base": null, "refs": { "SessionsStatisticsResources$fleetIds": "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.
One to 10 queue IDs that specify the queues to return statistics for. If you specify the queueIds field, you can't specify the fleetIds field.
The sort order for the field.
", "ParameterSortExpression$sortOrder": "The sort order for the parameter.
" } }, "StartSessionsStatisticsAggregationRequest": { "base": null, "refs": { } }, "StartSessionsStatisticsAggregationResponse": { "base": null, "refs": { } }, "StartedAt": { "base": null, "refs": { "GetJobResponse$startedAt": "The date and time the resource started running.
", "GetSessionActionResponse$startedAt": "The date and time the resource started running.
", "GetSessionResponse$startedAt": "The date and time the resource started running.
", "GetStepResponse$startedAt": "The date and time the resource started running.
", "GetTaskResponse$startedAt": "The date and time the resource started running.
", "JobSearchSummary$startedAt": "The date and time the resource started running.
", "JobSummary$startedAt": "The date and time the resource started running.
", "SessionActionSummary$startedAt": "The date and time the resource started running.
", "SessionSummary$startedAt": "The date and time the resource started running.
", "StepSearchSummary$startedAt": "The date and time the resource started running.
", "StepSummary$startedAt": "The date and time the resource started running.
", "TaskSearchSummary$startedAt": "The date and time the resource started running.
", "TaskSummary$startedAt": "The date and time the resource started running.
", "WorkerSessionSummary$startedAt": "The date and time the resource started running.
" } }, "StartsAt": { "base": null, "refs": { "FixedBudgetSchedule$startTime": "When the budget starts.
" } }, "Statistics": { "base": "A list of statistics for a session.
", "refs": { "StatisticsList$member": null } }, "StatisticsList": { "base": null, "refs": { "GetSessionsStatisticsAggregationResponse$statistics": "The statistics for the specified fleets or queues.
" } }, "Stats": { "base": "The minimum, maximum, average, and sum.
", "refs": { "Statistics$costInUsd": "How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
", "Statistics$runtimeInSeconds": "The total aggregated runtime.
" } }, "StatusMessage": { "base": null, "refs": { "GetLicenseEndpointResponse$statusMessage": "The status message of the license endpoint.
", "LicenseEndpointSummary$statusMessage": "The status message of the license endpoint.
" } }, "StepAmountCapabilities": { "base": null, "refs": { "StepRequiredCapabilities$amounts": "The capability amounts that the step requires.
" } }, "StepAmountCapability": { "base": "The details outlining the minimum and maximum capability of a step.
", "refs": { "StepAmountCapabilities$member": null } }, "StepAttributeCapabilities": { "base": null, "refs": { "StepRequiredCapabilities$attributes": "The capability attributes that the step requires.
" } }, "StepAttributeCapability": { "base": "The list of step attributes.
", "refs": { "StepAttributeCapabilities$member": null } }, "StepConsumer": { "base": "The details of a step consumer.
", "refs": { "StepConsumers$member": null } }, "StepConsumers": { "base": null, "refs": { "ListStepConsumersResponse$consumers": "The consumers on the list.
" } }, "StepDependencies": { "base": null, "refs": { "ListStepDependenciesResponse$dependencies": "The dependencies on the list.
" } }, "StepDependency": { "base": "The details of step dependency.
", "refs": { "StepDependencies$member": null } }, "StepDescription": { "base": null, "refs": { "GetStepResponse$description": "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 details of a step entity.
", "refs": { "JobEntity$stepDetails": "The step details.
" } }, "StepDetailsError": { "base": "The details of the step error.
", "refs": { "GetJobEntityError$stepDetails": "The step details for the failed job entity.
" } }, "StepDetailsIdentifiers": { "base": "The details of identifiers for a step.
", "refs": { "JobEntityIdentifiersUnion$stepDetails": "The step details.
" } }, "StepId": { "base": null, "refs": { "AssignedSyncInputJobAttachmentsSessionActionDefinition$stepId": "The step ID.
", "AssignedTaskRunSessionActionDefinition$stepId": "The step ID.
", "DependenciesList$member": null, "GetStepRequest$stepId": "The step ID.
", "GetStepResponse$stepId": "The step ID.
", "GetTaskRequest$stepId": "The step ID for the step connected to the task.
", "ListStepConsumersRequest$stepId": "The step ID to include on the list.
", "ListStepDependenciesRequest$stepId": "The step ID to include on the list.
", "ListTasksRequest$stepId": "The step ID for the tasks.
", "StepConsumer$stepId": "The step ID.
", "StepDependency$stepId": "The step ID.
", "StepDetailsEntity$stepId": "The step ID.
", "StepDetailsError$stepId": "The step ID.
", "StepDetailsIdentifiers$stepId": "The step ID.
", "StepSearchSummary$stepId": "The step ID.
", "StepSummary$stepId": "The step ID.
", "SyncInputJobAttachmentsSessionActionDefinition$stepId": "The step ID for the step in the job attachment.
", "SyncInputJobAttachmentsSessionActionDefinitionSummary$stepId": "The step ID of the step in the job attachment.
", "TaskRunSessionActionDefinition$stepId": "The step ID.
", "TaskRunSessionActionDefinitionSummary$stepId": "The step ID.
", "TaskSearchSummary$stepId": "The step ID.
", "UpdateStepRequest$stepId": "The step ID to update.
", "UpdateTaskRequest$stepId": "The step ID to update.
" } }, "StepLifecycleStatus": { "base": null, "refs": { "GetStepResponse$lifecycleStatus": "The life cycle status of the step.
", "StepSearchSummary$lifecycleStatus": "The life cycle status.
", "StepSummary$lifecycleStatus": "The life cycle status.
" } }, "StepName": { "base": null, "refs": { "GetStepResponse$name": "The name of the step.
", "StepSearchSummary$name": "The step name.
", "StepSummary$name": "The name of the step.
" } }, "StepParameter": { "base": "The details of a step parameter.
", "refs": { "StepParameterList$member": null } }, "StepParameterList": { "base": null, "refs": { "ParameterSpace$parameters": "The parameters to search for.
" } }, "StepParameterName": { "base": null, "refs": { "StepParameter$name": "The name of the parameter.
" } }, "StepParameterType": { "base": null, "refs": { "StepParameter$type": "The data type of the parameter.
" } }, "StepRequiredCapabilities": { "base": "The details of required step capabilities.
", "refs": { "GetStepResponse$requiredCapabilities": "The required capabilities of the step.
" } }, "StepSearchSummaries": { "base": null, "refs": { "SearchStepsResponse$steps": "The steps in the search.
" } }, "StepSearchSummary": { "base": "The details of a step search.
", "refs": { "StepSearchSummaries$member": null } }, "StepSummaries": { "base": null, "refs": { "ListStepsResponse$steps": "The steps on the list.
" } }, "StepSummary": { "base": "The details for a step.
", "refs": { "StepSummaries$member": null } }, "StepTargetTaskRunStatus": { "base": null, "refs": { "GetStepResponse$targetTaskRunStatus": "The task status with which the job started.
", "StepSearchSummary$targetTaskRunStatus": "The task status to start with on the job.
", "StepSummary$targetTaskRunStatus": "The task status to start with on the job.
", "UpdateStepRequest$targetTaskRunStatus": "The task status to update the step's tasks to.
" } }, "StorageProfileId": { "base": null, "refs": { "AllowedStorageProfileIds$member": null, "CreateJobRequest$storageProfileId": "The storage profile ID for the storage profile to connect to the job.
", "CreateStorageProfileResponse$storageProfileId": "The storage profile ID.
", "CustomerManagedFleetConfiguration$storageProfileId": "The storage profile ID.
", "DeleteStorageProfileRequest$storageProfileId": "The storage profile ID of the storage profile to delete.
", "GetJobResponse$storageProfileId": "The storage profile ID associated with the job.
", "GetStorageProfileForQueueRequest$storageProfileId": "The storage profile ID for the storage profile in the queue.
", "GetStorageProfileForQueueResponse$storageProfileId": "The storage profile ID.
", "GetStorageProfileRequest$storageProfileId": "The storage profile ID.
", "GetStorageProfileResponse$storageProfileId": "The storage profile ID.
", "ServiceManagedEc2FleetConfiguration$storageProfileId": "The storage profile ID.
", "StorageProfileSummary$storageProfileId": "The storage profile ID.
", "UpdateStorageProfileRequest$storageProfileId": "The storage profile ID to update.
" } }, "StorageProfileOperatingSystemFamily": { "base": null, "refs": { "CreateStorageProfileRequest$osFamily": "The type of operating system (OS) for the storage profile.
", "GetStorageProfileForQueueResponse$osFamily": "The operating system of the storage profile in the queue.
", "GetStorageProfileResponse$osFamily": "The operating system (OS) for the storage profile.
", "StorageProfileSummary$osFamily": "The operating system (OS) family.
", "UpdateStorageProfileRequest$osFamily": "The OS system to update.
" } }, "StorageProfileSummaries": { "base": null, "refs": { "ListStorageProfilesForQueueResponse$storageProfiles": "The storage profiles in the queue.
", "ListStorageProfilesResponse$storageProfiles": "The storage profiles.
" } }, "StorageProfileSummary": { "base": "The details of a storage profile.
", "refs": { "StorageProfileSummaries$member": null } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "ConflictException$resourceId": "The identifier of the resource in use.
", "ConflictException$resourceType": "The type of the resource in use.
", "DateTimeFilterExpression$name": "The name of the date-time field to filter on.
", "EnvironmentDetailsEntity$schemaVersion": "The schema version in the environment.
", "EnvironmentDetailsError$message": "The error message detailing the error's cause.
", "ExceptionContext$key": null, "ExceptionContext$value": null, "FieldSortExpression$name": "The name of the field.
", "FleetSummary$statusMessage": "A message that communicates a suspended status of the fleet.
", "GetFleetResponse$statusMessage": "A message that communicates a suspended status of the fleet.
", "GetJobResponse$lifecycleStatusMessage": "A message that communicates the status of the life cycle for the job.
", "GetSessionsStatisticsAggregationRequest$nextToken": "The token for the next set of results, or null to start from the beginning.
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.
A message that describes the status.
", "GetStepResponse$lifecycleStatusMessage": "A message that describes the lifecycle status of the step.
", "HostPropertiesResponse$ec2InstanceArn": "The ARN of the host EC2 instance.
", "InternalServerErrorException$message": null, "JobAttachmentDetailsError$message": "The error message detailing the error's cause.
", "JobDetailsEntity$logGroupName": "The log group name.
", "JobDetailsEntity$schemaVersion": "The schema version.
", "JobDetailsError$message": "The error message detailing the error's cause.
", "JobSearchSummary$lifecycleStatusMessage": "The life cycle status message.
", "JobSummary$lifecycleStatusMessage": "The life cycle status message.
", "ListAvailableMeteredProductsRequest$nextToken": "The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
The token for the next set of results, or null to start from the beginning.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The resource ARN to list tags for.
", "ListTasksRequest$nextToken": "The token for the next set of results, or null to start from the beginning.
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.
The token for the next set of results, or null to start from the beginning.
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.
The name of the parameter to filter on.
", "ParameterSortExpression$name": "The parameter name to sort by.
", "PathMappingRule$sourcePath": "The source path.
", "PathMappingRule$destinationPath": "The destination path.
", "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "The identifier of the resource that couldn't be found.
", "ResourceNotFoundException$resourceType": "The type of the resource that couldn't be found.
", "ServiceQuotaExceededException$message": null, "ServiceQuotaExceededException$resourceType": "The type of the affected resource
", "ServiceQuotaExceededException$serviceCode": "Identifies the service that exceeded the quota.
", "ServiceQuotaExceededException$quotaCode": "Identifies the quota that has been exceeded.
", "ServiceQuotaExceededException$resourceId": "The identifier of the affected resource.
", "StepDetailsEntity$schemaVersion": "The schema version for a step template.
", "StepDetailsError$message": "The error message detailing the error's cause.
", "StepSearchSummary$lifecycleStatusMessage": "The life cycle status message.
", "StepSummary$lifecycleStatusMessage": "A message that describes the lifecycle of the step.
", "StringFilterExpression$name": "The field name to search.
", "StringList$member": null, "TagResourceRequest$resourceArn": "The ARN of the resource to apply tags to.
", "Tags$key": null, "Tags$value": null, "TaskParameterValue$chunkInt": "A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.
", "TaskParameters$key": null, "TaskRunManifestPropertiesResponse$outputManifestPath": "The manifest file path.
", "TaskRunManifestPropertiesResponse$outputManifestHash": "The hash value of the file.
", "ThrottlingException$message": null, "ThrottlingException$serviceCode": "Identifies the service that is being throttled.
", "ThrottlingException$quotaCode": "Identifies the quota that is being throttled.
", "UntagResourceRequest$resourceArn": "The ARN of the resource to remove the tag from.
", "UserJobsFirst$userIdentityId": "The user's ID.
", "ValidationException$message": null, "ValidationExceptionField$name": "The name of the validation exception.
", "ValidationExceptionField$message": "The error message for the validation exception.
" } }, "StringFilter": { "base": null, "refs": { "StringFilterExpression$value": "The string to search for.
" } }, "StringFilterExpression": { "base": "Searches for a particular string.
", "refs": { "SearchFilterExpression$stringFilter": "Filters by a string.
" } }, "StringList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "They keys of the tag.
" } }, "Subdomain": { "base": null, "refs": { "CreateMonitorRequest$subdomain": "The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "GetMonitorResponse$subdomain": "The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "MonitorSummary$subdomain": "The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "UpdateMonitorRequest$subdomain": "The new value of the subdomain to use when forming the monitor URL.
" } }, "SubnetId": { "base": null, "refs": { "CreateLicenseEndpointRequestSubnetIdsList$member": null, "GetLicenseEndpointResponseSubnetIdsList$member": null } }, "SyncInputJobAttachmentsSessionActionDefinition": { "base": "The job attachment in a session action to sync.
", "refs": { "SessionActionDefinition$syncInputJobAttachments": "The job attachments to sync with a session action.
" } }, "SyncInputJobAttachmentsSessionActionDefinitionSummary": { "base": "The details of a synced job attachment.
", "refs": { "SessionActionDefinitionSummary$syncInputJobAttachments": "The job attachments to sync with the session action definition.
" } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "AwsCredentials$expiration": "The expiration date and time of the IAM credentials.
", "DateTimeFilterExpression$dateTime": "The date and time.
", "StartSessionsStatisticsAggregationRequest$startTime": "The Linux timestamp of the date and time that the statistics start.
", "StartSessionsStatisticsAggregationRequest$endTime": "The Linux timestamp of the date and time that the statistics end.
", "Statistics$aggregationStartTime": "The start time for the aggregation.
", "Statistics$aggregationEndTime": "The end time for the aggregation.
", "UpdatedSessionActionInfo$startedAt": "The date and time the resource started running.
", "UpdatedSessionActionInfo$endedAt": "The date and time the resource ended running.
", "UpdatedSessionActionInfo$updatedAt": "The updated time.
" } }, "TagPropagationMode": { "base": null, "refs": { "CustomerManagedFleetConfiguration$tagPropagationMode": "Specifies whether tags associated with a fleet are attached to workers when the worker is launched.
When the tagPropagationMode is set to PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers do not change.
If you don't specify tagPropagationMode, the default is NO_PROPAGATION.
The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
", "CreateFleetRequest$tags": "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.
", "CreateLicenseEndpointRequest$tags": "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.
", "CreateMonitorRequest$tags": "The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
", "CreateQueueRequest$tags": "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.
", "CreateWorkerRequest$tags": "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.
", "ListTagsForResourceResponse$tags": "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.
", "TagResourceRequest$tags": "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.
" } }, "TaskFailureRetryCount": { "base": null, "refs": { "GetJobResponse$taskFailureRetryCount": "The total number of times tasks from the job failed and were retried.
", "GetStepResponse$taskFailureRetryCount": "The total number of times tasks from the step failed and were retried.
", "JobSearchSummary$taskFailureRetryCount": "The total number of times tasks from the job failed and were retried.
", "JobSummary$taskFailureRetryCount": "The total number of times tasks from the job failed and were retried.
", "StepSearchSummary$taskFailureRetryCount": "The total number of times tasks from the step failed and were retried.
", "StepSummary$taskFailureRetryCount": "The total number of times tasks from the step failed and were retried.
" } }, "TaskId": { "base": null, "refs": { "AssignedTaskRunSessionActionDefinition$taskId": "The task ID.
", "GetTaskRequest$taskId": "The task ID.
", "GetTaskResponse$taskId": "The task ID.
", "ListSessionActionsRequest$taskId": "The task ID for the session actions list.
", "TaskRunSessionActionDefinition$taskId": "The task ID.
", "TaskRunSessionActionDefinitionSummary$taskId": "The task ID.
", "TaskSearchSummary$taskId": "The task ID.
", "TaskSummary$taskId": "The task ID.
", "UpdateTaskRequest$taskId": "The task ID to update.
" } }, "TaskParameterValue": { "base": "The data types for the task parameters.
", "refs": { "TaskParameters$value": null } }, "TaskParameters": { "base": null, "refs": { "AssignedTaskRunSessionActionDefinition$parameters": "The parameters to include.
", "GetTaskResponse$parameters": "The parameters for the task.
", "TaskRunSessionActionDefinition$parameters": "The task parameters.
", "TaskRunSessionActionDefinitionSummary$parameters": "The parameters of a task run in a session action.
", "TaskSearchSummary$parameters": "The parameters to search for.
", "TaskSummary$parameters": "The task parameters.
" } }, "TaskRetryCount": { "base": null, "refs": { "GetTaskResponse$failureRetryCount": "The number of times that the task failed and was retried.
", "TaskSearchSummary$failureRetryCount": "The number of times that the task failed and was retried.
", "TaskSummary$failureRetryCount": "The number of times that the task failed and was retried.
" } }, "TaskRunManifestPropertiesListRequest": { "base": null, "refs": { "UpdatedSessionActionInfo$manifests": "A list of output manifest properties reported by the worker agent, with each entry corresponding to a manifest property in the job.
" } }, "TaskRunManifestPropertiesListResponse": { "base": null, "refs": { "GetSessionActionResponse$manifests": "The list of manifest properties that describe file attachments for the task run.
", "SessionActionSummary$manifests": "The list of manifest properties that describe file attachments for the task run.
" } }, "TaskRunManifestPropertiesRequest": { "base": "The output manifest properties reported by the worker agent for a completed task run.
", "refs": { "TaskRunManifestPropertiesListRequest$member": null } }, "TaskRunManifestPropertiesRequestOutputManifestHashString": { "base": null, "refs": { "TaskRunManifestPropertiesRequest$outputManifestHash": "The hash value of the file.
" } }, "TaskRunManifestPropertiesRequestOutputManifestPathString": { "base": null, "refs": { "TaskRunManifestPropertiesRequest$outputManifestPath": "The manifest file path.
" } }, "TaskRunManifestPropertiesResponse": { "base": "The manifest properties for a task run, corresponding to the manifest properties in the job.
", "refs": { "TaskRunManifestPropertiesListResponse$member": null } }, "TaskRunSessionActionDefinition": { "base": "The task, step, and parameters for the task run in the session action.
", "refs": { "SessionActionDefinition$taskRun": "The task run in the session.
" } }, "TaskRunSessionActionDefinitionSummary": { "base": "The details of a task run in a session action.
", "refs": { "SessionActionDefinitionSummary$taskRun": "The task run.
" } }, "TaskRunStatus": { "base": null, "refs": { "GetJobResponse$taskRunStatus": "The task run status for the job.
", "GetStepResponse$taskRunStatus": "The task run status for the job.
", "GetTaskResponse$runStatus": "The run status for the task.
", "JobSearchSummary$taskRunStatus": "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 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 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 run status of the task.
", "TaskSummary$runStatus": "The run status of the task.
" } }, "TaskRunStatusCounts": { "base": null, "refs": { "GetJobResponse$taskRunStatusCounts": "The number of tasks running on the job.
", "GetStepResponse$taskRunStatusCounts": "The number of tasks running on the job.
", "JobSearchSummary$taskRunStatusCounts": "The number of tasks running on the job.
", "JobSummary$taskRunStatusCounts": "The number of tasks running on the job.
", "StepSearchSummary$taskRunStatusCounts": "The number of tasks running on the job.
", "StepSummary$taskRunStatusCounts": "The number of tasks running on the job.
" } }, "TaskSearchSummaries": { "base": null, "refs": { "SearchTasksResponse$tasks": "Tasks in the search.
" } }, "TaskSearchSummary": { "base": "The details of a task search.
", "refs": { "TaskSearchSummaries$member": null } }, "TaskSummaries": { "base": null, "refs": { "ListTasksResponse$tasks": "Tasks for the job.
" } }, "TaskSummary": { "base": "The details of a task.
", "refs": { "TaskSummaries$member": null } }, "TaskTargetRunStatus": { "base": null, "refs": { "GetTaskResponse$targetRunStatus": "The run status with which to start the task.
", "TaskSearchSummary$targetRunStatus": "The run status that the task is being updated to.
", "TaskSummary$targetRunStatus": "The run status on which the started.
", "UpdateTaskRequest$targetRunStatus": "The run status with which to start the task.
" } }, "ThresholdPercentage": { "base": null, "refs": { "BudgetActionToAdd$thresholdPercentage": "The percentage threshold for the budget action to add.
", "BudgetActionToRemove$thresholdPercentage": "The percentage threshold for the budget action to remove.
", "ResponseBudgetAction$thresholdPercentage": "The percentage threshold for the budget.
" } }, "ThrottlingException": { "base": "Your request exceeded a request rate quota.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "GetSessionActionResponse$workerUpdatedAt": "The Linux timestamp of the date and time the session action was last updated.
", "SessionActionSummary$workerUpdatedAt": "The Linux timestamp of the last date and time that the session action was updated.
" } }, "Timezone": { "base": null, "refs": { "StartSessionsStatisticsAggregationRequest$timezone": "The timezone to use for the statistics. Use UTC notation such as \"UTC+8.\"
" } }, "TotalResults": { "base": null, "refs": { "SearchJobsResponse$totalResults": "The total number of results in the search.
", "SearchStepsResponse$totalResults": "The total number of results in the search.
", "SearchTasksResponse$totalResults": "The total number of results in the search.
", "SearchWorkersResponse$totalResults": "The total number of results in the search.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateBudgetRequest": { "base": null, "refs": { } }, "UpdateBudgetResponse": { "base": null, "refs": { } }, "UpdateFarmRequest": { "base": null, "refs": { } }, "UpdateFarmResponse": { "base": null, "refs": { } }, "UpdateFleetRequest": { "base": null, "refs": { } }, "UpdateFleetResponse": { "base": null, "refs": { } }, "UpdateJobLifecycleStatus": { "base": null, "refs": { "UpdateJobRequest$lifecycleStatus": "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.
The status to update.
" } }, "UpdateQueueLimitAssociationRequest": { "base": null, "refs": { } }, "UpdateQueueLimitAssociationResponse": { "base": null, "refs": { } }, "UpdateQueueLimitAssociationStatus": { "base": null, "refs": { "UpdateQueueLimitAssociationRequest$status": "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.
" } }, "UpdateQueueRequest": { "base": null, "refs": { } }, "UpdateQueueResponse": { "base": null, "refs": { } }, "UpdateSessionRequest": { "base": null, "refs": { } }, "UpdateSessionResponse": { "base": null, "refs": { } }, "UpdateStepRequest": { "base": null, "refs": { } }, "UpdateStepResponse": { "base": null, "refs": { } }, "UpdateStorageProfileRequest": { "base": null, "refs": { } }, "UpdateStorageProfileResponse": { "base": null, "refs": { } }, "UpdateTaskRequest": { "base": null, "refs": { } }, "UpdateTaskResponse": { "base": null, "refs": { } }, "UpdateWorkerRequest": { "base": null, "refs": { } }, "UpdateWorkerResponse": { "base": null, "refs": { } }, "UpdateWorkerScheduleInterval": { "base": null, "refs": { "UpdateWorkerScheduleResponse$updateIntervalSeconds": "Updates the time interval (in seconds) for the schedule.
" } }, "UpdateWorkerScheduleRequest": { "base": null, "refs": { } }, "UpdateWorkerScheduleResponse": { "base": null, "refs": { } }, "UpdatedAt": { "base": null, "refs": { "BudgetSummary$updatedAt": "The date and time the resource was updated.
", "FarmSummary$updatedAt": "The date and time the resource was updated.
", "FleetSummary$updatedAt": "The date and time the resource was updated.
", "GetBudgetResponse$updatedAt": "The date and time the resource was updated.
", "GetBudgetResponse$queueStoppedAt": "The date and time the queue stopped.
", "GetFarmResponse$updatedAt": "The date and time the resource was updated.
", "GetFleetResponse$updatedAt": "The date and time the resource was updated.
", "GetJobResponse$updatedAt": "The date and time the resource was updated.
", "GetLimitResponse$updatedAt": "The Unix timestamp of the date and time that the limit was last updated.
", "GetMonitorResponse$updatedAt": "The UNIX timestamp of the last date and time that the monitor was updated.
", "GetQueueEnvironmentResponse$updatedAt": "The date and time the resource was updated.
", "GetQueueFleetAssociationResponse$updatedAt": "The date and time the resource was updated.
", "GetQueueLimitAssociationResponse$updatedAt": "The Unix timestamp of the date and time that the association was last updated.
", "GetQueueResponse$updatedAt": "The date and time the resource was updated.
", "GetSessionResponse$updatedAt": "The date and time the resource was updated.
", "GetStepResponse$updatedAt": "The date and time the resource was updated.
", "GetStorageProfileResponse$updatedAt": "The date and time the resource was updated.
", "GetTaskResponse$updatedAt": "The date and time the resource was updated.
", "GetWorkerResponse$updatedAt": "The date and time the resource was updated.
", "JobSearchSummary$updatedAt": "The date and time the resource was updated.
", "JobSummary$updatedAt": "The date and time the resource was updated.
", "LimitSummary$updatedAt": "The Unix timestamp of the date and time that the limit was last updated.
", "MonitorSummary$updatedAt": "The UNIX timestamp of the date and time that the monitor was last updated.
", "QueueFleetAssociationSummary$updatedAt": "The date and time the resource was updated.
", "QueueLimitAssociationSummary$updatedAt": "The Unix timestamp of the date and time that the association was last updated.
", "QueueSummary$updatedAt": "The date and time the resource was updated.
", "SessionSummary$updatedAt": "The date and time the resource was updated.
", "StepSearchSummary$updatedAt": "The date and time the resource was updated.
", "StepSummary$updatedAt": "The date and time the resource was updated.
", "TaskSearchSummary$updatedAt": "The date and time the resource was updated.
", "TaskSummary$updatedAt": "The date and time the resource was updated.
", "WorkerSearchSummary$updatedAt": "The date and time the resource was updated.
", "WorkerSummary$updatedAt": "The date and time the resource was updated.
" } }, "UpdatedBy": { "base": null, "refs": { "BudgetSummary$updatedBy": "The user or system that updated this resource.
", "FarmSummary$updatedBy": "The user or system that updated this resource.
", "FleetSummary$updatedBy": "The user or system that updated this resource.
", "GetBudgetResponse$updatedBy": "The user or system that updated this resource.
", "GetFarmResponse$updatedBy": "The user or system that updated this resource.
", "GetFleetResponse$updatedBy": "The user or system that updated this resource.
", "GetJobResponse$updatedBy": "The user or system that updated this resource.
", "GetLimitResponse$updatedBy": "The user identifier of the person that last updated the limit.
", "GetMonitorResponse$updatedBy": "The user name of the person that last updated the monitor.
", "GetQueueEnvironmentResponse$updatedBy": "The user or system that updated this resource.
", "GetQueueFleetAssociationResponse$updatedBy": "The user or system that updated this resource.
", "GetQueueLimitAssociationResponse$updatedBy": "The user identifier of the person that last updated the association.
", "GetQueueResponse$updatedBy": "The user or system that updated this resource.
", "GetSessionResponse$updatedBy": "The user or system that updated this resource.
", "GetStepResponse$updatedBy": "The user or system that updated this resource.
", "GetStorageProfileResponse$updatedBy": "The user or system that updated this resource.
", "GetTaskResponse$updatedBy": "The user or system that updated this resource.
", "GetWorkerResponse$updatedBy": "The user or system that updated this resource.
", "JobSearchSummary$updatedBy": "The user or system that updated this resource.
", "JobSummary$updatedBy": "The user or system that updated this resource.
", "LimitSummary$updatedBy": "The user identifier of the person that last updated the limit.
", "MonitorSummary$updatedBy": "The user name of the person that last updated the monitor.
", "QueueFleetAssociationSummary$updatedBy": "The user or system that updated this resource.
", "QueueLimitAssociationSummary$updatedBy": "The user identifier of the person that updated the association.
", "QueueSummary$updatedBy": "The user or system that updated this resource.
", "SessionSummary$updatedBy": "The user or system that updated this resource.
", "StepSearchSummary$updatedBy": "The user or system that updated this resource.
", "StepSummary$updatedBy": "The user or system that updated this resource.
", "TaskSearchSummary$updatedBy": "The user or system that updated this resource.
", "TaskSummary$updatedBy": "The user or system that updated this resource.
", "WorkerSearchSummary$updatedBy": "The user or system that updated this resource.
", "WorkerSummary$updatedBy": "The user or system that updated this resource.
" } }, "UpdatedSessionActionInfo": { "base": "The updated session action information as it relates to completion and progress of the session.
", "refs": { "UpdatedSessionActions$value": null } }, "UpdatedSessionActions": { "base": null, "refs": { "UpdateWorkerScheduleRequest$updatedSessionActions": "The session actions associated with the worker schedule to update.
" } }, "UpdatedWorkerStatus": { "base": null, "refs": { "UpdateWorkerRequest$status": "The worker status to update.
" } }, "Url": { "base": null, "refs": { "GetMonitorResponse$url": "The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "MonitorSummary$url": "The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
" } }, "UsageGroupBy": { "base": null, "refs": { "StartSessionsStatisticsAggregationRequest$groupBy": "The field to use to group the statistics.
" } }, "UsageGroupByField": { "base": null, "refs": { "UsageGroupBy$member": null } }, "UsageStatistic": { "base": null, "refs": { "UsageStatistics$member": null } }, "UsageStatistics": { "base": null, "refs": { "StartSessionsStatisticsAggregationRequest$statistics": "One to four statistics to return.
" } }, "UsageTrackingResource": { "base": "The usage details of the allotted budget.
", "refs": { "BudgetSummary$usageTrackingResource": "The resource used to track expenditure in the budget.
", "CreateBudgetRequest$usageTrackingResource": "The queue ID provided to this budget to track usage.
", "GetBudgetResponse$usageTrackingResource": "The resource that the budget is tracking usage for.
" } }, "UsageType": { "base": null, "refs": { "Statistics$usageType": "The type of usage for the statistics.
" } }, "UserId": { "base": null, "refs": { "Statistics$userId": "The user ID.
" } }, "UserJobsFirst": { "base": "Allows setting a specific user's job to run first.
", "refs": { "SearchSortExpression$userJobsFirst": "Options for sorting a particular user's jobs first.
" } }, "VCpuCountRange": { "base": "The allowable range of vCPU processing power for the fleet.
", "refs": { "CustomerManagedWorkerCapabilities$vCpuCount": "The vCPU count for the customer manged worker capabilities.
", "ServiceManagedEc2InstanceCapabilities$vCpuCount": "The amount of vCPU to require for instances in this fleet.
" } }, "ValidationException": { "base": "The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
", "refs": { } }, "ValidationExceptionField": { "base": "The details of a validation exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "A list of fields that failed validation.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The reason that the request failed validation.
" } }, "VpcConfiguration": { "base": "The configuration options for a service managed fleet's VPC.
", "refs": { "ServiceManagedEc2FleetConfiguration$vpcConfiguration": "The VPC configuration details for a service managed Amazon EC2 fleet.
" } }, "VpcId": { "base": null, "refs": { "CreateLicenseEndpointRequest$vpcId": "The VPC (virtual private cloud) ID to use with the license endpoint.
", "GetLicenseEndpointResponse$vpcId": "The VCP(virtual private cloud) ID associated with the license endpoint.
", "LicenseEndpointSummary$vpcId": "The VCP(virtual private cloud) ID associated with the license endpoint.
" } }, "VpcResourceConfigurationArn": { "base": null, "refs": { "VpcResourceConfigurationArns$member": null } }, "VpcResourceConfigurationArns": { "base": null, "refs": { "VpcConfiguration$resourceConfigurationArns": "The ARNs of the VPC Lattice resource configurations attached to the fleet.
" } }, "WindowsUser": { "base": "The Windows user details.
", "refs": { "JobRunAsUser$windows": "Identifies a Microsoft Windows user.
" } }, "WindowsUserPasswordArnString": { "base": null, "refs": { "WindowsUser$passwordArn": "The password ARN for the Windows user.
" } }, "WindowsUserUserString": { "base": null, "refs": { "WindowsUser$user": "The user.
" } }, "WorkerAmountCapability": { "base": "The details of the worker amount capability.
", "refs": { "WorkerAmountCapabilityList$member": null } }, "WorkerAmountCapabilityList": { "base": null, "refs": { "WorkerCapabilities$amounts": "The worker capabilities amounts on a list of worker capabilities.
" } }, "WorkerAttributeCapability": { "base": "The details of the worker attribute capability.
", "refs": { "WorkerAttributeCapabilityList$member": null } }, "WorkerAttributeCapabilityList": { "base": null, "refs": { "WorkerCapabilities$attributes": "The worker attribute capabilities in the list of attribute capabilities.
" } }, "WorkerCapabilities": { "base": "The details for worker capabilities.
", "refs": { "UpdateWorkerRequest$capabilities": "The worker capabilities to update.
" } }, "WorkerId": { "base": null, "refs": { "AssumeFleetRoleForWorkerRequest$workerId": "The ID of the worker assuming the fleet role.
", "AssumeQueueRoleForWorkerRequest$workerId": "The worker ID of the worker assuming the queue role.
", "BatchGetJobEntityRequest$workerId": "The worker ID of the worker containing the job details to get.
", "CreateWorkerResponse$workerId": "The worker ID.
", "DeleteWorkerRequest$workerId": "The worker ID of the worker to delete.
", "GetSessionResponse$workerId": "The worker ID for the session.
", "GetWorkerRequest$workerId": "The worker ID.
", "GetWorkerResponse$workerId": "The worker ID.
", "ListSessionsForWorkerRequest$workerId": "The worker ID for the session.
", "SessionSummary$workerId": "The worker ID.
", "UpdateWorkerRequest$workerId": "The worker ID to update.
", "UpdateWorkerScheduleRequest$workerId": "The worker ID to update.
", "WorkerSearchSummary$workerId": "The worker ID.
", "WorkerSummary$workerId": "The worker ID.
" } }, "WorkerSearchSummaries": { "base": null, "refs": { "SearchWorkersResponse$workers": "The workers for the search.
" } }, "WorkerSearchSummary": { "base": "The details of a worker search.
", "refs": { "WorkerSearchSummaries$member": null } }, "WorkerSessionSummary": { "base": "Summarizes the session for a particular worker.
", "refs": { "ListSessionsForWorkerSummaries$member": null } }, "WorkerStatus": { "base": null, "refs": { "GetWorkerResponse$status": "The status of the worker.
", "WorkerSearchSummary$status": "The status of the worker search.
", "WorkerSummary$status": "The status of the worker.
" } }, "WorkerSummaries": { "base": null, "refs": { "ListWorkersResponse$workers": "The workers on the list.
" } }, "WorkerSummary": { "base": "The summary of details for a worker.
", "refs": { "WorkerSummaries$member": null } } } }