EC2 / Client / describe_prefix_lists

describe_prefix_lists

EC2.Client.describe_prefix_lists(**kwargs)

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.

We recommend that you use DescribeManagedPrefixLists instead.

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

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

• PrefixListIds (list) –

  One or more prefix list IDs.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'PrefixLists': [
        {
            'Cidrs': [
                'string',
            ],
            'PrefixListId': 'string',
            'PrefixListName': 'string'
        },
    ]
}

Response Structure

• (dict) –

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

  • PrefixLists (list) –

    All available prefix lists.

    • (dict) –

      Describes prefixes for Amazon Web Services services.

      • Cidrs (list) –

        The IP address range of the Amazon Web Service.

        • (string) –

      • PrefixListId (string) –

        The ID of the prefix.

      • PrefixListName (string) –

        The name of the prefix.