Amazon Cloud Map Namespaces API

openapi: 3.1.0
info:
  title: Amazon Cloud Map Instances Namespaces API
  description: Amazon Cloud Map is a cloud resource discovery service that maintains an updated registry of application resources. Define custom names for application resources and use Cloud Map to dynamically discover service dependencies with integrated health checking.
  version: '2017-03-14'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
  x-generated-from: documentation
servers:
- url: https://servicediscovery.{region}.amazonaws.com
  description: Amazon Cloud Map Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
security:
- aws_signature: []
tags:
- name: Namespaces
  description: Operations for managing service discovery namespaces
paths:
  /namespaces:
    get:
      operationId: ListNamespaces
      summary: Amazon Cloud Map List Namespaces
      description: Lists summary information about the namespaces that were created by the current AWS account.
      tags:
      - Namespaces
      parameters:
      - name: NextToken
        in: query
        description: For the first ListNamespaces request, omit this value.
        schema:
          type: string
      - name: MaxResults
        in: query
        description: The maximum number of namespaces that you want AWS Cloud Map to return.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNamespacesResponse'
              examples:
                ListNamespaces200Example:
                  summary: Default ListNamespaces 200 response
                  x-microcks-default: true
                  value:
                    Namespaces:
                    - Id: ns-abc12345
                      Arn: arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-abc12345
                      Name: production.internal
                      Type: DNS_PRIVATE
                    NextToken: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    InternalServiceError:
      type: object
      description: One or more required elements are missing or one or more elements are wrong.
      properties:
        Message:
          type: string
    InvalidInput:
      type: object
      description: One or more specified values aren't valid.
      properties:
        Message:
          type: string
    ListNamespacesResponse:
      type: object
      description: Response for listing namespaces.
      properties:
        Namespaces:
          type: array
          items:
            $ref: '#/components/schemas/Namespace'
        NextToken:
          type: string
    Namespace:
      type: object
      description: Represents a Cloud Map namespace for service discovery.
      properties:
        Id:
          type: string
          description: The ID of the namespace.
          example: ns-abc12345
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the namespace.
        Name:
          type: string
          description: The name of the namespace.
          example: production.internal
        Type:
          type: string
          enum:
          - DNS_PUBLIC
          - DNS_PRIVATE
          - HTTP
          description: The type of the namespace.
        Description:
          type: string
          description: The description of the namespace.
        CreateDate:
          type: string
          format: date-time
          description: The date and time that the namespace was created.
  securitySchemes:
    aws_signature:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4
externalDocs:
  description: Amazon Cloud Map API Reference
  url: https://docs.aws.amazon.com/cloud-map/latest/api/