delete_ipam_scope `async` ¶

delete_ipam_scope(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_scope_id: Optional[IpamScopeId] = None,
) -> DeleteIpamScopeResult

Delete the scope for an IPAM. You cannot delete the default scopes.

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.

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_scope_id (Optional[IpamScopeId], default: None ) –

The ID of the scope to delete.

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 delete_ipam_scope(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_scope_id: Optional["capo_ec2.types.ipam_scope_id.IpamScopeId"] = None,
) -> "capo_ec2.types.delete_ipam_scope_result.DeleteIpamScopeResult":
    """<p>Delete the scope for an IPAM. You cannot delete the default scopes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html">Delete a scope</a> in the <i>Amazon VPC IPAM User Guide</i>. </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_scope_id: <p>The ID of the scope to delete.</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.delete_ipam_scope_request.DeleteIpamScopeRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.delete_ipam_scope_result.DeleteIpamScopeResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_ipam_scope

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIpamScope")
    )
    input_: capo_ec2.types.delete_ipam_scope_request.DeleteIpamScopeRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_scope_id is not None:
        input_["ipam_scope_id"] = ipam_scope_id

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

delete_ipam_scope async ¶

delete_ipam_scope `async` ¶