EC2 / Client / describe_managed_prefix_lists

describe_managed_prefix_lists

EC2.Client.describe_managed_prefix_lists(**kwargs)

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

To view the entries for your prefix list, use GetManagedPrefixListEntries.

See also: AWS API Documentation

Request Syntax

response = client.describe_managed_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.

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

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

  • prefix-list-name - The name of the 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': [
        {
            'PrefixListId': 'string',
            'AddressFamily': 'string',
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
            'StateMessage': 'string',
            'PrefixListArn': 'string',
            'PrefixListName': 'string',
            'MaxEntries': 123,
            'Version': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'OwnerId': '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) –

    Information about the prefix lists.

    • (dict) –

      Describes a managed prefix list.

      • PrefixListId (string) –

        The ID of the prefix list.

      • AddressFamily (string) –

        The IP address version.

      • State (string) –

        The current state of the prefix list.

      • StateMessage (string) –

        The state message.

      • PrefixListArn (string) –

        The Amazon Resource Name (ARN) for the prefix list.

      • PrefixListName (string) –

        The name of the prefix list.

      • MaxEntries (integer) –

        The maximum number of entries for the prefix list.

      • Version (integer) –

        The version of the prefix list.

      • Tags (list) –

        The tags for the prefix list.

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

      • OwnerId (string) –

        The ID of the owner of the prefix list.