Amazon Connect

Amazon Connect Connect Metadata API

The Connect Metadata API from Amazon Connect — 6 operation(s) for connect metadata.

GitHub OpenAPI

Operations 6

POST /contact-flows/{InstanceId}/{ContactFlowId}/metadata Update Contact Flow Metadata #
POST /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata Update Contact Flow Module Metadata #
POST /metrics/definitions/{InstanceId}/{MetricId}/metadata Update Metric Metadata #
PUT /phone-number/{PhoneNumberId}/metadata Update Phone Number Metadata #
POST /views/{InstanceId}/{ViewId}/metadata Update View Metadata #
POST /workspaces/{InstanceId}/{WorkspaceId}/metadata Update Workspace Metadata #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-connect/openapi/amazon-connect-metadata-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-metadata-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

amazon-connect-metadata-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon Connect Service Metadata API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 6 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:
  /contact-flows/{InstanceId}/{ContactFlowId}/metadata:
    post:
      operationId: UpdateContactFlowMetadata
      summary: Update Contact Flow Metadata
      description: Updates metadata about specified flow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactFlowMetadataResponse'
        '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'
        '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/UpdateContactFlowMetadataRequest'
      tags:
      - Metadata
  /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata:
    post:
      operationId: UpdateContactFlowModuleMetadata
      summary: Update Contact Flow Module Metadata
      description: Updates metadata about specified flow module.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactFlowModuleMetadataResponse'
        '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'
        '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/UpdateContactFlowModuleMetadataRequest'
      tags:
      - Metadata
  /metrics/definitions/{InstanceId}/{MetricId}/metadata:
    post:
      operationId: UpdateMetricMetadata
      summary: Update Metric Metadata
      description: Updates the name and/or description of an existing metric in the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMetricMetadataResponse'
        '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'
        '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/UpdateMetricMetadataRequest'
      tags:
      - Metadata
  /phone-number/{PhoneNumberId}/metadata:
    put:
      operationId: UpdatePhoneNumberMetadata
      summary: Update Phone Number Metadata
      description: Updates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation,
        call the DescribePhoneNumber API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: IdempotencyException; ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdempotencyException'
        '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/UpdatePhoneNumberMetadataRequest'
      tags:
      - Metadata
  /views/{InstanceId}/{ViewId}/metadata:
    post:
      operationId: UpdateViewMetadata
      summary: Update View Metadata
      description: Updates the view metadata. Note that either Name or Description must be provided.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateViewMetadataResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException; ResourceInUseException
          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: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateViewMetadataRequest'
      tags:
      - Metadata
  /workspaces/{InstanceId}/{WorkspaceId}/metadata:
    post:
      operationId: UpdateWorkspaceMetadata
      summary: Update Workspace Metadata
      description: Updates the metadata of a workspace, such as its name and description.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceMetadataResponse'
        '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'
        '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/UpdateWorkspaceMetadataRequest'
      tags:
      - Metadata
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
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    IdempotencyException:
      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.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
    UpdateContactFlowMetadataRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
        Name:
          type: string
          description: The name of the flow.
        Description:
          type: string
          description: The description of the flow.
        ContactFlowState:
          type: string
          enum:
          - ACTIVE
          - ARCHIVED
          description: The state of flow.
      required:
      - InstanceId
      - ContactFlowId
    UpdateContactFlowMetadataResponse:
      type: object
      properties: {}
    UpdateContactFlowModuleMetadataRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
        Name:
          type: string
          description: The name of the flow module.
        Description:
          type: string
          description: The description of the flow module.
        State:
          type: string
          enum:
          - ACTIVE
          - ARCHIVED
          description: The state of flow module.
      required:
      - InstanceId
      - ContactFlowModuleId
    UpdateContactFlowModuleMetadataResponse:
      type: object
      properties: {}
    UpdateMetricMetadataRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        MetricId:
          type: string
          description: The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of
            the metric. Adding $LATEST or omitting a qualifier will update the published version.
        Name:
          type: string
          description: The updated name of the metric.
        Description:
          type: string
          description: The updated description of the metric.
      required:
      - InstanceId
      - MetricId
    UpdateMetricMetadataResponse:
      type: object
      properties: {}
    UpdatePhoneNumberMetadataRequest:
      type: object
      properties:
        PhoneNumberId:
          type: string
          description: The Amazon Resource Name (ARN) or resource ID of the phone number.
        PhoneNumberDescription:
          type: string
          description: The description of the phone number.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
            provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making
            retries safe with idempotent APIs.
      required:
      - PhoneNumberId
    UpdateViewMetadataRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.
        ViewId:
          type: string
          description: The identifier of the view. Both ViewArn and ViewId can be used.
        Name:
          type: string
          description: The name of the view.
        Description:
          type: string
          description: The description of the view.
      required:
      - InstanceId
      - ViewId
    UpdateViewMetadataResponse:
      type: object
      properties: {}
    UpdateWorkspaceMetadataRequest:
      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.
        Name:
          type: string
          description: The name of the workspace.
        Description:
          type: string
          description: The description of the workspace.
        Title:
          type: string
          description: The title displayed for the workspace.
      required:
      - InstanceId
      - WorkspaceId
    UpdateWorkspaceMetadataResponse:
      type: object
      properties: {}
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)