String environmentId
The environment ID of the assigned environment at the start of a session.
String environmentId
The environment ID of the assigned environment when exiting a session.
String jobId
The job ID for the assigned session.
LogConfiguration logConfiguration
The log configuration for the worker's assigned session.
String queueId
The queue ID of the assigned session.
List<E> sessionActions
The session actions to apply to the assigned session.
AssignedSessionActionDefinition definition
The definition of the assigned session action.
String sessionActionId
The session action ID for the assigned session.
AssignedEnvironmentEnterSessionActionDefinition envEnter
The environment a session starts on.
AssignedEnvironmentExitSessionActionDefinition envExit
The environment a session exits from.
AssignedSyncInputJobAttachmentsSessionActionDefinition syncInputJobAttachments
The job attachment to sync with an assigned session action.
AssignedTaskRunSessionActionDefinition taskRun
The task run.
String stepId
The step ID.
String farmId
The ID of the farm to associate with the member.
String identityStoreId
The identity store ID of the member to associate with the farm.
String membershipLevel
The principal's membership level for the associated farm.
String principalId
The member's principal ID to associate with the farm.
String principalType
The principal type of the member to associate with the farm.
String farmId
The farm ID of the fleet to associate with the member.
String fleetId
The ID of the fleet to associate with a member.
String identityStoreId
The member's identity store ID to associate with the fleet.
String membershipLevel
The principal's membership level for the associated fleet.
String principalId
The member's principal ID to associate with a fleet.
String principalType
The member's principal type to associate with the fleet.
String farmId
The farm ID of the job to associate with the member.
String identityStoreId
The member's identity store ID to associate with the job.
String jobId
The job ID to associate with the member.
String membershipLevel
The principal's membership level for the associated job.
String principalId
The member's principal ID to associate with the job.
String principalType
The member's principal type to associate with the job.
String queueId
The queue ID to associate to the member.
String farmId
The farm ID of the queue to associate with the member.
String identityStoreId
The member's identity store ID to associate with the queue.
String membershipLevel
The principal's membership level for the associated queue.
String principalId
The member's principal ID to associate with the queue.
String principalType
The member's principal type to associate with the queue.
String queueId
The ID of the queue to associate to the member.
AwsCredentials credentials
The credentials for the fleet role.
AwsCredentials credentials
The credentials for the worker.
AwsCredentials credentials
The credentials for the queue role.
AwsCredentials credentials
The credentials for the queue role that a user has access to.
AwsCredentials credentials
The Amazon Web Services credentials for the role that the worker is assuming.
String 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.
String 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.
List<E> identifiers
The job identifiers to include within the job entity batch details.
String workerId
The worker ID of the worker containing the job details to get.
FixedBudgetSchedule fixed
The fixed start and end time of the budget's schedule.
Float approximateDollarLimit
The approximate dollar limit of the budget.
String budgetId
The budget ID.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String description
The description of the budget summary.
String displayName
The display name of the budget summary to update.
String 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.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
UsageTrackingResource usageTrackingResource
The resource used to track expenditure in the budget.
ConsumedUsages usages
The consumed usage for the budget.
Float approximateDollarUsage
The amount of the budget consumed.
String farmId
The farm ID to copy.
String jobId
The job ID to copy.
String queueId
The queue ID to copy.
S3Location targetS3Location
The Amazon S3 bucket name and key where you would like to add a copy of the job template.
String templateType
The format of the job template, either JSON or YAML.
List<E> actions
The budget actions to specify what happens when the budget runs out.
Float approximateDollarLimit
The dollar limit based on consumed usage.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String description
The description of the budget.
String displayName
The display name of the budget.
String farmId
The farm ID to include in this budget.
BudgetSchedule schedule
The schedule to associate with this budget.
UsageTrackingResource usageTrackingResource
The queue ID provided to this budget to track usage.
String budgetId
The budget ID.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String description
The description of the farm.
String displayName
The display name of the farm.
String kmsKeyArn
The ARN of the KMS key to use on the farm.
Map<K,V> tags
The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
String farmId
The farm ID.
String clientToken
The unique token which the server uses to recognize retries of the same request.
FleetConfiguration configuration
The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
String description
The description of the fleet.
String displayName
The display name of the fleet.
String farmId
The farm ID of the farm to connect to the fleet.
Integer maxWorkerCount
The maximum number of workers for the fleet.
Integer minWorkerCount
The minimum number of workers for the fleet.
String roleArn
The IAM role ARN for the role that the fleet's workers will use.
Map<K,V> 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.
String fleetId
The fleet ID.
Attachments attachments
The attachments for the job. Attach files required for the job to run to a render job.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID of the farm to connect to the job.
Integer maxFailedTasksCount
The number of task failures before the job stops running and is marked as FAILED.
Integer maxRetriesPerTask
The maximum number of retries for a job.
Map<K,V> parameters
The parameters for the job.
Integer priority
The priority of the job on a scale of 1 to 100. The highest priority is 1.
String queueId
The ID of the queue that the job is submitted to.
String storageProfileId
The storage profile ID for the storage profile to connect to the job.
String targetTaskRunStatus
The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED
status will not run until you update their status.
String template
The job template to use for this job.
String templateType
The file type for the job template.
String jobId
The job ID.
String clientToken
The unique token which the server uses to recognize retries of the same request.
List<E> securityGroupIds
The security group IDs.
List<E> subnetIds
The subnet IDs.
Map<K,V> 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.
String vpcId
The VPC (virtual private cloud) ID to use with the license endpoint.
String licenseEndpointId
The license endpoint ID.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String displayName
The name that you give the monitor that is displayed in the Deadline Cloud console.
String identityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.
String 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.
String subdomain
The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID of the farm to connect to the environment.
Integer priority
Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.
String queueId
The queue ID to connect the queue and environment.
String template
The environment template to use in the queue.
String templateType
The template's file type, JSON or YAML.
String queueEnvironmentId
The queue environment ID.
List<E> allowedStorageProfileIds
The storage profile IDs to include in the queue.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String defaultBudgetAction
The default action to take on a queue if a budget isn't configured.
String description
The description of the queue.
String displayName
The display name of the queue.
String farmId
The farm ID of the farm to connect to the queue.
JobAttachmentSettings jobAttachmentSettings
The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
JobRunAsUser jobRunAsUser
The jobs in the queue run as the specified POSIX user.
List<E> requiredFileSystemLocationNames
The file system location name to include in the queue.
String roleArn
The IAM role ARN that workers will use while running jobs for this queue.
Map<K,V> 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.
String queueId
The queue ID.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String displayName
The display name of the storage profile.
String farmId
The farm ID of the farm to connect to the storage profile.
List<E> fileSystemLocations
File system paths to include in the storage profile.
String osFamily
The type of operating system (OS) for the storage profile.
String storageProfileId
The storage profile ID.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID of the farm to connect to the worker.
String fleetId
The fleet ID to connect to the worker.
HostPropertiesRequest hostProperties
The IP address and host name of the worker.
String workerId
The worker ID.
String mode
The Auto Scaling mode for the customer managed fleet configuration.
String storageProfileId
The storage profile ID.
CustomerManagedWorkerCapabilities workerCapabilities
The worker capabilities for a customer managed fleet configuration.
AcceleratorCountRange acceleratorCount
The range of the accelerator.
AcceleratorTotalMemoryMiBRange acceleratorTotalMemoryMiB
The total memory (MiB) for the customer managed worker capabilities.
List<E> acceleratorTypes
The accelerator types for the customer managed worker capabilities.
String cpuArchitectureType
The CPU architecture type for the customer managed worker capabilities.
List<E> customAmounts
Custom requirement ranges for customer managed worker capabilities.
List<E> customAttributes
Custom attributes for the customer manged worker capabilities.
MemoryMiBRange memoryMiB
The memory (MiB).
String osFamily
The operating system (OS) family.
VCpuCountRange vCpuCount
The vCPU count for the customer manged worker capabilities.
String farmId
The farm ID of the farm to delete.
String licenseEndpointId
The license endpoint ID of the license endpoint to delete.
String 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.
Integer consumersResolved
The number of consumers resolved.
Integer consumersUnresolved
The number of unresolved consumers.
Integer dependenciesResolved
The number of resolved dependencies.
Integer dependenciesUnresolved
The number of unresolved dependencies.
String farmId
The farm ID for the job to disassociate from the member.
String jobId
The job ID to disassociate from a member in a job.
String principalId
A member's principal ID to disassociate from a job.
String queueId
The queue ID connected to a job for which you're disassociating a member.
String environmentId
The environment ID.
String environmentId
The environment ID.
String environmentId
The environment ID.
String environmentId
The environment ID.
String farmId
The farm ID of the farm member.
String identityStoreId
The identity store ID of the farm member.
String membershipLevel
The farm member's membership level.
String principalId
The principal ID of the farm member.
String principalType
The principal type of the farm member.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String displayName
The display name of the farm.
String farmId
The farm ID.
String kmsKeyArn
The ARN for the KMS key.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
CustomerManagedFleetConfiguration customerManaged
The customer managed fleets within a fleet configuration.
ServiceManagedEc2FleetConfiguration serviceManagedEc2
The service managed Amazon EC2 instances for a fleet configuration.
String farmId
The farm ID.
String fleetId
The fleet ID.
String identityStoreId
The identity store ID.
String membershipLevel
The fleet member's membership level.
String principalId
The principal ID of the fleet member.
String principalType
The principal type of the fleet member.
String autoScalingStatus
The Auto Scaling status of a fleet.
FleetConfiguration configuration
The configuration details for the fleet.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String displayName
The display name of the fleet summary to update.
String farmId
The farm ID.
String fleetId
The fleet ID.
Integer maxWorkerCount
The maximum number of workers specified in the fleet.
Integer minWorkerCount
The minimum number of workers in the fleet.
String status
The status of the fleet.
Integer targetWorkerCount
The target number of workers in a fleet.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
Integer workerCount
The number of workers in the fleet summary.
List<E> actions
The budget actions for the budget.
Float approximateDollarLimit
The consumed usage limit for the budget.
String budgetId
The budget ID.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String description
The description of the budget.
String displayName
The display name of the budget.
Date queueStoppedAt
The date and time the queue stopped.
BudgetSchedule schedule
The budget schedule.
String status
The status of the budget.
ACTIVE–Get a budget being evaluated.
INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
UsageTrackingResource usageTrackingResource
The resource that the budget is tracking usage for.
ConsumedUsages usages
The usages of the budget.
String farmId
The farm ID of the farm.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String description
The description of the farm.
String displayName
The display name of the farm.
String farmId
The farm ID of the farm to get.
String kmsKeyArn
The ARN of the KMS key used on the farm.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String autoScalingStatus
The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING
.
FleetCapabilities capabilities
Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
FleetConfiguration configuration
The configuration setting for the fleet.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String description
The description of the fleet.
String displayName
The display name of the fleet.
String farmId
The farm ID of the farm in the fleet.
String fleetId
The fleet ID.
Integer maxWorkerCount
The maximum number of workers specified in the fleet.
Integer minWorkerCount
The minimum number of workers specified in the fleet.
String roleArn
The IAM role ARN.
String status
The Auto Scaling status of the fleet.
Integer targetWorkerCount
The number of target workers in the fleet.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
Integer workerCount
The number of workers in the fleet.
EnvironmentDetailsError environmentDetails
The environment details for the failed job entity.
JobAttachmentDetailsError jobAttachmentDetails
The job attachment details for the failed job entity.
JobDetailsError jobDetails
The job details for the failed job entity.
StepDetailsError stepDetails
The step details for the failed job entity.
Attachments attachments
The attachments for the job.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String description
The description of the job.
Date endedAt
The date and time the resource ended running.
String jobId
The job ID.
String lifecycleStatus
The life cycle status for the job.
String lifecycleStatusMessage
A message that communicates the status of the life cycle for the job.
Integer maxFailedTasksCount
The number of task failures before the job stops running and is marked as FAILED.
Integer maxRetriesPerTask
The maximum number of retries per failed tasks.
String name
The name of the job.
Map<K,V> parameters
The parameters for the job.
Integer priority
The job priority.
Date startedAt
The date and time the resource started running.
String storageProfileId
The storage profile ID associated with the job.
String targetTaskRunStatus
The task status with which the job started.
String taskRunStatus
The task run status for the job.
Map<K,V> taskRunStatusCounts
The number of tasks running on the job.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String licenseEndpointId
The license endpoint ID.
String dnsName
The DNS name.
String licenseEndpointId
The license endpoint ID.
List<E> securityGroupIds
The security group IDs for the license endpoint.
String status
The status of the license endpoint.
String statusMessage
The status message of the license endpoint.
List<E> subnetIds
The subnet IDs.
String vpcId
The VCP(virtual private cloud) ID associated with the license endpoint.
String monitorId
The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.
Date createdAt
The UNIX timestamp of the date and time that the monitor was created.
String createdBy
The user name of the person that created the monitor.
String displayName
The name used to identify the monitor on the Deadline Cloud console.
String identityCenterApplicationArn
The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
String identityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
String monitorId
The unique identifier for the monitor.
String 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.
String subdomain
The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
Date updatedAt
The UNIX timestamp of the last date and time that the monitor was updated.
String updatedBy
The user name of the person that last updated the monitor.
String url
The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.>
String name
The name of the queue environment.
Integer priority
The priority of the queue environment.
String queueEnvironmentId
The queue environment ID.
String template
The template for the queue environment.
String templateType
The type of template for the queue environment.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String fleetId
The fleet ID for the queue-fleet association.
String queueId
The queue ID for the queue-fleet association.
String status
The status of the queue-fleet association.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
List<E> allowedStorageProfileIds
The storage profile IDs for the queue.
String blockedReason
The reason the queue was blocked.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String defaultBudgetAction
The default action taken on a queue if a budget wasn't configured.
String description
The description of the queue.
String displayName
The display name of the queue.
String farmId
The farm ID for the queue.
JobAttachmentSettings jobAttachmentSettings
The job attachment settings for the queue.
JobRunAsUser jobRunAsUser
The jobs in the queue ran as this specified POSIX user.
String queueId
The queue ID.
List<E> requiredFileSystemLocationNames
A list of the required file system location names in the queue.
String roleArn
The IAM role ARN.
String 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.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
SessionActionDefinition definition
The session action definition.
Date endedAt
The date and time the resource ended running.
Integer processExitCode
The exit code to exit the session.
String progressMessage
The message that communicates the progress of the session action.
Float progressPercent
The percentage completed for a session action.
String sessionActionId
The session action ID.
String sessionId
The session ID for the session action.
Date startedAt
The date and time the resource started running.
String status
The status of the session action.
Date workerUpdatedAt
The Linux timestamp of the date and time the session action was last updated.
Date endedAt
The date and time the resource ended running.
String fleetId
The fleet ID for the session.
HostPropertiesResponse hostProperties
Provides the Amazon EC2 properties of the host.
String lifecycleStatus
The life cycle status of the session.
LogConfiguration log
The session log.
String sessionId
The session ID.
Date startedAt
The date and time the resource started running.
String targetLifecycleStatus
The life cycle status with which the session started.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String workerId
The worker ID for the session.
LogConfiguration workerLog
The worker log for the session.
String aggregationId
The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the
aggregated statistics.
String 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.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String nextToken
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.
List<E> statistics
The statistics for the specified fleets or queues.
String status
The status of the aggregated results.
String statusMessage
A message that describes the status.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
DependencyCounts dependencyCounts
The number of dependencies in the step.
String description
The description of the step.
Date endedAt
The date and time the resource ended running.
String lifecycleStatus
The life cycle status of the step.
String lifecycleStatusMessage
A message that describes the lifecycle status of the step.
String name
The name of the step.
ParameterSpace parameterSpace
A list of step parameters and the combination expression for the step.
StepRequiredCapabilities requiredCapabilities
The required capabilities of the step.
Date startedAt
The date and time the resource started running.
String stepId
The step ID.
String targetTaskRunStatus
The task status with which the job started.
String taskRunStatus
The task run status for the job.
Map<K,V> taskRunStatusCounts
The number of tasks running on the job.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String displayName
The display name of the storage profile connected to a queue.
List<E> fileSystemLocations
The location of the files for the storage profile within the queue.
String osFamily
The operating system of the storage profile in the queue.
String storageProfileId
The storage profile ID.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String displayName
The display name of the storage profile.
List<E> fileSystemLocations
The location of the files for the storage profile.
String osFamily
The operating system (OS) for the storage profile.
String storageProfileId
The storage profile ID.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String farmId
The farm ID of the farm connected to the task.
String jobId
The job ID of the job connected to the task.
String queueId
The queue ID for the queue connected to the task.
String stepId
The step ID for the step connected to the task.
String taskId
The task ID.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
Date endedAt
The date and time the resource ended running.
Integer failureRetryCount
The number of times that the task failed and was retried.
String latestSessionActionId
The latest session ID for the task.
Map<K,V> parameters
The parameters for the task.
String runStatus
The run status for the task.
Date startedAt
The date and time the resource started running.
String targetRunStatus
The run status with which to start the task.
String taskId
The task ID.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String farmId
The farm ID.
String fleetId
The fleet ID.
HostPropertiesResponse hostProperties
The host properties for the worker.
LogConfiguration log
The logs for the associated worker.
String status
The status of the worker.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String workerId
The worker ID.
String hostName
The host name.
IpAddresses ipAddresses
The IP address of the host.
String ec2InstanceArn
The ARN of the host EC2 instance.
String ec2InstanceType
The instance type of the host EC2 instance.
String hostName
The host name.
IpAddresses ipAddresses
The IP address of the host.
Integer retryAfterSeconds
The number of seconds a client should wait before retrying the request.
Attachments attachments
The job attachments.
String jobId
The job ID.
String jobId
The job ID.
JobAttachmentSettings jobAttachmentSettings
The job attachment settings.
String jobId
The job ID.
JobRunAsUser jobRunAsUser
The user name and group that the job uses when run.
String logGroupName
The log group name.
Map<K,V> parameters
The parameters.
List<E> pathMappingRules
The path mapping rules.
String queueRoleArn
The queue role ARN.
String schemaVersion
The schema version.
String jobId
The job ID.
JobAttachmentDetailsEntity jobAttachmentDetails
The job attachment details.
JobDetailsEntity jobDetails
The job details.
EnvironmentDetailsIdentifiers environmentDetails
The environment details.
JobAttachmentDetailsIdentifiers jobAttachmentDetails
The job attachment details.
JobDetailsIdentifiers jobDetails
The job details.
StepDetailsIdentifiers stepDetails
The step details.
String farmId
The farm ID.
String identityStoreId
The identity store ID.
String jobId
The job ID.
String membershipLevel
The job member's membership level.
String principalId
The principal ID of the job member.
String principalType
The principal type of the job member.
String queueId
The queue ID.
PosixUser posix
The user and group that the jobs in the queue run as.
String 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.
WindowsUser windows
Identifies a Microsoft Windows user.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
Date endedAt
The date and time the resource ended running.
String jobId
The job ID.
Map<K,V> jobParameters
The job parameters.
String lifecycleStatus
The life cycle status.
String lifecycleStatusMessage
The life cycle status message.
Integer maxFailedTasksCount
The number of task failures before the job stops running and is marked as FAILED.
Integer maxRetriesPerTask
The maximum number of retries for a job.
String name
The job name.
Integer priority
The job priority.
String queueId
The queue ID.
Date startedAt
The date and time the resource started running.
String targetTaskRunStatus
The task status to start with on the job.
String taskRunStatus
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.
Map<K,V> taskRunStatusCounts
The number of tasks running on the job.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
Date endedAt
The date and time the resource ended running.
String jobId
The job ID.
String lifecycleStatus
The life cycle status.
String lifecycleStatusMessage
The life cycle status message.
Integer maxFailedTasksCount
The number of task failures before the job stops running and is marked as FAILED.
Integer maxRetriesPerTask
The maximum number of retries for a job.
String name
The job name.
Integer priority
The job priority.
Date startedAt
The date and time the resource started running.
String targetTaskRunStatus
The task status to start with on the job.
String 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.
Map<K,V> taskRunStatusCounts
The number of tasks running on the job.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
List<E> meteredProducts
The metered products.
String nextToken
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.
String farmId
The farm ID associated with the budgets.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String status
The status to list for the budgets.
List<E> budgets
The budgets to include on the list.
String nextToken
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.
List<E> members
The members on the list.
String nextToken
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.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String principalId
The principal ID of the member to list on the farm.
List<E> farms
Farms on the list.
String nextToken
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.
String farmId
The farm ID of the fleet.
String fleetId
The fleet ID to include on the list.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
List<E> members
The members on the list.
String nextToken
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.
String displayName
The display names of a list of fleets.
String farmId
The farm ID of the fleets.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String principalId
The principal ID of the members to include in the fleet.
String status
The status of the fleet.
List<E> fleets
The fleets on the list.
String nextToken
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.
String farmId
The farm ID of the job to list.
String jobId
The job ID to include on the list.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID to include on the list.
List<E> members
The members on the list.
String nextToken
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.
String farmId
The farm ID for the jobs.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String principalId
The principal ID of the members on the jobs.
String queueId
The queue ID for the job.
List<E> jobs
The jobs on the list.
String nextToken
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.
List<E> licenseEndpoints
The license endpoints.
String nextToken
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.
String licenseEndpointId
The license endpoint ID to include on the list of metered products.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
List<E> meteredProducts
The metered products to list.
String nextToken
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.
List<E> monitors
A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.
String nextToken
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.
String farmId
The farm ID for the queue environment list.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID for the queue environment list.
List<E> environments
The environments to include in the queue environments list.
String nextToken
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.
String farmId
The farm ID for the queue-fleet association list.
String fleetId
The fleet ID for the queue-fleet association list.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID for the queue-fleet association list.
String nextToken
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.
List<E> queueFleetAssociations
The queue-fleet associations on the list.
String farmId
The farm ID for the queue.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID to include on the list.
List<E> members
The members on the list.
String nextToken
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.
String farmId
The farm ID of the queue.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String principalId
The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.
String status
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.
String nextToken
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.
List<E> queues
The queues on the list.
String farmId
The farm ID for the session actions list.
String jobId
The job ID for the session actions list.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID for the session actions list.
String sessionId
The session ID to include on the sessions action list.
String taskId
The task ID for the session actions list.
String nextToken
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.
List<E> sessionActions
The session actions.
String farmId
The farm ID for the session.
String fleetId
The fleet ID for the session.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String workerId
The worker ID for the session.
String farmId
The farm ID for the list of sessions.
String jobId
The job ID for the list of sessions.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID for the list of sessions
String nextToken
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.
List<E> sessions
The sessions on the list.
String farmId
The farm ID for the list of step consumers.
String jobId
The job ID for the step consumer.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID for the step consumer.
String stepId
The step ID to include on the list.
List<E> consumers
The consumers on the list.
String nextToken
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.
String farmId
The farm ID for the step dependencies list.
String jobId
The job ID for the step dependencies list.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID for the step dependencies list.
String stepId
The step ID to include on the list.
List<E> dependencies
The dependencies on the list.
String nextToken
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.
String farmId
The farm ID to include on the list of steps.
String jobId
The job ID to include on the list of steps.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID to include on the list of steps.
String nextToken
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.
List<E> steps
The steps on the list.
String farmId
The farm ID of the queue's storage profile.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID for the storage profile.
String nextToken
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.
List<E> storageProfiles
The storage profiles in the queue.
String farmId
The farm ID of the storage profile.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String nextToken
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.
List<E> storageProfiles
The storage profiles.
String resourceArn
The resource ARN to list tags for.
String farmId
The farm ID connected to the tasks.
String jobId
The job ID for the tasks.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String queueId
The queue ID connected to the tasks.
String stepId
The step ID for the tasks.
String nextToken
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.
List<E> tasks
Tasks for the job.
String farmId
The farm ID connected to the workers.
String fleetId
The fleet ID of the workers.
Integer maxResults
The maximum number of results to return. Use this parameter with NextToken to get results as a set
of sequential pages.
String nextToken
The token for the next set of results, or null to start from the beginning.
String nextToken
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.
List<E> workers
The workers on the list.
String fileSystemLocationName
The file system location name.
String inputManifestHash
The has value of the file.
String inputManifestPath
The file path.
List<E> outputRelativeDirectories
The file path relative to the directory.
String rootPath
The file's root path.
String rootPathFormat
The format of the root path.
Date createdAt
The UNIX timestamp of the date and time that the monitor was created.
String createdBy
The user name of the person that created the monitor.
String displayName
The name of the monitor that displays on the Deadline Cloud console.
String identityCenterApplicationArn
The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
String identityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
String monitorId
The unique identifier for the monitor.
String 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.
String subdomain
The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
Date updatedAt
The UNIX timestamp of the date and time that the monitor was last updated.
String updatedBy
The user name of the person that last updated the monitor.
String url
The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String fleetId
The fleet ID.
String queueId
The queue ID.
String 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.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String farmId
The farm ID.
String identityStoreId
The identity store ID.
String membershipLevel
The queue member's membership level.
String principalId
The principal ID of the queue member.
String principalType
The principal type of the queue member.
String queueId
The queue ID.
String blockedReason
The reason the queue is blocked, if applicable.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String defaultBudgetAction
The default action taken on a queue summary if a budget wasn't configured.
String displayName
The display name of the queue summary to update.
String farmId
The farm ID.
String queueId
The queue ID.
String status
That status of the queue.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
DateTimeFilterExpression dateTimeFilter
Filters based on date and time.
SearchGroupedFilterExpressions groupFilter
Filters by group.
ParameterFilterExpression parameterFilter
Filters by parameter.
SearchTermFilterExpression searchTermFilter
Filters by a specified search term.
StringFilterExpression stringFilter
Filters by a string.
String farmId
The farm ID of the job.
SearchGroupedFilterExpressions 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 ().
Integer itemOffset
Defines how far into the scrollable list to start the return of results.
Integer pageSize
Specifies the number of items per page for the resource.
List<E> queueIds
The queue ID to use in the job search.
List<E> sortExpressions
The search terms for a resource.
FieldSortExpression fieldSort
Options for sorting by a field.
ParameterSortExpression parameterSort
Options for sorting by a parameter.
UserJobsFirst userJobsFirst
Options for sorting a particular user's jobs first.
String farmId
The farm ID to use for the step search.
SearchGroupedFilterExpressions 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 ().
Integer itemOffset
Defines how far into the scrollable list to start the return of results.
String jobId
The job ID to use in the step search.
Integer pageSize
Specifies the number of items per page for the resource.
List<E> queueIds
The queue IDs in the step search.
List<E> sortExpressions
The search terms for a resource.
String farmId
The farm ID of the task.
SearchGroupedFilterExpressions 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 ().
Integer itemOffset
Defines how far into the scrollable list to start the return of results.
String jobId
The job ID for the task search.
Integer pageSize
Specifies the number of items per page for the resource.
List<E> queueIds
The queue IDs to include in the search.
List<E> sortExpressions
The search terms for a resource.
String searchTerm
The term to search for.
String farmId
The farm ID in the workers search.
SearchGroupedFilterExpressions 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 ().
List<E> fleetIds
The fleet ID of the workers to search for.
Integer itemOffset
Defines how far into the scrollable list to start the return of results.
Integer pageSize
Specifies the number of items per page for the resource.
List<E> sortExpressions
The search terms for a resource.
ServiceManagedEc2InstanceCapabilities instanceCapabilities
The Amazon EC2 instance capabilities.
ServiceManagedEc2InstanceMarketOptions instanceMarketOptions
The Amazon EC2 market type.
List<E> allowedInstanceTypes
The allowable Amazon EC2 instance types.
String cpuArchitectureType
The CPU architecture type.
List<E> customAmounts
The custom capability amounts to require for instances in this fleet.
List<E> customAttributes
The custom capability attributes to require for instances in this fleet.
List<E> excludedInstanceTypes
The instance types to exclude from the fleet.
MemoryMiBRange memoryMiB
The memory, as MiB, for the Amazon EC2 instance type.
String osFamily
The operating system (OS) family.
Ec2EbsVolume rootEbsVolume
The root EBS volume.
VCpuCountRange vCpuCount
The amount of vCPU to require for instances in this fleet.
String type
The Amazon EC2 instance type.
Map<K,V> context
Information about the resources in use when the exception was thrown.
String quotaCode
Identifies the quota that has been exceeded.
String reason
A string that describes the reason the quota was exceeded.
String resourceId
The identifier of the affected resource.
String resourceType
The type of the affected resource
String serviceCode
Identifies the service that exceeded the quota.
EnvironmentEnterSessionActionDefinition envEnter
The environment to enter into.
EnvironmentExitSessionActionDefinition envExit
The environment to exit from.
SyncInputJobAttachmentsSessionActionDefinition syncInputJobAttachments
The job attachments to sync with a session action.
TaskRunSessionActionDefinition taskRun
The task run in the session.
EnvironmentEnterSessionActionDefinitionSummary envEnter
The environment to enter into.
EnvironmentExitSessionActionDefinitionSummary envExit
The environment to exit from.
SyncInputJobAttachmentsSessionActionDefinitionSummary syncInputJobAttachments
The job attachments to sync with the session action definition.
TaskRunSessionActionDefinitionSummary taskRun
The task run.
SessionActionDefinitionSummary definition
The session action definition.
Date endedAt
The date and time the resource ended running.
Float progressPercent
The completion percentage for the session action.
String sessionActionId
The session action ID.
Date startedAt
The date and time the resource started running.
String status
The status of the session action.
Date workerUpdatedAt
The Linux timestamp of the last date and time that the session action was updated.
List<E> 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.
List<E> queueIds
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.
Date endedAt
The date and time the resource ended running.
String fleetId
The fleet ID.
String lifecycleStatus
The life cycle status for the session.
String sessionId
The session ID.
Date startedAt
The date and time the resource started running.
String targetLifecycleStatus
The target life cycle status for the session.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String workerId
The worker ID.
Date endTime
The Linux timestamp of the date and time that the statistics end.
String farmId
The identifier of the farm that contains queues or fleets to return statistics for.
List<E> groupBy
The field to use to group the statistics.
String period
The period to aggregate the statistics.
SessionsStatisticsResources resourceIds
A list of fleet IDs or queue IDs to gather statistics for.
Date startTime
The Linux timestamp of the date and time that the statistics start.
List<E> statistics
One to four statistics to return.
String timezone
The timezone to use for the statistics. Use UTC notation such as "UTC+8."
String aggregationId
A unique identifier for the aggregated statistics. Use this identifier with the
GetAggregatedStatisticsForSessions operation to return the statistics.
Date aggregationEndTime
The end time for the aggregation.
Date aggregationStartTime
The start time for the aggregation.
Stats costInUsd
How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
Integer count
The number of instances in a list of statistics.
String fleetId
The fleet ID.
String instanceType
The type of instance.
String jobId
The job ID.
String jobName
The job name.
String licenseProduct
The licensed product.
String queueId
The queue ID.
Stats runtimeInSeconds
The total aggregated runtime.
String usageType
The type of usage for the statistics.
String userId
The user ID.
Date createdAt
The date and time the resource was created.
Date endedAt
The date and time the resource ended running.
String jobId
The job ID.
String lifecycleStatus
The life cycle status.
String lifecycleStatusMessage
The life cycle status message.
String name
The step name.
ParameterSpace parameterSpace
The parameters and combination expressions for the search.
String queueId
The queue ID.
Date startedAt
The date and time the resource started running.
String stepId
The step ID.
String targetTaskRunStatus
The task status to start with on the job.
String 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.
Map<K,V> taskRunStatusCounts
The number of tasks running on the job.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
DependencyCounts dependencyCounts
The number of dependencies for the step.
Date endedAt
The date and time the resource ended running.
String lifecycleStatus
The life cycle status.
String lifecycleStatusMessage
A message that describes the lifecycle of the step.
String name
The name of the step.
Date startedAt
The date and time the resource started running.
String stepId
The step ID.
String targetTaskRunStatus
The task status to start with on the job.
String taskRunStatus
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.
Map<K,V> taskRunStatusCounts
The number of tasks running on the job.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String stepId
The step ID for the step in the job attachment.
String stepId
The step ID of the step in the job attachment.
Date endedAt
The date and time the resource ended running.
Integer failureRetryCount
The number of times that the task failed and was retried.
String jobId
The job ID.
Map<K,V> parameters
The parameters to search for.
String queueId
The queue ID.
String runStatus
The run status of the task.
Date startedAt
The date and time the resource started running.
String stepId
The step ID.
String targetRunStatus
The run status that the task is being updated to.
String taskId
The task ID.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
Date endedAt
The date and time the resource ended running.
Integer failureRetryCount
The number of times that the task failed and was retried.
String latestSessionActionId
The latest session action for the task.
Map<K,V> parameters
The task parameters.
String runStatus
The run status of the task.
Date startedAt
The date and time the resource started running.
String targetRunStatus
The run status on which the started.
String taskId
The task ID.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
Map<K,V> context
Information about the resources in use when the exception was thrown.
String quotaCode
Identifies the quota that is being throttled.
Integer retryAfterSeconds
The number of seconds a client should wait before retrying the request.
String serviceCode
Identifies the service that is being throttled.
List<E> actionsToAdd
The budget actions to add. Budget actions specify what happens when the budget runs out.
List<E> actionsToRemove
The budget actions to remove from the budget.
Float approximateDollarLimit
The dollar limit to update on the budget. Based on consumed usage.
String budgetId
The budget ID to update.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String description
The description of the budget to update.
String displayName
The display name of the budget to update.
String farmId
The farm ID of the budget to update.
BudgetSchedule schedule
The schedule to update.
String 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.
String completedStatus
The status of the session upon completion.
Date endedAt
The date and time the resource ended running.
Integer processExitCode
The process exit code.
String progressMessage
A message to indicate the progress of the updated session action.
Float progressPercent
The percentage completed.
Date startedAt
The date and time the resource started running.
Date updatedAt
The updated time.
String clientToken
The unique token which the server uses to recognize retries of the same request.
FleetConfiguration configuration
The fleet configuration to update.
String description
The description of the fleet to update.
String displayName
The display name of the fleet to update.
String farmId
The farm ID to update.
String fleetId
The fleet ID to update.
Integer maxWorkerCount
The maximum number of workers in the fleet.
Integer minWorkerCount
The minimum number of workers in the fleet.
String roleArn
The IAM role ARN that the fleet's workers assume while running jobs.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID of the job to update.
String jobId
The job ID to update.
String lifecycleStatus
The status of a job in its lifecycle.
Integer maxFailedTasksCount
The number of task failures before the job stops running and is marked as FAILED.
Integer maxRetriesPerTask
The maximum number of retries for a job.
Integer priority
The job priority to update.
String queueId
The queue ID of the job to update.
String targetTaskRunStatus
The task status to update the job's tasks to.
String displayName
The new value to use for the monitor's display name.
String monitorId
The unique identifier of the monitor to update.
String roleArn
The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
String subdomain
The new value of the subdomain to use when forming the monitor URL.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID of the queue environment to update.
Integer priority
The priority to update.
String queueEnvironmentId
The queue environment ID to update.
String queueId
The queue ID of the queue environment to update.
String template
The template to update.
String templateType
The template type to update.
List<E> allowedStorageProfileIdsToAdd
The storage profile IDs to add.
List<E> allowedStorageProfileIdsToRemove
The storage profile ID to remove.
String clientToken
The idempotency token to update in the queue.
String defaultBudgetAction
The default action to take for a queue update if a budget isn't configured.
String description
The description of the queue to update.
String displayName
The display name of the queue to update.
String farmId
The farm ID to update in the queue.
JobAttachmentSettings jobAttachmentSettings
The job attachment settings to update for the queue.
JobRunAsUser jobRunAsUser
Update the jobs in the queue to run as a specified POSIX user.
String queueId
The queue ID to update.
List<E> requiredFileSystemLocationNamesToAdd
The required file system location names to add to the queue.
List<E> requiredFileSystemLocationNamesToRemove
The required file system location names to remove from the queue.
String roleArn
The IAM role ARN that's used to run jobs from this queue.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID to update in the session.
String jobId
The job ID to update in the session.
String queueId
The queue ID to update in the session.
String sessionId
The session ID to update.
String targetLifecycleStatus
The life cycle status to update in the session.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID to update.
String jobId
The job ID to update.
String queueId
The queue ID to update.
String stepId
The step ID to update.
String targetTaskRunStatus
The task status to update the step's tasks to.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String displayName
The display name of the storage profile to update.
String farmId
The farm ID to update.
List<E> fileSystemLocationsToAdd
The file system location names to add.
List<E> fileSystemLocationsToRemove
The file system location names to remove.
String osFamily
The OS system to update.
String storageProfileId
The storage profile ID to update.
String clientToken
The unique token which the server uses to recognize retries of the same request.
String farmId
The farm ID to update.
String jobId
The job ID to update.
String queueId
The queue ID to update.
String stepId
The step ID to update.
String targetRunStatus
The run status with which to start the task.
String taskId
The task ID to update.
WorkerCapabilities capabilities
The worker capabilities to update.
String farmId
The farm ID to update.
String fleetId
The fleet ID to update.
HostPropertiesRequest hostProperties
The host properties to update.
String status
The worker status to update.
String workerId
The worker ID to update.
LogConfiguration log
The worker log to update.
Map<K,V> assignedSessions
The assigned sessions to update.
Map<K,V> cancelSessionActions
The session actions associated with the worker schedule to cancel.
String desiredWorkerStatus
The status to update the worker to.
Integer updateIntervalSeconds
Updates the time interval (in seconds) for the schedule.
String queueId
The queue ID.
String userIdentityId
The user's ID.
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String fleetId
The fleet ID.
HostPropertiesResponse hostProperties
Provides the Amazon EC2 instance properties of the worker host.
String status
The status of the worker search.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String workerId
The worker ID.
Date endedAt
The date and time the resource ended running.
String jobId
The job ID for the job associated with the worker's session.
String lifecycleStatus
The life cycle status for the worker's session.
String queueId
The queue ID for the queue associated to the worker.
String sessionId
The session ID for the session action.
Date startedAt
The date and time the resource started running.
String targetLifecycleStatus
The life cycle status
Date createdAt
The date and time the resource was created.
String createdBy
The user or system that created this resource.
String farmId
The farm ID.
String fleetId
The fleet ID.
HostPropertiesResponse hostProperties
The host properties of the worker.
LogConfiguration log
The log configuration for the worker.
String status
The status of the worker.
Date updatedAt
The date and time the resource was updated.
String updatedBy
The user or system that updated this resource.
String workerId
The worker ID.
Copyright © 2024. All rights reserved.