Amazon Global Accelerator #X Amz Target=GlobalAccelerator V20180706.CreateCustomRoutingEndpointGroup 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.CreateCustomRoutingEndpointGroup'
paths:
  /#X-Amz-Target=GlobalAccelerator_V20180706.CreateCustomRoutingEndpointGroup:
    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: CreateCustomRoutingEndpointGroup
      description: Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomRoutingEndpointGroupResponse'
              examples:
                CreateCustomRoutingEndpointGroup200Example:
                  summary: Default CreateCustomRoutingEndpointGroup 200 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '480':
          description: AcceleratorNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceleratorNotFoundException'
              examples:
                CreateCustomRoutingEndpointGroup480Example:
                  summary: Default CreateCustomRoutingEndpointGroup 480 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '481':
          description: EndpointGroupAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointGroupAlreadyExistsException'
              examples:
                CreateCustomRoutingEndpointGroup481Example:
                  summary: Default CreateCustomRoutingEndpointGroup 481 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '482':
          description: ListenerNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListenerNotFoundException'
              examples:
                CreateCustomRoutingEndpointGroup482Example:
                  summary: Default CreateCustomRoutingEndpointGroup 482 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '483':
          description: InternalServiceErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
              examples:
                CreateCustomRoutingEndpointGroup483Example:
                  summary: Default CreateCustomRoutingEndpointGroup 483 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '484':
          description: InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
              examples:
                CreateCustomRoutingEndpointGroup484Example:
                  summary: Default CreateCustomRoutingEndpointGroup 484 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '485':
          description: InvalidPortRangeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidPortRangeException'
              examples:
                CreateCustomRoutingEndpointGroup485Example:
                  summary: Default CreateCustomRoutingEndpointGroup 485 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '486':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
              examples:
                CreateCustomRoutingEndpointGroup486Example:
                  summary: Default CreateCustomRoutingEndpointGroup 486 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '487':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                CreateCustomRoutingEndpointGroup487Example:
                  summary: Default CreateCustomRoutingEndpointGroup 487 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/CreateCustomRoutingEndpointGroupRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.CreateCustomRoutingEndpointGroup
      summary: Amazon Global Accelerator Create Custom Routing Endpoint Group
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GlobalAccelerator V20180706.CreateCustomRoutingEndpointGroup'
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:
    InternalServiceErrorException: {}
    Protocol:
      type: string
      enum:
      - TCP
      - UDP
    CustomRoutingProtocols:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingProtocol'
      minItems: 1
      maxItems: 2
    Protocols:
      type: array
      items:
        $ref: '#/components/schemas/Protocol'
    CustomRoutingDestinationConfigurations:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingDestinationConfiguration'
      minItems: 1
      maxItems: 100
    CreateCustomRoutingEndpointGroupRequest:
      type: object
      required:
      - ListenerArn
      - EndpointGroupRegion
      - DestinationConfigurations
      - IdempotencyToken
      title: CreateCustomRoutingEndpointGroupRequest
      properties:
        ListenerArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
        EndpointGroupRegion:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
        DestinationConfigurations:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingDestinationConfigurations'
          - description: Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.
        IdempotencyToken:
          allOf:
          - $ref: '#/components/schemas/IdempotencyToken'
          - description: A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
    ListenerNotFoundException: {}
    InvalidArgumentException: {}
    EndpointGroupAlreadyExistsException: {}
    LimitExceededException: {}
    CustomRoutingEndpointGroup:
      type: object
      properties:
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group.
        EndpointGroupRegion:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Web Services Region where the endpoint group is located.
        DestinationDescriptions:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingDestinationDescriptions'
          - description: For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
        EndpointDescriptions:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingEndpointDescriptions'
          - description: For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
      description: 'A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener. '
    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.
    CustomRoutingDestinationConfiguration:
      type: object
      required:
      - FromPort
      - ToPort
      - Protocols
      properties:
        FromPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
        ToPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
        Protocols:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingProtocols'
          - description: The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
      description: For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
    CustomRoutingEndpointDescriptions:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingEndpointDescription'
    CustomRoutingDestinationDescriptions:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingDestinationDescription'
    InvalidPortRangeException: {}
    CustomRoutingProtocol:
      type: string
      enum:
      - TCP
      - UDP
    CustomRoutingDestinationDescription:
      type: object
      properties:
        FromPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
        ToPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
        Protocols:
          allOf:
          - $ref: '#/components/schemas/Protocols'
          - description: The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
      description: For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
    AccessDeniedException: {}
    PortNumber:
      type: integer
      minimum: 1
      maximum: 65535
    AcceleratorNotFoundException: {}
    GenericString:
      type: string
      maxLength: 255
    CreateCustomRoutingEndpointGroupResponse:
      type: object
      properties:
        EndpointGroup:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingEndpointGroup'
          - description: The information about the endpoint group created for a custom routing accelerator.
    IdempotencyToken:
      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