Amazon AppSync Appsync Channelnamespaces API

The Appsync Channelnamespaces API from Amazon AppSync — 2 operation(s) for appsync channelnamespaces.

Operations 5

POST /v2/apis/{apiId}/channelNamespaces Create Channel Namespace #
GET /v2/apis/{apiId}/channelNamespaces List Channel Namespaces #
DELETE /v2/apis/{apiId}/channelNamespaces/{name} Delete Channel Namespace #
GET /v2/apis/{apiId}/channelNamespaces/{name} Get Channel Namespace #
POST /v2/apis/{apiId}/channelNamespaces/{name} Update Channel Namespace #

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-appsync:amazon-appsync-channelnamespaces-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.

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

OpenAPI Specification

amazon-appsync-channelnamespaces-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AWS AppSync Channelnamespaces API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS AppSync. 5 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://appsync.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Channelnamespaces
paths:
  /v2/apis/{apiId}/channelNamespaces:
    post:
      operationId: CreateChannelNamespace
      summary: Create Channel Namespace
      description: Creates a ChannelNamespace for an Api.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChannelNamespaceResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException; ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChannelNamespaceRequest'
      tags:
      - Channelnamespaces
    get:
      operationId: ListChannelNamespaces
      summary: List Channel Namespaces
      description: Lists the channel namespaces for a specified Api. ListChannelNamespaces returns only high level details for the channel namespace. To retrieve code handlers, use GetChannelNamespace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChannelNamespacesResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListChannelNamespacesRequest'
      tags:
      - Channelnamespaces
  /v2/apis/{apiId}/channelNamespaces/{name}:
    delete:
      operationId: DeleteChannelNamespace
      summary: Delete Channel Namespace
      description: Deletes a ChannelNamespace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteChannelNamespaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteChannelNamespaceRequest'
      tags:
      - Channelnamespaces
    get:
      operationId: GetChannelNamespace
      summary: Get Channel Namespace
      description: Retrieves the channel namespace for a specified Api.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChannelNamespaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetChannelNamespaceRequest'
      tags:
      - Channelnamespaces
    post:
      operationId: UpdateChannelNamespace
      summary: Update Channel Namespace
      description: Updates a ChannelNamespace associated with an Api.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChannelNamespaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChannelNamespaceRequest'
      tags:
      - Channelnamespaces
components:
  schemas:
    Integration:
      type: object
      properties:
        dataSourceName:
          type: string
          description: The unique name of the data source that has been configured on the API.
        lambdaConfig:
          $ref: '#/components/schemas/LambdaConfig'
      required:
      - dataSourceName
    ListChannelNamespacesResponse:
      type: object
      properties:
        channelNamespaces:
          type: array
          items:
            $ref: '#/components/schemas/ChannelNamespace'
          description: The ChannelNamespace objects.
        nextToken:
          type: string
          description: An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
    GetChannelNamespaceResponse:
      type: object
      properties:
        channelNamespace:
          $ref: '#/components/schemas/ChannelNamespace'
    CreateChannelNamespaceResponse:
      type: object
      properties:
        channelNamespace:
          $ref: '#/components/schemas/ChannelNamespace'
    BadRequestDetail:
      type: object
      properties:
        codeErrors:
          type: array
          items:
            $ref: '#/components/schemas/CodeError'
          description: Contains the list of errors in the request.
    DeleteChannelNamespaceRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The ID of the Api associated with the ChannelNamespace.
        name:
          type: string
          description: The name of the ChannelNamespace.
      required:
      - apiId
      - name
    UpdateChannelNamespaceRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The Api ID.
        name:
          type: string
          description: The name of the ChannelNamespace.
        subscribeAuthModes:
          type: array
          items:
            $ref: '#/components/schemas/AuthMode'
          description: The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.
        publishAuthModes:
          type: array
          items:
            $ref: '#/components/schemas/AuthMode'
          description: The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.
        codeHandlers:
          type: string
          description: The event handler functions that run custom business logic to process published events and subscribe requests.
        handlerConfigs:
          $ref: '#/components/schemas/HandlerConfigs'
      required:
      - apiId
      - name
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    LambdaConfig:
      type: object
      properties:
        invokeType:
          type: string
          enum:
          - REQUEST_RESPONSE
          - EVENT
          description: The invocation type for a Lambda data source.
    ListChannelNamespacesRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The Api ID.
        nextToken:
          type: string
          description: An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
        maxResults:
          type: integer
          description: The maximum number of results that you want the request to return.
      required:
      - apiId
    HandlerConfig:
      type: object
      properties:
        behavior:
          type: string
          enum:
          - CODE
          - DIRECT
          description: The behavior for the handler.
        integration:
          $ref: '#/components/schemas/Integration'
      required:
      - behavior
      - integration
    CreateChannelNamespaceRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The Api ID.
        name:
          type: string
          description: The name of the ChannelNamespace. This name must be unique within the Api
        subscribeAuthModes:
          type: array
          items:
            $ref: '#/components/schemas/AuthMode'
          description: The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.
        publishAuthModes:
          type: array
          items:
            $ref: '#/components/schemas/AuthMode'
          description: The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.
        codeHandlers:
          type: string
          description: The event handler functions that run custom business logic to process published events and subscribe requests.
        tags:
          type: object
          additionalProperties:
            type: string
        handlerConfigs:
          $ref: '#/components/schemas/HandlerConfigs'
      required:
      - apiId
      - name
    HandlerConfigs:
      type: object
      properties:
        onPublish:
          $ref: '#/components/schemas/HandlerConfig'
        onSubscribe:
          $ref: '#/components/schemas/HandlerConfig'
    BadRequestException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CODE_ERROR
        detail:
          $ref: '#/components/schemas/BadRequestDetail'
    GetChannelNamespaceRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The Api ID.
        name:
          type: string
          description: The name of the ChannelNamespace.
      required:
      - apiId
      - name
    DeleteChannelNamespaceResponse:
      type: object
      properties: {}
    CodeError:
      type: object
      properties:
        errorType:
          type: string
          description: 'The type of code error. Examples include, but aren''t limited to: LINT_ERROR, PARSER_ERROR.'
        value:
          type: string
          description: 'A user presentable error. Examples include, but aren''t limited to: Parsing error: Unterminated string literal.'
        location:
          $ref: '#/components/schemas/CodeErrorLocation'
    AuthMode:
      type: object
      properties:
        authType:
          type: string
          enum:
          - API_KEY
          - AWS_IAM
          - AMAZON_COGNITO_USER_POOLS
          - OPENID_CONNECT
          - AWS_LAMBDA
          description: The authorization type.
      required:
      - authType
    CodeErrorLocation:
      type: object
      properties:
        line:
          type: integer
          description: The line number in the code. Defaults to 0 if unknown.
        column:
          type: integer
          description: The column number in the code. Defaults to 0 if unknown.
        span:
          type: integer
          description: The span/length of the error. Defaults to -1 if unknown.
    UpdateChannelNamespaceResponse:
      type: object
      properties:
        channelNamespace:
          $ref: '#/components/schemas/ChannelNamespace'
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ChannelNamespace:
      type: object
      properties:
        apiId:
          type: string
          description: The Api ID.
        name:
          type: string
          description: The name of the channel namespace. This name must be unique within the Api.
        subscribeAuthModes:
          type: array
          items:
            $ref: '#/components/schemas/AuthMode'
          description: The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
        publishAuthModes:
          type: array
          items:
            $ref: '#/components/schemas/AuthMode'
          description: The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
        codeHandlers:
          type: string
          description: The event handler functions that run custom business logic to process published events and subscribe requests.
        tags:
          type: object
          additionalProperties:
            type: string
        channelNamespaceArn:
          type: string
          description: The Amazon Resource Name (ARN) for the ChannelNamespace.
        created:
          type: string
          format: date-time
          description: The date and time that the ChannelNamespace was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time that the ChannelNamespace was last changed.
        handlerConfigs:
          $ref: '#/components/schemas/HandlerConfigs'
  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: appsync
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/appsync/service/2017-07-25/appsync-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)