describe_prefix_lists `async` ¶

describe_prefix_lists(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
    prefix_list_ids: Optional[PrefixListResourceIdStringList] = None,
) -> DescribePrefixListsResult

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:

dry_run (Optional[Boolean], default: 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 (Optional[FilterList], default: 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 (Optional[Integer], default: 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 (Optional[String], default: None ) –

The token for the next page of results.
prefix_list_ids (Optional[PrefixListResourceIdStringList], default: None ) –

One or more prefix list IDs.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def describe_prefix_lists(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    prefix_list_ids: Optional[
        "capo_ec2.types.prefix_list_resource_id_string_list.PrefixListResourceIdStringList"
    ] = None,
) -> "capo_ec2.types.describe_prefix_lists_result.DescribePrefixListsResult":
    """<p>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.</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        filters: <p>One or more filters.</p> <ul> <li> <p> <code>prefix-list-id</code>: The ID of a prefix list.</p> </li> <li> <p> <code>prefix-list-name</code>: The name of a prefix list.</p> </li> </ul>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</p>
        prefix_list_ids: <p>One or more prefix list IDs.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_prefix_lists_request.DescribePrefixListsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_prefix_lists_result.DescribePrefixListsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_prefix_lists

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_prefix_lists.async_describe_prefix_lists(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePrefixLists")
    )
    input_: capo_ec2.types.describe_prefix_lists_request.DescribePrefixListsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if prefix_list_ids is not None:
        input_["prefix_list_ids"] = prefix_list_ids

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_prefix_lists async ¶

describe_prefix_lists `async` ¶