Skip to content

disable_ipam_organization_admin_account

disable_ipam_organization_admin_account(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    delegated_admin_account_id: Optional[String] = None,
) -> DisableIpamOrganizationAdminAccountResult

Disable the IPAM account. For more information, see Enable integration with Organizations 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.

  • delegated_admin_account_id (Optional[String], default: None ) –

    The Organizations member account ID that you want to disable as IPAM account.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def disable_ipam_organization_admin_account(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    delegated_admin_account_id: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.disable_ipam_organization_admin_account_result.DisableIpamOrganizationAdminAccountResult":
    """<p>Disable the IPAM account. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html">Enable integration with Organizations</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>
        delegated_admin_account_id: <p>The Organizations member account ID that you want to disable as IPAM account.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.disable_ipam_organization_admin_account_request.DisableIpamOrganizationAdminAccountRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.disable_ipam_organization_admin_account_result.DisableIpamOrganizationAdminAccountResult"
    ]:
        import capo_ec2._operations.amazon_ec2.disable_ipam_organization_admin_account

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisableIpamOrganizationAdminAccount")
    )
    input_: capo_ec2.types.disable_ipam_organization_admin_account_request.DisableIpamOrganizationAdminAccountRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if delegated_admin_account_id is not None:
        input_["delegated_admin_account_id"] = delegated_admin_account_id

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