GetTransitGatewayPrefixListReferences¶

class EC2.Paginator.GetTransitGatewayPrefixListReferences¶

paginator = client.get_paginator('get_transit_gateway_prefix_list_references')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EC2.Client.get_transit_gateway_prefix_list_references().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TransitGatewayRouteTableId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

TransitGatewayRouteTableId (string) --
[REQUIRED]

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) --
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 .
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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'
            }
        },
    ],

}

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.

Table Of Contents

GetTransitGatewayPrefixListReferences¶