EC2 / Client / get_transit_gateway_prefix_list_references



Gets information about the prefix list references in a specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

response = client.get_transit_gateway_prefix_list_references(
            'Name': 'string',
            'Values': [
  • TransitGatewayRouteTableId (string) –


    The ID of the transit gateway route table.

  • Filters (list) –

    One or more filters. The possible values are:

    • attachment.resource-id - The ID of the resource for the attachment.

    • attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.

    • attachment.transit-gateway-attachment-id - The ID of the attachment.

    • is-blackhole - Whether traffic matching the route is blocked ( true | false).

    • prefix-list-id - The ID of the prefix list.

    • prefix-list-owner-id - The ID of the owner of the prefix list.

    • state - The state of the prefix list reference ( pending | available | modifying | deleting).

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

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



Response Syntax

    'TransitGatewayPrefixListReferences': [
            'TransitGatewayRouteTableId': 'string',
            'PrefixListId': 'string',
            'PrefixListOwnerId': 'string',
            'State': 'pending'|'available'|'modifying'|'deleting',
            'Blackhole': True|False,
            'TransitGatewayAttachment': {
                'TransitGatewayAttachmentId': 'string',
                'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
                'ResourceId': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • TransitGatewayPrefixListReferences (list) –

      Information about the prefix list references.

      • (dict) –

        Describes a prefix list reference.

        • TransitGatewayRouteTableId (string) –

          The ID of the transit gateway route table.

        • PrefixListId (string) –

          The ID of the prefix list.

        • PrefixListOwnerId (string) –

          The ID of the prefix list owner.

        • State (string) –

          The state of the prefix list reference.

        • Blackhole (boolean) –

          Indicates whether traffic that matches this route is dropped.

        • TransitGatewayAttachment (dict) –

          Information about the transit gateway attachment.

          • TransitGatewayAttachmentId (string) –

            The ID of the attachment.

          • ResourceType (string) –

            The resource type. Note that the tgw-peering resource type has been deprecated.

          • ResourceId (string) –

            The ID of the resource.

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