Skip to content

describe_ipam_external_resource_verification_tokens async

describe_ipam_external_resource_verification_tokens(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[IpamMaxResults] = None,
    ipam_external_resource_verification_token_ids: Optional[ValueStringList] = None,
) -> DescribeIpamExternalResourceVerificationTokensResult

Describe verification tokens.

A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    A check for 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 for the request. For more information about filtering, see Filtering CLI output.

    Available filters:

    • ipam-arn

    • ipam-external-resource-verification-token-arn

    • ipam-external-resource-verification-token-id

    • ipam-id

    • ipam-region

    • state

    • status

    • token-name

    • token-value

  • next_token (Optional[NextToken], default: None ) –

    The token for the next page of results.

  • max_results (Optional[IpamMaxResults], default: None ) –

    The maximum number of tokens to return in one page of results.

  • ipam_external_resource_verification_token_ids (Optional[ValueStringList], default: None ) –

    Verification token IDs.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_ipam_external_resource_verification_tokens(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
    ipam_external_resource_verification_token_ids: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
) -> "capo_ec2.types.describe_ipam_external_resource_verification_tokens_result.DescribeIpamExternalResourceVerificationTokensResult":
    """<p>Describe verification tokens.</p> <p>A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP). </p>

    Args:
        dry_run: <p>A check for 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 for the request. For more information about filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Filtering CLI output</a>.</p> <p>Available filters:</p> <ul> <li> <p> <code>ipam-arn</code> </p> </li> <li> <p> <code>ipam-external-resource-verification-token-arn</code> </p> </li> <li> <p> <code>ipam-external-resource-verification-token-id</code> </p> </li> <li> <p> <code>ipam-id</code> </p> </li> <li> <p> <code>ipam-region</code> </p> </li> <li> <p> <code>state</code> </p> </li> <li> <p> <code>status</code> </p> </li> <li> <p> <code>token-name</code> </p> </li> <li> <p> <code>token-value</code> </p> </li> </ul>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of tokens to return in one page of results.</p>
        ipam_external_resource_verification_token_ids: <p>Verification token 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_ipam_external_resource_verification_tokens_request.DescribeIpamExternalResourceVerificationTokensRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_ipam_external_resource_verification_tokens_result.DescribeIpamExternalResourceVerificationTokensResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_ipam_external_resource_verification_tokens

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeIpamExternalResourceVerificationTokens"),
    )
    input_: capo_ec2.types.describe_ipam_external_resource_verification_tokens_request.DescribeIpamExternalResourceVerificationTokensRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if ipam_external_resource_verification_token_ids is not None:
        input_["ipam_external_resource_verification_token_ids"] = (
            ipam_external_resource_verification_token_ids
        )

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