Skip to content

delete_db_instance 

delete_db_instance(
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_instance_identifier: Optional[String] = None,
) -> DeleteDBInstanceResult

Deletes a previously provisioned instance.

Parameters:

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

    The instance identifier for the instance to be deleted. This parameter isn't case sensitive.

    Constraints:

    • Must match the name of an existing instance.

Raises:

Source code in docs_src/capo_docdb/_services/doc_db.py 
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
def delete_db_instance(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_instance_identifier: Optional["capo_docdb.types.string.String"] = None,
) -> "capo_docdb.types.delete_db_instance_result.DeleteDBInstanceResult":
    """<p>Deletes a previously provisioned instance.</p>

    Args:
        db_instance_identifier: <p>The instance identifier for the instance to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing instance.</p> </li> </ul>

    Raises:
        capo_docdb.errors.db_instance_not_found_fault.DBInstanceNotFoundFault: <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing instance. </p>
        capo_docdb.errors.db_snapshot_already_exists_fault.DBSnapshotAlreadyExistsFault: <p> <code>DBSnapshotIdentifier</code> is already being used by an existing snapshot. </p>
        capo_docdb.errors.invalid_db_cluster_state_fault.InvalidDBClusterStateFault: <p>The cluster isn't in a valid state.</p>
        capo_docdb.errors.invalid_db_instance_state_fault.InvalidDBInstanceStateFault: <p> The specified instance isn't in the <i>available</i> state. </p>
        capo_docdb.errors.snapshot_quota_exceeded_fault.SnapshotQuotaExceededFault: <p>The request would cause you to exceed the allowed number of snapshots.</p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb.types.delete_db_instance_message.DeleteDBInstanceMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.delete_db_instance_result.DeleteDBInstanceResult"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.delete_db_instance

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.delete_db_instance.delete_db_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDBInstance")
    )
    input_: capo_docdb.types.delete_db_instance_message.DeleteDBInstanceMessage = {}
    if db_instance_identifier is not None:
        input_["db_instance_identifier"] = db_instance_identifier

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