Skip to content

GetIpamResourceCidrsRequest

Source code in docs_src/capo_ec2/types/get_ipam_resource_cidrs_request.py
class GetIpamResourceCidrsRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<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: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<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: NotRequired["capo_ec2.types.ipam_max_results.IpamMaxResults"]
    """<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: NotRequired["capo_ec2.types.next_token.NextToken"]
    """<p>The token for the next page of results.</p>"""
    ipam_scope_id: NotRequired["capo_ec2.types.ipam_scope_id.IpamScopeId"]
    """<p>The ID of the scope that the resource is in.</p>"""
    ipam_pool_id: NotRequired["capo_ec2.types.ipam_pool_id.IpamPoolId"]
    """<p>The ID of the IPAM pool that the resource is in.</p>"""
    resource_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the resource.</p>"""
    resource_type: NotRequired["capo_ec2.types.ipam_resource_type.IpamResourceType"]
    """<p>The resource type.</p>"""
    resource_tag: NotRequired[
        "capo_ec2.types.request_ipam_resource_tag.RequestIpamResourceTag"
    ]
    """<p>The resource tag.</p>"""
    resource_owner: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Amazon Web Services account that owns the resource.</p>"""

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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 instance-attribute

filters: NotRequired[FilterList]

One or more filters for the request. For more information about filtering, see Filtering CLI output.

ipam_pool_id instance-attribute

ipam_pool_id: NotRequired[IpamPoolId]

The ID of the IPAM pool that the resource is in.

ipam_scope_id instance-attribute

ipam_scope_id: NotRequired[IpamScopeId]

The ID of the scope that the resource is in.

max_results instance-attribute

max_results: NotRequired[IpamMaxResults]

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 Pagination.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for the next page of results.

resource_id instance-attribute

resource_id: NotRequired[String]

The ID of the resource.

resource_owner instance-attribute

resource_owner: NotRequired[String]

The ID of the Amazon Web Services account that owns the resource.

resource_tag instance-attribute

resource_tag: NotRequired[RequestIpamResourceTag]

The resource tag.

resource_type instance-attribute

resource_type: NotRequired[IpamResourceType]

The resource type.