Amazon Deadline Cloud Deadline Cloud Storage Profiles API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Storage Profiles API
  version: '2023-10-12'
  description: Generated from AWS's published Smithy model for AWSDeadlineCloud. 7 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}/storage-profiles:
    post:
      operationId: CreateStorageProfile
      summary: Create Storage Profile
      description: Creates a storage profile that specifies the operating system, file type, and file location of resources
        used on a farm.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateStorageProfileResponse'
        '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/CreateStorageProfileRequest'
      tags:
      - Storage Profiles
    get:
      operationId: ListStorageProfiles
      summary: List Storage Profiles
      description: Lists storage profiles.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStorageProfilesResponse'
        '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/ListStorageProfilesRequest'
      tags:
      - Storage Profiles
  /2023-10-12/farms/{farmId}/storage-profiles/{storageProfileId}:
    delete:
      operationId: DeleteStorageProfile
      summary: Delete Storage Profile
      description: Deletes a storage profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteStorageProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '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/DeleteStorageProfileRequest'
      tags:
      - Storage Profiles
    get:
      operationId: GetStorageProfile
      summary: Get Storage Profile
      description: Gets a storage profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStorageProfileResponse'
        '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/GetStorageProfileRequest'
      tags:
      - Storage Profiles
    patch:
      operationId: UpdateStorageProfile
      summary: Update Storage Profile
      description: Updates a storage profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateStorageProfileResponse'
        '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/UpdateStorageProfileRequest'
      tags:
      - Storage Profiles
  /2023-10-12/farms/{farmId}/queues/{queueId}/storage-profiles/{storageProfileId}:
    get:
      operationId: GetStorageProfileForQueue
      summary: Get Storage Profile For Queue
      description: Gets a storage profile for a queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStorageProfileForQueueResponse'
        '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/GetStorageProfileForQueueRequest'
      tags:
      - Storage Profiles
  /2023-10-12/farms/{farmId}/queues/{queueId}/storage-profiles:
    get:
      operationId: ListStorageProfilesForQueue
      summary: List Storage Profiles For Queue
      description: Lists storage profiles for a queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStorageProfilesForQueueResponse'
        '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/ListStorageProfilesForQueueRequest'
      tags:
      - Storage Profiles
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
    CreateStorageProfileRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to connect to the storage profile.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        displayName:
          type: string
          description: The display name of the storage profile. 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.
        osFamily:
          type: string
          enum:
          - WINDOWS
          - LINUX
          - MACOS
          description: The type of operating system (OS) for the storage profile.
        fileSystemLocations:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemLocation'
          description: File system paths to include in the storage profile.
      required:
      - farmId
      - displayName
      - osFamily
    CreateStorageProfileResponse:
      type: object
      properties:
        storageProfileId:
          type: string
          description: The storage profile ID.
      required:
      - storageProfileId
    DeleteStorageProfileRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm from which to remove the storage profile.
        storageProfileId:
          type: string
          description: The storage profile ID of the storage profile to delete.
      required:
      - farmId
      - storageProfileId
    DeleteStorageProfileResponse:
      type: object
      properties: {}
    FileSystemLocation:
      type: object
      properties:
        name:
          type: string
          description: The location name.
        path:
          type: string
          description: The file path.
        type:
          type: string
          enum:
          - SHARED
          - LOCAL
          description: The type of file.
      required:
      - name
      - path
      - type
    GetStorageProfileForQueueRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the queue in storage profile.
        queueId:
          type: string
          description: The queue ID the queue in the storage profile.
        storageProfileId:
          type: string
          description: The storage profile ID for the storage profile in the queue.
      required:
      - farmId
      - queueId
      - storageProfileId
    GetStorageProfileForQueueResponse:
      type: object
      properties:
        storageProfileId:
          type: string
          description: The storage profile ID.
        displayName:
          type: string
          description: The display name of the storage profile connected to a queue. 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.
        osFamily:
          type: string
          enum:
          - WINDOWS
          - LINUX
          - MACOS
          description: The operating system of the storage profile in the queue.
        fileSystemLocations:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemLocation'
          description: The location of the files for the storage profile within the queue.
      required:
      - storageProfileId
      - displayName
      - osFamily
    GetStorageProfileRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the storage profile.
        storageProfileId:
          type: string
          description: The storage profile ID.
      required:
      - farmId
      - storageProfileId
    GetStorageProfileResponse:
      type: object
      properties:
        storageProfileId:
          type: string
          description: The storage profile ID.
        displayName:
          type: string
          description: The display name of the storage profile. 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.
        osFamily:
          type: string
          enum:
          - WINDOWS
          - LINUX
          - MACOS
          description: The operating system (OS) for the storage profile.
        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.
        fileSystemLocations:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemLocation'
          description: The location of the files for the storage profile.
      required:
      - storageProfileId
      - displayName
      - osFamily
      - 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
    ListStorageProfilesForQueueRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the queue's storage profile.
        queueId:
          type: string
          description: The queue ID for the storage profile.
        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
    ListStorageProfilesForQueueResponse:
      type: object
      properties:
        storageProfiles:
          type: array
          items:
            $ref: '#/components/schemas/StorageProfileSummary'
          description: The storage profiles in the queue.
        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:
      - storageProfiles
    ListStorageProfilesRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the storage profile.
        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
    ListStorageProfilesResponse:
      type: object
      properties:
        storageProfiles:
          type: array
          items:
            $ref: '#/components/schemas/StorageProfileSummary'
          description: The storage profiles.
        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:
      - storageProfiles
    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
    StorageProfileSummary:
      type: object
      properties:
        storageProfileId:
          type: string
          description: The storage profile ID.
        displayName:
          type: string
          description: The display name of the storage profile summary to update. 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.
        osFamily:
          type: string
          enum:
          - WINDOWS
          - LINUX
          - MACOS
          description: The operating system (OS) family.
      required:
      - storageProfileId
      - displayName
      - osFamily
    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
    UpdateStorageProfileRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to update.
        storageProfileId:
          type: string
          description: The storage profile ID to update.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        displayName:
          type: string
          description: The display name of the storage profile to update. 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.
        osFamily:
          type: string
          enum:
          - WINDOWS
          - LINUX
          - MACOS
          description: The OS system to update.
        fileSystemLocationsToAdd:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemLocation'
          description: The file system location names to add.
        fileSystemLocationsToRemove:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemLocation'
          description: The file system location names to remove.
      required:
      - farmId
      - storageProfileId
    UpdateStorageProfileResponse:
      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)