GlobalAccelerator / Paginator / ListCustomRoutingPortMappings


class GlobalAccelerator.Paginator.ListCustomRoutingPortMappings#
paginator = client.get_paginator('list_custom_routing_port_mappings')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • AcceleratorArn (string) –


    The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.

  • EndpointGroupArn (string) – The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.

  • 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:



Response Syntax

    'PortMappings': [
            'AcceleratorPort': 123,
            'EndpointGroupArn': 'string',
            'EndpointId': 'string',
            'DestinationSocketAddress': {
                'IpAddress': 'string',
                'Port': 123
            'Protocols': [
            'DestinationTrafficState': 'ALLOW'|'DENY'


Response Structure

  • (dict) –

    • PortMappings (list) –

      The port mappings for a custom routing accelerator.

      • (dict) –

        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.

        • AcceleratorPort (integer) –

          The accelerator port.

        • EndpointGroupArn (string) –

          The Amazon Resource Name (ARN) of the endpoint group.

        • EndpointId (string) –

          The IP address of the VPC subnet (the subnet ID).

        • DestinationSocketAddress (dict) –

          The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.

          • IpAddress (string) –

            The IP address for the socket address.

          • Port (integer) –

            The port for the socket address.

        • Protocols (list) –

          The protocols supported by the endpoint group.

          • (string) –

        • 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.