Amazon Deadline Cloud Deadline Cloud Steps API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Steps API
  version: '2023-10-12'
  description: Generated from AWS's published Smithy model for AWSDeadlineCloud. 3 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/{jobId}/steps/{stepId}:
    get:
      operationId: GetStep
      summary: Get Step
      description: Gets a step.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStepResponse'
        '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/GetStepRequest'
      tags:
      - Steps
    patch:
      operationId: UpdateStep
      summary: Update Step
      description: Updates a step.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateStepResponse'
        '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/UpdateStepRequest'
      tags:
      - Steps
  /2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps:
    get:
      operationId: ListSteps
      summary: List Steps
      description: Lists steps for a job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStepsResponse'
        '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/ListStepsRequest'
      tags:
      - Steps
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
    DependencyCounts:
      type: object
      properties:
        dependenciesResolved:
          type: integer
          description: The number of resolved dependencies.
        dependenciesUnresolved:
          type: integer
          description: The number of unresolved dependencies.
        consumersResolved:
          type: integer
          description: The number of consumers resolved.
        consumersUnresolved:
          type: integer
          description: The number of unresolved consumers.
      required:
      - dependenciesResolved
      - dependenciesUnresolved
      - consumersResolved
      - consumersUnresolved
    GetStepRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the step.
        queueId:
          type: string
          description: The queue ID for the step.
        jobId:
          type: string
          description: The job ID for the step.
        stepId:
          type: string
          description: The step ID.
      required:
      - farmId
      - queueId
      - jobId
      - stepId
    GetStepResponse:
      type: object
      properties:
        stepId:
          type: string
          description: The step ID.
        name:
          type: string
          description: The name of the step.
        lifecycleStatus:
          type: string
          enum:
          - CREATE_COMPLETE
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_SUCCEEDED
          description: The life cycle status of the step.
        lifecycleStatusMessage:
          type: string
          description: A message that describes the lifecycle status of the step.
        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.
        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 step failed and were retried.
        targetTaskRunStatus:
          type: string
          enum:
          - READY
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUSPENDED
          - PENDING
          description: The task status with which the job started.
        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.
        dependencyCounts:
          $ref: '#/components/schemas/DependencyCounts'
        requiredCapabilities:
          $ref: '#/components/schemas/StepRequiredCapabilities'
        parameterSpace:
          $ref: '#/components/schemas/ParameterSpace'
        description:
          type: string
          description: The description of the step. This field can store any content. Escape or encode this content before
            displaying it on a webpage or any other system that might interpret the content of this field.
      required:
      - stepId
      - name
      - lifecycleStatus
      - taskRunStatus
      - taskRunStatusCounts
      - 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
    ListStepsRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to include on the list of steps.
        queueId:
          type: string
          description: The queue ID to include on the list of steps.
        jobId:
          type: string
          description: The job ID to include on the list of steps.
        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
      - queueId
      - jobId
    ListStepsResponse:
      type: object
      properties:
        steps:
          type: array
          items:
            $ref: '#/components/schemas/StepSummary'
          description: The steps 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:
      - steps
    ParameterSpace:
      type: object
      properties:
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/StepParameter'
          description: The parameters to search for.
        combination:
          type: string
          description: The combination expression to use in the search.
      required:
      - parameters
    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
    StepAmountCapability:
      type: object
      properties:
        name:
          type: string
          description: The name of the step.
        min:
          type: number
          description: The minimum amount.
        max:
          type: number
          description: The maximum amount.
        value:
          type: number
          description: The amount value.
      required:
      - name
    StepAttributeCapability:
      type: object
      properties:
        name:
          type: string
          description: The name of the step attribute.
        anyOf:
          type: array
          items:
            type: string
          description: Requires any of the step attributes in a given list.
        allOf:
          type: array
          items:
            type: string
          description: Requires all of the step attribute values.
      required:
      - name
    StepParameter:
      type: object
      properties:
        name:
          type: string
          description: The name of the parameter.
        type:
          type: string
          enum:
          - INT
          - FLOAT
          - STRING
          - PATH
          - CHUNK_INT
          description: The data type of the parameter.
        chunks:
          $ref: '#/components/schemas/StepParameterChunks'
      required:
      - name
      - type
    StepParameterChunks:
      type: object
      properties:
        defaultTaskCount:
          type: integer
          description: The number of tasks to combine into a single chunk by default.
        targetRuntimeSeconds:
          type: integer
          description: The number of seconds to aim for when forming chunks.
        rangeConstraint:
          type: string
          enum:
          - CONTIGUOUS
          - NONCONTIGUOUS
          description: Specifies whether the chunked ranges must be contiguous or can have gaps between them.
      required:
      - defaultTaskCount
      - rangeConstraint
    StepRequiredCapabilities:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/StepAttributeCapability'
          description: The capability attributes that the step requires.
        amounts:
          type: array
          items:
            $ref: '#/components/schemas/StepAmountCapability'
          description: The capability amounts that the step requires.
      required:
      - attributes
      - amounts
    StepSummary:
      type: object
      properties:
        stepId:
          type: string
          description: The step ID.
        name:
          type: string
          description: The name of the step.
        lifecycleStatus:
          type: string
          enum:
          - CREATE_COMPLETE
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_SUCCEEDED
          description: The life cycle status.
        lifecycleStatusMessage:
          type: string
          description: A message that describes the lifecycle of the step.
        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 process.
            ASSIGNED–assigned and will run next on a worker. SCHEDULED–scheduled to run on a worker. INTERRUPTING–being interrupted.
            RUNNING–running on a worker. SUSPENDED–the task is suspended. CANCELED–the task has been canceled. FAILED–the
            task has failed. SUCCEEDED–the task has succeeded.
        taskRunStatusCounts:
          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 step failed and were retried.
        targetTaskRunStatus:
          type: string
          enum:
          - READY
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUSPENDED
          - PENDING
          description: The task status to update the job's tasks to.
        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.
        dependencyCounts:
          $ref: '#/components/schemas/DependencyCounts'
      required:
      - stepId
      - name
      - lifecycleStatus
      - taskRunStatus
      - taskRunStatusCounts
      - createdAt
      - createdBy
    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
    UpdateStepRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to update.
        queueId:
          type: string
          description: The queue ID to update.
        jobId:
          type: string
          description: The job ID to update.
        stepId:
          type: string
          description: The step 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 step's tasks to.
      required:
      - farmId
      - queueId
      - jobId
      - stepId
      - targetTaskRunStatus
    UpdateStepResponse:
      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/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)