EC2 / Client / describe_trunk_interface_associations

describe_trunk_interface_associations

EC2.Client.describe_trunk_interface_associations(**kwargs)

Note

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Describes one or more network interface trunk associations.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AssociationIds (list) –

  The IDs of the associations.

  • (string) –

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

• Filters (list) –

  One or more filters.

  • gre-key - The ID of a trunk interface association.

  • interface-protocol - The interface protocol. Valid values are VLAN and GRE.

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

    • 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) –

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

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

Return type:

dict

Returns:

Response Syntax

{
    'InterfaceAssociations': [
        {
            'AssociationId': 'string',
            'BranchInterfaceId': 'string',
            'TrunkInterfaceId': 'string',
            'InterfaceProtocol': 'VLAN'|'GRE',
            'VlanId': 123,
            'GreKey': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • InterfaceAssociations (list) –

    Information about the trunk associations.

    • (dict) –

      Note

      Currently available in limited preview only. If you are interested in using this feature, contact your account manager.

      Information about an association between a branch network interface with a trunk network interface.

      • AssociationId (string) –

        The ID of the association.

      • BranchInterfaceId (string) –

        The ID of the branch network interface.

      • TrunkInterfaceId (string) –

        The ID of the trunk network interface.

      • InterfaceProtocol (string) –

        The interface protocol. Valid values are VLAN and GRE.

      • VlanId (integer) –

        The ID of the VLAN when you use the VLAN protocol.

      • GreKey (integer) –

        The application key when you use the GRE protocol.

      • Tags (list) –

        The tags for the trunk interface association.

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