SDK for PHP 3.x

Client: Aws\Deadline\DeadlineClient
Service ID: deadline
Version: 2023-10-12

This page describes the parameters and results for the operations of the AWSDeadlineCloud (2023-10-12), and shows how to use the Aws\Deadline\DeadlineClient object to call the described operations. This documentation is specific to the 2023-10-12 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateMemberToFarm ( array $params = [] )
Assigns a farm membership level to a member.
AssociateMemberToFleet ( array $params = [] )
Assigns a fleet membership level to a member.
AssociateMemberToJob ( array $params = [] )
Assigns a job membership level to a member
AssociateMemberToQueue ( array $params = [] )
Assigns a queue membership level to a member
AssumeFleetRoleForRead ( array $params = [] )
Get Amazon Web Services credentials from the fleet role.
AssumeFleetRoleForWorker ( array $params = [] )
Get credentials from the fleet role for a worker.
AssumeQueueRoleForRead ( array $params = [] )
Gets Amazon Web Services credentials from the queue role.
AssumeQueueRoleForUser ( array $params = [] )
Allows a user to assume a role for a queue.
AssumeQueueRoleForWorker ( array $params = [] )
Allows a worker to assume a queue role.
BatchGetJobEntity ( array $params = [] )
Get batched job details for a worker.
CopyJobTemplate ( array $params = [] )
Copies a job template to an Amazon S3 bucket.
CreateBudget ( array $params = [] )
Creates a budget to set spending thresholds for your rendering activity.
CreateFarm ( array $params = [] )
Creates a farm to allow space for queues and fleets.
CreateFleet ( array $params = [] )
Creates a fleet.
CreateJob ( array $params = [] )
Creates a job.
CreateLicenseEndpoint ( array $params = [] )
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
CreateMonitor ( array $params = [] )
Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets.
CreateQueue ( array $params = [] )
Creates a queue to coordinate the order in which jobs run on a farm.
CreateQueueEnvironment ( array $params = [] )
Creates an environment for a queue that defines how jobs in the queue run.
CreateQueueFleetAssociation ( array $params = [] )
Creates an association between a queue and a fleet.
CreateStorageProfile ( array $params = [] )
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
CreateWorker ( array $params = [] )
Creates a worker.
DeleteBudget ( array $params = [] )
Deletes a budget.
DeleteFarm ( array $params = [] )
Deletes a farm.
DeleteFleet ( array $params = [] )
Deletes a fleet.
DeleteLicenseEndpoint ( array $params = [] )
Deletes a license endpoint.
DeleteMeteredProduct ( array $params = [] )
Deletes a metered product.
DeleteMonitor ( array $params = [] )
Removes a Deadline Cloud monitor.
DeleteQueue ( array $params = [] )
Deletes a queue.
DeleteQueueEnvironment ( array $params = [] )
Deletes a queue environment.
DeleteQueueFleetAssociation ( array $params = [] )
Deletes a queue-fleet association.
DeleteStorageProfile ( array $params = [] )
Deletes a storage profile.
DeleteWorker ( array $params = [] )
Deletes a worker.
DisassociateMemberFromFarm ( array $params = [] )
Disassociates a member from a farm.
DisassociateMemberFromFleet ( array $params = [] )
Disassociates a member from a fleet.
DisassociateMemberFromJob ( array $params = [] )
Disassociates a member from a job.
DisassociateMemberFromQueue ( array $params = [] )
Disassociates a member from a queue.
GetBudget ( array $params = [] )
Get a budget.
GetFarm ( array $params = [] )
Get a farm.
GetFleet ( array $params = [] )
Get a fleet.
GetJob ( array $params = [] )
Gets a Deadline Cloud job.
GetLicenseEndpoint ( array $params = [] )
Gets a licence endpoint.
GetMonitor ( array $params = [] )
Gets information about the specified monitor.
GetQueue ( array $params = [] )
Gets a queue.
GetQueueEnvironment ( array $params = [] )
Gets a queue environment.
GetQueueFleetAssociation ( array $params = [] )
Gets a queue-fleet association.
GetSession ( array $params = [] )
Gets a session.
GetSessionAction ( array $params = [] )
Gets a session action for the job.
GetSessionsStatisticsAggregation ( array $params = [] )
Gets a set of statistics for queues or farms.
GetStep ( array $params = [] )
Gets a step.
GetStorageProfile ( array $params = [] )
Gets a storage profile.
GetStorageProfileForQueue ( array $params = [] )
Gets a storage profile for a queue.
GetTask ( array $params = [] )
Gets a task.
GetWorker ( array $params = [] )
Gets a worker.
ListAvailableMeteredProducts ( array $params = [] )
A list of the available metered products.
ListBudgets ( array $params = [] )
A list of budgets in a farm.
ListFarmMembers ( array $params = [] )
Lists the members of a farm.
ListFarms ( array $params = [] )
Lists farms.
ListFleetMembers ( array $params = [] )
Lists fleet members.
ListFleets ( array $params = [] )
Lists fleets.
ListJobMembers ( array $params = [] )
Lists members on a job.
ListJobParameterDefinitions ( array $params = [] )
Lists parameter definitions of a job.
ListJobs ( array $params = [] )
Lists jobs.
ListLicenseEndpoints ( array $params = [] )
Lists license endpoints.
ListMeteredProducts ( array $params = [] )
Lists metered products.
ListMonitors ( array $params = [] )
Gets a list of your monitors in Deadline Cloud.
ListQueueEnvironments ( array $params = [] )
Lists queue environments.
ListQueueFleetAssociations ( array $params = [] )
Lists queue-fleet associations.
ListQueueMembers ( array $params = [] )
Lists the members in a queue.
ListQueues ( array $params = [] )
Lists queues.
ListSessionActions ( array $params = [] )
Lists session actions.
ListSessions ( array $params = [] )
Lists sessions.
ListSessionsForWorker ( array $params = [] )
Lists sessions for a worker.
ListStepConsumers ( array $params = [] )
Lists step consumers.
ListStepDependencies ( array $params = [] )
Lists the dependencies for a step.
ListSteps ( array $params = [] )
Lists steps for a job.
ListStorageProfiles ( array $params = [] )
Lists storage profiles.
ListStorageProfilesForQueue ( array $params = [] )
Lists storage profiles for a queue.
ListTagsForResource ( array $params = [] )
Lists tags for a resource.
ListTasks ( array $params = [] )
Lists tasks for a job.
ListWorkers ( array $params = [] )
Lists workers.
PutMeteredProduct ( array $params = [] )
Adds a metered product.
SearchJobs ( array $params = [] )
Searches for jobs.
SearchSteps ( array $params = [] )
Searches for steps.
SearchTasks ( array $params = [] )
Searches for tasks.
SearchWorkers ( array $params = [] )
Searches for workers.
StartSessionsStatisticsAggregation ( array $params = [] )
Starts an asynchronous request for getting aggregated statistics about queues and farms.
TagResource ( array $params = [] )
Tags a resource using the resource's ARN and desired tags.
UntagResource ( array $params = [] )
Removes a tag from a resource using the resource's ARN and tag to remove.
UpdateBudget ( array $params = [] )
Updates a budget that sets spending thresholds for rendering activity.
UpdateFarm ( array $params = [] )
Updates a farm.
UpdateFleet ( array $params = [] )
Updates a fleet.
UpdateJob ( array $params = [] )
Updates a job.
UpdateMonitor ( array $params = [] )
Modifies the settings for a Deadline Cloud monitor.
UpdateQueue ( array $params = [] )
Updates a queue.
UpdateQueueEnvironment ( array $params = [] )
Updates the queue environment.
UpdateQueueFleetAssociation ( array $params = [] )
Updates a queue-fleet association.
UpdateSession ( array $params = [] )
Updates a session.
UpdateStep ( array $params = [] )
Updates a step.
UpdateStorageProfile ( array $params = [] )
Updates a storage profile.
UpdateTask ( array $params = [] )
Updates a task.
UpdateWorker ( array $params = [] )
Updates a worker.
UpdateWorkerSchedule ( array $params = [] )
Updates the schedule for a worker.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetSessionsStatisticsAggregation
ListAvailableMeteredProducts
ListBudgets
ListFarmMembers
ListFarms
ListFleetMembers
ListFleets
ListJobMembers
ListJobParameterDefinitions
ListJobs
ListLicenseEndpoints
ListMeteredProducts
ListMonitors
ListQueueEnvironments
ListQueueFleetAssociations
ListQueueMembers
ListQueues
ListSessionActions
ListSessions
ListSessionsForWorker
ListStepConsumers
ListStepDependencies
ListSteps
ListStorageProfiles
ListStorageProfilesForQueue
ListTasks
ListWorkers

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
FleetActive GetFleet 5 180
JobCreateComplete GetJob 1 120
LicenseEndpointDeleted GetLicenseEndpoint 10 234
LicenseEndpointValid GetLicenseEndpoint 10 114
QueueFleetAssociationStopped GetQueueFleetAssociation 10 60
QueueScheduling GetQueue 10 70
QueueSchedulingBlocked GetQueue 10 30

Operations

AssociateMemberToFarm

$result = $client->associateMemberToFarm([/* ... */]);
$promise = $client->associateMemberToFarmAsync([/* ... */]);

Assigns a farm membership level to a member.

Parameter Syntax

$result = $client->associateMemberToFarm([
    'farmId' => '<string>', // REQUIRED
    'identityStoreId' => '<string>', // REQUIRED
    'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'principalType' => 'USER|GROUP', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The ID of the farm to associate with the member.

identityStoreId
Required: Yes
Type: string

The identity store ID of the member to associate with the farm.

membershipLevel
Required: Yes
Type: string

The principal's membership level for the associated farm.

principalId
Required: Yes
Type: string

The member's principal ID to associate with the farm.

principalType
Required: Yes
Type: string

The principal type of the member to associate with the farm.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

AssociateMemberToFleet

$result = $client->associateMemberToFleet([/* ... */]);
$promise = $client->associateMemberToFleetAsync([/* ... */]);

Assigns a fleet membership level to a member.

Parameter Syntax

$result = $client->associateMemberToFleet([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'identityStoreId' => '<string>', // REQUIRED
    'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'principalType' => 'USER|GROUP', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the fleet to associate with the member.

fleetId
Required: Yes
Type: string

The ID of the fleet to associate with a member.

identityStoreId
Required: Yes
Type: string

The member's identity store ID to associate with the fleet.

membershipLevel
Required: Yes
Type: string

The principal's membership level for the associated fleet.

principalId
Required: Yes
Type: string

The member's principal ID to associate with a fleet.

principalType
Required: Yes
Type: string

The member's principal type to associate with the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

AssociateMemberToJob

$result = $client->associateMemberToJob([/* ... */]);
$promise = $client->associateMemberToJobAsync([/* ... */]);

Assigns a job membership level to a member

Parameter Syntax

$result = $client->associateMemberToJob([
    'farmId' => '<string>', // REQUIRED
    'identityStoreId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'principalType' => 'USER|GROUP', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the job to associate with the member.

identityStoreId
Required: Yes
Type: string

The member's identity store ID to associate with the job.

jobId
Required: Yes
Type: string

The job ID to associate with the member.

membershipLevel
Required: Yes
Type: string

The principal's membership level for the associated job.

principalId
Required: Yes
Type: string

The member's principal ID to associate with the job.

principalType
Required: Yes
Type: string

The member's principal type to associate with the job.

queueId
Required: Yes
Type: string

The queue ID to associate to the member.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

AssociateMemberToQueue

$result = $client->associateMemberToQueue([/* ... */]);
$promise = $client->associateMemberToQueueAsync([/* ... */]);

Assigns a queue membership level to a member

Parameter Syntax

$result = $client->associateMemberToQueue([
    'farmId' => '<string>', // REQUIRED
    'identityStoreId' => '<string>', // REQUIRED
    'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'principalType' => 'USER|GROUP', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the queue to associate with the member.

identityStoreId
Required: Yes
Type: string

The member's identity store ID to associate with the queue.

membershipLevel
Required: Yes
Type: string

The principal's membership level for the associated queue.

principalId
Required: Yes
Type: string

The member's principal ID to associate with the queue.

principalType
Required: Yes
Type: string

The member's principal type to associate with the queue.

queueId
Required: Yes
Type: string

The ID of the queue to associate to the member.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

AssumeFleetRoleForRead

$result = $client->assumeFleetRoleForRead([/* ... */]);
$promise = $client->assumeFleetRoleForReadAsync([/* ... */]);

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

Parameter Syntax

$result = $client->assumeFleetRoleForRead([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the fleet's farm.

fleetId
Required: Yes
Type: string

The fleet ID.

Result Syntax

[
    'credentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <DateTime>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
]

Result Details

Members
credentials
Required: Yes
Type: AwsCredentials structure

The credentials for the fleet role.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AssumeFleetRoleForWorker

$result = $client->assumeFleetRoleForWorker([/* ... */]);
$promise = $client->assumeFleetRoleForWorkerAsync([/* ... */]);

Get credentials from the fleet role for a worker.

Parameter Syntax

$result = $client->assumeFleetRoleForWorker([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the fleet's farm.

fleetId
Required: Yes
Type: string

The fleet ID that contains the worker.

workerId
Required: Yes
Type: string

The ID of the worker assuming the fleet role.

Result Syntax

[
    'credentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <DateTime>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
]

Result Details

Members
credentials
Required: Yes
Type: AwsCredentials structure

The credentials for the worker.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AssumeQueueRoleForRead

$result = $client->assumeQueueRoleForRead([/* ... */]);
$promise = $client->assumeQueueRoleForReadAsync([/* ... */]);

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

Parameter Syntax

$result = $client->assumeQueueRoleForRead([
    'farmId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm containing the queue.

queueId
Required: Yes
Type: string

The queue ID.

Result Syntax

[
    'credentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <DateTime>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
]

Result Details

Members
credentials
Required: Yes
Type: AwsCredentials structure

The credentials for the queue role.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AssumeQueueRoleForUser

$result = $client->assumeQueueRoleForUser([/* ... */]);
$promise = $client->assumeQueueRoleForUserAsync([/* ... */]);

Allows a user to assume a role for a queue.

Parameter Syntax

$result = $client->assumeQueueRoleForUser([
    'farmId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the queue that the user assumes the role for.

queueId
Required: Yes
Type: string

The queue ID of the queue that the user assumes the role for.

Result Syntax

[
    'credentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <DateTime>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
]

Result Details

Members
credentials
Required: Yes
Type: AwsCredentials structure

The credentials for the queue role that a user has access to.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AssumeQueueRoleForWorker

$result = $client->assumeQueueRoleForWorker([/* ... */]);
$promise = $client->assumeQueueRoleForWorkerAsync([/* ... */]);

Allows a worker to assume a queue role.

Parameter Syntax

$result = $client->assumeQueueRoleForWorker([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the worker assuming the queue role.

fleetId
Required: Yes
Type: string

The fleet ID of the worker assuming the queue role.

queueId
Required: Yes
Type: string

The queue ID of the worker assuming the queue role.

workerId
Required: Yes
Type: string

The worker ID of the worker assuming the queue role.

Result Syntax

[
    'credentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <DateTime>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
]

Result Details

Members
credentials
Type: AwsCredentials structure

The Amazon Web Services credentials for the role that the worker is assuming.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

BatchGetJobEntity

$result = $client->batchGetJobEntity([/* ... */]);
$promise = $client->batchGetJobEntityAsync([/* ... */]);

Get batched job details for a worker.

Parameter Syntax

$result = $client->batchGetJobEntity([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'identifiers' => [ // REQUIRED
        [
            'environmentDetails' => [
                'environmentId' => '<string>', // REQUIRED
                'jobId' => '<string>', // REQUIRED
            ],
            'jobAttachmentDetails' => [
                'jobId' => '<string>', // REQUIRED
            ],
            'jobDetails' => [
                'jobId' => '<string>', // REQUIRED
            ],
            'stepDetails' => [
                'jobId' => '<string>', // REQUIRED
                'stepId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

fleetId
Required: Yes
Type: string

The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

identifiers
Required: Yes
Type: Array of JobEntityIdentifiersUnion structures

The job identifiers to include within the job entity batch details.

workerId
Required: Yes
Type: string

The worker ID of the worker containing the job details to get.

Result Syntax

[
    'entities' => [
        [
            'environmentDetails' => [
                'environmentId' => '<string>',
                'jobId' => '<string>',
                'schemaVersion' => '<string>',
                'template' => [
                ],
            ],
            'jobAttachmentDetails' => [
                'attachments' => [
                    'fileSystem' => 'COPIED|VIRTUAL',
                    'manifests' => [
                        [
                            'fileSystemLocationName' => '<string>',
                            'inputManifestHash' => '<string>',
                            'inputManifestPath' => '<string>',
                            'outputRelativeDirectories' => ['<string>', ...],
                            'rootPath' => '<string>',
                            'rootPathFormat' => 'windows|posix',
                        ],
                        // ...
                    ],
                ],
                'jobId' => '<string>',
            ],
            'jobDetails' => [
                'jobAttachmentSettings' => [
                    'rootPrefix' => '<string>',
                    's3BucketName' => '<string>',
                ],
                'jobId' => '<string>',
                'jobRunAsUser' => [
                    'posix' => [
                        'group' => '<string>',
                        'user' => '<string>',
                    ],
                    'runAs' => 'QUEUE_CONFIGURED_USER|WORKER_AGENT_USER',
                    'windows' => [
                        'passwordArn' => '<string>',
                        'user' => '<string>',
                    ],
                ],
                'logGroupName' => '<string>',
                'parameters' => [
                    '<String>' => [
                        'float' => '<string>',
                        'int' => '<string>',
                        'path' => '<string>',
                        'string' => '<string>',
                    ],
                    // ...
                ],
                'pathMappingRules' => [
                    [
                        'destinationPath' => '<string>',
                        'sourcePath' => '<string>',
                        'sourcePathFormat' => 'windows|posix',
                    ],
                    // ...
                ],
                'queueRoleArn' => '<string>',
                'schemaVersion' => '<string>',
            ],
            'stepDetails' => [
                'dependencies' => ['<string>', ...],
                'jobId' => '<string>',
                'schemaVersion' => '<string>',
                'stepId' => '<string>',
                'template' => [
                ],
            ],
        ],
        // ...
    ],
    'errors' => [
        [
            'environmentDetails' => [
                'code' => 'AccessDeniedException|InternalServerException|ValidationException|ResourceNotFoundException|MaxPayloadSizeExceeded|ConflictException',
                'environmentId' => '<string>',
                'jobId' => '<string>',
                'message' => '<string>',
            ],
            'jobAttachmentDetails' => [
                'code' => 'AccessDeniedException|InternalServerException|ValidationException|ResourceNotFoundException|MaxPayloadSizeExceeded|ConflictException',
                'jobId' => '<string>',
                'message' => '<string>',
            ],
            'jobDetails' => [
                'code' => 'AccessDeniedException|InternalServerException|ValidationException|ResourceNotFoundException|MaxPayloadSizeExceeded|ConflictException',
                'jobId' => '<string>',
                'message' => '<string>',
            ],
            'stepDetails' => [
                'code' => 'AccessDeniedException|InternalServerException|ValidationException|ResourceNotFoundException|MaxPayloadSizeExceeded|ConflictException',
                'jobId' => '<string>',
                'message' => '<string>',
                'stepId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
entities
Required: Yes
Type: Array of JobEntity structures

A list of the job entities, or details, in the batch.

errors
Required: Yes
Type: Array of GetJobEntityError structures

A list of errors from the job error logs for the batch.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

CopyJobTemplate

$result = $client->copyJobTemplate([/* ... */]);
$promise = $client->copyJobTemplateAsync([/* ... */]);

Copies a job template to an Amazon S3 bucket.

Parameter Syntax

$result = $client->copyJobTemplate([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'targetS3Location' => [ // REQUIRED
        'bucketName' => '<string>', // REQUIRED
        'key' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID to copy.

jobId
Required: Yes
Type: string

The job ID to copy.

queueId
Required: Yes
Type: string

The queue ID to copy.

targetS3Location
Required: Yes
Type: S3Location structure

The Amazon S3 bucket name and key where you would like to add a copy of the job template.

Result Syntax

[
    'templateType' => 'JSON|YAML',
]

Result Details

Members
templateType
Required: Yes
Type: string

The format of the job template, either JSON or YAML.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

CreateBudget

$result = $client->createBudget([/* ... */]);
$promise = $client->createBudgetAsync([/* ... */]);

Creates a budget to set spending thresholds for your rendering activity.

Parameter Syntax

$result = $client->createBudget([
    'actions' => [ // REQUIRED
        [
            'description' => '<string>',
            'thresholdPercentage' => <float>, // REQUIRED
            'type' => 'STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS', // REQUIRED
        ],
        // ...
    ],
    'approximateDollarLimit' => <float>, // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'schedule' => [ // REQUIRED
        'fixed' => [
            'endTime' => <integer || string || DateTime>, // REQUIRED
            'startTime' => <integer || string || DateTime>, // REQUIRED
        ],
    ],
    'usageTrackingResource' => [ // REQUIRED
        'queueId' => '<string>',
    ],
]);

Parameter Details

Members
actions
Required: Yes
Type: Array of BudgetActionToAdd structures

The budget actions to specify what happens when the budget runs out.

approximateDollarLimit
Required: Yes
Type: float

The dollar limit based on consumed usage.

clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID to include in this budget.

schedule
Required: Yes
Type: BudgetSchedule structure

The schedule to associate with this budget.

usageTrackingResource
Required: Yes
Type: UsageTrackingResource structure

The queue ID provided to this budget to track usage.

Result Syntax

[
    'budgetId' => '<string>',
]

Result Details

Members
budgetId
Required: Yes
Type: string

The budget ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateFarm

$result = $client->createFarm([/* ... */]);
$promise = $client->createFarmAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createFarm([
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'kmsKeyArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

kmsKeyArn
Type: string

The ARN of the KMS key to use on the farm.

tags
Type: Associative array of custom strings keys (String) to strings

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.

Result Syntax

[
    'farmId' => '<string>',
]

Result Details

Members
farmId
Required: Yes
Type: string

The farm ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateFleet

$result = $client->createFleet([/* ... */]);
$promise = $client->createFleetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createFleet([
    'clientToken' => '<string>',
    'configuration' => [ // REQUIRED
        'customerManaged' => [
            'mode' => 'NO_SCALING|EVENT_BASED_AUTO_SCALING', // REQUIRED
            'storageProfileId' => '<string>',
            'workerCapabilities' => [ // REQUIRED
                'acceleratorCount' => [
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'acceleratorTotalMemoryMiB' => [
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'acceleratorTypes' => ['<string>', ...],
                'cpuArchitectureType' => 'x86_64|arm64', // REQUIRED
                'customAmounts' => [
                    [
                        'max' => <float>,
                        'min' => <float>, // REQUIRED
                        'name' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'customAttributes' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'values' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
                'memoryMiB' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'osFamily' => 'WINDOWS|LINUX|MACOS', // REQUIRED
                'vCpuCount' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
            ],
        ],
        'serviceManagedEc2' => [
            'instanceCapabilities' => [ // REQUIRED
                'acceleratorCapabilities' => [
                    'count' => [
                        'max' => <integer>,
                        'min' => <integer>, // REQUIRED
                    ],
                    'selections' => [ // REQUIRED
                        [
                            'name' => 't4|a10g|l4|l40s', // REQUIRED
                            'runtime' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'allowedInstanceTypes' => ['<string>', ...],
                'cpuArchitectureType' => 'x86_64|arm64', // REQUIRED
                'customAmounts' => [
                    [
                        'max' => <float>,
                        'min' => <float>, // REQUIRED
                        'name' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'customAttributes' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'values' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
                'excludedInstanceTypes' => ['<string>', ...],
                'memoryMiB' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'osFamily' => 'WINDOWS|LINUX', // REQUIRED
                'rootEbsVolume' => [
                    'iops' => <integer>,
                    'sizeGiB' => <integer>,
                    'throughputMiB' => <integer>,
                ],
                'vCpuCount' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
            ],
            'instanceMarketOptions' => [ // REQUIRED
                'type' => 'on-demand|spot', // REQUIRED
            ],
        ],
    ],
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'maxWorkerCount' => <integer>, // REQUIRED
    'minWorkerCount' => <integer>,
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

configuration
Required: Yes
Type: FleetConfiguration structure

The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID of the farm to connect to the fleet.

maxWorkerCount
Required: Yes
Type: int

The maximum number of workers for the fleet.

minWorkerCount
Type: int

The minimum number of workers for the fleet.

roleArn
Required: Yes
Type: string

The IAM role ARN for the role that the fleet's workers will use.

tags
Type: Associative array of custom strings keys (String) to strings

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.

Result Syntax

[
    'fleetId' => '<string>',
]

Result Details

Members
fleetId
Required: Yes
Type: string

The fleet ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateJob

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

Creates a job. A job is a set of instructions that AWS Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

Parameter Syntax

$result = $client->createJob([
    'attachments' => [
        'fileSystem' => 'COPIED|VIRTUAL',
        'manifests' => [ // REQUIRED
            [
                'fileSystemLocationName' => '<string>',
                'inputManifestHash' => '<string>',
                'inputManifestPath' => '<string>',
                'outputRelativeDirectories' => ['<string>', ...],
                'rootPath' => '<string>', // REQUIRED
                'rootPathFormat' => 'windows|posix', // REQUIRED
            ],
            // ...
        ],
    ],
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'maxFailedTasksCount' => <integer>,
    'maxRetriesPerTask' => <integer>,
    'parameters' => [
        '<String>' => [
            'float' => '<string>',
            'int' => '<string>',
            'path' => '<string>',
            'string' => '<string>',
        ],
        // ...
    ],
    'priority' => <integer>, // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'sourceJobId' => '<string>',
    'storageProfileId' => '<string>',
    'targetTaskRunStatus' => 'READY|SUSPENDED',
    'template' => '<string>',
    'templateType' => 'JSON|YAML',
]);

Parameter Details

Members
attachments
Type: Attachments structure

The attachments for the job. Attach files required for the job to run to a render job.

clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID of the farm to connect to the job.

maxFailedTasksCount
Type: int

The number of task failures before the job stops running and is marked as FAILED.

maxRetriesPerTask
Type: int

The maximum number of retries for each task.

parameters
Type: Associative array of custom strings keys (String) to JobParameter structures

The parameters for the job.

priority
Required: Yes
Type: int

The priority of the job on a scale of 0 to 100. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

queueId
Required: Yes
Type: string

The ID of the queue that the job is submitted to.

sourceJobId
Type: string

The job ID for the source job.

storageProfileId
Type: string

The storage profile ID for the storage profile to connect to the job.

targetTaskRunStatus
Type: string

The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

template
Type: string

The job template to use for this job.

templateType
Type: string

The file type for the job template.

Result Syntax

[
    'jobId' => '<string>',
]

Result Details

Members
jobId
Required: Yes
Type: string

The job ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateLicenseEndpoint

$result = $client->createLicenseEndpoint([/* ... */]);
$promise = $client->createLicenseEndpointAsync([/* ... */]);

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

Parameter Syntax

$result = $client->createLicenseEndpoint([
    'clientToken' => '<string>',
    'securityGroupIds' => ['<string>', ...], // REQUIRED
    'subnetIds' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'vpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

securityGroupIds
Required: Yes
Type: Array of strings

The security group IDs.

subnetIds
Required: Yes
Type: Array of strings

The subnet IDs.

tags
Type: Associative array of custom strings keys (String) to strings

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.

vpcId
Required: Yes
Type: string

The VPC (virtual private cloud) ID to use with the license endpoint.

Result Syntax

[
    'licenseEndpointId' => '<string>',
]

Result Details

Members
licenseEndpointId
Required: Yes
Type: string

The license endpoint ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateMonitor

$result = $client->createMonitor([/* ... */]);
$promise = $client->createMonitorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createMonitor([
    'clientToken' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'identityCenterInstanceArn' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'subdomain' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

displayName
Required: Yes
Type: string

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.

identityCenterInstanceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.

roleArn
Required: Yes
Type: string

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.

subdomain
Required: Yes
Type: string

The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

Result Syntax

[
    'identityCenterApplicationArn' => '<string>',
    'monitorId' => '<string>',
]

Result Details

Members
identityCenterApplicationArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.

monitorId
Required: Yes
Type: string

The unique identifier of the monitor.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateQueue

$result = $client->createQueue([/* ... */]);
$promise = $client->createQueueAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createQueue([
    'allowedStorageProfileIds' => ['<string>', ...],
    'clientToken' => '<string>',
    'defaultBudgetAction' => 'NONE|STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS',
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'jobAttachmentSettings' => [
        'rootPrefix' => '<string>', // REQUIRED
        's3BucketName' => '<string>', // REQUIRED
    ],
    'jobRunAsUser' => [
        'posix' => [
            'group' => '<string>', // REQUIRED
            'user' => '<string>', // REQUIRED
        ],
        'runAs' => 'QUEUE_CONFIGURED_USER|WORKER_AGENT_USER', // REQUIRED
        'windows' => [
            'passwordArn' => '<string>', // REQUIRED
            'user' => '<string>', // REQUIRED
        ],
    ],
    'requiredFileSystemLocationNames' => ['<string>', ...],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
allowedStorageProfileIds
Type: Array of strings

The storage profile IDs to include in the queue.

clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

defaultBudgetAction
Type: string

The default action to take on a queue if a budget isn't configured.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID of the farm to connect to the queue.

jobAttachmentSettings
Type: JobAttachmentSettings structure

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

jobRunAsUser
Type: JobRunAsUser structure

The jobs in the queue run as the specified POSIX user.

requiredFileSystemLocationNames
Type: Array of strings

The file system location name to include in the queue.

roleArn
Type: string

The IAM role ARN that workers will use while running jobs for this queue.

tags
Type: Associative array of custom strings keys (String) to strings

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.

Result Syntax

[
    'queueId' => '<string>',
]

Result Details

Members
queueId
Required: Yes
Type: string

The queue ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateQueueEnvironment

$result = $client->createQueueEnvironment([/* ... */]);
$promise = $client->createQueueEnvironmentAsync([/* ... */]);

Creates an environment for a queue that defines how jobs in the queue run.

Parameter Syntax

$result = $client->createQueueEnvironment([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'priority' => <integer>, // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'template' => '<string>', // REQUIRED
    'templateType' => 'JSON|YAML', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID of the farm to connect to the environment.

priority
Required: Yes
Type: int

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.

queueId
Required: Yes
Type: string

The queue ID to connect the queue and environment.

template
Required: Yes
Type: string

The environment template to use in the queue.

templateType
Required: Yes
Type: string

The template's file type, JSON or YAML.

Result Syntax

[
    'queueEnvironmentId' => '<string>',
]

Result Details

Members
queueEnvironmentId
Required: Yes
Type: string

The queue environment ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateQueueFleetAssociation

$result = $client->createQueueFleetAssociation([/* ... */]);
$promise = $client->createQueueFleetAssociationAsync([/* ... */]);

Creates an association between a queue and a fleet.

Parameter Syntax

$result = $client->createQueueFleetAssociation([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The ID of the farm that the queue and fleet belong to.

fleetId
Required: Yes
Type: string

The fleet ID.

queueId
Required: Yes
Type: string

The queue ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

CreateStorageProfile

$result = $client->createStorageProfile([/* ... */]);
$promise = $client->createStorageProfileAsync([/* ... */]);

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

Parameter Syntax

$result = $client->createStorageProfile([
    'clientToken' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'fileSystemLocations' => [
        [
            'name' => '<string>', // REQUIRED
            'path' => '<string>', // REQUIRED
            'type' => 'SHARED|LOCAL', // REQUIRED
        ],
        // ...
    ],
    'osFamily' => 'WINDOWS|LINUX|MACOS', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID of the farm to connect to the storage profile.

fileSystemLocations
Type: Array of FileSystemLocation structures

File system paths to include in the storage profile.

osFamily
Required: Yes
Type: string

The type of operating system (OS) for the storage profile.

Result Syntax

[
    'storageProfileId' => '<string>',
]

Result Details

Members
storageProfileId
Required: Yes
Type: string

The storage profile ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

CreateWorker

$result = $client->createWorker([/* ... */]);
$promise = $client->createWorkerAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createWorker([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'hostProperties' => [
        'hostName' => '<string>',
        'ipAddresses' => [
            'ipV4Addresses' => ['<string>', ...],
            'ipV6Addresses' => ['<string>', ...],
        ],
    ],
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID of the farm to connect to the worker.

fleetId
Required: Yes
Type: string

The fleet ID to connect to the worker.

hostProperties
Type: HostPropertiesRequest structure

The IP address and host name of the worker.

Result Syntax

[
    'workerId' => '<string>',
]

Result Details

Members
workerId
Required: Yes
Type: string

The worker ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteBudget

$result = $client->deleteBudget([/* ... */]);
$promise = $client->deleteBudgetAsync([/* ... */]);

Deletes a budget.

Parameter Syntax

$result = $client->deleteBudget([
    'budgetId' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
]);

Parameter Details

Members
budgetId
Required: Yes
Type: string

The budget ID of the budget to delete.

farmId
Required: Yes
Type: string

The farm ID of the farm to remove from the budget.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteFarm

$result = $client->deleteFarm([/* ... */]);
$promise = $client->deleteFarmAsync([/* ... */]);

Deletes a farm.

Parameter Syntax

$result = $client->deleteFarm([
    'farmId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteFleet

$result = $client->deleteFleet([/* ... */]);
$promise = $client->deleteFleetAsync([/* ... */]);

Deletes a fleet.

Parameter Syntax

$result = $client->deleteFleet([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID of the farm to remove from the fleet.

fleetId
Required: Yes
Type: string

The fleet ID of the fleet to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteLicenseEndpoint

$result = $client->deleteLicenseEndpoint([/* ... */]);
$promise = $client->deleteLicenseEndpointAsync([/* ... */]);

Deletes a license endpoint.

Parameter Syntax

$result = $client->deleteLicenseEndpoint([
    'licenseEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members
licenseEndpointId
Required: Yes
Type: string

The license endpoint ID of the license endpoint to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteMeteredProduct

$result = $client->deleteMeteredProduct([/* ... */]);
$promise = $client->deleteMeteredProductAsync([/* ... */]);

Deletes a metered product.

Parameter Syntax

$result = $client->deleteMeteredProduct([
    'licenseEndpointId' => '<string>', // REQUIRED
    'productId' => '<string>', // REQUIRED
]);

Parameter Details

Members
licenseEndpointId
Required: Yes
Type: string

The ID of the license endpoint from which to remove the metered product.

productId
Required: Yes
Type: string

The product ID to remove from the license endpoint.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteMonitor

$result = $client->deleteMonitor([/* ... */]);
$promise = $client->deleteMonitorAsync([/* ... */]);

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

Parameter Syntax

$result = $client->deleteMonitor([
    'monitorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
monitorId
Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteQueue

$result = $client->deleteQueue([/* ... */]);
$promise = $client->deleteQueueAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteQueue([
    'farmId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The ID of the farm from which to remove the queue.

queueId
Required: Yes
Type: string

The queue ID of the queue to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteQueueEnvironment

$result = $client->deleteQueueEnvironment([/* ... */]);
$promise = $client->deleteQueueEnvironmentAsync([/* ... */]);

Deletes a queue environment.

Parameter Syntax

$result = $client->deleteQueueEnvironment([
    'farmId' => '<string>', // REQUIRED
    'queueEnvironmentId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm from which to remove the queue environment.

queueEnvironmentId
Required: Yes
Type: string

The queue environment ID of the queue environment to delete.

queueId
Required: Yes
Type: string

The queue ID of the queue environment to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteQueueFleetAssociation

$result = $client->deleteQueueFleetAssociation([/* ... */]);
$promise = $client->deleteQueueFleetAssociationAsync([/* ... */]);

Deletes a queue-fleet association.

Parameter Syntax

$result = $client->deleteQueueFleetAssociation([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm that holds the queue-fleet association.

fleetId
Required: Yes
Type: string

The fleet ID of the queue-fleet association.

queueId
Required: Yes
Type: string

The queue ID of the queue-fleet association.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteStorageProfile

$result = $client->deleteStorageProfile([/* ... */]);
$promise = $client->deleteStorageProfileAsync([/* ... */]);

Deletes a storage profile.

Parameter Syntax

$result = $client->deleteStorageProfile([
    'farmId' => '<string>', // REQUIRED
    'storageProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm from which to remove the storage profile.

storageProfileId
Required: Yes
Type: string

The storage profile ID of the storage profile to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeleteWorker

$result = $client->deleteWorker([/* ... */]);
$promise = $client->deleteWorkerAsync([/* ... */]);

Deletes a worker.

Parameter Syntax

$result = $client->deleteWorker([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the worker to delete.

fleetId
Required: Yes
Type: string

The fleet ID of the worker to delete.

workerId
Required: Yes
Type: string

The worker ID of the worker to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DisassociateMemberFromFarm

$result = $client->disassociateMemberFromFarm([/* ... */]);
$promise = $client->disassociateMemberFromFarmAsync([/* ... */]);

Disassociates a member from a farm.

Parameter Syntax

$result = $client->disassociateMemberFromFarm([
    'farmId' => '<string>', // REQUIRED
    'principalId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm to disassociate from the member.

principalId
Required: Yes
Type: string

A member's principal ID to disassociate from a farm.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DisassociateMemberFromFleet

$result = $client->disassociateMemberFromFleet([/* ... */]);
$promise = $client->disassociateMemberFromFleetAsync([/* ... */]);

Disassociates a member from a fleet.

Parameter Syntax

$result = $client->disassociateMemberFromFleet([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'principalId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the fleet to disassociate a member from.

fleetId
Required: Yes
Type: string

The fleet ID of the fleet to from which to disassociate a member.

principalId
Required: Yes
Type: string

A member's principal ID to disassociate from a fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DisassociateMemberFromJob

$result = $client->disassociateMemberFromJob([/* ... */]);
$promise = $client->disassociateMemberFromJobAsync([/* ... */]);

Disassociates a member from a job.

Parameter Syntax

$result = $client->disassociateMemberFromJob([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the job to disassociate from the member.

jobId
Required: Yes
Type: string

The job ID to disassociate from a member in a job.

principalId
Required: Yes
Type: string

A member's principal ID to disassociate from a job.

queueId
Required: Yes
Type: string

The queue ID connected to a job for which you're disassociating a member.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DisassociateMemberFromQueue

$result = $client->disassociateMemberFromQueue([/* ... */]);
$promise = $client->disassociateMemberFromQueueAsync([/* ... */]);

Disassociates a member from a queue.

Parameter Syntax

$result = $client->disassociateMemberFromQueue([
    'farmId' => '<string>', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the queue to disassociate from a member.

principalId
Required: Yes
Type: string

A member's principal ID to disassociate from a queue.

queueId
Required: Yes
Type: string

The queue ID of the queue in which you're disassociating from a member.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetBudget

$result = $client->getBudget([/* ... */]);
$promise = $client->getBudgetAsync([/* ... */]);

Get a budget.

Parameter Syntax

$result = $client->getBudget([
    'budgetId' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
]);

Parameter Details

Members
budgetId
Required: Yes
Type: string

The budget ID.

farmId
Required: Yes
Type: string

The farm ID of the farm connected to the budget.

Result Syntax

[
    'actions' => [
        [
            'description' => '<string>',
            'thresholdPercentage' => <float>,
            'type' => 'STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS',
        ],
        // ...
    ],
    'approximateDollarLimit' => <float>,
    'budgetId' => '<string>',
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'queueStoppedAt' => <DateTime>,
    'schedule' => [
        'fixed' => [
            'endTime' => <DateTime>,
            'startTime' => <DateTime>,
        ],
    ],
    'status' => 'ACTIVE|INACTIVE',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'usageTrackingResource' => [
        'queueId' => '<string>',
    ],
    'usages' => [
        'approximateDollarUsage' => <float>,
    ],
]

Result Details

Members
actions
Required: Yes
Type: Array of ResponseBudgetAction structures

The budget actions for the budget.

approximateDollarLimit
Required: Yes
Type: float

The consumed usage limit for the budget.

budgetId
Required: Yes
Type: string

The budget ID.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

queueStoppedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the queue stopped.

schedule
Required: Yes
Type: BudgetSchedule structure

The budget schedule.

status
Required: Yes
Type: string

The status of the budget.

  • ACTIVE–Get a budget being evaluated.

  • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

usageTrackingResource
Required: Yes
Type: UsageTrackingResource structure

The resource that the budget is tracking usage for.

usages
Required: Yes
Type: ConsumedUsages structure

The usages of the budget.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetFarm

$result = $client->getFarm([/* ... */]);
$promise = $client->getFarmAsync([/* ... */]);

Get a farm.

Parameter Syntax

$result = $client->getFarm([
    'farmId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>',
    'kmsKeyArn' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID of the farm to get.

kmsKeyArn
Required: Yes
Type: string

The ARN of the KMS key used on the farm.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetFleet

$result = $client->getFleet([/* ... */]);
$promise = $client->getFleetAsync([/* ... */]);

Get a fleet.

Parameter Syntax

$result = $client->getFleet([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm in the fleet.

fleetId
Required: Yes
Type: string

The fleet ID of the fleet to get.

Result Syntax

[
    'autoScalingStatus' => 'GROWING|STEADY|SHRINKING',
    'capabilities' => [
        'amounts' => [
            [
                'max' => <float>,
                'min' => <float>,
                'name' => '<string>',
            ],
            // ...
        ],
        'attributes' => [
            [
                'name' => '<string>',
                'values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'configuration' => [
        'customerManaged' => [
            'mode' => 'NO_SCALING|EVENT_BASED_AUTO_SCALING',
            'storageProfileId' => '<string>',
            'workerCapabilities' => [
                'acceleratorCount' => [
                    'max' => <integer>,
                    'min' => <integer>,
                ],
                'acceleratorTotalMemoryMiB' => [
                    'max' => <integer>,
                    'min' => <integer>,
                ],
                'acceleratorTypes' => ['<string>', ...],
                'cpuArchitectureType' => 'x86_64|arm64',
                'customAmounts' => [
                    [
                        'max' => <float>,
                        'min' => <float>,
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'customAttributes' => [
                    [
                        'name' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'memoryMiB' => [
                    'max' => <integer>,
                    'min' => <integer>,
                ],
                'osFamily' => 'WINDOWS|LINUX|MACOS',
                'vCpuCount' => [
                    'max' => <integer>,
                    'min' => <integer>,
                ],
            ],
        ],
        'serviceManagedEc2' => [
            'instanceCapabilities' => [
                'acceleratorCapabilities' => [
                    'count' => [
                        'max' => <integer>,
                        'min' => <integer>,
                    ],
                    'selections' => [
                        [
                            'name' => 't4|a10g|l4|l40s',
                            'runtime' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'allowedInstanceTypes' => ['<string>', ...],
                'cpuArchitectureType' => 'x86_64|arm64',
                'customAmounts' => [
                    [
                        'max' => <float>,
                        'min' => <float>,
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'customAttributes' => [
                    [
                        'name' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'excludedInstanceTypes' => ['<string>', ...],
                'memoryMiB' => [
                    'max' => <integer>,
                    'min' => <integer>,
                ],
                'osFamily' => 'WINDOWS|LINUX',
                'rootEbsVolume' => [
                    'iops' => <integer>,
                    'sizeGiB' => <integer>,
                    'throughputMiB' => <integer>,
                ],
                'vCpuCount' => [
                    'max' => <integer>,
                    'min' => <integer>,
                ],
            ],
            'instanceMarketOptions' => [
                'type' => 'on-demand|spot',
            ],
        ],
    ],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>',
    'fleetId' => '<string>',
    'maxWorkerCount' => <integer>,
    'minWorkerCount' => <integer>,
    'roleArn' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|UPDATE_IN_PROGRESS|CREATE_FAILED|UPDATE_FAILED',
    'targetWorkerCount' => <integer>,
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'workerCount' => <integer>,
]

Result Details

Members
autoScalingStatus
Type: string

The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.

capabilities
Type: FleetCapabilities structure

Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

configuration
Required: Yes
Type: FleetConfiguration structure

The configuration setting for the fleet.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID of the farm in the fleet.

fleetId
Required: Yes
Type: string

The fleet ID.

maxWorkerCount
Required: Yes
Type: int

The maximum number of workers specified in the fleet.

minWorkerCount
Required: Yes
Type: int

The minimum number of workers specified in the fleet.

roleArn
Required: Yes
Type: string

The IAM role ARN.

status
Required: Yes
Type: string

The Auto Scaling status of the fleet.

targetWorkerCount
Type: int

The number of target workers in the fleet.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

workerCount
Required: Yes
Type: int

The number of workers in the fleet.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetJob

$result = $client->getJob([/* ... */]);
$promise = $client->getJobAsync([/* ... */]);

Gets a Deadline Cloud job.

Parameter Syntax

$result = $client->getJob([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm in the job.

jobId
Required: Yes
Type: string

The job ID.

queueId
Required: Yes
Type: string

The queue ID associated with the job.

Result Syntax

[
    'attachments' => [
        'fileSystem' => 'COPIED|VIRTUAL',
        'manifests' => [
            [
                'fileSystemLocationName' => '<string>',
                'inputManifestHash' => '<string>',
                'inputManifestPath' => '<string>',
                'outputRelativeDirectories' => ['<string>', ...],
                'rootPath' => '<string>',
                'rootPathFormat' => 'windows|posix',
            ],
            // ...
        ],
    ],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'endedAt' => <DateTime>,
    'jobId' => '<string>',
    'lifecycleStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|UPLOAD_IN_PROGRESS|UPLOAD_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_SUCCEEDED|ARCHIVED',
    'lifecycleStatusMessage' => '<string>',
    'maxFailedTasksCount' => <integer>,
    'maxRetriesPerTask' => <integer>,
    'name' => '<string>',
    'parameters' => [
        '<String>' => [
            'float' => '<string>',
            'int' => '<string>',
            'path' => '<string>',
            'string' => '<string>',
        ],
        // ...
    ],
    'priority' => <integer>,
    'sourceJobId' => '<string>',
    'startedAt' => <DateTime>,
    'storageProfileId' => '<string>',
    'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
    'taskRunStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
    'taskRunStatusCounts' => [<integer>, ...],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
attachments
Type: Attachments structure

The attachments for the job.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

description
Type: string

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.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

jobId
Required: Yes
Type: string

The job ID.

lifecycleStatus
Required: Yes
Type: string

The life cycle status for the job.

lifecycleStatusMessage
Required: Yes
Type: string

A message that communicates the status of the life cycle for the job.

maxFailedTasksCount
Type: int

The number of task failures before the job stops running and is marked as FAILED.

maxRetriesPerTask
Type: int

The maximum number of retries per failed tasks.

name
Required: Yes
Type: string

The name of the job.

parameters
Type: Associative array of custom strings keys (String) to JobParameter structures

The parameters for the job.

priority
Required: Yes
Type: int

The job priority.

sourceJobId
Type: string

The job ID for the source job.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

storageProfileId
Type: string

The storage profile ID associated with the job.

targetTaskRunStatus
Type: string

The task status with which the job started.

taskRunStatus
Type: string

The task run status for the job.

taskRunStatusCounts
Type: Associative array of custom strings keys (TaskRunStatus) to ints

The number of tasks running on the job.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetLicenseEndpoint

$result = $client->getLicenseEndpoint([/* ... */]);
$promise = $client->getLicenseEndpointAsync([/* ... */]);

Gets a licence endpoint.

Parameter Syntax

$result = $client->getLicenseEndpoint([
    'licenseEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members
licenseEndpointId
Required: Yes
Type: string

The license endpoint ID.

Result Syntax

[
    'dnsName' => '<string>',
    'licenseEndpointId' => '<string>',
    'securityGroupIds' => ['<string>', ...],
    'status' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|NOT_READY',
    'statusMessage' => '<string>',
    'subnetIds' => ['<string>', ...],
    'vpcId' => '<string>',
]

Result Details

Members
dnsName
Type: string

The DNS name.

licenseEndpointId
Required: Yes
Type: string

The license endpoint ID.

securityGroupIds
Type: Array of strings

The security group IDs for the license endpoint.

status
Required: Yes
Type: string

The status of the license endpoint.

statusMessage
Required: Yes
Type: string

The status message of the license endpoint.

subnetIds
Type: Array of strings

The subnet IDs.

vpcId
Type: string

The VCP(virtual private cloud) ID associated with the license endpoint.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetMonitor

$result = $client->getMonitor([/* ... */]);
$promise = $client->getMonitorAsync([/* ... */]);

Gets information about the specified monitor.

Parameter Syntax

$result = $client->getMonitor([
    'monitorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
monitorId
Required: Yes
Type: string

The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'displayName' => '<string>',
    'identityCenterApplicationArn' => '<string>',
    'identityCenterInstanceArn' => '<string>',
    'monitorId' => '<string>',
    'roleArn' => '<string>',
    'subdomain' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'url' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The UNIX timestamp of the date and time that the monitor was created.

createdBy
Required: Yes
Type: string

The user name of the person that created the monitor.

displayName
Required: Yes
Type: string

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.

identityCenterApplicationArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.

identityCenterInstanceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

monitorId
Required: Yes
Type: string

The unique identifier for the monitor.

roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

subdomain
Required: Yes
Type: string

The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The UNIX timestamp of the last date and time that the monitor was updated.

updatedBy
Type: string

The user name of the person that last updated the monitor.

url
Required: Yes
Type: string

The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetQueue

$result = $client->getQueue([/* ... */]);
$promise = $client->getQueueAsync([/* ... */]);

Gets a queue.

Parameter Syntax

$result = $client->getQueue([
    'farmId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm in the queue.

queueId
Required: Yes
Type: string

The queue ID for the queue to retrieve.

Result Syntax

[
    'allowedStorageProfileIds' => ['<string>', ...],
    'blockedReason' => 'NO_BUDGET_CONFIGURED|BUDGET_THRESHOLD_REACHED',
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'defaultBudgetAction' => 'NONE|STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS',
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>',
    'jobAttachmentSettings' => [
        'rootPrefix' => '<string>',
        's3BucketName' => '<string>',
    ],
    'jobRunAsUser' => [
        'posix' => [
            'group' => '<string>',
            'user' => '<string>',
        ],
        'runAs' => 'QUEUE_CONFIGURED_USER|WORKER_AGENT_USER',
        'windows' => [
            'passwordArn' => '<string>',
            'user' => '<string>',
        ],
    ],
    'queueId' => '<string>',
    'requiredFileSystemLocationNames' => ['<string>', ...],
    'roleArn' => '<string>',
    'status' => 'IDLE|SCHEDULING|SCHEDULING_BLOCKED',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
allowedStorageProfileIds
Type: Array of strings

The storage profile IDs for the queue.

blockedReason
Type: string

The reason the queue was blocked.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

defaultBudgetAction
Required: Yes
Type: string

The default action taken on a queue if a budget wasn't configured.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID for the queue.

jobAttachmentSettings
Type: JobAttachmentSettings structure

The job attachment settings for the queue.

jobRunAsUser
Type: JobRunAsUser structure

The jobs in the queue ran as this specified POSIX user.

queueId
Required: Yes
Type: string

The queue ID.

requiredFileSystemLocationNames
Type: Array of strings

A list of the required file system location names in the queue.

roleArn
Type: string

The IAM role ARN.

status
Required: Yes
Type: string

The status of the queue.

  • ACTIVE–The queue is active.

  • SCHEDULING–The queue is scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetQueueEnvironment

$result = $client->getQueueEnvironment([/* ... */]);
$promise = $client->getQueueEnvironmentAsync([/* ... */]);

Gets a queue environment.

Parameter Syntax

$result = $client->getQueueEnvironment([
    'farmId' => '<string>', // REQUIRED
    'queueEnvironmentId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the queue environment.

queueEnvironmentId
Required: Yes
Type: string

The queue environment ID.

queueId
Required: Yes
Type: string

The queue ID for the queue environment.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'name' => '<string>',
    'priority' => <integer>,
    'queueEnvironmentId' => '<string>',
    'template' => '<string>',
    'templateType' => 'JSON|YAML',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.>

name
Required: Yes
Type: string

The name of the queue environment.

priority
Required: Yes
Type: int

The priority of the queue environment.

queueEnvironmentId
Required: Yes
Type: string

The queue environment ID.

template
Required: Yes
Type: string

The template for the queue environment.

templateType
Required: Yes
Type: string

The type of template for the queue environment.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetQueueFleetAssociation

$result = $client->getQueueFleetAssociation([/* ... */]);
$promise = $client->getQueueFleetAssociationAsync([/* ... */]);

Gets a queue-fleet association.

Parameter Syntax

$result = $client->getQueueFleetAssociation([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm that contains the queue-fleet association.

fleetId
Required: Yes
Type: string

The fleet ID for the queue-fleet association.

queueId
Required: Yes
Type: string

The queue ID for the queue-fleet association.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'fleetId' => '<string>',
    'queueId' => '<string>',
    'status' => 'ACTIVE|STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS|STOPPED',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

fleetId
Required: Yes
Type: string

The fleet ID for the queue-fleet association.

queueId
Required: Yes
Type: string

The queue ID for the queue-fleet association.

status
Required: Yes
Type: string

The status of the queue-fleet association.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetSession

$result = $client->getSession([/* ... */]);
$promise = $client->getSessionAsync([/* ... */]);

Gets a session.

Parameter Syntax

$result = $client->getSession([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the session.

jobId
Required: Yes
Type: string

The job ID for the session.

queueId
Required: Yes
Type: string

The queue ID for the session.

sessionId
Required: Yes
Type: string

The session ID.

Result Syntax

[
    'endedAt' => <DateTime>,
    'fleetId' => '<string>',
    'hostProperties' => [
        'ec2InstanceArn' => '<string>',
        'ec2InstanceType' => '<string>',
        'hostName' => '<string>',
        'ipAddresses' => [
            'ipV4Addresses' => ['<string>', ...],
            'ipV6Addresses' => ['<string>', ...],
        ],
    ],
    'lifecycleStatus' => 'STARTED|UPDATE_IN_PROGRESS|UPDATE_SUCCEEDED|UPDATE_FAILED|ENDED',
    'log' => [
        'error' => '<string>',
        'logDriver' => '<string>',
        'options' => ['<string>', ...],
        'parameters' => ['<string>', ...],
    ],
    'sessionId' => '<string>',
    'startedAt' => <DateTime>,
    'targetLifecycleStatus' => 'ENDED',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'workerId' => '<string>',
    'workerLog' => [
        'error' => '<string>',
        'logDriver' => '<string>',
        'options' => ['<string>', ...],
        'parameters' => ['<string>', ...],
    ],
]

Result Details

Members
endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

fleetId
Required: Yes
Type: string

The fleet ID for the session.

hostProperties
Type: HostPropertiesResponse structure

Provides the Amazon EC2 properties of the host.

lifecycleStatus
Required: Yes
Type: string

The life cycle status of the session.

log
Required: Yes
Type: LogConfiguration structure

The session log.

sessionId
Required: Yes
Type: string

The session ID.

startedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

targetLifecycleStatus
Type: string

The life cycle status with which the session started.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

workerId
Required: Yes
Type: string

The worker ID for the session.

workerLog
Type: LogConfiguration structure

The worker log for the session.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetSessionAction

$result = $client->getSessionAction([/* ... */]);
$promise = $client->getSessionActionAsync([/* ... */]);

Gets a session action for the job.

Parameter Syntax

$result = $client->getSessionAction([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'sessionActionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the session action.

jobId
Required: Yes
Type: string

The job ID for the session.

queueId
Required: Yes
Type: string

The queue ID for the session action.

sessionActionId
Required: Yes
Type: string

The session action ID for the session.

Result Syntax

[
    'definition' => [
        'envEnter' => [
            'environmentId' => '<string>',
        ],
        'envExit' => [
            'environmentId' => '<string>',
        ],
        'syncInputJobAttachments' => [
            'stepId' => '<string>',
        ],
        'taskRun' => [
            'parameters' => [
                '<String>' => [
                    'float' => '<string>',
                    'int' => '<string>',
                    'path' => '<string>',
                    'string' => '<string>',
                ],
                // ...
            ],
            'stepId' => '<string>',
            'taskId' => '<string>',
        ],
    ],
    'endedAt' => <DateTime>,
    'processExitCode' => <integer>,
    'progressMessage' => '<string>',
    'progressPercent' => <float>,
    'sessionActionId' => '<string>',
    'sessionId' => '<string>',
    'startedAt' => <DateTime>,
    'status' => 'ASSIGNED|RUNNING|CANCELING|SUCCEEDED|FAILED|INTERRUPTED|CANCELED|NEVER_ATTEMPTED|SCHEDULED|RECLAIMING|RECLAIMED',
    'workerUpdatedAt' => <DateTime>,
]

Result Details

Members
definition
Required: Yes
Type: SessionActionDefinition structure

The session action definition.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

processExitCode
Type: int

The exit code to exit the session.

progressMessage
Type: string

The message that communicates the progress of the session action.

progressPercent
Type: float

The percentage completed for a session action.

sessionActionId
Required: Yes
Type: string

The session action ID.

sessionId
Required: Yes
Type: string

The session ID for the session action.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

status
Required: Yes
Type: string

The status of the session action.

workerUpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Linux timestamp of the date and time the session action was last updated.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetSessionsStatisticsAggregation

$result = $client->getSessionsStatisticsAggregation([/* ... */]);
$promise = $client->getSessionsStatisticsAggregationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getSessionsStatisticsAggregation([
    'aggregationId' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
aggregationId
Required: Yes
Type: string

The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.

farmId
Required: Yes
Type: string

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.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'nextToken' => '<string>',
    'statistics' => [
        [
            'aggregationEndTime' => <DateTime>,
            'aggregationStartTime' => <DateTime>,
            'costInUsd' => [
                'avg' => <float>,
                'max' => <float>,
                'min' => <float>,
                'sum' => <float>,
            ],
            'count' => <integer>,
            'fleetId' => '<string>',
            'instanceType' => '<string>',
            'jobId' => '<string>',
            'jobName' => '<string>',
            'licenseProduct' => '<string>',
            'queueId' => '<string>',
            'runtimeInSeconds' => [
                'avg' => <float>,
                'max' => <float>,
                'min' => <float>,
                'sum' => <float>,
            ],
            'usageType' => 'COMPUTE|LICENSE',
            'userId' => '<string>',
        ],
        // ...
    ],
    'status' => 'IN_PROGRESS|TIMEOUT|FAILED|COMPLETED',
    'statusMessage' => '<string>',
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

statistics
Type: Array of Statistics structures

The statistics for the specified fleets or queues.

status
Required: Yes
Type: string

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.

statusMessage
Type: string

A message that describes the status.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetStep

$result = $client->getStep([/* ... */]);
$promise = $client->getStepAsync([/* ... */]);

Gets a step.

Parameter Syntax

$result = $client->getStep([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'stepId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the step.

jobId
Required: Yes
Type: string

The job ID for the step.

queueId
Required: Yes
Type: string

The queue ID for the step.

stepId
Required: Yes
Type: string

The step ID.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'dependencyCounts' => [
        'consumersResolved' => <integer>,
        'consumersUnresolved' => <integer>,
        'dependenciesResolved' => <integer>,
        'dependenciesUnresolved' => <integer>,
    ],
    'description' => '<string>',
    'endedAt' => <DateTime>,
    'lifecycleStatus' => 'CREATE_COMPLETE|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_SUCCEEDED',
    'lifecycleStatusMessage' => '<string>',
    'name' => '<string>',
    'parameterSpace' => [
        'combination' => '<string>',
        'parameters' => [
            [
                'name' => '<string>',
                'type' => 'INT|FLOAT|STRING|PATH',
            ],
            // ...
        ],
    ],
    'requiredCapabilities' => [
        'amounts' => [
            [
                'max' => <float>,
                'min' => <float>,
                'name' => '<string>',
                'value' => <float>,
            ],
            // ...
        ],
        'attributes' => [
            [
                'allOf' => ['<string>', ...],
                'anyOf' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
    ],
    'startedAt' => <DateTime>,
    'stepId' => '<string>',
    'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
    'taskRunStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
    'taskRunStatusCounts' => [<integer>, ...],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

dependencyCounts
Type: DependencyCounts structure

The number of dependencies in the step.

description
Type: string

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.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

lifecycleStatus
Required: Yes
Type: string

The life cycle status of the step.

lifecycleStatusMessage
Type: string

A message that describes the lifecycle status of the step.

name
Required: Yes
Type: string

The name of the step.

parameterSpace
Type: ParameterSpace structure

A list of step parameters and the combination expression for the step.

requiredCapabilities
Type: StepRequiredCapabilities structure

The required capabilities of the step.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

stepId
Required: Yes
Type: string

The step ID.

targetTaskRunStatus
Type: string

The task status with which the job started.

taskRunStatus
Required: Yes
Type: string

The task run status for the job.

taskRunStatusCounts
Required: Yes
Type: Associative array of custom strings keys (TaskRunStatus) to ints

The number of tasks running on the job.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetStorageProfile

$result = $client->getStorageProfile([/* ... */]);
$promise = $client->getStorageProfileAsync([/* ... */]);

Gets a storage profile.

Parameter Syntax

$result = $client->getStorageProfile([
    'farmId' => '<string>', // REQUIRED
    'storageProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the storage profile.

storageProfileId
Required: Yes
Type: string

The storage profile ID.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'displayName' => '<string>',
    'fileSystemLocations' => [
        [
            'name' => '<string>',
            'path' => '<string>',
            'type' => 'SHARED|LOCAL',
        ],
        // ...
    ],
    'osFamily' => 'WINDOWS|LINUX|MACOS',
    'storageProfileId' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

displayName
Required: Yes
Type: string

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.

fileSystemLocations
Type: Array of FileSystemLocation structures

The location of the files for the storage profile.

osFamily
Required: Yes
Type: string

The operating system (OS) for the storage profile.

storageProfileId
Required: Yes
Type: string

The storage profile ID.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetStorageProfileForQueue

$result = $client->getStorageProfileForQueue([/* ... */]);
$promise = $client->getStorageProfileForQueueAsync([/* ... */]);

Gets a storage profile for a queue.

Parameter Syntax

$result = $client->getStorageProfileForQueue([
    'farmId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'storageProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the queue in storage profile.

queueId
Required: Yes
Type: string

The queue ID the queue in the storage profile.

storageProfileId
Required: Yes
Type: string

The storage profile ID for the storage profile in the queue.

Result Syntax

[
    'displayName' => '<string>',
    'fileSystemLocations' => [
        [
            'name' => '<string>',
            'path' => '<string>',
            'type' => 'SHARED|LOCAL',
        ],
        // ...
    ],
    'osFamily' => 'WINDOWS|LINUX|MACOS',
    'storageProfileId' => '<string>',
]

Result Details

Members
displayName
Required: Yes
Type: string

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.

fileSystemLocations
Type: Array of FileSystemLocation structures

The location of the files for the storage profile within the queue.

osFamily
Required: Yes
Type: string

The operating system of the storage profile in the queue.

storageProfileId
Required: Yes
Type: string

The storage profile ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetTask

$result = $client->getTask([/* ... */]);
$promise = $client->getTaskAsync([/* ... */]);

Gets a task.

Parameter Syntax

$result = $client->getTask([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'stepId' => '<string>', // REQUIRED
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the farm connected to the task.

jobId
Required: Yes
Type: string

The job ID of the job connected to the task.

queueId
Required: Yes
Type: string

The queue ID for the queue connected to the task.

stepId
Required: Yes
Type: string

The step ID for the step connected to the task.

taskId
Required: Yes
Type: string

The task ID.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'endedAt' => <DateTime>,
    'failureRetryCount' => <integer>,
    'latestSessionActionId' => '<string>',
    'parameters' => [
        '<String>' => [
            'float' => '<string>',
            'int' => '<string>',
            'path' => '<string>',
            'string' => '<string>',
        ],
        // ...
    ],
    'runStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
    'startedAt' => <DateTime>,
    'targetRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
    'taskId' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

failureRetryCount
Type: int

The number of times that the task failed and was retried.

latestSessionActionId
Type: string

The latest session ID for the task.

parameters
Type: Associative array of custom strings keys (String) to TaskParameterValue structures

The parameters for the task.

runStatus
Required: Yes
Type: string

The run status for the task.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

targetRunStatus
Type: string

The run status with which to start the task.

taskId
Required: Yes
Type: string

The task ID.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

GetWorker

$result = $client->getWorker([/* ... */]);
$promise = $client->getWorkerAsync([/* ... */]);

Gets a worker.

Parameter Syntax

$result = $client->getWorker([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the worker.

fleetId
Required: Yes
Type: string

The fleet ID of the worker.

workerId
Required: Yes
Type: string

The worker ID.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'farmId' => '<string>',
    'fleetId' => '<string>',
    'hostProperties' => [
        'ec2InstanceArn' => '<string>',
        'ec2InstanceType' => '<string>',
        'hostName' => '<string>',
        'ipAddresses' => [
            'ipV4Addresses' => ['<string>', ...],
            'ipV6Addresses' => ['<string>', ...],
        ],
    ],
    'log' => [
        'error' => '<string>',
        'logDriver' => '<string>',
        'options' => ['<string>', ...],
        'parameters' => ['<string>', ...],
    ],
    'status' => 'CREATED|STARTED|STOPPING|STOPPED|NOT_RESPONDING|NOT_COMPATIBLE|RUNNING|IDLE',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'workerId' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

farmId
Required: Yes
Type: string

The farm ID.

fleetId
Required: Yes
Type: string

The fleet ID.

hostProperties
Type: HostPropertiesResponse structure

The host properties for the worker.

log
Type: LogConfiguration structure

The logs for the associated worker.

status
Required: Yes
Type: string

The status of the worker.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

workerId
Required: Yes
Type: string

The worker ID.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListAvailableMeteredProducts

$result = $client->listAvailableMeteredProducts([/* ... */]);
$promise = $client->listAvailableMeteredProductsAsync([/* ... */]);

A list of the available metered products.

Parameter Syntax

$result = $client->listAvailableMeteredProducts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'meteredProducts' => [
        [
            'family' => '<string>',
            'port' => <integer>,
            'productId' => '<string>',
            'vendor' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
meteredProducts
Required: Yes
Type: Array of MeteredProductSummary structures

The metered products.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota.

ListBudgets

$result = $client->listBudgets([/* ... */]);
$promise = $client->listBudgetsAsync([/* ... */]);

A list of budgets in a farm.

Parameter Syntax

$result = $client->listBudgets([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID associated with the budgets.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

status
Type: string

The status to list for the budgets.

Result Syntax

[
    'budgets' => [
        [
            'approximateDollarLimit' => <float>,
            'budgetId' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'description' => '<string>',
            'displayName' => '<string>',
            'status' => 'ACTIVE|INACTIVE',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'usageTrackingResource' => [
                'queueId' => '<string>',
            ],
            'usages' => [
                'approximateDollarUsage' => <float>,
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
budgets
Required: Yes
Type: Array of BudgetSummary structures

The budgets to include on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListFarmMembers

$result = $client->listFarmMembers([/* ... */]);
$promise = $client->listFarmMembersAsync([/* ... */]);

Lists the members of a farm.

Parameter Syntax

$result = $client->listFarmMembers([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'members' => [
        [
            'farmId' => '<string>',
            'identityStoreId' => '<string>',
            'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER',
            'principalId' => '<string>',
            'principalType' => 'USER|GROUP',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
members
Required: Yes
Type: Array of FarmMember structures

The members on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListFarms

$result = $client->listFarms([/* ... */]);
$promise = $client->listFarmsAsync([/* ... */]);

Lists farms.

Parameter Syntax

$result = $client->listFarms([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principalId' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

principalId
Type: string

The principal ID of the member to list on the farm.

Result Syntax

[
    'farms' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'displayName' => '<string>',
            'farmId' => '<string>',
            'kmsKeyArn' => '<string>',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
farms
Required: Yes
Type: Array of FarmSummary structures

Farms on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListFleetMembers

$result = $client->listFleetMembers([/* ... */]);
$promise = $client->listFleetMembersAsync([/* ... */]);

Lists fleet members.

Parameter Syntax

$result = $client->listFleetMembers([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the fleet.

fleetId
Required: Yes
Type: string

The fleet ID to include on the list.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'members' => [
        [
            'farmId' => '<string>',
            'fleetId' => '<string>',
            'identityStoreId' => '<string>',
            'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER',
            'principalId' => '<string>',
            'principalType' => 'USER|GROUP',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
members
Required: Yes
Type: Array of FleetMember structures

The members on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListFleets

$result = $client->listFleets([/* ... */]);
$promise = $client->listFleetsAsync([/* ... */]);

Lists fleets.

Parameter Syntax

$result = $client->listFleets([
    'displayName' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principalId' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|UPDATE_IN_PROGRESS|CREATE_FAILED|UPDATE_FAILED',
]);

Parameter Details

Members
displayName
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID of the fleets.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

principalId
Type: string

The principal ID of the members to include in the fleet.

status
Type: string

The status of the fleet.

Result Syntax

[
    'fleets' => [
        [
            'autoScalingStatus' => 'GROWING|STEADY|SHRINKING',
            'configuration' => [
                'customerManaged' => [
                    'mode' => 'NO_SCALING|EVENT_BASED_AUTO_SCALING',
                    'storageProfileId' => '<string>',
                    'workerCapabilities' => [
                        'acceleratorCount' => [
                            'max' => <integer>,
                            'min' => <integer>,
                        ],
                        'acceleratorTotalMemoryMiB' => [
                            'max' => <integer>,
                            'min' => <integer>,
                        ],
                        'acceleratorTypes' => ['<string>', ...],
                        'cpuArchitectureType' => 'x86_64|arm64',
                        'customAmounts' => [
                            [
                                'max' => <float>,
                                'min' => <float>,
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'customAttributes' => [
                            [
                                'name' => '<string>',
                                'values' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'memoryMiB' => [
                            'max' => <integer>,
                            'min' => <integer>,
                        ],
                        'osFamily' => 'WINDOWS|LINUX|MACOS',
                        'vCpuCount' => [
                            'max' => <integer>,
                            'min' => <integer>,
                        ],
                    ],
                ],
                'serviceManagedEc2' => [
                    'instanceCapabilities' => [
                        'acceleratorCapabilities' => [
                            'count' => [
                                'max' => <integer>,
                                'min' => <integer>,
                            ],
                            'selections' => [
                                [
                                    'name' => 't4|a10g|l4|l40s',
                                    'runtime' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'allowedInstanceTypes' => ['<string>', ...],
                        'cpuArchitectureType' => 'x86_64|arm64',
                        'customAmounts' => [
                            [
                                'max' => <float>,
                                'min' => <float>,
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'customAttributes' => [
                            [
                                'name' => '<string>',
                                'values' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'excludedInstanceTypes' => ['<string>', ...],
                        'memoryMiB' => [
                            'max' => <integer>,
                            'min' => <integer>,
                        ],
                        'osFamily' => 'WINDOWS|LINUX',
                        'rootEbsVolume' => [
                            'iops' => <integer>,
                            'sizeGiB' => <integer>,
                            'throughputMiB' => <integer>,
                        ],
                        'vCpuCount' => [
                            'max' => <integer>,
                            'min' => <integer>,
                        ],
                    ],
                    'instanceMarketOptions' => [
                        'type' => 'on-demand|spot',
                    ],
                ],
            ],
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'displayName' => '<string>',
            'farmId' => '<string>',
            'fleetId' => '<string>',
            'maxWorkerCount' => <integer>,
            'minWorkerCount' => <integer>,
            'status' => 'ACTIVE|CREATE_IN_PROGRESS|UPDATE_IN_PROGRESS|CREATE_FAILED|UPDATE_FAILED',
            'targetWorkerCount' => <integer>,
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'workerCount' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
fleets
Required: Yes
Type: Array of FleetSummary structures

The fleets on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListJobMembers

$result = $client->listJobMembers([/* ... */]);
$promise = $client->listJobMembersAsync([/* ... */]);

Lists members on a job.

Parameter Syntax

$result = $client->listJobMembers([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the job to list.

jobId
Required: Yes
Type: string

The job ID to include on the list.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID to include on the list.

Result Syntax

[
    'members' => [
        [
            'farmId' => '<string>',
            'identityStoreId' => '<string>',
            'jobId' => '<string>',
            'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER',
            'principalId' => '<string>',
            'principalType' => 'USER|GROUP',
            'queueId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
members
Required: Yes
Type: Array of JobMember structures

The members on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListJobParameterDefinitions

$result = $client->listJobParameterDefinitions([/* ... */]);
$promise = $client->listJobParameterDefinitionsAsync([/* ... */]);

Lists parameter definitions of a job.

Parameter Syntax

$result = $client->listJobParameterDefinitions([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the job to list.

jobId
Required: Yes
Type: string

The job ID to include on the list.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID to include on the list.

Result Syntax

[
    'jobParameterDefinitions' => [
        [
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
jobParameterDefinitions
Required: Yes
Type: Array of document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documentss

Lists parameter definitions of a job.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

Lists jobs.

Parameter Syntax

$result = $client->listJobs([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principalId' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the jobs.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

principalId
Type: string

The principal ID of the members on the jobs.

queueId
Required: Yes
Type: string

The queue ID for the job.

Result Syntax

[
    'jobs' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'endedAt' => <DateTime>,
            'jobId' => '<string>',
            'lifecycleStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|UPLOAD_IN_PROGRESS|UPLOAD_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_SUCCEEDED|ARCHIVED',
            'lifecycleStatusMessage' => '<string>',
            'maxFailedTasksCount' => <integer>,
            'maxRetriesPerTask' => <integer>,
            'name' => '<string>',
            'priority' => <integer>,
            'sourceJobId' => '<string>',
            'startedAt' => <DateTime>,
            'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
            'taskRunStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
            'taskRunStatusCounts' => [<integer>, ...],
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
jobs
Required: Yes
Type: Array of JobSummary structures

The jobs on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListLicenseEndpoints

$result = $client->listLicenseEndpoints([/* ... */]);
$promise = $client->listLicenseEndpointsAsync([/* ... */]);

Lists license endpoints.

Parameter Syntax

$result = $client->listLicenseEndpoints([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'licenseEndpoints' => [
        [
            'licenseEndpointId' => '<string>',
            'status' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|NOT_READY',
            'statusMessage' => '<string>',
            'vpcId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
licenseEndpoints
Required: Yes
Type: Array of LicenseEndpointSummary structures

The license endpoints.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListMeteredProducts

$result = $client->listMeteredProducts([/* ... */]);
$promise = $client->listMeteredProductsAsync([/* ... */]);

Lists metered products.

Parameter Syntax

$result = $client->listMeteredProducts([
    'licenseEndpointId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
licenseEndpointId
Required: Yes
Type: string

The license endpoint ID to include on the list of metered products.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'meteredProducts' => [
        [
            'family' => '<string>',
            'port' => <integer>,
            'productId' => '<string>',
            'vendor' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
meteredProducts
Required: Yes
Type: Array of MeteredProductSummary structures

The metered products to list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListMonitors

$result = $client->listMonitors([/* ... */]);
$promise = $client->listMonitorsAsync([/* ... */]);

Gets a list of your monitors in Deadline Cloud.

Parameter Syntax

$result = $client->listMonitors([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'monitors' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'displayName' => '<string>',
            'identityCenterApplicationArn' => '<string>',
            'identityCenterInstanceArn' => '<string>',
            'monitorId' => '<string>',
            'roleArn' => '<string>',
            'subdomain' => '<string>',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
monitors
Required: Yes
Type: Array of MonitorSummary structures

A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListQueueEnvironments

$result = $client->listQueueEnvironments([/* ... */]);
$promise = $client->listQueueEnvironmentsAsync([/* ... */]);

Lists queue environments.

Parameter Syntax

$result = $client->listQueueEnvironments([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the queue environment list.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID for the queue environment list.

Result Syntax

[
    'environments' => [
        [
            'name' => '<string>',
            'priority' => <integer>,
            'queueEnvironmentId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
environments
Required: Yes
Type: Array of QueueEnvironmentSummary structures

The environments to include in the queue environments list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListQueueFleetAssociations

$result = $client->listQueueFleetAssociations([/* ... */]);
$promise = $client->listQueueFleetAssociationsAsync([/* ... */]);

Lists queue-fleet associations.

Parameter Syntax

$result = $client->listQueueFleetAssociations([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the queue-fleet association list.

fleetId
Type: string

The fleet ID for the queue-fleet association list.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Type: string

The queue ID for the queue-fleet association list.

Result Syntax

[
    'nextToken' => '<string>',
    'queueFleetAssociations' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'fleetId' => '<string>',
            'queueId' => '<string>',
            'status' => 'ACTIVE|STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS|STOPPED',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

queueFleetAssociations
Required: Yes
Type: Array of QueueFleetAssociationSummary structures

The queue-fleet associations on the list.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ListQueueMembers

$result = $client->listQueueMembers([/* ... */]);
$promise = $client->listQueueMembersAsync([/* ... */]);

Lists the members in a queue.

Parameter Syntax

$result = $client->listQueueMembers([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the queue.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID to include on the list.

Result Syntax

[
    'members' => [
        [
            'farmId' => '<string>',
            'identityStoreId' => '<string>',
            'membershipLevel' => 'VIEWER|CONTRIBUTOR|OWNER|MANAGER',
            'principalId' => '<string>',
            'principalType' => 'USER|GROUP',
            'queueId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
members
Required: Yes
Type: Array of QueueMember structures

The members on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListQueues

$result = $client->listQueues([/* ... */]);
$promise = $client->listQueuesAsync([/* ... */]);

Lists queues.

Parameter Syntax

$result = $client->listQueues([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principalId' => '<string>',
    'status' => 'IDLE|SCHEDULING|SCHEDULING_BLOCKED',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the queue.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

principalId
Type: string

The principal IDs to include in the list of queues.

status
Type: string

The status of the queues listed.

  • ACTIVE–The queues are active.

  • SCHEDULING–The queues are scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

Result Syntax

[
    'nextToken' => '<string>',
    'queues' => [
        [
            'blockedReason' => 'NO_BUDGET_CONFIGURED|BUDGET_THRESHOLD_REACHED',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'defaultBudgetAction' => 'NONE|STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS',
            'displayName' => '<string>',
            'farmId' => '<string>',
            'queueId' => '<string>',
            'status' => 'IDLE|SCHEDULING|SCHEDULING_BLOCKED',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

queues
Required: Yes
Type: Array of QueueSummary structures

The queues on the list.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListSessionActions

$result = $client->listSessionActions([/* ... */]);
$promise = $client->listSessionActionsAsync([/* ... */]);

Lists session actions.

Parameter Syntax

$result = $client->listSessionActions([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
    'sessionId' => '<string>',
    'taskId' => '<string>',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the session actions list.

jobId
Required: Yes
Type: string

The job ID for the session actions list.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID for the session actions list.

sessionId
Type: string

The session ID to include on the sessions action list.

taskId
Type: string

The task ID for the session actions list.

Result Syntax

[
    'nextToken' => '<string>',
    'sessionActions' => [
        [
            'definition' => [
                'envEnter' => [
                    'environmentId' => '<string>',
                ],
                'envExit' => [
                    'environmentId' => '<string>',
                ],
                'syncInputJobAttachments' => [
                    'stepId' => '<string>',
                ],
                'taskRun' => [
                    'stepId' => '<string>',
                    'taskId' => '<string>',
                ],
            ],
            'endedAt' => <DateTime>,
            'progressPercent' => <float>,
            'sessionActionId' => '<string>',
            'startedAt' => <DateTime>,
            'status' => 'ASSIGNED|RUNNING|CANCELING|SUCCEEDED|FAILED|INTERRUPTED|CANCELED|NEVER_ATTEMPTED|SCHEDULED|RECLAIMING|RECLAIMED',
            'workerUpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

sessionActions
Required: Yes
Type: Array of SessionActionSummary structures

The session actions.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListSessions

$result = $client->listSessions([/* ... */]);
$promise = $client->listSessionsAsync([/* ... */]);

Lists sessions.

Parameter Syntax

$result = $client->listSessions([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the list of sessions.

jobId
Required: Yes
Type: string

The job ID for the list of sessions.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID for the list of sessions

Result Syntax

[
    'nextToken' => '<string>',
    'sessions' => [
        [
            'endedAt' => <DateTime>,
            'fleetId' => '<string>',
            'lifecycleStatus' => 'STARTED|UPDATE_IN_PROGRESS|UPDATE_SUCCEEDED|UPDATE_FAILED|ENDED',
            'sessionId' => '<string>',
            'startedAt' => <DateTime>,
            'targetLifecycleStatus' => 'ENDED',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'workerId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

sessions
Required: Yes
Type: Array of SessionSummary structures

The sessions on the list.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListSessionsForWorker

$result = $client->listSessionsForWorker([/* ... */]);
$promise = $client->listSessionsForWorkerAsync([/* ... */]);

Lists sessions for a worker.

Parameter Syntax

$result = $client->listSessionsForWorker([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the session.

fleetId
Required: Yes
Type: string

The fleet ID for the session.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

workerId
Required: Yes
Type: string

The worker ID for the session.

Result Syntax

[
    'nextToken' => '<string>',
    'sessions' => [
        [
            'endedAt' => <DateTime>,
            'jobId' => '<string>',
            'lifecycleStatus' => 'STARTED|UPDATE_IN_PROGRESS|UPDATE_SUCCEEDED|UPDATE_FAILED|ENDED',
            'queueId' => '<string>',
            'sessionId' => '<string>',
            'startedAt' => <DateTime>,
            'targetLifecycleStatus' => 'ENDED',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

sessions
Required: Yes
Type: Array of WorkerSessionSummary structures

The sessions in the response.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListStepConsumers

$result = $client->listStepConsumers([/* ... */]);
$promise = $client->listStepConsumersAsync([/* ... */]);

Lists step consumers.

Parameter Syntax

$result = $client->listStepConsumers([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
    'stepId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the list of step consumers.

jobId
Required: Yes
Type: string

The job ID for the step consumer.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID for the step consumer.

stepId
Required: Yes
Type: string

The step ID to include on the list.

Result Syntax

[
    'consumers' => [
        [
            'status' => 'RESOLVED|UNRESOLVED',
            'stepId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
consumers
Required: Yes
Type: Array of StepConsumer structures

The consumers on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListStepDependencies

$result = $client->listStepDependencies([/* ... */]);
$promise = $client->listStepDependenciesAsync([/* ... */]);

Lists the dependencies for a step.

Parameter Syntax

$result = $client->listStepDependencies([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
    'stepId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID for the step dependencies list.

jobId
Required: Yes
Type: string

The job ID for the step dependencies list.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID for the step dependencies list.

stepId
Required: Yes
Type: string

The step ID to include on the list.

Result Syntax

[
    'dependencies' => [
        [
            'status' => 'RESOLVED|UNRESOLVED',
            'stepId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
dependencies
Required: Yes
Type: Array of StepDependency structures

The dependencies on the list.

nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListSteps

$result = $client->listSteps([/* ... */]);
$promise = $client->listStepsAsync([/* ... */]);

Lists steps for a job.

Parameter Syntax

$result = $client->listSteps([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID to include on the list of steps.

jobId
Required: Yes
Type: string

The job ID to include on the list of steps.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID to include on the list of steps.

Result Syntax

[
    'nextToken' => '<string>',
    'steps' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'dependencyCounts' => [
                'consumersResolved' => <integer>,
                'consumersUnresolved' => <integer>,
                'dependenciesResolved' => <integer>,
                'dependenciesUnresolved' => <integer>,
            ],
            'endedAt' => <DateTime>,
            'lifecycleStatus' => 'CREATE_COMPLETE|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_SUCCEEDED',
            'lifecycleStatusMessage' => '<string>',
            'name' => '<string>',
            'startedAt' => <DateTime>,
            'stepId' => '<string>',
            'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
            'taskRunStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
            'taskRunStatusCounts' => [<integer>, ...],
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

steps
Required: Yes
Type: Array of StepSummary structures

The steps on the list.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListStorageProfiles

$result = $client->listStorageProfiles([/* ... */]);
$promise = $client->listStorageProfilesAsync([/* ... */]);

Lists storage profiles.

Parameter Syntax

$result = $client->listStorageProfiles([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the storage profile.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'nextToken' => '<string>',
    'storageProfiles' => [
        [
            'displayName' => '<string>',
            'osFamily' => 'WINDOWS|LINUX|MACOS',
            'storageProfileId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

storageProfiles
Required: Yes
Type: Array of StorageProfileSummary structures

The storage profiles.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListStorageProfilesForQueue

$result = $client->listStorageProfilesForQueue([/* ... */]);
$promise = $client->listStorageProfilesForQueueAsync([/* ... */]);

Lists storage profiles for a queue.

Parameter Syntax

$result = $client->listStorageProfilesForQueue([
    'farmId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the queue's storage profile.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID for the storage profile.

Result Syntax

[
    'nextToken' => '<string>',
    'storageProfiles' => [
        [
            'displayName' => '<string>',
            'osFamily' => 'WINDOWS|LINUX|MACOS',
            'storageProfileId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

storageProfiles
Required: Yes
Type: Array of StorageProfileSummary structures

The storage profiles in the queue.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The resource ARN to list tags for.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (String) to strings

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.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListTasks

$result = $client->listTasks([/* ... */]);
$promise = $client->listTasksAsync([/* ... */]);

Lists tasks for a job.

Parameter Syntax

$result = $client->listTasks([
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queueId' => '<string>', // REQUIRED
    'stepId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID connected to the tasks.

jobId
Required: Yes
Type: string

The job ID for the tasks.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

queueId
Required: Yes
Type: string

The queue ID connected to the tasks.

stepId
Required: Yes
Type: string

The step ID for the tasks.

Result Syntax

[
    'nextToken' => '<string>',
    'tasks' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'endedAt' => <DateTime>,
            'failureRetryCount' => <integer>,
            'latestSessionActionId' => '<string>',
            'parameters' => [
                '<String>' => [
                    'float' => '<string>',
                    'int' => '<string>',
                    'path' => '<string>',
                    'string' => '<string>',
                ],
                // ...
            ],
            'runStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
            'startedAt' => <DateTime>,
            'targetRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
            'taskId' => '<string>',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

tasks
Required: Yes
Type: Array of TaskSummary structures

Tasks for the job.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ListWorkers

$result = $client->listWorkers([/* ... */]);
$promise = $client->listWorkersAsync([/* ... */]);

Lists workers.

Parameter Syntax

$result = $client->listWorkers([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID connected to the workers.

fleetId
Required: Yes
Type: string

The fleet ID of the workers.

maxResults
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken
Type: string

The token for the next set of results, or null to start from the beginning.

Result Syntax

[
    'nextToken' => '<string>',
    'workers' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'farmId' => '<string>',
            'fleetId' => '<string>',
            'hostProperties' => [
                'ec2InstanceArn' => '<string>',
                'ec2InstanceType' => '<string>',
                'hostName' => '<string>',
                'ipAddresses' => [
                    'ipV4Addresses' => ['<string>', ...],
                    'ipV6Addresses' => ['<string>', ...],
                ],
            ],
            'log' => [
                'error' => '<string>',
                'logDriver' => '<string>',
                'options' => ['<string>', ...],
                'parameters' => ['<string>', ...],
            ],
            'status' => 'CREATED|STARTED|STOPPING|STOPPED|NOT_RESPONDING|NOT_COMPATIBLE|RUNNING|IDLE',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'workerId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

workers
Required: Yes
Type: Array of WorkerSummary structures

The workers on the list.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

PutMeteredProduct

$result = $client->putMeteredProduct([/* ... */]);
$promise = $client->putMeteredProductAsync([/* ... */]);

Adds a metered product.

Parameter Syntax

$result = $client->putMeteredProduct([
    'licenseEndpointId' => '<string>', // REQUIRED
    'productId' => '<string>', // REQUIRED
]);

Parameter Details

Members
licenseEndpointId
Required: Yes
Type: string

The license endpoint ID to add to the metered product.

productId
Required: Yes
Type: string

The product ID to add to the metered product.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

SearchJobs

$result = $client->searchJobs([/* ... */]);
$promise = $client->searchJobsAsync([/* ... */]);

Searches for jobs.

Parameter Syntax

$result = $client->searchJobs([
    'farmId' => '<string>', // REQUIRED
    'filterExpressions' => [
        'filters' => [ // REQUIRED
            [
                'dateTimeFilter' => [
                    'dateTime' => <integer || string || DateTime>, // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                ],
                'groupFilter' => [...], // RECURSIVE
                'parameterFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'searchTermFilter' => [
                    'searchTerm' => '<string>', // REQUIRED
                ],
                'stringFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'operator' => 'AND|OR', // REQUIRED
    ],
    'itemOffset' => <integer>, // REQUIRED
    'pageSize' => <integer>,
    'queueIds' => ['<string>', ...], // REQUIRED
    'sortExpressions' => [
        [
            'fieldSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'parameterSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'userJobsFirst' => [
                'userIdentityId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the job.

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 ().

itemOffset
Required: Yes
Type: int

Defines how far into the scrollable list to start the return of results.

pageSize
Type: int

Specifies the number of items per page for the resource.

queueIds
Required: Yes
Type: Array of strings

The queue ID to use in the job search.

sortExpressions
Type: Array of SearchSortExpression structures

The search terms for a resource.

Result Syntax

[
    'jobs' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'endedAt' => <DateTime>,
            'jobId' => '<string>',
            'jobParameters' => [
                '<String>' => [
                    'float' => '<string>',
                    'int' => '<string>',
                    'path' => '<string>',
                    'string' => '<string>',
                ],
                // ...
            ],
            'lifecycleStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|UPLOAD_IN_PROGRESS|UPLOAD_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_SUCCEEDED|ARCHIVED',
            'lifecycleStatusMessage' => '<string>',
            'maxFailedTasksCount' => <integer>,
            'maxRetriesPerTask' => <integer>,
            'name' => '<string>',
            'priority' => <integer>,
            'queueId' => '<string>',
            'sourceJobId' => '<string>',
            'startedAt' => <DateTime>,
            'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
            'taskRunStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
            'taskRunStatusCounts' => [<integer>, ...],
        ],
        // ...
    ],
    'nextItemOffset' => <integer>,
    'totalResults' => <integer>,
]

Result Details

Members
jobs
Required: Yes
Type: Array of JobSearchSummary structures

The jobs in the search.

nextItemOffset
Type: int

The next incremental starting point after the defined itemOffset.

totalResults
Required: Yes
Type: int

The total number of results in the search.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

SearchSteps

$result = $client->searchSteps([/* ... */]);
$promise = $client->searchStepsAsync([/* ... */]);

Searches for steps.

Parameter Syntax

$result = $client->searchSteps([
    'farmId' => '<string>', // REQUIRED
    'filterExpressions' => [
        'filters' => [ // REQUIRED
            [
                'dateTimeFilter' => [
                    'dateTime' => <integer || string || DateTime>, // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                ],
                'groupFilter' => [...], // RECURSIVE
                'parameterFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'searchTermFilter' => [
                    'searchTerm' => '<string>', // REQUIRED
                ],
                'stringFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'operator' => 'AND|OR', // REQUIRED
    ],
    'itemOffset' => <integer>, // REQUIRED
    'jobId' => '<string>',
    'pageSize' => <integer>,
    'queueIds' => ['<string>', ...], // REQUIRED
    'sortExpressions' => [
        [
            'fieldSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'parameterSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'userJobsFirst' => [
                'userIdentityId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID to use for the step search.

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 ().

itemOffset
Required: Yes
Type: int

Defines how far into the scrollable list to start the return of results.

jobId
Type: string

The job ID to use in the step search.

pageSize
Type: int

Specifies the number of items per page for the resource.

queueIds
Required: Yes
Type: Array of strings

The queue IDs in the step search.

sortExpressions
Type: Array of SearchSortExpression structures

The search terms for a resource.

Result Syntax

[
    'nextItemOffset' => <integer>,
    'steps' => [
        [
            'createdAt' => <DateTime>,
            'endedAt' => <DateTime>,
            'jobId' => '<string>',
            'lifecycleStatus' => 'CREATE_COMPLETE|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_SUCCEEDED',
            'lifecycleStatusMessage' => '<string>',
            'name' => '<string>',
            'parameterSpace' => [
                'combination' => '<string>',
                'parameters' => [
                    [
                        'name' => '<string>',
                        'type' => 'INT|FLOAT|STRING|PATH',
                    ],
                    // ...
                ],
            ],
            'queueId' => '<string>',
            'startedAt' => <DateTime>,
            'stepId' => '<string>',
            'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
            'taskRunStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
            'taskRunStatusCounts' => [<integer>, ...],
        ],
        // ...
    ],
    'totalResults' => <integer>,
]

Result Details

Members
nextItemOffset
Type: int

The next incremental starting point after the defined itemOffset.

steps
Required: Yes
Type: Array of StepSearchSummary structures

The steps in the search.

totalResults
Required: Yes
Type: int

The total number of results in the search.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

SearchTasks

$result = $client->searchTasks([/* ... */]);
$promise = $client->searchTasksAsync([/* ... */]);

Searches for tasks.

Parameter Syntax

$result = $client->searchTasks([
    'farmId' => '<string>', // REQUIRED
    'filterExpressions' => [
        'filters' => [ // REQUIRED
            [
                'dateTimeFilter' => [
                    'dateTime' => <integer || string || DateTime>, // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                ],
                'groupFilter' => [...], // RECURSIVE
                'parameterFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'searchTermFilter' => [
                    'searchTerm' => '<string>', // REQUIRED
                ],
                'stringFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'operator' => 'AND|OR', // REQUIRED
    ],
    'itemOffset' => <integer>, // REQUIRED
    'jobId' => '<string>',
    'pageSize' => <integer>,
    'queueIds' => ['<string>', ...], // REQUIRED
    'sortExpressions' => [
        [
            'fieldSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'parameterSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'userJobsFirst' => [
                'userIdentityId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID of the task.

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 ().

itemOffset
Required: Yes
Type: int

Defines how far into the scrollable list to start the return of results.

jobId
Type: string

The job ID for the task search.

pageSize
Type: int

Specifies the number of items per page for the resource.

queueIds
Required: Yes
Type: Array of strings

The queue IDs to include in the search.

sortExpressions
Type: Array of SearchSortExpression structures

The search terms for a resource.

Result Syntax

[
    'nextItemOffset' => <integer>,
    'tasks' => [
        [
            'endedAt' => <DateTime>,
            'failureRetryCount' => <integer>,
            'jobId' => '<string>',
            'parameters' => [
                '<String>' => [
                    'float' => '<string>',
                    'int' => '<string>',
                    'path' => '<string>',
                    'string' => '<string>',
                ],
                // ...
            ],
            'queueId' => '<string>',
            'runStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
            'startedAt' => <DateTime>,
            'stepId' => '<string>',
            'targetRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
            'taskId' => '<string>',
        ],
        // ...
    ],
    'totalResults' => <integer>,
]

Result Details

Members
nextItemOffset
Type: int

The next incremental starting point after the defined itemOffset.

tasks
Required: Yes
Type: Array of TaskSearchSummary structures

Tasks in the search.

totalResults
Required: Yes
Type: int

The total number of results in the search.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

SearchWorkers

$result = $client->searchWorkers([/* ... */]);
$promise = $client->searchWorkersAsync([/* ... */]);

Searches for workers.

Parameter Syntax

$result = $client->searchWorkers([
    'farmId' => '<string>', // REQUIRED
    'filterExpressions' => [
        'filters' => [ // REQUIRED
            [
                'dateTimeFilter' => [
                    'dateTime' => <integer || string || DateTime>, // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                ],
                'groupFilter' => [...], // RECURSIVE
                'parameterFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                'searchTermFilter' => [
                    'searchTerm' => '<string>', // REQUIRED
                ],
                'stringFilter' => [
                    'name' => '<string>', // REQUIRED
                    'operator' => 'EQUAL|NOT_EQUAL|GREATER_THAN_EQUAL_TO|GREATER_THAN|LESS_THAN_EQUAL_TO|LESS_THAN', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'operator' => 'AND|OR', // REQUIRED
    ],
    'fleetIds' => ['<string>', ...], // REQUIRED
    'itemOffset' => <integer>, // REQUIRED
    'pageSize' => <integer>,
    'sortExpressions' => [
        [
            'fieldSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'parameterSort' => [
                'name' => '<string>', // REQUIRED
                'sortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
            ],
            'userJobsFirst' => [
                'userIdentityId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID in the workers search.

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 ().

fleetIds
Required: Yes
Type: Array of strings

The fleet ID of the workers to search for.

itemOffset
Required: Yes
Type: int

Defines how far into the scrollable list to start the return of results.

pageSize
Type: int

Specifies the number of items per page for the resource.

sortExpressions
Type: Array of SearchSortExpression structures

The search terms for a resource.

Result Syntax

[
    'nextItemOffset' => <integer>,
    'totalResults' => <integer>,
    'workers' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'fleetId' => '<string>',
            'hostProperties' => [
                'ec2InstanceArn' => '<string>',
                'ec2InstanceType' => '<string>',
                'hostName' => '<string>',
                'ipAddresses' => [
                    'ipV4Addresses' => ['<string>', ...],
                    'ipV6Addresses' => ['<string>', ...],
                ],
            ],
            'status' => 'CREATED|STARTED|STOPPING|STOPPED|NOT_RESPONDING|NOT_COMPATIBLE|RUNNING|IDLE',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'workerId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextItemOffset
Type: int

The next incremental starting point after the defined itemOffset.

totalResults
Required: Yes
Type: int

The total number of results in the search.

workers
Required: Yes
Type: Array of WorkerSearchSummary structures

The workers for the search.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

StartSessionsStatisticsAggregation

$result = $client->startSessionsStatisticsAggregation([/* ... */]);
$promise = $client->startSessionsStatisticsAggregationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startSessionsStatisticsAggregation([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'groupBy' => ['<string>', ...], // REQUIRED
    'period' => 'HOURLY|DAILY|WEEKLY|MONTHLY',
    'resourceIds' => [ // REQUIRED
        'fleetIds' => ['<string>', ...],
        'queueIds' => ['<string>', ...],
    ],
    'startTime' => <integer || string || DateTime>, // REQUIRED
    'statistics' => ['<string>', ...], // REQUIRED
    'timezone' => '<string>',
]);

Parameter Details

Members
endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Linux timestamp of the date and time that the statistics end.

farmId
Required: Yes
Type: string

The identifier of the farm that contains queues or fleets to return statistics for.

groupBy
Required: Yes
Type: Array of strings

The field to use to group the statistics.

period
Type: string

The period to aggregate the statistics.

resourceIds
Required: Yes
Type: SessionsStatisticsResources structure

A list of fleet IDs or queue IDs to gather statistics for.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Linux timestamp of the date and time that the statistics start.

statistics
Required: Yes
Type: Array of strings

One to four statistics to return.

timezone
Type: string

The timezone to use for the statistics. Use UTC notation such as "UTC+8."

Result Syntax

[
    'aggregationId' => '<string>',
]

Result Details

Members
aggregationId
Required: Yes
Type: string

A unique identifier for the aggregated statistics. Use this identifier with the GetAggregatedStatisticsForSessions operation to return the statistics.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags a resource using the resource's ARN and desired tags.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource to apply tags to.

tags
Type: Associative array of custom strings keys (String) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource using the resource's ARN and tag to remove.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource to remove the tag from.

tagKeys
Required: Yes
Type: Array of strings

They keys of the tag.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateBudget

$result = $client->updateBudget([/* ... */]);
$promise = $client->updateBudgetAsync([/* ... */]);

Updates a budget that sets spending thresholds for rendering activity.

Parameter Syntax

$result = $client->updateBudget([
    'actionsToAdd' => [
        [
            'description' => '<string>',
            'thresholdPercentage' => <float>, // REQUIRED
            'type' => 'STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS', // REQUIRED
        ],
        // ...
    ],
    'actionsToRemove' => [
        [
            'thresholdPercentage' => <float>, // REQUIRED
            'type' => 'STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS', // REQUIRED
        ],
        // ...
    ],
    'approximateDollarLimit' => <float>,
    'budgetId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'schedule' => [
        'fixed' => [
            'endTime' => <integer || string || DateTime>, // REQUIRED
            'startTime' => <integer || string || DateTime>, // REQUIRED
        ],
    ],
    'status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members
actionsToAdd
Type: Array of BudgetActionToAdd structures

The budget actions to add. Budget actions specify what happens when the budget runs out.

actionsToRemove
Type: Array of BudgetActionToRemove structures

The budget actions to remove from the budget.

approximateDollarLimit
Type: float

The dollar limit to update on the budget. Based on consumed usage.

budgetId
Required: Yes
Type: string

The budget ID to update.

clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

description
Type: string

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.

displayName
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID of the budget to update.

schedule
Type: BudgetSchedule structure

The schedule to update.

status
Type: string

Updates the status of the budget.

  • ACTIVE–The budget is being evaluated.

  • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateFarm

$result = $client->updateFarm([/* ... */]);
$promise = $client->updateFarmAsync([/* ... */]);

Updates a farm.

Parameter Syntax

$result = $client->updateFarm([
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

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.

displayName
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateFleet

$result = $client->updateFleet([/* ... */]);
$promise = $client->updateFleetAsync([/* ... */]);

Updates a fleet.

Parameter Syntax

$result = $client->updateFleet([
    'clientToken' => '<string>',
    'configuration' => [
        'customerManaged' => [
            'mode' => 'NO_SCALING|EVENT_BASED_AUTO_SCALING', // REQUIRED
            'storageProfileId' => '<string>',
            'workerCapabilities' => [ // REQUIRED
                'acceleratorCount' => [
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'acceleratorTotalMemoryMiB' => [
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'acceleratorTypes' => ['<string>', ...],
                'cpuArchitectureType' => 'x86_64|arm64', // REQUIRED
                'customAmounts' => [
                    [
                        'max' => <float>,
                        'min' => <float>, // REQUIRED
                        'name' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'customAttributes' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'values' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
                'memoryMiB' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'osFamily' => 'WINDOWS|LINUX|MACOS', // REQUIRED
                'vCpuCount' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
            ],
        ],
        'serviceManagedEc2' => [
            'instanceCapabilities' => [ // REQUIRED
                'acceleratorCapabilities' => [
                    'count' => [
                        'max' => <integer>,
                        'min' => <integer>, // REQUIRED
                    ],
                    'selections' => [ // REQUIRED
                        [
                            'name' => 't4|a10g|l4|l40s', // REQUIRED
                            'runtime' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'allowedInstanceTypes' => ['<string>', ...],
                'cpuArchitectureType' => 'x86_64|arm64', // REQUIRED
                'customAmounts' => [
                    [
                        'max' => <float>,
                        'min' => <float>, // REQUIRED
                        'name' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'customAttributes' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'values' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
                'excludedInstanceTypes' => ['<string>', ...],
                'memoryMiB' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
                'osFamily' => 'WINDOWS|LINUX', // REQUIRED
                'rootEbsVolume' => [
                    'iops' => <integer>,
                    'sizeGiB' => <integer>,
                    'throughputMiB' => <integer>,
                ],
                'vCpuCount' => [ // REQUIRED
                    'max' => <integer>,
                    'min' => <integer>, // REQUIRED
                ],
            ],
            'instanceMarketOptions' => [ // REQUIRED
                'type' => 'on-demand|spot', // REQUIRED
            ],
        ],
    ],
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'maxWorkerCount' => <integer>,
    'minWorkerCount' => <integer>,
    'roleArn' => '<string>',
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

configuration
Type: FleetConfiguration structure

The fleet configuration to update.

description
Type: string

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.

displayName
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID to update.

fleetId
Required: Yes
Type: string

The fleet ID to update.

maxWorkerCount
Type: int

The maximum number of workers in the fleet.

minWorkerCount
Type: int

The minimum number of workers in the fleet.

roleArn
Type: string

The IAM role ARN that the fleet's workers assume while running jobs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

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.

UpdateJob

$result = $client->updateJob([/* ... */]);
$promise = $client->updateJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateJob([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'lifecycleStatus' => 'ARCHIVED',
    'maxFailedTasksCount' => <integer>,
    'maxRetriesPerTask' => <integer>,
    'priority' => <integer>,
    'queueId' => '<string>', // REQUIRED
    'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID of the job to update.

jobId
Required: Yes
Type: string

The job ID to update.

lifecycleStatus
Type: string

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.

maxFailedTasksCount
Type: int

The number of task failures before the job stops running and is marked as FAILED.

maxRetriesPerTask
Type: int

The maximum number of retries for a job.

priority
Type: int

The job priority to update.

queueId
Required: Yes
Type: string

The queue ID of the job to update.

targetTaskRunStatus
Type: string

The task status to update the job's tasks to.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateMonitor

$result = $client->updateMonitor([/* ... */]);
$promise = $client->updateMonitorAsync([/* ... */]);

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.

Parameter Syntax

$result = $client->updateMonitor([
    'displayName' => '<string>',
    'monitorId' => '<string>', // REQUIRED
    'roleArn' => '<string>',
    'subdomain' => '<string>',
]);

Parameter Details

Members
displayName
Type: string

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.

monitorId
Required: Yes
Type: string

The unique identifier of the monitor to update.

roleArn
Type: string

The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.

subdomain
Type: string

The new value of the subdomain to use when forming the monitor URL.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateQueue

$result = $client->updateQueue([/* ... */]);
$promise = $client->updateQueueAsync([/* ... */]);

Updates a queue.

Parameter Syntax

$result = $client->updateQueue([
    'allowedStorageProfileIdsToAdd' => ['<string>', ...],
    'allowedStorageProfileIdsToRemove' => ['<string>', ...],
    'clientToken' => '<string>',
    'defaultBudgetAction' => 'NONE|STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS',
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'jobAttachmentSettings' => [
        'rootPrefix' => '<string>', // REQUIRED
        's3BucketName' => '<string>', // REQUIRED
    ],
    'jobRunAsUser' => [
        'posix' => [
            'group' => '<string>', // REQUIRED
            'user' => '<string>', // REQUIRED
        ],
        'runAs' => 'QUEUE_CONFIGURED_USER|WORKER_AGENT_USER', // REQUIRED
        'windows' => [
            'passwordArn' => '<string>', // REQUIRED
            'user' => '<string>', // REQUIRED
        ],
    ],
    'queueId' => '<string>', // REQUIRED
    'requiredFileSystemLocationNamesToAdd' => ['<string>', ...],
    'requiredFileSystemLocationNamesToRemove' => ['<string>', ...],
    'roleArn' => '<string>',
]);

Parameter Details

Members
allowedStorageProfileIdsToAdd
Type: Array of strings

The storage profile IDs to add.

allowedStorageProfileIdsToRemove
Type: Array of strings

The storage profile ID to remove.

clientToken
Type: string

The idempotency token to update in the queue.

defaultBudgetAction
Type: string

The default action to take for a queue update if a budget isn't configured.

description
Type: string

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.

displayName
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID to update in the queue.

jobAttachmentSettings
Type: JobAttachmentSettings structure

The job attachment settings to update for the queue.

jobRunAsUser
Type: JobRunAsUser structure

Update the jobs in the queue to run as a specified POSIX user.

queueId
Required: Yes
Type: string

The queue ID to update.

requiredFileSystemLocationNamesToAdd
Type: Array of strings

The required file system location names to add to the queue.

requiredFileSystemLocationNamesToRemove
Type: Array of strings

The required file system location names to remove from the queue.

roleArn
Type: string

The IAM role ARN that's used to run jobs from this queue.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateQueueEnvironment

$result = $client->updateQueueEnvironment([/* ... */]);
$promise = $client->updateQueueEnvironmentAsync([/* ... */]);

Updates the queue environment.

Parameter Syntax

$result = $client->updateQueueEnvironment([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'priority' => <integer>,
    'queueEnvironmentId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'template' => '<string>',
    'templateType' => 'JSON|YAML',
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID of the queue environment to update.

priority
Type: int

The priority to update.

queueEnvironmentId
Required: Yes
Type: string

The queue environment ID to update.

queueId
Required: Yes
Type: string

The queue ID of the queue environment to update.

template
Type: string

The template to update.

templateType
Type: string

The template type to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateQueueFleetAssociation

$result = $client->updateQueueFleetAssociation([/* ... */]);
$promise = $client->updateQueueFleetAssociationAsync([/* ... */]);

Updates a queue-fleet association.

Parameter Syntax

$result = $client->updateQueueFleetAssociation([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'status' => 'ACTIVE|STOP_SCHEDULING_AND_COMPLETE_TASKS|STOP_SCHEDULING_AND_CANCEL_TASKS', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID to update.

fleetId
Required: Yes
Type: string

The fleet ID to update.

queueId
Required: Yes
Type: string

The queue ID to update.

status
Required: Yes
Type: string

The status to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateSession

$result = $client->updateSession([/* ... */]);
$promise = $client->updateSessionAsync([/* ... */]);

Updates a session.

Parameter Syntax

$result = $client->updateSession([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
    'targetLifecycleStatus' => 'ENDED', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID to update in the session.

jobId
Required: Yes
Type: string

The job ID to update in the session.

queueId
Required: Yes
Type: string

The queue ID to update in the session.

sessionId
Required: Yes
Type: string

The session ID to update.

targetLifecycleStatus
Required: Yes
Type: string

The life cycle status to update in the session.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateStep

$result = $client->updateStep([/* ... */]);
$promise = $client->updateStepAsync([/* ... */]);

Updates a step.

Parameter Syntax

$result = $client->updateStep([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'stepId' => '<string>', // REQUIRED
    'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID to update.

jobId
Required: Yes
Type: string

The job ID to update.

queueId
Required: Yes
Type: string

The queue ID to update.

stepId
Required: Yes
Type: string

The step ID to update.

targetTaskRunStatus
Required: Yes
Type: string

The task status to update the step's tasks to.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateStorageProfile

$result = $client->updateStorageProfile([/* ... */]);
$promise = $client->updateStorageProfileAsync([/* ... */]);

Updates a storage profile.

Parameter Syntax

$result = $client->updateStorageProfile([
    'clientToken' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'fileSystemLocationsToAdd' => [
        [
            'name' => '<string>', // REQUIRED
            'path' => '<string>', // REQUIRED
            'type' => 'SHARED|LOCAL', // REQUIRED
        ],
        // ...
    ],
    'fileSystemLocationsToRemove' => [
        [
            'name' => '<string>', // REQUIRED
            'path' => '<string>', // REQUIRED
            'type' => 'SHARED|LOCAL', // REQUIRED
        ],
        // ...
    ],
    'osFamily' => 'WINDOWS|LINUX|MACOS',
    'storageProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

displayName
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID to update.

fileSystemLocationsToAdd
Type: Array of FileSystemLocation structures

The file system location names to add.

fileSystemLocationsToRemove
Type: Array of FileSystemLocation structures

The file system location names to remove.

osFamily
Type: string

The OS system to update.

storageProfileId
Required: Yes
Type: string

The storage profile ID to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateTask

$result = $client->updateTask([/* ... */]);
$promise = $client->updateTaskAsync([/* ... */]);

Updates a task.

Parameter Syntax

$result = $client->updateTask([
    'clientToken' => '<string>',
    'farmId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'queueId' => '<string>', // REQUIRED
    'stepId' => '<string>', // REQUIRED
    'targetRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING', // REQUIRED
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

The unique token which the server uses to recognize retries of the same request.

farmId
Required: Yes
Type: string

The farm ID to update.

jobId
Required: Yes
Type: string

The job ID to update.

queueId
Required: Yes
Type: string

The queue ID to update.

stepId
Required: Yes
Type: string

The step ID to update.

targetRunStatus
Required: Yes
Type: string

The run status with which to start the task.

taskId
Required: Yes
Type: string

The task ID to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateWorker

$result = $client->updateWorker([/* ... */]);
$promise = $client->updateWorkerAsync([/* ... */]);

Updates a worker.

Parameter Syntax

$result = $client->updateWorker([
    'capabilities' => [
        'amounts' => [ // REQUIRED
            [
                'name' => '<string>', // REQUIRED
                'value' => <float>, // REQUIRED
            ],
            // ...
        ],
        'attributes' => [ // REQUIRED
            [
                'name' => '<string>', // REQUIRED
                'values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'hostProperties' => [
        'hostName' => '<string>',
        'ipAddresses' => [
            'ipV4Addresses' => ['<string>', ...],
            'ipV6Addresses' => ['<string>', ...],
        ],
    ],
    'status' => 'STARTED|STOPPING|STOPPED',
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
capabilities
Type: WorkerCapabilities structure

The worker capabilities to update.

farmId
Required: Yes
Type: string

The farm ID to update.

fleetId
Required: Yes
Type: string

The fleet ID to update.

hostProperties
Type: HostPropertiesRequest structure

The host properties to update.

status
Type: string

The worker status to update.

workerId
Required: Yes
Type: string

The worker ID to update.

Result Syntax

[
    'log' => [
        'error' => '<string>',
        'logDriver' => '<string>',
        'options' => ['<string>', ...],
        'parameters' => ['<string>', ...],
    ],
]

Result Details

Members
log
Type: LogConfiguration structure

The worker log to update.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

UpdateWorkerSchedule

$result = $client->updateWorkerSchedule([/* ... */]);
$promise = $client->updateWorkerScheduleAsync([/* ... */]);

Updates the schedule for a worker.

Parameter Syntax

$result = $client->updateWorkerSchedule([
    'farmId' => '<string>', // REQUIRED
    'fleetId' => '<string>', // REQUIRED
    'updatedSessionActions' => [
        '<SessionActionId>' => [
            'completedStatus' => 'SUCCEEDED|FAILED|INTERRUPTED|CANCELED|NEVER_ATTEMPTED',
            'endedAt' => <integer || string || DateTime>,
            'processExitCode' => <integer>,
            'progressMessage' => '<string>',
            'progressPercent' => <float>,
            'startedAt' => <integer || string || DateTime>,
            'updatedAt' => <integer || string || DateTime>,
        ],
        // ...
    ],
    'workerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
farmId
Required: Yes
Type: string

The farm ID to update.

fleetId
Required: Yes
Type: string

The fleet ID to update.

updatedSessionActions
Type: Associative array of custom strings keys (SessionActionId) to UpdatedSessionActionInfo structures

The session actions associated with the worker schedule to update.

workerId
Required: Yes
Type: string

The worker ID to update.

Result Syntax

[
    'assignedSessions' => [
        '<SessionId>' => [
            'jobId' => '<string>',
            'logConfiguration' => [
                'error' => '<string>',
                'logDriver' => '<string>',
                'options' => ['<string>', ...],
                'parameters' => ['<string>', ...],
            ],
            'queueId' => '<string>',
            'sessionActions' => [
                [
                    'definition' => [
                        'envEnter' => [
                            'environmentId' => '<string>',
                        ],
                        'envExit' => [
                            'environmentId' => '<string>',
                        ],
                        'syncInputJobAttachments' => [
                            'stepId' => '<string>',
                        ],
                        'taskRun' => [
                            'parameters' => [
                                '<String>' => [
                                    'float' => '<string>',
                                    'int' => '<string>',
                                    'path' => '<string>',
                                    'string' => '<string>',
                                ],
                                // ...
                            ],
                            'stepId' => '<string>',
                            'taskId' => '<string>',
                        ],
                    ],
                    'sessionActionId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'cancelSessionActions' => [
        '<SessionId>' => ['<string>', ...],
        // ...
    ],
    'desiredWorkerStatus' => 'STOPPED',
    'updateIntervalSeconds' => <integer>,
]

Result Details

Members
assignedSessions
Required: Yes
Type: Associative array of custom strings keys (SessionId) to AssignedSession structures

The assigned sessions to update.

cancelSessionActions
Required: Yes
Type: Associative array of custom strings keys (SessionId) to stringss

The session actions associated with the worker schedule to cancel.

desiredWorkerStatus
Type: string

The status to update the worker to.

updateIntervalSeconds
Required: Yes
Type: int

Updates the time interval (in seconds) for the schedule.

Errors

AccessDeniedException:

You don't have permission to perform the action.

InternalServerErrorException:

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota.

ConflictException:

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.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

Shapes

AcceleratorCapabilities

Description

Provides information about the GPU accelerators and drivers for the instance types in a fleet. If you include the acceleratorCapabilities property in the ServiceManagedEc2InstanceCapabilities object, all of the Amazon EC2 instances will have at least one accelerator.

Members
count
Type: AcceleratorCountRange structure

The number of GPUs on each worker. The default is 1.

selections
Required: Yes
Type: Array of AcceleratorSelection structures

A list of objects that contain the GPU name of the accelerator and driver for the instance types that support the accelerator.

AcceleratorCountRange

Description

The range for the GPU fleet acceleration.

Members
max
Type: int

The maximum number of GPUs for the accelerator.

min
Required: Yes
Type: int

The minimum number of GPUs for the accelerator. If you set the value to 0, a worker will still have 1 GPU.

AcceleratorSelection

Description

Values that you can use to select a particular Amazon EC2 instance type.

Members
name
Required: Yes
Type: string

The name of the GPU accelerator.

runtime
Type: string

The driver version that the GPU accelerator uses.

AcceleratorTotalMemoryMiBRange

Description

The range for memory, in MiB, to use for the accelerator.

Members
max
Type: int

The maximum amount of memory to use for the accelerator, measured in MiB.

min
Required: Yes
Type: int

The minimum amount of memory to use for the accelerator, measured in MiB.

AccessDeniedException

Description

You don't have permission to perform the action.

Members
context
Type: Associative array of custom strings keys (String) to strings

Information about the resources in use when the exception was thrown.

message
Required: Yes
Type: string

AssignedEnvironmentEnterSessionActionDefinition

Description

The assigned starting environment for a worker during session.

Members
environmentId
Required: Yes
Type: string

The environment ID of the assigned environment at the start of a session.

AssignedEnvironmentExitSessionActionDefinition

Description

The assigned environment when a worker exits a session.

Members
environmentId
Required: Yes
Type: string

The environment ID of the assigned environment when exiting a session.

AssignedSession

Description

The assigned session for the worker.

Members
jobId
Required: Yes
Type: string

The job ID for the assigned session.

logConfiguration
Required: Yes
Type: LogConfiguration structure

The log configuration for the worker's assigned session.

queueId
Required: Yes
Type: string

The queue ID of the assigned session.

sessionActions
Required: Yes
Type: Array of AssignedSessionAction structures

The session actions to apply to the assigned session.

AssignedSessionAction

Description

The action for a session defined by the session action ID.

Members
definition
Required: Yes
Type: AssignedSessionActionDefinition structure

The definition of the assigned session action.

sessionActionId
Required: Yes
Type: string

The session action ID for the assigned session.

AssignedSessionActionDefinition

Description

The definition of the assigned session action.

Members
envEnter

The environment a session starts on.

envExit

The environment a session exits from.

syncInputJobAttachments

The job attachment to sync with an assigned session action.

taskRun

The task run.

AssignedSyncInputJobAttachmentsSessionActionDefinition

Description

The details for an assigned session action as it relates to a job attachment.

Members
stepId
Type: string

The step ID.

AssignedTaskRunSessionActionDefinition

Description

The specific task, step, and parameters to include.

Members
parameters
Required: Yes
Type: Associative array of custom strings keys (String) to TaskParameterValue structures

The parameters to include.

stepId
Required: Yes
Type: string

The step ID.

taskId
Required: Yes
Type: string

The task ID.

Attachments

Description

The attachments for jobs.

Members
fileSystem
Type: string

The file system.

manifests
Required: Yes
Type: Array of ManifestProperties structures

A list of manifests which describe job attachment configurations.

AwsCredentials

Description

The Identity and Access Management credentials.

Members
accessKeyId
Required: Yes
Type: string

The IAM access key ID.

expiration
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The expiration date and time of the IAM credentials.

secretAccessKey
Required: Yes
Type: string

The IAM secret access key.

sessionToken
Required: Yes
Type: string

The IAM session token

BudgetActionToAdd

Description

The budget action to add.

Members
description
Type: string

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.

thresholdPercentage
Required: Yes
Type: float

The percentage threshold for the budget action to add.

type
Required: Yes
Type: string

The type of budget action to add.

BudgetActionToRemove

Description

The budget action to remove.

Members
thresholdPercentage
Required: Yes
Type: float

The percentage threshold for the budget action to remove.

type
Required: Yes
Type: string

The type of budget action to remove.

BudgetSchedule

Description

The start and end time of the budget.

Members
fixed
Type: FixedBudgetSchedule structure

The fixed start and end time of the budget's schedule.

BudgetSummary

Description

The budget summary.

Members
approximateDollarLimit
Required: Yes
Type: float

The approximate dollar limit of the budget.

budgetId
Required: Yes
Type: string

The budget ID.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

description
Type: string

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.

displayName
Required: Yes
Type: string

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.

status
Required: Yes
Type: string

The status of the budget.

  • ACTIVE–The budget is being evaluated.

  • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

usageTrackingResource
Required: Yes
Type: UsageTrackingResource structure

The resource used to track expenditure in the budget.

usages
Required: Yes
Type: ConsumedUsages structure

The consumed usage for the budget.

ConflictException

Description

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.

Members
context
Type: Associative array of custom strings keys (String) to strings

Information about the resources in use when the exception was thrown.

message
Required: Yes
Type: string
reason
Required: Yes
Type: string

A description of the error.

resourceId
Required: Yes
Type: string

The identifier of the resource in use.

resourceType
Required: Yes
Type: string

The type of the resource in use.

ConsumedUsages

Description

The consumed usage for the resource.

Members
approximateDollarUsage
Required: Yes
Type: float

The amount of the budget consumed.

CustomerManagedFleetConfiguration

Description

The details of a customer managed fleet configuration.

Members
mode
Required: Yes
Type: string

The Auto Scaling mode for the customer managed fleet configuration.

storageProfileId
Type: string

The storage profile ID.

workerCapabilities
Required: Yes
Type: CustomerManagedWorkerCapabilities structure

The worker capabilities for a customer managed fleet configuration.

CustomerManagedWorkerCapabilities

Description

The worker capabilities for a customer managed workflow.

Members
acceleratorCount
Type: AcceleratorCountRange structure

The range of the accelerator.

acceleratorTotalMemoryMiB

The total memory (MiB) for the customer managed worker capabilities.

acceleratorTypes
Type: Array of strings

The accelerator types for the customer managed worker capabilities.

cpuArchitectureType
Required: Yes
Type: string

The CPU architecture type for the customer managed worker capabilities.

customAmounts
Type: Array of FleetAmountCapability structures

Custom requirement ranges for customer managed worker capabilities.

customAttributes
Type: Array of FleetAttributeCapability structures

Custom attributes for the customer manged worker capabilities.

memoryMiB
Required: Yes
Type: MemoryMiBRange structure

The memory (MiB).

osFamily
Required: Yes
Type: string

The operating system (OS) family.

vCpuCount
Required: Yes
Type: VCpuCountRange structure

The vCPU count for the customer manged worker capabilities.

DateTimeFilterExpression

Description

The time stamp in date-time format.

Members
dateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time.

name
Required: Yes
Type: string

The name of the date-time field to filter on.

operator
Required: Yes
Type: string

The type of comparison to use to filter the results.

DependencyCounts

Description

The number of dependencies for the consumer.

Members
consumersResolved
Required: Yes
Type: int

The number of consumers resolved.

consumersUnresolved
Required: Yes
Type: int

The number of unresolved consumers.

dependenciesResolved
Required: Yes
Type: int

The number of resolved dependencies.

dependenciesUnresolved
Required: Yes
Type: int

The number of unresolved dependencies.

Document

Members

Ec2EbsVolume

Description

Specifies the EBS volume.

Members
iops
Type: int

The IOPS per volume.

sizeGiB
Type: int

The EBS volume size in GiB.

throughputMiB
Type: int

The throughput per volume in MiB.

EnvironmentDetailsEntity

Description

The details of a specified environment.

Members
environmentId
Required: Yes
Type: string

The environment ID.

jobId
Required: Yes
Type: string

The job ID.

schemaVersion
Required: Yes
Type: string

The schema version in the environment.

template
Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The template used for the environment.

EnvironmentDetailsError

Description

The error details for the environment.

Members
code
Required: Yes
Type: string

The error code.

environmentId
Required: Yes
Type: string

The environment ID.

jobId
Required: Yes
Type: string

The job ID.

message
Required: Yes
Type: string

The error message detailing the error's cause.

EnvironmentDetailsIdentifiers

Description

The IDs of the job and environment.

Members
environmentId
Required: Yes
Type: string

The environment ID.

jobId
Required: Yes
Type: string

The job ID.

EnvironmentEnterSessionActionDefinition

Description

The environment ID to use to enter a session action.

Members
environmentId
Required: Yes
Type: string

The environment ID.

EnvironmentEnterSessionActionDefinitionSummary

Description

Defines the environment a session action enters in.

Members
environmentId
Required: Yes
Type: string

The environment ID.

EnvironmentExitSessionActionDefinition

Description

Defines the environment a session action exits from.

Members
environmentId
Required: Yes
Type: string

The environment ID.

EnvironmentExitSessionActionDefinitionSummary

Description

A summary of the environment details for which a session action to exits.

Members
environmentId
Required: Yes
Type: string

The environment ID.

FarmMember

Description

The member of a farm.

Members
farmId
Required: Yes
Type: string

The farm ID of the farm member.

identityStoreId
Required: Yes
Type: string

The identity store ID of the farm member.

membershipLevel
Required: Yes
Type: string

The farm member's membership level.

principalId
Required: Yes
Type: string

The principal ID of the farm member.

principalType
Required: Yes
Type: string

The principal type of the farm member.

FarmSummary

Description

The summary of details for a farm.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID.

kmsKeyArn
Type: string

The ARN for the KMS key.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

FieldSortExpression

Description

The field sorting order and name of the field.

Members
name
Required: Yes
Type: string

The name of the field.

sortOrder
Required: Yes
Type: string

The sort order for the field.

FileSystemLocation

Description

The details of the file system location for the resource.

Members
name
Required: Yes
Type: string

The location name.

path
Required: Yes
Type: string

The file path.

type
Required: Yes
Type: string

The type of file.

FixedBudgetSchedule

Description

The details of a fixed budget schedule.

Members
endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the budget ends.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the budget starts.

FleetAmountCapability

Description

The fleet amount and attribute capabilities.

Members
max
Type: float

The maximum amount of the fleet worker capability.

min
Required: Yes
Type: float

The minimum amount of fleet worker capability.

name
Required: Yes
Type: string

The name of the fleet capability.

FleetAttributeCapability

Description

Defines the fleet's capability name, minimum, and maximum.

Members
name
Required: Yes
Type: string

The name of the fleet attribute capability for the worker.

values
Required: Yes
Type: Array of strings

The number of fleet attribute capabilities.

FleetCapabilities

Description

The amounts and attributes of fleets.

Members
amounts
Type: Array of FleetAmountCapability structures

Amount capabilities of the fleet.

attributes
Type: Array of FleetAttributeCapability structures

Attribute capabilities of the fleet.

FleetMember

Description

The fleet member.

Members
farmId
Required: Yes
Type: string

The farm ID.

fleetId
Required: Yes
Type: string

The fleet ID.

identityStoreId
Required: Yes
Type: string

The identity store ID.

membershipLevel
Required: Yes
Type: string

The fleet member's membership level.

principalId
Required: Yes
Type: string

The principal ID of the fleet member.

principalType
Required: Yes
Type: string

The principal type of the fleet member.

FleetSummary

Description

The details of a fleet.

Members
autoScalingStatus
Type: string

The Auto Scaling status of a fleet.

configuration
Required: Yes
Type: FleetConfiguration structure

The configuration details for the fleet.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID.

fleetId
Required: Yes
Type: string

The fleet ID.

maxWorkerCount
Required: Yes
Type: int

The maximum number of workers specified in the fleet.

minWorkerCount
Required: Yes
Type: int

The minimum number of workers in the fleet.

status
Required: Yes
Type: string

The status of the fleet.

targetWorkerCount
Type: int

The target number of workers in a fleet.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

workerCount
Required: Yes
Type: int

The number of workers in the fleet summary.

GetJobEntityError

Description

The error for the job entity.

Members
environmentDetails
Type: EnvironmentDetailsError structure

The environment details for the failed job entity.

jobAttachmentDetails
Type: JobAttachmentDetailsError structure

The job attachment details for the failed job entity.

jobDetails
Type: JobDetailsError structure

The job details for the failed job entity.

stepDetails
Type: StepDetailsError structure

The step details for the failed job entity.

HostPropertiesRequest

Description

The host property details.

Members
hostName
Type: string

The host name.

ipAddresses
Type: IpAddresses structure

The IP address of the host.

HostPropertiesResponse

Description

The host property details.

Members
ec2InstanceArn
Type: string

The ARN of the host EC2 instance.

ec2InstanceType
Type: string

The instance type of the host EC2 instance.

hostName
Type: string

The host name.

ipAddresses
Type: IpAddresses structure

The IP address of the host.

InternalServerErrorException

Description

Deadline Cloud can't process your request right now. Try again later.

Members
message
Required: Yes
Type: string
retryAfterSeconds
Type: int

The number of seconds a client should wait before retrying the request.

IpAddresses

Description

The IP addresses for a host.

Members
ipV4Addresses
Type: Array of strings

The IpV4 address of the network.

ipV6Addresses
Type: Array of strings

The IpV6 address for the network and node component.

JobAttachmentDetailsEntity

Description

The job attachments.

Members
attachments
Required: Yes
Type: Attachments structure

The job attachments.

jobId
Required: Yes
Type: string

The job ID.

JobAttachmentDetailsError

Description

The error details for job attachments.

Members
code
Required: Yes
Type: string

The error code.

jobId
Required: Yes
Type: string

The job ID.

message
Required: Yes
Type: string

The error message detailing the error's cause.

JobAttachmentDetailsIdentifiers

Description

Identifier details for job attachments.

Members
jobId
Required: Yes
Type: string

The job ID.

JobAttachmentSettings

Description

The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.

Members
rootPrefix
Required: Yes
Type: string

The root prefix.

s3BucketName
Required: Yes
Type: string

The Amazon S3 bucket name.

JobDetailsEntity

Description

The job details for a specific job.

Members
jobAttachmentSettings
Type: JobAttachmentSettings structure

The job attachment settings.

jobId
Required: Yes
Type: string

The job ID.

jobRunAsUser
Type: JobRunAsUser structure

The user name and group that the job uses when run.

logGroupName
Required: Yes
Type: string

The log group name.

parameters
Type: Associative array of custom strings keys (String) to JobParameter structures

The parameters.

pathMappingRules
Type: Array of PathMappingRule structures

The path mapping rules.

queueRoleArn
Type: string

The queue role ARN.

schemaVersion
Required: Yes
Type: string

The schema version.

JobDetailsError

Description

The details of a job error.

Members
code
Required: Yes
Type: string

The error code.

jobId
Required: Yes
Type: string

The job ID.

message
Required: Yes
Type: string

The error message detailing the error's cause.

JobDetailsIdentifiers

Description

The identifiers for a job.

Members
jobId
Required: Yes
Type: string

The job ID.

JobMember

Description

The details for a job member.

Members
farmId
Required: Yes
Type: string

The farm ID.

identityStoreId
Required: Yes
Type: string

The identity store ID.

jobId
Required: Yes
Type: string

The job ID.

membershipLevel
Required: Yes
Type: string

The job member's membership level.

principalId
Required: Yes
Type: string

The principal ID of the job member.

principalType
Required: Yes
Type: string

The principal type of the job member.

queueId
Required: Yes
Type: string

The queue ID.

JobParameter

Description

The details of job parameters.

Members
float
Type: string

A double precision IEEE-754 floating point number represented as a string.

int
Type: string

A signed integer represented as a string.

path
Type: string

A file system path represented as a string.

string
Type: string

A UTF-8 string.

JobParameterDefinition

Members

JobRunAsUser

Description

Identifies the user for a job.

Members
posix
Type: PosixUser structure

The user and group that the jobs in the queue run as.

runAs
Required: Yes
Type: string

Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.

windows
Type: WindowsUser structure

Identifies a Microsoft Windows user.

JobSearchSummary

Description

The details of a job search.

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Type: string

The user or system that created this resource.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

jobId
Type: string

The job ID.

jobParameters
Type: Associative array of custom strings keys (String) to JobParameter structures

The job parameters.

lifecycleStatus
Type: string

The life cycle status.

lifecycleStatusMessage
Type: string

The life cycle status message.

maxFailedTasksCount
Type: int

The number of task failures before the job stops running and is marked as FAILED.

maxRetriesPerTask
Type: int

The maximum number of retries for a job.

name
Type: string

The job name.

priority
Type: int

The job priority.

queueId
Type: string

The queue ID.

sourceJobId
Type: string

The job ID for the source job.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

targetTaskRunStatus
Type: string

The task status to start with on the job.

taskRunStatus
Type: string

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to be processed.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to be run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

taskRunStatusCounts
Type: Associative array of custom strings keys (TaskRunStatus) to ints

The number of tasks running on the job.

JobSummary

Description

A summary of job details.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

jobId
Required: Yes
Type: string

The job ID.

lifecycleStatus
Required: Yes
Type: string

The life cycle status.

lifecycleStatusMessage
Required: Yes
Type: string

The life cycle status message.

maxFailedTasksCount
Type: int

The number of task failures before the job stops running and is marked as FAILED.

maxRetriesPerTask
Type: int

The maximum number of retries for a job.

name
Required: Yes
Type: string

The job name.

priority
Required: Yes
Type: int

The job priority.

sourceJobId
Type: string

The job ID for the source job.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

targetTaskRunStatus
Type: string

The task status to start with on the job.

taskRunStatus
Type: string

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to be processed.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to be run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

taskRunStatusCounts
Type: Associative array of custom strings keys (TaskRunStatus) to ints

The number of tasks running on the job.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

LicenseEndpointSummary

Description

The details for a license endpoint.

Members
licenseEndpointId
Type: string

The license endpoint ID.

status
Type: string

The status of the license endpoint.

statusMessage
Type: string

The status message of the license endpoint.

vpcId
Type: string

The VCP(virtual private cloud) ID associated with the license endpoint.

LogConfiguration

Description

Log configuration details.

Members
error
Type: string

The log configuration error details.

logDriver
Required: Yes
Type: string

The log drivers for worker related logs.

options
Type: Associative array of custom strings keys (String) to strings

The options for a log driver.

parameters
Type: Associative array of custom strings keys (String) to strings

The parameters for the log configuration.

ManifestProperties

Description

The details of the manifest that links a job's source information.

Members
fileSystemLocationName
Type: string

The file system location name.

inputManifestHash
Type: string

The has value of the file.

inputManifestPath
Type: string

The file path.

outputRelativeDirectories
Type: Array of strings

The file path relative to the directory.

rootPath
Required: Yes
Type: string

The file's root path.

rootPathFormat
Required: Yes
Type: string

The format of the root path.

MemoryMiBRange

Description

The range of memory in MiB.

Members
max
Type: int

The maximum amount of memory (in MiB).

min
Required: Yes
Type: int

The minimum amount of memory (in MiB).

MeteredProductSummary

Description

The details of a metered product.

Members
family
Required: Yes
Type: string

The family to which the metered product belongs.

port
Required: Yes
Type: int

The port on which the metered product should run.

productId
Required: Yes
Type: string

The product ID.

vendor
Required: Yes
Type: string

The vendor.

MonitorSummary

Description

Provides information about a monitor in Deadline Cloud.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The UNIX timestamp of the date and time that the monitor was created.

createdBy
Required: Yes
Type: string

The user name of the person that created the monitor.

displayName
Required: Yes
Type: string

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.

identityCenterApplicationArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.

identityCenterInstanceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

monitorId
Required: Yes
Type: string

The unique identifier for the monitor.

roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

subdomain
Required: Yes
Type: string

The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The UNIX timestamp of the date and time that the monitor was last updated.

updatedBy
Type: string

The user name of the person that last updated the monitor.

url
Required: Yes
Type: string

The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

ParameterFilterExpression

Description

The details of a filtered search for parameters.

Members
name
Required: Yes
Type: string

The name of the parameter to filter on.

operator
Required: Yes
Type: string

The type of comparison to use to filter results.

value
Required: Yes
Type: string

The parameter's value.

ParameterSortExpression

Description

Organizes parameters according to your specifications.

Members
name
Required: Yes
Type: string

The parameter name to sort by.

sortOrder
Required: Yes
Type: string

The sort order for the parameter.

ParameterSpace

Description

The details of a search for two or more step parameters.

Members
combination
Type: string

The combination expression to use in the search.

parameters
Required: Yes
Type: Array of StepParameter structures

The parameters to search for.

PathMappingRule

Description

The details of a source and destination path.

Members
destinationPath
Required: Yes
Type: string

The destination path.

sourcePath
Required: Yes
Type: string

The source path.

sourcePathFormat
Required: Yes
Type: string

The source path format.

PosixUser

Description

The POSIX user.

Members
group
Required: Yes
Type: string

The name of the POSIX user's group.

user
Required: Yes
Type: string

The name of the POSIX user.

QueueEnvironmentSummary

Description

The summary of a queue environment.

Members
name
Required: Yes
Type: string

The name of the queue environment.

priority
Required: Yes
Type: int

The queue environment's priority.

queueEnvironmentId
Required: Yes
Type: string

The queue environment ID.

QueueFleetAssociationSummary

Description

The details of a queue-fleet association.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

fleetId
Required: Yes
Type: string

The fleet ID.

queueId
Required: Yes
Type: string

The queue ID.

status
Required: Yes
Type: string

The status of task scheduling in the queue-fleet association.

  • ACTIVE–Association is active.

  • STOP_SCHEDULING_AND_COMPLETE_TASKS–Association has stopped scheduling new tasks and is completing current tasks.

  • STOP_SCHEDULING_AND_CANCEL_TASKS–Association has stopped scheduling new tasks and is canceling current tasks.

  • STOPPED–Association has been stopped.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

QueueMember

Description

The details of a queue member.

Members
farmId
Required: Yes
Type: string

The farm ID.

identityStoreId
Required: Yes
Type: string

The identity store ID.

membershipLevel
Required: Yes
Type: string

The queue member's membership level.

principalId
Required: Yes
Type: string

The principal ID of the queue member.

principalType
Required: Yes
Type: string

The principal type of the queue member.

queueId
Required: Yes
Type: string

The queue ID.

QueueSummary

Description

The details of a queue summary.

Members
blockedReason
Type: string

The reason the queue is blocked, if applicable.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

defaultBudgetAction
Required: Yes
Type: string

The default action taken on a queue summary if a budget wasn't configured.

displayName
Required: Yes
Type: string

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.

farmId
Required: Yes
Type: string

The farm ID.

queueId
Required: Yes
Type: string

The queue ID.

status
Required: Yes
Type: string

That status of the queue.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

ResourceNotFoundException

Description

The requested resource can't be found.

Members
context
Type: Associative array of custom strings keys (String) to strings

Information about the resources in use when the exception was thrown.

message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The identifier of the resource that couldn't be found.

resourceType
Required: Yes
Type: string

The type of the resource that couldn't be found.

ResponseBudgetAction

Description

The details of a budget action.

Members
description
Type: string

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.

thresholdPercentage
Required: Yes
Type: float

The percentage threshold for the budget.

type
Required: Yes
Type: string

The action taken on the budget once scheduling stops.

S3Location

Description

The Amazon S3 location information.

Members
bucketName
Required: Yes
Type: string

The name of the Amazon S3 bucket.

key
Required: Yes
Type: string

The Amazon S3 object key that uniquely identifies the Amazon S3 bucket.

SearchGroupedFilterExpressions

Description

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 ().

Members
filters
Required: Yes
Type: Array of SearchFilterExpression structures

The filters to use for the search.

operator
Required: Yes
Type: string

The operators to include in the search.

SearchSortExpression

Description

The resources to search.

Members
fieldSort
Type: FieldSortExpression structure

Options for sorting by a field.

parameterSort
Type: ParameterSortExpression structure

Options for sorting by a parameter.

userJobsFirst
Type: UserJobsFirst structure

Options for sorting a particular user's jobs first.

SearchTermFilterExpression

Description

Searches for a particular search term.

Members
searchTerm
Required: Yes
Type: string

The term to search for.

ServiceManagedEc2InstanceCapabilities

Description

The Amazon EC2 instance capabilities.

Members
acceleratorCapabilities
Type: AcceleratorCapabilities structure

The GPU accelerator capabilities required for the Amazon EC2 instances. If you include the acceleratorCapabilities property in the ServiceManagedEc2InstanceCapabilities object, all of the Amazon EC2 instances will have at least one accelerator.

allowedInstanceTypes
Type: Array of strings

The allowable Amazon EC2 instance types.

cpuArchitectureType
Required: Yes
Type: string

The CPU architecture type.

customAmounts
Type: Array of FleetAmountCapability structures

The custom capability amounts to require for instances in this fleet.

customAttributes
Type: Array of FleetAttributeCapability structures

The custom capability attributes to require for instances in this fleet.

excludedInstanceTypes
Type: Array of strings

The instance types to exclude from the fleet.

memoryMiB
Required: Yes
Type: MemoryMiBRange structure

The memory, as MiB, for the Amazon EC2 instance type.

osFamily
Required: Yes
Type: string

The operating system (OS) family.

rootEbsVolume
Type: Ec2EbsVolume structure

The root EBS volume.

vCpuCount
Required: Yes
Type: VCpuCountRange structure

The amount of vCPU to require for instances in this fleet.

ServiceManagedEc2InstanceMarketOptions

Description

The details of the Amazon EC2 instance market options for a service managed fleet.

Members
type
Required: Yes
Type: string

The Amazon EC2 instance type.

ServiceQuotaExceededException

Description

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.

Members
context
Type: Associative array of custom strings keys (String) to strings

Information about the resources in use when the exception was thrown.

message
Required: Yes
Type: string
quotaCode
Required: Yes
Type: string

Identifies the quota that has been exceeded.

reason
Required: Yes
Type: string

A string that describes the reason the quota was exceeded.

resourceId
Type: string

The identifier of the affected resource.

resourceType
Required: Yes
Type: string

The type of the affected resource

serviceCode
Required: Yes
Type: string

Identifies the service that exceeded the quota.

SessionActionDefinitionSummary

Description

The details of a session action definition.

Members
envEnter

The environment to enter into.

envExit

The environment to exit from.

syncInputJobAttachments

The job attachments to sync with the session action definition.

taskRun

The task run.

SessionActionSummary

Description

The details of a session action.

Members
definition
Required: Yes
Type: SessionActionDefinitionSummary structure

The session action definition.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

progressPercent
Type: float

The completion percentage for the session action.

sessionActionId
Required: Yes
Type: string

The session action ID.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

status
Required: Yes
Type: string

The status of the session action.

workerUpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Linux timestamp of the last date and time that the session action was updated.

SessionSummary

Description

The summary of a session.

Members
endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

fleetId
Required: Yes
Type: string

The fleet ID.

lifecycleStatus
Required: Yes
Type: string

The life cycle status for the session.

sessionId
Required: Yes
Type: string

The session ID.

startedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

targetLifecycleStatus
Type: string

The target life cycle status for the session.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

workerId
Required: Yes
Type: string

The worker ID.

SessionsStatisticsResources

Description

Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both.

Members
fleetIds
Type: Array of strings

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.

queueIds
Type: Array of strings

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.

Statistics

Description

A list of statistics for a session.

Members
aggregationEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time for the aggregation.

aggregationStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time for the aggregation.

costInUsd
Required: Yes
Type: Stats structure

How the statistics should appear in USD. Options include: minimum, maximum, average or sum.

count
Required: Yes
Type: int

The number of instances in a list of statistics.

fleetId
Type: string

The fleet ID.

instanceType
Type: string

The type of instance.

jobId
Type: string

The job ID.

jobName
Type: string

The job name.

licenseProduct
Type: string

The licensed product.

queueId
Type: string

The queue ID.

runtimeInSeconds
Required: Yes
Type: Stats structure

The total aggregated runtime.

usageType
Type: string

The type of usage for the statistics.

userId
Type: string

The user ID.

Stats

Description

The minimum, maximum, average, and sum.

Members
avg
Type: double

The average of the usage statistics.

max
Type: double

The maximum among the usage statistics.

min
Type: double

The minimum of the usage statistics.

sum
Type: double

The sum of the usage statistics.

StepAmountCapability

Description

The details outlining the minimum and maximum capability of a step.

Members
max
Type: double

The maximum amount.

min
Type: double

The minimum amount.

name
Required: Yes
Type: string

The name of the step.

value
Type: double

The amount value.

StepAttributeCapability

Description

The list of step attributes.

Members
allOf
Type: Array of strings

Requires all of the step attribute values.

anyOf
Type: Array of strings

Requires any of the step attributes in a given list.

name
Required: Yes
Type: string

The name of the step attribute.

StepConsumer

Description

The details of a step consumer.

Members
status
Required: Yes
Type: string

The step consumer status.

stepId
Required: Yes
Type: string

The step ID.

StepDependency

Description

The details of step dependency.

Members
status
Required: Yes
Type: string

The step dependency status.

stepId
Required: Yes
Type: string

The step ID.

StepDetailsEntity

Description

The details of a step entity.

Members
dependencies
Required: Yes
Type: Array of strings

The dependencies for a step.

jobId
Required: Yes
Type: string

The job ID.

schemaVersion
Required: Yes
Type: string

The schema version for a step template.

stepId
Required: Yes
Type: string

The step ID.

template
Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The template for a step.

StepDetailsError

Description

The details of the step error.

Members
code
Required: Yes
Type: string

The error code.

jobId
Required: Yes
Type: string

The job ID.

message
Required: Yes
Type: string

The error message detailing the error's cause.

stepId
Required: Yes
Type: string

The step ID.

StepDetailsIdentifiers

Description

The details of identifiers for a step.

Members
jobId
Required: Yes
Type: string

The job ID.

stepId
Required: Yes
Type: string

The step ID.

StepParameter

Description

The details of a step parameter.

Members
name
Required: Yes
Type: string

The name of the parameter.

type
Required: Yes
Type: string

The data type of the parameter.

StepRequiredCapabilities

Description

The details of required step capabilities.

Members
amounts
Required: Yes
Type: Array of StepAmountCapability structures

The capability amounts that the step requires.

attributes
Required: Yes
Type: Array of StepAttributeCapability structures

The capability attributes that the step requires.

StepSearchSummary

Description

The details of a step search.

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

jobId
Type: string

The job ID.

lifecycleStatus
Type: string

The life cycle status.

lifecycleStatusMessage
Type: string

The life cycle status message.

name
Type: string

The step name.

parameterSpace
Type: ParameterSpace structure

The parameters and combination expressions for the search.

queueId
Type: string

The queue ID.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

stepId
Type: string

The step ID.

targetTaskRunStatus
Type: string

The task status to start with on the job.

taskRunStatus
Type: string

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to be processed.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to be run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

taskRunStatusCounts
Type: Associative array of custom strings keys (TaskRunStatus) to ints

The number of tasks running on the job.

StepSummary

Description

The details for a step.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

dependencyCounts
Type: DependencyCounts structure

The number of dependencies for the step.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

lifecycleStatus
Required: Yes
Type: string

The life cycle status.

lifecycleStatusMessage
Type: string

A message that describes the lifecycle of the step.

name
Required: Yes
Type: string

The name of the step.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

stepId
Required: Yes
Type: string

The step ID.

targetTaskRunStatus
Type: string

The task status to start with on the job.

taskRunStatus
Required: Yes
Type: string

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to process.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

taskRunStatusCounts
Required: Yes
Type: Associative array of custom strings keys (TaskRunStatus) to ints

The number of tasks running on the job.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

StorageProfileSummary

Description

The details of a storage profile.

Members
displayName
Required: Yes
Type: string

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.

osFamily
Required: Yes
Type: string

The operating system (OS) family.

storageProfileId
Required: Yes
Type: string

The storage profile ID.

StringFilterExpression

Description

Searches for a particular string.

Members
name
Required: Yes
Type: string

The field name to search.

operator
Required: Yes
Type: string

The type of comparison to use for this search.

value
Required: Yes
Type: string

The string to search for.

SyncInputJobAttachmentsSessionActionDefinition

Description

The job attachment in a session action to sync.

Members
stepId
Type: string

The step ID for the step in the job attachment.

SyncInputJobAttachmentsSessionActionDefinitionSummary

Description

The details of a synced job attachment.

Members
stepId
Type: string

The step ID of the step in the job attachment.

TaskParameterValue

Description

The data types for the task parameters.

Members
float
Type: string

A double precision IEEE-754 floating point number represented as a string.

int
Type: string

A signed integer represented as a string.

path
Type: string

A file system path represented as a string.

string
Type: string

A UTF-8 string.

TaskRunSessionActionDefinition

Description

The task, step, and parameters for the task run in the session action.

Members
parameters
Required: Yes
Type: Associative array of custom strings keys (String) to TaskParameterValue structures

The task parameters.

stepId
Required: Yes
Type: string

The step ID.

taskId
Required: Yes
Type: string

The task ID.

TaskRunSessionActionDefinitionSummary

Description

The details of a task run in a session action.

Members
stepId
Required: Yes
Type: string

The step ID.

taskId
Required: Yes
Type: string

The task ID.

TaskSearchSummary

Description

The details of a task search.

Members
endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

failureRetryCount
Type: int

The number of times that the task failed and was retried.

jobId
Type: string

The job ID.

parameters
Type: Associative array of custom strings keys (String) to TaskParameterValue structures

The parameters to search for.

queueId
Type: string

The queue ID.

runStatus
Type: string

The run status of the task.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

stepId
Type: string

The step ID.

targetRunStatus
Type: string

The run status that the task is being updated to.

taskId
Type: string

The task ID.

TaskSummary

Description

The details of a task.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was created.

createdBy
Required: Yes
Type: string

The user or system that created this resource.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

failureRetryCount
Type: int

The number of times that the task failed and was retried.

latestSessionActionId
Type: string

The latest session action for the task.

parameters
Type: Associative array of custom strings keys (String) to TaskParameterValue structures

The task parameters.

runStatus
Required: Yes
Type: string

The run status of the task.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

targetRunStatus
Type: string

The run status on which the started.

taskId
Required: Yes
Type: string

The task ID.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource was updated.

updatedBy
Type: string

The user or system that updated this resource.

ThrottlingException

Description

Your request exceeded a request rate quota.

Members
context
Type: Associative array of custom strings keys (String) to strings

Information about the resources in use when the exception was thrown.

message
Required: Yes
Type: string
quotaCode
Type: string

Identifies the quota that is being throttled.

retryAfterSeconds
Type: int

The number of seconds a client should wait before retrying the request.

serviceCode
Type: string

Identifies the service that is being throttled.

UpdatedSessionActionInfo

Description

The updated session action information as it relates to completion and progress of the session.

Members
completedStatus
Type: string

The status of the session upon completion.

endedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource ended running.

processExitCode
Type: int

The process exit code.

progressMessage
Type: string

A message to indicate the progress of the updated session action.

progressPercent
Type: float

The percentage completed.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the resource started running.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The updated time.

UsageTrackingResource

Description

The usage details of the allotted budget.

Members
queueId
Type: string

The queue ID.

UserJobsFirst

Description

Allows setting a specific user's job to run first.

Members
userIdentityId
Required: Yes
Type: string

The user's ID.

VCpuCountRange

Description

The allowable range of vCPU processing power for the fleet.

Members
max
Type: int

The maximum amount of vCPU.

min
Required: Yes
Type: int

The minimum amount of vCPU.

ValidationException

Description

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

Members
context
Type: Associative array of custom strings keys (String) to strings

Information about the resources in use when the exception was thrown.

fieldList
Type: Array of ValidationExceptionField structures

A list of fields that failed validation.

message
Required: Yes
Type: string
reason
Required: Yes
Type: string

The reason that the request failed validation.