Amazon Global Accelerator #X Amz Target=GlobalAccelerator V20180706.AddCustomRoutingEndpoints API

openapi: 3.2.0
info:
  version: '2018-08-08'
  x-release: v4
  title: 'AWS Global Accelerator #X Amz Target=GlobalAccelerator…'
  description: 'Global Accelerator

    This is the Global Accelerator API Reference.'
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: globalaccelerator
  x-aws-signingName: globalaccelerator
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/globalaccelerator-2018-08-08.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://globalaccelerator.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Global Accelerator multi-region endpoint
- url: https://globalaccelerator.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Global Accelerator multi-region endpoint
- url: http://globalaccelerator.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
- url: https://globalaccelerator.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=GlobalAccelerator V20180706.AddCustomRoutingEndpoints'
paths:
  /#X-Amz-Target=GlobalAccelerator_V20180706.AddCustomRoutingEndpoints:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: AddCustomRoutingEndpoints
      description: 'Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.


        The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.


        Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.


        By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCustomRoutingEndpointsResponse'
              examples:
                AddCustomRoutingEndpoints200Example:
                  summary: Default AddCustomRoutingEndpoints 200 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '480':
          description: EndpointAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointAlreadyExistsException'
              examples:
                AddCustomRoutingEndpoints480Example:
                  summary: Default AddCustomRoutingEndpoints 480 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '481':
          description: EndpointGroupNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointGroupNotFoundException'
              examples:
                AddCustomRoutingEndpoints481Example:
                  summary: Default AddCustomRoutingEndpoints 481 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '482':
          description: InternalServiceErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
              examples:
                AddCustomRoutingEndpoints482Example:
                  summary: Default AddCustomRoutingEndpoints 482 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '483':
          description: InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
              examples:
                AddCustomRoutingEndpoints483Example:
                  summary: Default AddCustomRoutingEndpoints 483 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '484':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
              examples:
                AddCustomRoutingEndpoints484Example:
                  summary: Default AddCustomRoutingEndpoints 484 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '485':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                AddCustomRoutingEndpoints485Example:
                  summary: Default AddCustomRoutingEndpoints 485 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '486':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                AddCustomRoutingEndpoints486Example:
                  summary: Default AddCustomRoutingEndpoints 486 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCustomRoutingEndpointsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.AddCustomRoutingEndpoints
      summary: Amazon Global Accelerator Add Custom Routing Endpoints
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GlobalAccelerator V20180706.AddCustomRoutingEndpoints'
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    EndpointGroupNotFoundException: {}
    ConflictException: {}
    InternalServiceErrorException: {}
    AddCustomRoutingEndpointsRequest:
      type: object
      required:
      - EndpointConfigurations
      - EndpointGroupArn
      title: AddCustomRoutingEndpointsRequest
      properties:
        EndpointConfigurations:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingEndpointConfigurations'
          - description: The list of endpoint objects to add to a custom routing accelerator.
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
    InvalidArgumentException: {}
    LimitExceededException: {}
    CustomRoutingEndpointConfiguration:
      type: object
      properties:
        EndpointId:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: 'An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. '
      description: The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.
    CustomRoutingEndpointConfigurations:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingEndpointConfiguration'
      minItems: 1
      maxItems: 20
    CustomRoutingEndpointDescription:
      type: object
      properties:
        EndpointId:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: 'An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. '
      description: A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
    CustomRoutingEndpointDescriptions:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingEndpointDescription'
    EndpointAlreadyExistsException: {}
    AddCustomRoutingEndpointsResponse:
      type: object
      properties:
        EndpointDescriptions:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingEndpointDescriptions'
          - description: The endpoint objects added to the custom routing accelerator.
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
    AccessDeniedException: {}
    GenericString:
      type: string
      maxLength: 255
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/globalaccelerator/
x-hasEquivalentPaths: true