openapi: 3.1.0
info:
  title: Amazon Cloud WAN API
  description: >-
    Amazon Cloud WAN is a managed wide area networking service that simplifies building,
    managing, and monitoring global WANs. Connect branch offices, data centers, and
    Amazon VPCs through a central dashboard with network policy automation.
  version: '2021-12-12'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
  x-generated-from: documentation
externalDocs:
  description: Amazon Cloud WAN API Reference
  url: https://docs.aws.amazon.com/network-manager/latest/cloudwan/
servers:
  - url: https://networkmanager.{region}.amazonaws.com
    description: Amazon Cloud WAN Regional Endpoint
    variables:
      region:
        default: us-east-1
        description: AWS Region
tags:
  - name: Core Networks
    description: Operations for managing Cloud WAN core networks
  - name: Network Policies
    description: Operations for managing network policies
  - name: Attachments
    description: Operations for managing network attachments
paths:
  /core-networks:
    get:
      operationId: ListCoreNetworks
      summary: Amazon Cloud WAN List Core Networks
      description: Returns a list of owned and shared core networks.
      tags:
        - Core Networks
      parameters:
        - name: maxResults
          in: query
          description: The maximum number of results to return.
          schema:
            type: integer
            minimum: 1
            maximum: 500
        - name: nextToken
          in: query
          description: The token for the next page of results.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCoreNetworksResponse'
              examples:
                ListCoreNetworks200Example:
                  summary: Default ListCoreNetworks 200 response
                  x-microcks-default: true
                  value:
                    CoreNetworks:
                      - CoreNetworkId: "core-network-abc12345"
                        CoreNetworkArn: "arn:aws:networkmanager::123456789012:core-network/core-network-abc12345"
                        GlobalNetworkId: "global-network-abc12345"
                        State: "AVAILABLE"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: CreateCoreNetwork
      summary: Amazon Cloud WAN Create a Core Network
      description: Creates a core network as part of your global network, and optionally, with a core network policy.
      tags:
        - Core Networks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCoreNetworkRequest'
            examples:
              CreateCoreNetworkRequestExample:
                summary: Default CreateCoreNetwork request
                x-microcks-default: true
                value:
                  GlobalNetworkId: "global-network-abc12345"
                  Description: "Production global network core"
      responses:
        '200':
          description: Core network created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCoreNetworkResponse'
              examples:
                CreateCoreNetwork200Example:
                  summary: Default CreateCoreNetwork 200 response
                  x-microcks-default: true
                  value:
                    CoreNetwork:
                      CoreNetworkId: "core-network-abc12345"
                      GlobalNetworkId: "global-network-abc12345"
                      State: "CREATING"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK

  /core-networks/{coreNetworkId}:
    get:
      operationId: GetCoreNetwork
      summary: Amazon Cloud WAN Get a Core Network
      description: Returns information about the LIVE policy for a core network.
      tags:
        - Core Networks
      parameters:
        - name: coreNetworkId
          in: path
          required: true
          description: The ID of a core network.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCoreNetworkResponse'
              examples:
                GetCoreNetwork200Example:
                  summary: Default GetCoreNetwork 200 response
                  x-microcks-default: true
                  value:
                    CoreNetwork:
                      CoreNetworkId: "core-network-abc12345"
                      GlobalNetworkId: "global-network-abc12345"
                      State: "AVAILABLE"
                      Description: "Production global network core"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: DeleteCoreNetwork
      summary: Amazon Cloud WAN Delete a Core Network
      description: Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.
      tags:
        - Core Networks
      parameters:
        - name: coreNetworkId
          in: path
          required: true
          description: The network ID of the deleted core network.
          schema:
            type: string
      responses:
        '200':
          description: Core network deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCoreNetworkResponse'
              examples:
                DeleteCoreNetwork200Example:
                  summary: Default DeleteCoreNetwork 200 response
                  x-microcks-default: true
                  value:
                    CoreNetwork:
                      CoreNetworkId: "core-network-abc12345"
                      State: "DELETING"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK

components:
  schemas:
    CoreNetwork:
      type: object
      description: "Describes a core network."
      properties:
        CoreNetworkId:
          type: string
          description: "The ID of a core network."
          example: "core-network-abc12345"
        CoreNetworkArn:
          type: string
          description: "The ARN of a core network."
        GlobalNetworkId:
          type: string
          description: "The ID of the global network where a core network is a part of."
        Description:
          type: string
          description: "The description of a core network."
        State:
          type: string
          enum:
            - CREATING
            - UPDATING
            - AVAILABLE
            - DELETING
          description: "The current state of a core network."
        CreatedAt:
          type: string
          format: date-time
          description: "The timestamp when a core network was created."

    ListCoreNetworksResponse:
      type: object
      description: "Response for listing core networks."
      properties:
        CoreNetworks:
          type: array
          items:
            $ref: '#/components/schemas/CoreNetwork'
        NextToken:
          type: string

    CreateCoreNetworkRequest:
      type: object
      description: "Request body for creating a core network."
      required:
        - GlobalNetworkId
      properties:
        GlobalNetworkId:
          type: string
          description: "The ID of the global network that a core network will be a part of."
          example: "global-network-abc12345"
        Description:
          type: string
          description: "The description of a core network."
        Tags:
          type: array
          items:
            type: object
          description: "Key-value tags for the core network."

    CreateCoreNetworkResponse:
      type: object
      description: "Response for creating a core network."
      properties:
        CoreNetwork:
          $ref: '#/components/schemas/CoreNetwork'

    GetCoreNetworkResponse:
      type: object
      description: "Response for getting a core network."
      properties:
        CoreNetwork:
          $ref: '#/components/schemas/CoreNetwork'

    DeleteCoreNetworkResponse:
      type: object
      description: "Response for deleting a core network."
      properties:
        CoreNetwork:
          $ref: '#/components/schemas/CoreNetwork'

    ValidationException:
      type: object
      description: "The input fails to satisfy the constraints."
      properties:
        Message:
          type: string

    ResourceNotFoundException:
      type: object
      description: "The specified resource could not be found."
      properties:
        Message:
          type: string
        ResourceId:
          type: string

    InternalServerException:
      type: object
      description: "The request has failed due to an internal error."
      properties:
        Message:
          type: string

  securitySchemes:
    aws_signature:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4

security:
  - aws_signature: []