delete_instance ¶

delete_instance(
    instance_arn: InstanceArn,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> DeleteInstanceResponse

Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.

Parameters:

instance_arn (InstanceArn) –

The ARN of the instance of IAM Identity Center under which the operation will run.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
InternalServerException –

The request processing has failed because of an unknown error, exception, or failure with an internal server.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sso_admin/_services/sso_admin.py

def delete_instance(
    self,
    instance_arn: "capo_sso_admin.types.instance_arn.InstanceArn",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> "capo_sso_admin.types.delete_instance_response.DeleteInstanceResponse":
    """<p>Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.</p>

    Args:
        instance_arn: <p>The ARN of the instance of IAM Identity Center under which the operation will run.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sso_admin.types.delete_instance_request.DeleteInstanceRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.delete_instance_response.DeleteInstanceResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.delete_instance

        output, http_response = (
            capo_sso_admin._operations.swb_external_service.delete_instance.delete_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteInstance")
    )
    input_: capo_sso_admin.types.delete_instance_request.DeleteInstanceRequest = {
        "instance_arn": instance_arn
    }

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