EC2 / Client / describe_outpost_lags

describe_outpost_lags

EC2.Client.describe_outpost_lags(**kwargs)

Describes the Outposts link aggregation groups (LAGs).

See also: AWS API Documentation

Request Syntax

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

Parameters:

• OutpostLagIds (list) –

  The IDs of the Outpost LAGs.

  • (string) –

• Filters (list) –

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

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

  • service-link-virtual-interface-arn - The ARN of the service link virtual interface.

  • outpost-id - The Outpost ID.

  • outpost-arn - The Outpost ARN.

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

  • vlan - The ID of the address pool.

  • local-address - The local address.

  • peer-address - The peer address.

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

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

  • configuration-state - The configuration state of the service link 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

{
    'OutpostLags': [
        {
            'OutpostArn': 'string',
            'OwnerId': 'string',
            'State': 'string',
            'OutpostLagId': 'string',
            'LocalGatewayVirtualInterfaceIds': [
                'string',
            ],
            'ServiceLinkVirtualInterfaceIds': [
                'string',
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • OutpostLags (list) –

    The Outpost LAGs.

    • (dict) –

      Describes an Outpost link aggregation group (LAG).

      • OutpostArn (string) –

        The Amazon Resource Number (ARN) of the Outpost LAG.

      • OwnerId (string) –

        The ID of the Outpost LAG owner.

      • State (string) –

        The current state of the Outpost LAG.

      • OutpostLagId (string) –

        The ID of the Outpost LAG.

      • LocalGatewayVirtualInterfaceIds (list) –

        The IDs of the local gateway virtual interfaces associated with the Outpost LAG.

        • (string) –

      • ServiceLinkVirtualInterfaceIds (list) –

        The service link virtual interface IDs associated with the Outpost LAG.

        • (string) –

      • Tags (list) –

        The tags associated with the Outpost LAG.

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

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