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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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' => [
                    '<JobParametersKeyString>' => [
                        '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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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>',
            'tagPropagationMode' => 'NO_PROPAGATION|PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH',
            '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|wait-and-save', // REQUIRED
            ],
            'storageProfileId' => '<string>',
            'vpcConfiguration' => [
                'resourceConfigurationArns' => ['<string>', ...],
            ],
        ],
    ],
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'hostConfiguration' => [
        'scriptBody' => '<string>', // REQUIRED
        'scriptTimeoutSeconds' => <integer>,
    ],
    'maxWorkerCount' => <integer>, // REQUIRED
    'minWorkerCount' => <integer>,
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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 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>,
    'maxWorkerCount' => <integer>,
    'parameters' => [
        '<JobParametersKeyString>' => [
            '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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

CreateLimit

$result = $client->createLimit([/* ... */]);
$promise = $client->createLimitAsync([/* ... */]);

Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.

You must add the amountRequirementName to a step in a job template to declare the limit requirement.

Parameter Syntax

$result = $client->createLimit([
    'amountRequirementName' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'farmId' => '<string>', // REQUIRED
    'maxCount' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

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
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

CreateQueueLimitAssociation

$result = $client->createQueueLimitAssociation([/* ... */]);
$promise = $client->createQueueLimitAssociationAsync([/* ... */]);

Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

DeleteLimit

$result = $client->deleteLimit([/* ... */]);
$promise = $client->deleteLimitAsync([/* ... */]);

Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

DeleteMeteredProduct

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

Deletes a metered product.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

DeleteQueueLimitAssociation

$result = $client->deleteQueueLimitAssociation([/* ... */]);
$promise = $client->deleteQueueLimitAssociationAsync([/* ... */]);

Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

Result Syntax

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

Result Details

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

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>',
            'tagPropagationMode' => 'NO_PROPAGATION|PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH',
            '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|wait-and-save',
            ],
            'storageProfileId' => '<string>',
            'vpcConfiguration' => [
                'resourceConfigurationArns' => ['<string>', ...],
            ],
        ],
    ],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>',
    'fleetId' => '<string>',
    'hostConfiguration' => [
        'scriptBody' => '<string>',
        'scriptTimeoutSeconds' => <integer>,
    ],
    'maxWorkerCount' => <integer>,
    'minWorkerCount' => <integer>,
    'roleArn' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|UPDATE_IN_PROGRESS|CREATE_FAILED|UPDATE_FAILED|SUSPENDED',
    'statusMessage' => '<string>',
    'targetWorkerCount' => <integer>,
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'workerCount' => <integer>,
]

Result Details

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

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>,
    'maxWorkerCount' => <integer>,
    'name' => '<string>',
    'parameters' => [
        '<JobParametersKeyString>' => [
            'float' => '<string>',
            'int' => '<string>',
            'path' => '<string>',
            'string' => '<string>',
        ],
        // ...
    ],
    'priority' => <integer>,
    'sourceJobId' => '<string>',
    'startedAt' => <DateTime>,
    'storageProfileId' => '<string>',
    'targetTaskRunStatus' => 'READY|FAILED|SUCCEEDED|CANCELED|SUSPENDED|PENDING',
    'taskFailureRetryCount' => <integer>,
    'taskRunStatus' => 'PENDING|READY|ASSIGNED|STARTING|SCHEDULED|INTERRUPTING|RUNNING|SUSPENDED|CANCELED|FAILED|SUCCEEDED|NOT_COMPATIBLE',
    'taskRunStatusCounts' => [<integer>, ...],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

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

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

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.

GetLimit

$result = $client->getLimit([/* ... */]);
$promise = $client->getLimitAsync([/* ... */]);

Gets information about a specific limit.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'amountRequirementName' => '<string>',
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'currentCount' => <integer>,
    'description' => '<string>',
    'displayName' => '<string>',
    'farmId' => '<string>',
    'limitId' => '<string>',
    'maxCount' => <integer>,
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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