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

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-pages-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

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

Get an API key

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

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Connect Service Pages 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}/{WorkspaceId}/pages:
    put:
      operationId: CreateWorkspacePage
      summary: Create Workspace Page
      description: Associates a view with a page in a workspace, defining what users see when they navigate to that page.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspacePageResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException; ResourceConflictException
          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/CreateWorkspacePageRequest'
      tags:
      - Pages
    get:
      operationId: ListWorkspacePages
      summary: List Workspace Pages
      description: Lists the page configurations in a workspace, including the views assigned to each page.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspacePagesResponse'
        '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/ListWorkspacePagesRequest'
      tags:
      - Pages
  /workspaces/{InstanceId}/{WorkspaceId}/pages/{Page}:
    delete:
      operationId: DeleteWorkspacePage
      summary: Delete Workspace Page
      description: Removes the association between a view and a page in a workspace. The page will display the default view
        after deletion.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspacePageResponse'
        '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'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '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/DeleteWorkspacePageRequest'
      tags:
      - Pages
    post:
      operationId: UpdateWorkspacePage
      summary: Update Workspace Page
      description: Updates the configuration of a page in a workspace, including the associated view and input data.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspacePageResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException; ResourceConflictException
          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'
        '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/UpdateWorkspacePageRequest'
      tags:
      - Pages
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
    CreateWorkspacePageRequest:
      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.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the view to associate with the page.
        Page:
          type: string
          description: 'The page identifier. Valid system pages include HOME and AGENT_EXPERIENCE. Custom pages cannot use
            the aws: or connect: prefixes.'
        Slug:
          type: string
          description: The URL-friendly identifier for the page.
        InputData:
          type: string
          description: A JSON string containing input parameters for the view, validated against the view's input schema.
      required:
      - InstanceId
      - WorkspaceId
      - ResourceArn
      - Page
    CreateWorkspacePageResponse:
      type: object
      properties: {}
    DeleteWorkspacePageRequest:
      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.
        Page:
          type: string
          description: The page identifier.
      required:
      - InstanceId
      - WorkspaceId
      - Page
    DeleteWorkspacePageResponse:
      type: object
      properties: {}
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    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.
    ListWorkspacePagesRequest:
      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.
        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
      - WorkspaceId
    ListWorkspacePagesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
        WorkspacePageList:
          type: array
          items:
            $ref: '#/components/schemas/WorkspacePage'
          description: A list of page configurations in the workspace.
      required:
      - WorkspacePageList
    ResourceConflictException:
      type: object
      properties:
        Message:
          type: string
    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
    UpdateWorkspacePageRequest:
      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.
        Page:
          type: string
          description: The current page identifier.
        NewPage:
          type: string
          description: The new page identifier, if changing the page name.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the view to associate with the page.
        Slug:
          type: string
          description: The URL-friendly identifier for the page.
        InputData:
          type: string
          description: A JSON string containing input parameters for the view.
      required:
      - InstanceId
      - WorkspaceId
      - Page
    UpdateWorkspacePageResponse:
      type: object
      properties: {}
    WorkspacePage:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the view associated with this page.
        Page:
          type: string
          description: The page identifier. System pages include HOME and AGENT_EXPERIENCE.
        Slug:
          type: string
          description: The URL-friendly identifier for the page.
        InputData:
          type: string
          description: A JSON string containing input parameters passed to the view when the page is rendered.
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)