get_ipam_resource_cidrs ¶

def get_ipam_resource_cidrs(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = 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.ipam_max_results.IpamMaxResults"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    ipam_scope_id: Optional["capo_ec2.types.ipam_scope_id.IpamScopeId"] = None,
    ipam_pool_id: Optional["capo_ec2.types.ipam_pool_id.IpamPoolId"] = None,
    resource_id: Optional["capo_ec2.types.string.String"] = None,
    resource_type: Optional[
        "capo_ec2.types.ipam_resource_type.IpamResourceType"
    ] = None,
    resource_tag: Optional[
        "capo_ec2.types.request_ipam_resource_tag.RequestIpamResourceTag"
    ] = None,
    resource_owner: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.get_ipam_resource_cidrs_result.GetIpamResourceCidrsResult":
    """<p>Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. 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>
        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>
        max_results: <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        next_token: <p>The token for the next page of results.</p>
        ipam_scope_id: <p>The ID of the scope that the resource is in.</p>
        ipam_pool_id: <p>The ID of the IPAM pool that the resource is in.</p>
        resource_id: <p>The ID of the resource.</p>
        resource_type: <p>The resource type.</p>
        resource_tag: <p>The resource tag.</p>
        resource_owner: <p>The ID of the Amazon Web Services account that owns the resource.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_ipam_resource_cidrs_request.GetIpamResourceCidrsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_ipam_resource_cidrs_result.GetIpamResourceCidrsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_resource_cidrs

        output, http_response = (
            capo_ec2._operations.amazon_ec2.get_ipam_resource_cidrs.get_ipam_resource_cidrs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIpamResourceCidrs")
    )
    input_: capo_ec2.types.get_ipam_resource_cidrs_request.GetIpamResourceCidrsRequest = {}
    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 ipam_scope_id is not None:
        input_["ipam_scope_id"] = ipam_scope_id
    if ipam_pool_id is not None:
        input_["ipam_pool_id"] = ipam_pool_id
    if resource_id is not None:
        input_["resource_id"] = resource_id
    if resource_type is not None:
        input_["resource_type"] = resource_type
    if resource_tag is not None:
        input_["resource_tag"] = resource_tag
    if resource_owner is not None:
        input_["resource_owner"] = resource_owner

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output