EC2 / Client / describe_local_gateway_virtual_interfaces

describe_local_gateway_virtual_interfaces

EC2.Client.describe_local_gateway_virtual_interfaces(**kwargs)

Describes the specified local gateway virtual interfaces.

See also: AWS API Documentation

Request Syntax

response = client.describe_local_gateway_virtual_interfaces(
    LocalGatewayVirtualInterfaceIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• LocalGatewayVirtualInterfaceIds (list) –

  The IDs of the virtual interfaces.

  • (string) –

• Filters (list) –

  One or more filters.

  • local-address - The local address.

  • local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

  • local-gateway-id - The ID of the local gateway.

  • local-gateway-virtual-interface-id - The ID of the virtual interface.

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.

  • peer-address - The peer address.

  • peer-bgp-asn - The peer BGP ASN.

  • vlan - The ID of the VLAN.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'LocalGatewayVirtualInterfaces': [
        {
            'LocalGatewayVirtualInterfaceId': 'string',
            'LocalGatewayId': 'string',
            'LocalGatewayVirtualInterfaceGroupId': 'string',
            'LocalGatewayVirtualInterfaceArn': 'string',
            'OutpostLagId': 'string',
            'Vlan': 123,
            'LocalAddress': 'string',
            'PeerAddress': 'string',
            'LocalBgpAsn': 123,
            'PeerBgpAsn': 123,
            'PeerBgpAsnExtended': 123,
            'OwnerId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • LocalGatewayVirtualInterfaces (list) –

    Information about the virtual interfaces.

    • (dict) –

      Describes a local gateway virtual interface.

      • LocalGatewayVirtualInterfaceId (string) –

        The ID of the virtual interface.

      • LocalGatewayId (string) –

        The ID of the local gateway.

      • LocalGatewayVirtualInterfaceGroupId (string) –

        The ID of the local gateway virtual interface group.

      • LocalGatewayVirtualInterfaceArn (string) –

        The Amazon Resource Number (ARN) of the local gateway virtual interface.

      • OutpostLagId (string) –

        The Outpost LAG ID.

      • Vlan (integer) –

        The ID of the VLAN.

      • LocalAddress (string) –

        The local address.

      • PeerAddress (string) –

        The peer address.

      • LocalBgpAsn (integer) –

        The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

      • PeerBgpAsn (integer) –

        The peer BGP ASN.

      • PeerBgpAsnExtended (integer) –

        The extended 32-bit ASN of the BGP peer for use with larger ASN values.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the local gateway virtual interface.

      • Tags (list) –

        The tags assigned to the virtual interface.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • ConfigurationState (string) –

        The current state of the local gateway virtual interface.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.