VPCLattice / Client / get_listener

get_listener

VPCLattice.Client.get_listener(**kwargs)

Retrieves information about the specified listener for the specified service.

See also: AWS API Documentation

Request Syntax

response = client.get_listener(
    listenerIdentifier='string',
    serviceIdentifier='string'
)

Parameters:

• listenerIdentifier (string) –

  [REQUIRED]

  The ID or Amazon Resource Name (ARN) of the listener.

• serviceIdentifier (string) –

  [REQUIRED]

  The ID or Amazon Resource Name (ARN) of the service.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'defaultAction': {
        'fixedResponse': {
            'statusCode': 123
        },
        'forward': {
            'targetGroups': [
                {
                    'targetGroupIdentifier': 'string',
                    'weight': 123
                },
            ]
        }
    },
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'port': 123,
    'protocol': 'HTTP'|'HTTPS',
    'serviceArn': 'string',
    'serviceId': 'string'
}

Response Structure

• (dict) –

  • arn (string) –

    The Amazon Resource Name (ARN) of the listener.

  • createdAt (datetime) –

    The date and time that the listener was created, specified in ISO-8601 format.

  • defaultAction (dict) –

    The actions for the default listener rule.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: fixedResponse, forward. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • fixedResponse (dict) –

      Describes the rule action that returns a custom HTTP response.

      • statusCode (integer) –

        The HTTP response code.

    • forward (dict) –

      The forward action. Traffic that matches the rule is forwarded to the specified target groups.

      • targetGroups (list) –

        The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

        The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

        • (dict) –

          Describes the weight of a target group.

          • targetGroupIdentifier (string) –

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight (integer) –

            Only required if you specify multiple target groups for a forward action. The “weight” determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there’s only one target group specified, then the default value is 100.

  • id (string) –

    The ID of the listener.

  • lastUpdatedAt (datetime) –

    The date and time that the listener was last updated, specified in ISO-8601 format.

  • name (string) –

    The name of the listener.

  • port (integer) –

    The listener port.

  • protocol (string) –

    The listener protocol.

  • serviceArn (string) –

    The Amazon Resource Name (ARN) of the service.

  • serviceId (string) –

    The ID of the service.

Exceptions

• VPCLattice.Client.exceptions.ValidationException

• VPCLattice.Client.exceptions.AccessDeniedException

• VPCLattice.Client.exceptions.ThrottlingException

• VPCLattice.Client.exceptions.ResourceNotFoundException

• VPCLattice.Client.exceptions.InternalServerException