Amazon Connect Connect Workspaces API

openapi: 3.1.0
info:
  title: Amazon Connect Service Workspaces API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 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://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /workspaces/{InstanceId}:
    put:
      operationId: CreateWorkspace
      summary: Create Workspace
      description: Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned
        to users or routing profiles.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '429':
          description: LimitExceededException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceRequest'
      tags:
      - Workspaces
    get:
      operationId: ListWorkspaces
      summary: List Workspaces
      description: Lists the workspaces in an Amazon Connect instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspacesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListWorkspacesRequest'
      tags:
      - Workspaces
  /workspaces/{InstanceId}/{WorkspaceId}:
    delete:
      operationId: DeleteWorkspace
      summary: Delete Workspace
      description: Deletes a workspace and removes all associated view and resource assignments.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteWorkspaceRequest'
      tags:
      - Workspaces
    get:
      operationId: DescribeWorkspace
      summary: Describe Workspace
      description: Retrieves details about a workspace, including its configuration and metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeWorkspaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeWorkspaceRequest'
      tags:
      - Workspaces
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: connect
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CreateWorkspaceRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        Name:
          type: string
          description: The name of the workspace. Must be unique within the instance and can contain 1-127 characters.
        Description:
          type: string
          description: The description of the workspace. Maximum length is 250 characters.
        Theme:
          $ref: '#/components/schemas/WorkspaceTheme'
        Title:
          type: string
          description: The title displayed for the workspace.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
      required:
      - InstanceId
      - Name
    CreateWorkspaceResponse:
      type: object
      properties:
        WorkspaceId:
          type: string
          description: The identifier of the workspace.
        WorkspaceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the workspace.
      required:
      - WorkspaceId
      - WorkspaceArn
    DeleteWorkspaceRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        WorkspaceId:
          type: string
          description: The identifier of the workspace.
      required:
      - InstanceId
      - WorkspaceId
    DeleteWorkspaceResponse:
      type: object
      properties: {}
    DescribeWorkspaceRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        WorkspaceId:
          type: string
          description: The identifier of the workspace.
      required:
      - InstanceId
      - WorkspaceId
    DescribeWorkspaceResponse:
      type: object
      properties:
        Workspace:
          $ref: '#/components/schemas/Workspace'
      required:
      - Workspace
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    FontFamily:
      type: object
      properties:
        Default:
          type: string
          enum:
          - Arial
          - Courier New
          - Georgia
          - Times New Roman
          - Trebuchet
          - Verdana
          description: The default font family to use in the workspace theme.
    ImagesLogo:
      type: object
      properties:
        Default:
          type: string
          description: The default logo image displayed in the workspace.
        Favicon:
          type: string
          description: The favicon image displayed in the browser tab.
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the limit.
    ListWorkspacesRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        NextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response in the next
            request to retrieve the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page.
      required:
      - InstanceId
    ListWorkspacesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
        WorkspaceSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceSummary'
          description: A summary list of workspaces.
      required:
      - WorkspaceSummaryList
    PaletteCanvas:
      type: object
      properties:
        ContainerBackground:
          type: string
          description: The background color for container elements.
        PageBackground:
          type: string
          description: The background color for page elements.
        ActiveBackground:
          type: string
          description: The background color for active elements.
    PaletteHeader:
      type: object
      properties:
        Background:
          type: string
          description: The background color of the header.
        Text:
          type: string
          description: The text color in the header.
        TextHover:
          type: string
          description: The text color when hovering over header elements.
        InvertActionsColors:
          type: boolean
          description: Whether to invert the colors of action buttons in the header.
    PaletteNavigation:
      type: object
      properties:
        Background:
          type: string
          description: The background color of the navigation area.
        TextBackgroundHover:
          type: string
          description: The background color when hovering over navigation text.
        TextBackgroundActive:
          type: string
          description: The background color for active navigation items.
        Text:
          type: string
          description: The text color in the navigation area.
        TextHover:
          type: string
          description: The text color when hovering over navigation items.
        TextActive:
          type: string
          description: The text color for active navigation items.
        InvertActionsColors:
          type: boolean
          description: Whether to invert the colors of action buttons in the navigation area.
    PalettePrimary:
      type: object
      properties:
        Default:
          type: string
          description: The default primary color used throughout the workspace.
        Active:
          type: string
          description: The primary color used for active states.
        ContrastText:
          type: string
          description: The text color that contrasts with the primary color for readability.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          $ref: '#/components/schemas/ServiceQuotaExceededExceptionReason'
    ServiceQuotaExceededExceptionReason:
      type: object
      properties:
        AttachedFileServiceQuotaExceededExceptionReason:
          type: string
          enum:
          - TOTAL_FILE_SIZE_EXCEEDED
          - TOTAL_FILE_COUNT_EXCEEDED
          description: Total file size of all files or total number of files exceeds the service quota
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    Workspace:
      type: object
      properties:
        Visibility:
          type: string
          enum:
          - ALL
          - ASSIGNED
          - NONE
          description: 'Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned
            users and routing profiles), and NONE (not visible).'
        Id:
          type: string
          description: The unique identifier of the workspace.
        Name:
          type: string
          description: The name of the workspace.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the workspace.
        Description:
          type: string
          description: The description of the workspace.
        Theme:
          $ref: '#/components/schemas/WorkspaceTheme'
        Title:
          type: string
          description: The title displayed for the workspace.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when the workspace was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where the workspace was last modified.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for the workspace.
      required:
      - Id
      - Name
      - Arn
      - LastModifiedTime
    WorkspaceSummary:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the workspace.
        Name:
          type: string
          description: The name of the workspace.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the workspace.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when the workspace was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where the workspace was last modified.
    WorkspaceTheme:
      type: object
      properties:
        Light:
          $ref: '#/components/schemas/WorkspaceThemeConfig'
        Dark:
          $ref: '#/components/schemas/WorkspaceThemeConfig'
    WorkspaceThemeConfig:
      type: object
      properties:
        Palette:
          $ref: '#/components/schemas/WorkspaceThemePalette'
        Images:
          $ref: '#/components/schemas/WorkspaceThemeImages'
        Typography:
          $ref: '#/components/schemas/WorkspaceThemeTypography'
    WorkspaceThemeImages:
      type: object
      properties:
        Logo:
          $ref: '#/components/schemas/ImagesLogo'
    WorkspaceThemePalette:
      type: object
      properties:
        Header:
          $ref: '#/components/schemas/PaletteHeader'
        Navigation:
          $ref: '#/components/schemas/PaletteNavigation'
        Canvas:
          $ref: '#/components/schemas/PaletteCanvas'
        Primary:
          $ref: '#/components/schemas/PalettePrimary'
    WorkspaceThemeTypography:
      type: object
      properties:
        FontFamily:
          $ref: '#/components/schemas/FontFamily'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)