Skip to content

EC2  >  Operations  >  describe_prefix_lists

describe_prefix_lists

Operation

describe_prefix_lists async

describe_prefix_lists(request: DescribePrefixListsInput | DescribePrefixListsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribePrefixListsOutput
describe_prefix_lists(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePrefixListsInputDict]) -> DescribePrefixListsOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribePrefixListsOutput

An instance of DescribePrefixListsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribePrefixListsInput dataclass

Bases: _SerdeShape

Dataclass for DescribePrefixListsInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters.

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

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

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

prefix_list_ids class-attribute instance-attribute
prefix_list_ids: list[str] | None = ...

One or more prefix list IDs.

Dictionaries

DescribePrefixListsInputDict

Bases: TypedDict

Dictionary form of DescribePrefixListsInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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 instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters.

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

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

max_results instance-attribute
max_results: int | None

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

prefix_list_ids instance-attribute
prefix_list_ids: Sequence[str] | None

One or more prefix list IDs.

Output

DescribePrefixListsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribePrefixListsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

prefix_lists class-attribute instance-attribute
prefix_lists: list[PrefixList] | None = ...

All available prefix lists.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.