ListCustomRoutingPortMappingsByDestination¶

class GlobalAccelerator.Paginator.ListCustomRoutingPortMappingsByDestination¶

paginator = client.get_paginator('list_custom_routing_port_mappings_by_destination')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from GlobalAccelerator.Client.list_custom_routing_port_mappings_by_destination().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EndpointId='string',
    DestinationAddress='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

EndpointId (string) --
[REQUIRED]

The ID for the virtual private cloud (VPC) subnet.
DestinationAddress (string) --
[REQUIRED]

The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'DestinationPortMappings': [
        {
            'AcceleratorArn': 'string',
            'AcceleratorSocketAddresses': [
                {
                    'IpAddress': 'string',
                    'Port': 123
                },
            ],
            'EndpointGroupArn': 'string',
            'EndpointId': 'string',
            'EndpointGroupRegion': 'string',
            'DestinationSocketAddress': {
                'IpAddress': 'string',
                'Port': 123
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK',
            'DestinationTrafficState': 'ALLOW'|'DENY'
        },
    ],

}

Response Structure

(dict) --
- DestinationPortMappings (list) --
  
  The port mappings for the endpoint IP address that you specified in the request.
  - (dict) --
    
    The port mappings for a specified endpoint IP address (destination).
    - AcceleratorArn (string) --
      
      The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
    - AcceleratorSocketAddresses (list) --
      
      The IP address/port combinations (sockets) that map to a given destination socket address.
      - (dict) --
        
        An IP address/port combination.
        
        IpAddress (string) --
        
        The IP address for the socket address.
        
        Port (integer) --
        
        The port for the socket address.
    - EndpointGroupArn (string) --
      
      The Amazon Resource Name (ARN) of the endpoint group.
    - EndpointId (string) --
      
      The ID for the virtual private cloud (VPC) subnet.
    - EndpointGroupRegion (string) --
      
      The Amazon Web Services Region for the endpoint group.
    - DestinationSocketAddress (dict) --
      
      The endpoint IP address/port combination for traffic received on the accelerator socket address.
      - IpAddress (string) --
        
        The IP address for the socket address.
      - Port (integer) --
        
        The port for the socket address.
    - IpAddressType (string) --
      
      The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
    - DestinationTrafficState (string) --
      
      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.

Table Of Contents

ListCustomRoutingPortMappingsByDestination¶