Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CopyJobTemplate

Copies a job template to an Amazon S3 bucket.

Request Syntax


POST /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/template HTTP/1.1
Content-type: application/json

{
   "targetS3Location": { 
      "bucketName": "string",
      "key": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID to copy.

Pattern: farm-[0-9a-f]{32}

Required: Yes

jobId

The job ID to copy.

Pattern: job-[0-9a-f]{32}

Required: Yes

queueId

The queue ID to copy.

Pattern: queue-[0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

targetS3Location

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

Type: S3Location object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "templateType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

templateType

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

Type: String

Valid Values: JSON | YAML

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

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

HTTP Status Code: 403

InternalServerErrorException

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

retryAfterSeconds: The number of seconds a client should wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

context: Information about the resources in use when the exception was thrown.
resourceId: The identifier of the resource that couldn't be found.
resourceType: The type of the resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

context: Information about the resources in use when the exception was thrown.
quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service that is being throttled.

HTTP Status Code: 429

ValidationException

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

context: Information about the resources in use when the exception was thrown.
fieldList: A list of fields that failed validation.
reason: The reason that the request failed validation.

HTTP Status Code: 400