EC2 / Client / describe_local_gateway_virtual_interface_groups

describe_local_gateway_virtual_interface_groups

EC2.Client.describe_local_gateway_virtual_interface_groups(**kwargs)

Describes the specified local gateway virtual interface groups.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• LocalGatewayVirtualInterfaceGroupIds (list) –

  The IDs of the virtual interface groups.

  • (string) –

• Filters (list) –

  One or more filters.

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

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

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

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

{
    'LocalGatewayVirtualInterfaceGroups': [
        {
            'LocalGatewayVirtualInterfaceGroupId': 'string',
            'LocalGatewayVirtualInterfaceIds': [
                'string',
            ],
            'LocalGatewayId': 'string',
            'OwnerId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • LocalGatewayVirtualInterfaceGroups (list) –

    The virtual interface groups.

    • (dict) –

      Describes a local gateway virtual interface group.

      • LocalGatewayVirtualInterfaceGroupId (string) –

        The ID of the virtual interface group.

      • LocalGatewayVirtualInterfaceIds (list) –

        The IDs of the virtual interfaces.

        • (string) –

      • LocalGatewayId (string) –

        The ID of the local gateway.

      • OwnerId (string) –

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

      • Tags (list) –

        The tags assigned to the virtual interface group.

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