Skip to content

get_managed_prefix_list_entries async

get_managed_prefix_list_entries(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    prefix_list_id: Optional[PrefixListResourceId] = None,
    target_version: Optional[Long] = None,
    max_results: Optional[PrefixListMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> GetManagedPrefixListEntriesResult

Gets information about the entries for a specified managed prefix list.

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.

  • prefix_list_id (Optional[PrefixListResourceId], default: None ) –

    The ID of the prefix list.

  • target_version (Optional[Long], default: None ) –

    The version of the prefix list for which to return the entries. The default is the current version.

  • max_results (Optional[PrefixListMaxResults], 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[NextToken], default: None ) –

    The token for the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def get_managed_prefix_list_entries(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    prefix_list_id: Optional[
        "capo_ec2.types.prefix_list_resource_id.PrefixListResourceId"
    ] = None,
    target_version: Optional["capo_ec2.types.long.Long"] = None,
    max_results: Optional[
        "capo_ec2.types.prefix_list_max_results.PrefixListMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.get_managed_prefix_list_entries_result.GetManagedPrefixListEntriesResult":
    """<p>Gets information about the entries for a specified managed prefix list.</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>
        prefix_list_id: <p>The ID of the prefix list.</p>
        target_version: <p>The version of the prefix list for which to return the entries. The default is the current version.</p>
        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>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.get_managed_prefix_list_entries_request.GetManagedPrefixListEntriesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.get_managed_prefix_list_entries_result.GetManagedPrefixListEntriesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_managed_prefix_list_entries

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetManagedPrefixListEntries")
    )
    input_: capo_ec2.types.get_managed_prefix_list_entries_request.GetManagedPrefixListEntriesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if prefix_list_id is not None:
        input_["prefix_list_id"] = prefix_list_id
    if target_version is not None:
        input_["target_version"] = target_version
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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