Amazon Global Accelerator #X Amz Target=GlobalAccelerator V20180706.ListCustomRoutingPortMappings 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.ListCustomRoutingPortMappings'
paths:
  /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappings:
    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: ListCustomRoutingPortMappings
      description: 'Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don''t change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.


        If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don''t change). If you add or remove EC2 instances in your subnet, the port mappings don''t change, because the mappings are created when you add the subnet to Global Accelerator.


        The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomRoutingPortMappingsResponse'
              examples:
                ListCustomRoutingPortMappings200Example:
                  summary: Default ListCustomRoutingPortMappings 200 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '480':
          description: InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
              examples:
                ListCustomRoutingPortMappings480Example:
                  summary: Default ListCustomRoutingPortMappings 480 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                ListCustomRoutingPortMappings481Example:
                  summary: Default ListCustomRoutingPortMappings 481 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '482':
          description: EndpointGroupNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointGroupNotFoundException'
              examples:
                ListCustomRoutingPortMappings482Example:
                  summary: Default ListCustomRoutingPortMappings 482 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '483':
          description: AcceleratorNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceleratorNotFoundException'
              examples:
                ListCustomRoutingPortMappings483Example:
                  summary: Default ListCustomRoutingPortMappings 483 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '484':
          description: InternalServiceErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
              examples:
                ListCustomRoutingPortMappings484Example:
                  summary: Default ListCustomRoutingPortMappings 484 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/ListCustomRoutingPortMappingsRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.ListCustomRoutingPortMappings
      summary: Amazon Global Accelerator List Custom Routing Port Mappings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GlobalAccelerator V20180706.ListCustomRoutingPortMappings'
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: {}
    InternalServiceErrorException: {}
    CustomRoutingProtocols:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingProtocol'
      minItems: 1
      maxItems: 2
    SocketAddress:
      type: object
      properties:
        IpAddress:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The IP address for the socket address.
        Port:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The port for the socket address.
      description: An IP address/port combination.
    PortMappingsMaxResults:
      type: integer
      minimum: 1
      maximum: 20000
    InvalidArgumentException: {}
    InvalidNextTokenException: {}
    PortMapping:
      type: object
      properties:
        AcceleratorPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The accelerator port.
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group.
        EndpointId:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The IP address of the VPC subnet (the subnet ID).
        DestinationSocketAddress:
          allOf:
          - $ref: '#/components/schemas/SocketAddress'
          - description: The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
        Protocols:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingProtocols'
          - description: The protocols supported by the endpoint group.
        DestinationTrafficState:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingDestinationTrafficState'
          - description: Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
      description: 'Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets. '
    ListCustomRoutingPortMappingsResponse:
      type: object
      properties:
        PortMappings:
          allOf:
          - $ref: '#/components/schemas/PortMappings'
          - description: The port mappings for a custom routing accelerator.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The token for the next set of results. You receive this token from a previous call.
    ListCustomRoutingPortMappingsRequest:
      type: object
      required:
      - AcceleratorArn
      title: ListCustomRoutingPortMappingsRequest
      properties:
        AcceleratorArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/PortMappingsMaxResults'
          - description: The number of destination port mappings that you want to return with this call. The default value is 10.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The token for the next set of results. You receive this token from a previous call.
    PortMappings:
      type: array
      items:
        $ref: '#/components/schemas/PortMapping'
    CustomRoutingProtocol:
      type: string
      enum:
      - TCP
      - UDP
    CustomRoutingDestinationTrafficState:
      type: string
      enum:
      - ALLOW
      - DENY
    PortNumber:
      type: integer
      minimum: 1
      maximum: 65535
    AcceleratorNotFoundException: {}
    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