RDS / Client / delete_tenant_database
delete_tenant_database#
- RDS.Client.delete_tenant_database(**kwargs)#
Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can’t delete a tenant database when it is the only tenant in the DB instance.
See also: AWS API Documentation
Request Syntax
response = client.delete_tenant_database( DBInstanceIdentifier='string', TenantDBName='string', SkipFinalSnapshot=True|False, FinalDBSnapshotIdentifier='string' )
- Parameters:
DBInstanceIdentifier (string) –
[REQUIRED]
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
TenantDBName (string) –
[REQUIRED]
The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.
SkipFinalSnapshot (boolean) – Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn’t create a DB snapshot. If you don’t enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn’t skip the final snapshot. If you don’t enable this parameter, you must specify the
FinalDBSnapshotIdentifier
parameter.FinalDBSnapshotIdentifier (string) –
The
DBSnapshotIdentifier
of the newDBSnapshot
created when theSkipFinalSnapshot
parameter is disabled.Note
If you enable this parameter and also enable
SkipFinalShapshot
, the command results in an error.
- Return type:
dict
- Returns:
Response Syntax
{ 'TenantDatabase': { 'TenantDatabaseCreateTime': datetime(2015, 1, 1), 'DBInstanceIdentifier': 'string', 'TenantDBName': 'string', 'Status': 'string', 'MasterUsername': 'string', 'DbiResourceId': 'string', 'TenantDatabaseResourceId': 'string', 'TenantDatabaseARN': 'string', 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'DeletionProtection': True|False, 'PendingModifiedValues': { 'MasterUserPassword': 'string', 'TenantDBName': 'string' }, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } }
Response Structure
(dict) –
TenantDatabase (dict) –
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.TenantDatabaseCreateTime (datetime) –
The creation time of the tenant database.
DBInstanceIdentifier (string) –
The ID of the DB instance that contains the tenant database.
TenantDBName (string) –
The database name of the tenant database.
Status (string) –
The status of the tenant database.
MasterUsername (string) –
The master username of the tenant database.
DbiResourceId (string) –
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
TenantDatabaseResourceId (string) –
The Amazon Web Services Region-unique, immutable identifier for the tenant database.
TenantDatabaseARN (string) –
The Amazon Resource Name (ARN) for the tenant database.
CharacterSetName (string) –
The character set of the tenant database.
NcharCharacterSetName (string) –
The
NCHAR
character set name of the tenant database.DeletionProtection (boolean) –
Specifies whether deletion protection is enabled for the DB instance.
PendingModifiedValues (dict) –
Information about pending changes for a tenant database.
MasterUserPassword (string) –
The master password for the tenant database.
TenantDBName (string) –
The name of the tenant database.
TagList (list) –
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) –
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Key (string) –
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Value (string) –
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFault
RDS.Client.exceptions.TenantDatabaseNotFoundFault
RDS.Client.exceptions.InvalidDBInstanceStateFault