Amazon Deadline Cloud Jobs API

Operations for managing rendering jobs

GitHub OpenAPI

Operations 4

POST /2023-10-12/farms/{farmId}/queues/{queueId}/jobs Create Job #
GET /2023-10-12/farms/{farmId}/queues/{queueId}/jobs List Jobs #
GET /2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId} Get Job #
PATCH /2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId} Update Job #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-deadline-cloud:amazon-deadline-cloud-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-deadline-cloud-jobs-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWSDeadlineCloud Jobs API
  version: '2023-10-12'
  description: Generated from AWS's published Smithy model for AWSDeadlineCloud. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://deadline.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2023-10-12/farms/{farmId}/queues/{queueId}/jobs:
    post:
      operationId: CreateJob
      summary: Create Job
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
      tags:
      - Jobs
    get:
      operationId: ListJobs
      summary: List Jobs
      description: Lists jobs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListJobsRequest'
      tags:
      - Jobs
  /2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}:
    get:
      operationId: GetJob
      summary: Get Job
      description: Gets a Deadline Cloud job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetJobRequest'
      tags:
      - Jobs
    patch:
      operationId: UpdateJob
      summary: Update Job
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobRequest'
      tags:
      - Jobs
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: deadline
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
    Attachments:
      type: object
      properties:
        manifests:
          type: array
          items:
            $ref: '#/components/schemas/ManifestProperties'
          description: The manifest properties for the attachments.
        fileSystem:
          type: string
          enum:
          - COPIED
          - VIRTUAL
          description: The file system location for the attachments.
      required:
      - manifests
    ConflictException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CONFLICT_EXCEPTION
          - CONCURRENT_MODIFICATION
          - RESOURCE_ALREADY_EXISTS
          - RESOURCE_IN_USE
          - STATUS_CONFLICT
          description: A description of the error.
        resourceId:
          type: string
          description: The identifier of the resource in use.
        resourceType:
          type: string
          description: The type of the resource in use.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - reason
      - resourceId
      - resourceType
    CreateJobRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to connect to the job.
        queueId:
          type: string
          description: The ID of the queue that the job is submitted to.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        template:
          type: string
          description: The job template to use for this job.
        templateType:
          type: string
          enum:
          - JSON
          - YAML
          description: The file type for the job template.
        priority:
          type: integer
          description: The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same
            priority, the oldest job is scheduled first.
        parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/JobParameter'
          description: The parameters for the job.
        attachments:
          $ref: '#/components/schemas/Attachments'
        storageProfileId:
          type: string
          description: The storage profile ID for the storage profile to connect to the job.
        targetTaskRunStatus:
          type: string
          enum:
          - READY
          - SUSPENDED
          description: The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run
            until manually requeued.
        maxFailedTasksCount:
          type: integer
          description: The number of task failures before the job stops running and is marked as FAILED.
        maxRetriesPerTask:
          type: integer
          description: The maximum number of retries for each task.
        maxWorkerCount:
          type: integer
          description: The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is
            reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has
            available workers. You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
            If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the
            job.
        sourceJobId:
          type: string
          description: The job ID for the source job.
        nameOverride:
          type: string
          description: A custom name to override the job name derived from the job template.
        descriptionOverride:
          type: string
          description: A custom description to override the job description derived from the job template.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to add to your job. 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.
      required:
      - farmId
      - queueId
      - priority
    CreateJobResponse:
      type: object
      properties:
        jobId:
          type: string
          description: The job ID.
      required:
      - jobId
    GetJobRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm in the job.
        queueId:
          type: string
          description: The queue ID associated with the job.
        jobId:
          type: string
          description: The job ID.
      required:
      - farmId
      - queueId
      - jobId
    GetJobResponse:
      type: object
      properties:
        jobId:
          type: string
          description: The job ID.
        name:
          type: string
          description: The name of the job.
        lifecycleStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_FAILED
          - CREATE_COMPLETE
          - UPLOAD_IN_PROGRESS
          - UPLOAD_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_SUCCEEDED
          - ARCHIVED
          description: The life cycle status for the job.
        lifecycleStatusMessage:
          type: string
          description: A message that communicates the status of the life cycle for the job.
        priority:
          type: integer
          description: The job priority.
        createdAt:
          type: string
          format: date-time
          description: The date and time the resource was created.
        createdBy:
          type: string
          description: The user or system that created this resource.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the resource was updated.
        updatedBy:
          type: string
          description: The user or system that updated this resource.
        startedAt:
          type: string
          format: date-time
          description: The date and time the resource started running.
        endedAt:
          type: string
          format: date-time
          description: The date and time the resource ended running.
        taskRunStatus:
          type: string
          enum:
          - PENDING
          - READY
          - ASSIGNED
          - STARTING
          - SCHEDULED
          - INTERRUPTING
          - RUNNING
          - SUSPENDED
          - CANCELED
          - FAILED
          - SUCCEEDED
          - NOT_COMPATIBLE
          description: The task run status for the job.
        targetTaskRunStatus:
          type: string
          enum:
          - READY
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUSPENDED
          - PENDING
          description: The task status with which the job started.
        taskRunStatusCounts:
          type: object
          additionalProperties:
            type: integer
          description: The number of tasks running on the job.
        taskFailureRetryCount:
          type: integer
          description: The total number of times tasks from the job failed and were retried.
        storageProfileId:
          type: string
          description: The storage profile ID associated with the job.
        maxFailedTasksCount:
          type: integer
          description: The number of task failures before the job stops running and is marked as FAILED.
        maxRetriesPerTask:
          type: integer
          description: The maximum number of retries per failed tasks.
        parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/JobParameter'
          description: The parameters for the job.
        attachments:
          $ref: '#/components/schemas/Attachments'
        description:
          type: string
          description: The description of the job. This field can store any content. Escape or encode this content before
            displaying it on a webpage or any other system that might interpret the content of this field.
        maxWorkerCount:
          type: integer
          description: The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is
            reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has
            available workers. If you don't set the maxWorkerCount when you create a job, this value is not returned in the
            response.
        sourceJobId:
          type: string
          description: The job ID for the source job.
      required:
      - jobId
      - name
      - lifecycleStatus
      - lifecycleStatusMessage
      - priority
      - createdAt
      - createdBy
    InternalServerErrorException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds a client should wait before retrying the request.
      required:
      - message
    JobParameter:
      type: object
      properties:
        int:
          type: string
          description: A signed integer represented as a string.
        float:
          type: string
          description: A double precision IEEE-754 floating point number represented as a string.
        string:
          type: string
          description: A UTF-8 string.
        path:
          type: string
          description: A file system path represented as a string.
        bool:
          type: string
          description: A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and
            0, case-insensitive.
        rangeExpr:
          type: string
          description: An Open Job Description range expression represented as a string, such as 1-10:2.
        stringList:
          type: array
          items:
            type: string
          description: A list of UTF-8 strings.
        pathList:
          type: array
          items:
            type: string
          description: A list of file system paths, each represented as a string.
        intList:
          type: array
          items:
            type: string
          description: A list of signed integers, each represented as a string.
        floatList:
          type: array
          items:
            type: string
          description: A list of double precision IEEE-754 floating point numbers, each represented as a string.
        boolList:
          type: array
          items:
            type: string
          description: A list of boolean values, each represented as a string.
        intListList:
          type: array
          items:
            type: array
            items:
              type: string
          description: A list of lists of signed integers, each represented as a string.
      description: Exactly one member is set.
    JobSummary:
      type: object
      properties:
        jobId:
          type: string
          description: The job ID.
        name:
          type: string
          description: The job name.
        lifecycleStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_FAILED
          - CREATE_COMPLETE
          - UPLOAD_IN_PROGRESS
          - UPLOAD_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_SUCCEEDED
          - ARCHIVED
          description: The life cycle status.
        lifecycleStatusMessage:
          type: string
          description: The life cycle status message.
        priority:
          type: integer
          description: The job priority.
        createdAt:
          type: string
          format: date-time
          description: The date and time the resource was created.
        createdBy:
          type: string
          description: The user or system that created this resource.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the resource was updated.
        updatedBy:
          type: string
          description: The user or system that updated this resource.
        startedAt:
          type: string
          format: date-time
          description: The date and time the resource started running.
        endedAt:
          type: string
          format: date-time
          description: The date and time the resource ended running.
        taskRunStatus:
          type: string
          enum:
          - PENDING
          - READY
          - ASSIGNED
          - STARTING
          - SCHEDULED
          - INTERRUPTING
          - RUNNING
          - SUSPENDED
          - CANCELED
          - FAILED
          - SUCCEEDED
          - NOT_COMPATIBLE
          description: 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.
        targetTaskRunStatus:
          type: string
          enum:
          - READY
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUSPENDED
          - PENDING
          description: The task status to update the job's tasks to.
        taskRunStatusCounts:
          type: object
          additionalProperties:
            type: integer
          description: The number of tasks running on the job.
        taskFailureRetryCount:
          type: integer
          description: The total number of times tasks from the job failed and were retried.
        maxFailedTasksCount:
          type: integer
          description: The number of task failures before the job stops running and is marked as FAILED.
        maxRetriesPerTask:
          type: integer
          description: The maximum number of retries for a job.
        maxWorkerCount:
          type: integer
          description: The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is
            reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has
            available workers. You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
            If you don't specify the maxWorkerCount, the default is -1.
        sourceJobId:
          type: string
          description: The job ID for the source job.
      required:
      - jobId
      - name
      - lifecycleStatus
      - lifecycleStatusMessage
      - priority
      - createdAt
      - createdBy
    ListJobsRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the jobs.
        queueId:
          type: string
          description: The queue ID for the job.
        nextToken:
          type: string
          description: The token for the next set of results, or null to start from the beginning.
        maxResults:
          type: integer
          description: The maximum number of results to return. Use this parameter with NextToken to get results as a set
            of sequential pages.
        principalId:
          type: string
          description: The principal ID of the members on the jobs.
      required:
      - farmId
      - queueId
    ListJobsResponse:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
          description: The jobs on the list.
        nextToken:
          type: string
          description: 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.
      required:
      - jobs
    ManifestProperties:
      type: object
      properties:
        fileSystemLocationName:
          type: string
          description: The file system location name.
        rootPath:
          type: string
          description: The file's root path.
        rootPathFormat:
          type: string
          enum:
          - windows
          - posix
          description: The format of the root path.
        outputRelativeDirectories:
          type: array
          items:
            type: string
          description: The file path relative to the directory.
        inputManifestPath:
          type: string
          description: The file path.
        inputManifestHash:
          type: string
          description: The hash value of the file.
      required:
      - rootPath
      - rootPathFormat
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The identifier of the resource that couldn't be found.
        resourceType:
          type: string
          description: The type of the resource that couldn't be found.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - resourceId
      - resourceType
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - SERVICE_QUOTA_EXCEEDED_EXCEPTION
          - KMS_KEY_LIMIT_EXCEEDED
          - DEPENDENCY_LIMIT_EXCEEDED
          description: A string that describes the reason the quota was exceeded.
        resourceType:
          type: string
          description: The type of the affected resource
        serviceCode:
          type: string
          description: Identifies the service that exceeded the quota.
        quotaCode:
          type: string
          description: Identifies the quota that has been exceeded.
        resourceId:
          type: string
          description: The identifier of the affected resource.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - reason
      - resourceType
      - serviceCode
      - quotaCode
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: Identifies the service that is being throttled.
        quotaCode:
          type: string
          description: Identifies the quota that is being throttled.
        retryAfterSeconds:
          type: integer
          description: The number of seconds a client should wait before retrying the request.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
    UpdateJobRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the job to update.
        queueId:
          type: string
          description: The queue ID of the job to update.
        jobId:
          type: string
          description: The job ID to update.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        targetTaskRunStatus:
          type: string
          enum:
          - READY
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUSPENDED
          - PENDING
          description: The task status to update the job's tasks to.
        priority:
          type: integer
          description: The updated job priority.
        maxFailedTasksCount:
          type: integer
          description: The number of task failures before the job stops running and is marked as FAILED.
        maxRetriesPerTask:
          type: integer
          description: The maximum number of retries for a job.
        lifecycleStatus:
          type: string
          enum:
          - ARCHIVED
          description: 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.
        maxWorkerCount:
          type: integer
          description: The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is
            reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has
            available workers. You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
            If you don't specify the maxWorkerCount, the default is -1. The maximum number of workers that can process tasks
            in the job.
        name:
          type: string
          description: The updated job name.
        description:
          type: string
          description: The updated job description.
      required:
      - farmId
      - queueId
      - jobId
    UpdateJobResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
          description: The reason that the request failed validation.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: A list of fields that failed validation.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - reason
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the validation exception.
        message:
          type: string
          description: The error message for the validation exception.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/deadline/service/2023-10-12/deadline-2023-10-12.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)