Amazon Deadline Cloud Workers API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Workers API
  version: '2023-10-12'
  description: Generated from AWS's published Smithy model for AWSDeadlineCloud. 5 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}/fleets/{fleetId}/workers:
    post:
      operationId: CreateWorker
      summary: Create Worker
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkerResponse'
        '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/CreateWorkerRequest'
      tags:
      - Workers
    get:
      operationId: ListWorkers
      summary: List Workers
      description: Lists workers.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkersResponse'
        '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/ListWorkersRequest'
      tags:
      - Workers
  /2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}:
    get:
      operationId: GetWorker
      summary: Get Worker
      description: Gets a worker.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkerResponse'
        '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/GetWorkerRequest'
      tags:
      - Workers
    patch:
      operationId: UpdateWorker
      summary: Update Worker
      description: Updates a worker.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkerResponse'
        '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/UpdateWorkerRequest'
      tags:
      - Workers
    delete:
      operationId: DeleteWorker
      summary: Delete Worker
      description: Deletes a worker.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkerResponse'
        '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/DeleteWorkerRequest'
      tags:
      - Workers
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
    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
    CreateWorkerRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to connect to the worker.
        fleetId:
          type: string
          description: The fleet ID to connect to the worker.
        hostProperties:
          $ref: '#/components/schemas/HostPropertiesRequest'
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        tags:
          type: object
          additionalProperties:
            type: string
          description: 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
      - fleetId
    CreateWorkerResponse:
      type: object
      properties:
        workerId:
          type: string
          description: The worker ID.
      required:
      - workerId
    DeleteWorkerRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the worker to delete.
        fleetId:
          type: string
          description: The fleet ID of the worker to delete.
        workerId:
          type: string
          description: The worker ID of the worker to delete.
      required:
      - farmId
      - fleetId
      - workerId
    DeleteWorkerResponse:
      type: object
      properties: {}
    GetWorkerRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the worker.
        fleetId:
          type: string
          description: The fleet ID of the worker.
        workerId:
          type: string
          description: The worker ID.
      required:
      - farmId
      - fleetId
      - workerId
    GetWorkerResponse:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID.
        fleetId:
          type: string
          description: The fleet ID.
        workerId:
          type: string
          description: The worker ID.
        hostProperties:
          $ref: '#/components/schemas/HostPropertiesResponse'
        status:
          type: string
          enum:
          - CREATED
          - STARTED
          - STOPPING
          - STOPPED
          - NOT_RESPONDING
          - NOT_COMPATIBLE
          - RUNNING
          - IDLE
          description: The status of the worker.
        log:
          $ref: '#/components/schemas/LogConfiguration'
        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.
      required:
      - farmId
      - fleetId
      - workerId
      - status
      - createdAt
      - createdBy
    HostConfiguration:
      type: object
      properties:
        scriptBody:
          type: string
          description: The text of the script that runs as a worker is starting up that you can use to provide additional
            configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the
            worker processes tasks. For more information about using the script, see Run scripts as an administrator to configure
            workers in the Deadline Cloud Developer Guide. The script runs as an administrative user (sudo root on Linux,
            as an Administrator on Windows).
        scriptTimeoutSeconds:
          type: integer
          description: The maximum time that the host configuration can run. If the timeout expires, the worker enters the
            NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration
            script. You should configure your fleet for a maximum of one worker while testing your host configuration script
            to avoid starting additional workers. The default is 300 seconds (5 minutes).
      required:
      - scriptBody
    HostPropertiesRequest:
      type: object
      properties:
        ipAddresses:
          $ref: '#/components/schemas/IpAddresses'
        hostName:
          type: string
          description: The host name.
    HostPropertiesResponse:
      type: object
      properties:
        ipAddresses:
          $ref: '#/components/schemas/IpAddresses'
        hostName:
          type: string
          description: The host name.
        ec2InstanceArn:
          type: string
          description: The ARN of the host EC2 instance.
        ec2InstanceType:
          type: string
          description: The instance type of the host EC2 instance.
    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
    IpAddresses:
      type: object
      properties:
        ipV4Addresses:
          type: array
          items:
            type: string
          description: The IpV4 address of the network.
        ipV6Addresses:
          type: array
          items:
            type: string
          description: The IpV6 address for the network and node component.
    ListWorkersRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID connected to the workers.
        fleetId:
          type: string
          description: The fleet ID of the workers.
        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.
      required:
      - farmId
      - fleetId
    ListWorkersResponse:
      type: object
      properties:
        workers:
          type: array
          items:
            $ref: '#/components/schemas/WorkerSummary'
          description: The workers 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:
      - workers
    LogConfiguration:
      type: object
      properties:
        logDriver:
          type: string
          description: The log drivers for worker related logs.
        options:
          type: object
          additionalProperties:
            type: string
          description: The options for a log driver.
        parameters:
          type: object
          additionalProperties:
            type: string
          description: The parameters for the log configuration.
        error:
          type: string
          description: The log configuration error details.
      required:
      - logDriver
    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
    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
    UpdateWorkerRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to update.
        fleetId:
          type: string
          description: The fleet ID to update.
        workerId:
          type: string
          description: The worker ID to update.
        status:
          type: string
          enum:
          - STARTED
          - STOPPING
          - STOPPED
          description: The worker status to update.
        capabilities:
          $ref: '#/components/schemas/WorkerCapabilities'
        hostProperties:
          $ref: '#/components/schemas/HostPropertiesRequest'
      required:
      - farmId
      - fleetId
      - workerId
    UpdateWorkerResponse:
      type: object
      properties:
        log:
          $ref: '#/components/schemas/LogConfiguration'
        hostConfiguration:
          $ref: '#/components/schemas/HostConfiguration'
    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
    WorkerAmountCapability:
      type: object
      properties:
        name:
          type: string
          description: The name of the worker amount capability.
        value:
          type: number
          description: The value of the worker amount capability.
      required:
      - name
      - value
    WorkerAttributeCapability:
      type: object
      properties:
        name:
          type: string
          description: The name of the worker attribute capability.
        values:
          type: array
          items:
            type: string
          description: The values of the worker amount capability.
      required:
      - name
      - values
    WorkerCapabilities:
      type: object
      properties:
        amounts:
          type: array
          items:
            $ref: '#/components/schemas/WorkerAmountCapability'
          description: The worker capabilities amounts on a list of worker capabilities.
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/WorkerAttributeCapability'
          description: The worker attribute capabilities in the list of attribute capabilities.
      required:
      - amounts
      - attributes
    WorkerSummary:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID.
        fleetId:
          type: string
          description: The fleet ID.
        workerId:
          type: string
          description: The worker ID.
        hostProperties:
          $ref: '#/components/schemas/HostPropertiesResponse'
        status:
          type: string
          enum:
          - CREATED
          - STARTED
          - STOPPING
          - STOPPED
          - NOT_RESPONDING
          - NOT_COMPATIBLE
          - RUNNING
          - IDLE
          description: The status of the worker.
        log:
          $ref: '#/components/schemas/LogConfiguration'
        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.
      required:
      - farmId
      - fleetId
      - workerId
      - status
      - createdAt
      - createdBy
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/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)