GlobalAccelerator / Client / list_custom_routing_port_mappings_by_destination

list_custom_routing_port_mappings_by_destination#

GlobalAccelerator.Client.list_custom_routing_port_mappings_by_destination(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_routing_port_mappings_by_destination(
    EndpointId='string',
    DestinationAddress='string',
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – The number of destination port mappings that you want to return with this call. The default value is 10.

  • NextToken (string) – The token for the next set of results. You receive this token from a previous call.

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'
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      The token for the next set of results. You receive this token from a previous call.

Exceptions