describe_ipam_resource_discoveries `async` ¶

describe_ipam_resource_discoveries(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_resource_discovery_ids: Optional[ValueStringList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[IpamMaxResults] = None,
    filters: Optional[FilterList] = None,
) -> DescribeIpamResourceDiscoveriesResult

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

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.
ipam_resource_discovery_ids (Optional[ValueStringList], default: None ) –

The IPAM resource discovery IDs.
next_token (Optional[NextToken], default: None ) –

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

The maximum number of resource discoveries to return in one page of results.
filters (Optional[FilterList], default: None ) –

The resource discovery filters.

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_ipam_resource_discoveries(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_resource_discovery_ids: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_ipam_resource_discoveries_result.DescribeIpamResourceDiscoveriesResult":
    """<p>Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</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>
        ipam_resource_discovery_ids: <p>The IPAM resource discovery IDs.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of resource discoveries to return in one page of results.</p>
        filters: <p>The resource discovery filters.</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_resource_discoveries_request.DescribeIpamResourceDiscoveriesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_ipam_resource_discoveries_result.DescribeIpamResourceDiscoveriesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_ipam_resource_discoveries

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIpamResourceDiscoveries")
    )
    input_: capo_ec2.types.describe_ipam_resource_discoveries_request.DescribeIpamResourceDiscoveriesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_resource_discovery_ids is not None:
        input_["ipam_resource_discovery_ids"] = ipam_resource_discovery_ids
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters

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

describe_ipam_resource_discoveries async ¶

describe_ipam_resource_discoveries `async` ¶