Amazon Global Accelerator #X Amz Target=GlobalAccelerator V20180706.ListCustomRoutingPortMappingsByDestination 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.ListCustomRoutingPortMappingsByDestination'
paths:
  /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappingsByDestination:
    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: ListCustomRoutingPortMappingsByDestination
      description: List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomRoutingPortMappingsByDestinationResponse'
              examples:
                ListCustomRoutingPortMappingsByDestination200Example:
                  summary: Default ListCustomRoutingPortMappingsByDestination 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:
                ListCustomRoutingPortMappingsByDestination480Example:
                  summary: Default ListCustomRoutingPortMappingsByDestination 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:
                ListCustomRoutingPortMappingsByDestination481Example:
                  summary: Default ListCustomRoutingPortMappingsByDestination 481 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '482':
          description: EndpointNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointNotFoundException'
              examples:
                ListCustomRoutingPortMappingsByDestination482Example:
                  summary: Default ListCustomRoutingPortMappingsByDestination 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:
                ListCustomRoutingPortMappingsByDestination483Example:
                  summary: Default ListCustomRoutingPortMappingsByDestination 483 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/ListCustomRoutingPortMappingsByDestinationRequest'
      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.ListCustomRoutingPortMappingsByDestination
      summary: Amazon Global Accelerator List Custom Routing Port Mappings by Destination
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GlobalAccelerator V20180706.ListCustomRoutingPortMappingsByDestination'
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: {}
    IpAddressType:
      type: string
      enum:
      - IPV4
      - DUAL_STACK
    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: {}
    DestinationPortMapping:
      type: object
      properties:
        AcceleratorArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
        AcceleratorSocketAddresses:
          allOf:
          - $ref: '#/components/schemas/SocketAddresses'
          - description: The IP address/port combinations (sockets) that map to a given destination socket address.
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group.
        EndpointId:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The ID for the virtual private cloud (VPC) subnet.
        EndpointGroupRegion:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Web Services Region for the endpoint group.
        DestinationSocketAddress:
          allOf:
          - $ref: '#/components/schemas/SocketAddress'
          - description: The endpoint IP address/port combination for traffic received on the accelerator socket address.
        IpAddressType:
          allOf:
          - $ref: '#/components/schemas/IpAddressType'
          - description: The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
        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: The port mappings for a specified endpoint IP address (destination).
    ListCustomRoutingPortMappingsByDestinationResponse:
      type: object
      properties:
        DestinationPortMappings:
          allOf:
          - $ref: '#/components/schemas/DestinationPortMappings'
          - description: The port mappings for the endpoint IP address that you specified in the request.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The token for the next set of results. You receive this token from a previous call.
    CustomRoutingDestinationTrafficState:
      type: string
      enum:
      - ALLOW
      - DENY
    SocketAddresses:
      type: array
      items:
        $ref: '#/components/schemas/SocketAddress'
    DestinationPortMappings:
      type: array
      items:
        $ref: '#/components/schemas/DestinationPortMapping'
    EndpointNotFoundException: {}
    ListCustomRoutingPortMappingsByDestinationRequest:
      type: object
      required:
      - EndpointId
      - DestinationAddress
      title: ListCustomRoutingPortMappingsByDestinationRequest
      properties:
        EndpointId:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The ID for the virtual private cloud (VPC) subnet.
        DestinationAddress:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.
        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.
    PortNumber:
      type: integer
      minimum: 1
      maximum: 65535
    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