EC2 / Client / describe_service_link_virtual_interfaces

describe_service_link_virtual_interfaces

EC2.Client.describe_service_link_virtual_interfaces(**kwargs)

Describes the Outpost service link virtual interfaces.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ServiceLinkVirtualInterfaceIds (list) –

  The IDs of the service link virtual interfaces.

  • (string) –

• Filters (list) –

  The filters to use for narrowing down the request. The following filters are supported:

  • outpost-lag-id - The ID of the Outpost LAG.

  • outpost-arn - The Outpost ARN.

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

  • state - The state of the Outpost LAG.

  • vlan - The ID of the address pool.

  • service-link-virtual-interface-id - The ID of the service link virtual interface.

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

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

{
    'ServiceLinkVirtualInterfaces': [
        {
            'ServiceLinkVirtualInterfaceId': 'string',
            'ServiceLinkVirtualInterfaceArn': 'string',
            'OutpostId': 'string',
            'OutpostArn': 'string',
            'OwnerId': 'string',
            'LocalAddress': 'string',
            'PeerAddress': 'string',
            'PeerBgpAsn': 123,
            'Vlan': 123,
            'OutpostLagId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ServiceLinkVirtualInterfaces (list) –

    Describes the service link virtual interfaces.

    • (dict) –

      Describes the service link virtual interfaces that establish connectivity between Amazon Web Services Outpost and on-premises networks.

      • ServiceLinkVirtualInterfaceId (string) –

        The ID of the service link virtual interface.

      • ServiceLinkVirtualInterfaceArn (string) –

        The Amazon Resource Number (ARN) for the service link virtual interface.

      • OutpostId (string) –

        The Outpost ID for the service link virtual interface.

      • OutpostArn (string) –

        The Outpost Amazon Resource Number (ARN) for the service link virtual interface.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the service link virtual interface..

      • LocalAddress (string) –

        The IPv4 address assigned to the local gateway virtual interface on the Outpost side.

      • PeerAddress (string) –

        The IPv4 peer address for the service link virtual interface.

      • PeerBgpAsn (integer) –

        The ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface.

      • Vlan (integer) –

        The virtual local area network for the service link virtual interface.

      • OutpostLagId (string) –

        The link aggregation group (LAG) ID for the service link virtual interface.

      • Tags (list) –

        The tags associated with the service link 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 service link 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.