DocDB / Client / delete_db_instance

delete_db_instance

DocDB.Client.delete_db_instance(**kwargs)

Deletes a previously provisioned instance.

See also: AWS API Documentation

Request Syntax

response = client.delete_db_instance(
    DBInstanceIdentifier='string'
)

Parameters:

DBInstanceIdentifier (string) –

[REQUIRED]

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

Constraints:

• Must match the name of an existing instance.

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ],
            'DBSubnetGroupArn': 'string'
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'DBInstanceClass': 'string',
            'AllocatedStorage': 123,
            'MasterUserPassword': 'string',
            'Port': 123,
            'BackupRetentionPeriod': 123,
            'MultiAZ': True|False,
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'Iops': 123,
            'DBInstanceIdentifier': 'string',
            'StorageType': 'string',
            'CACertificateIdentifier': 'string',
            'DBSubnetGroupName': 'string',
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            }
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'PubliclyAccessible': True|False,
        'StatusInfos': [
            {
                'StatusType': 'string',
                'Normal': True|False,
                'Status': 'string',
                'Message': 'string'
            },
        ],
        'DBClusterIdentifier': 'string',
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DbiResourceId': 'string',
        'CACertificateIdentifier': 'string',
        'CopyTagsToSnapshot': True|False,
        'PromotionTier': 123,
        'DBInstanceArn': 'string',
        'EnabledCloudwatchLogsExports': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • DBInstance (dict) –

    Detailed information about an instance.

    • DBInstanceIdentifier (string) –

      Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

    • DBInstanceClass (string) –

      Contains the name of the compute and memory capacity class of the instance.

    • Engine (string) –

      Provides the name of the database engine to be used for this instance.

    • DBInstanceStatus (string) –

      Specifies the current state of this database.

    • Endpoint (dict) –

      Specifies the connection endpoint.

      • Address (string) –

        Specifies the DNS address of the instance.

      • Port (integer) –

        Specifies the port that the database engine is listening on.

      • HostedZoneId (string) –

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    • InstanceCreateTime (datetime) –

      Provides the date and time that the instance was created.

    • PreferredBackupWindow (string) –

      Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    • BackupRetentionPeriod (integer) –

      Specifies the number of days for which automatic snapshots are retained.

    • VpcSecurityGroups (list) –

      Provides a list of VPC security group elements that the instance belongs to.

      • (dict) –

        Used as a response element for queries on virtual private cloud (VPC) security group membership.

        • VpcSecurityGroupId (string) –

          The name of the VPC security group.

        • Status (string) –

          The status of the VPC security group.

    • AvailabilityZone (string) –

      Specifies the name of the Availability Zone that the instance is located in.

    • DBSubnetGroup (dict) –

      Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

      • DBSubnetGroupName (string) –

        The name of the subnet group.

      • DBSubnetGroupDescription (string) –

        Provides the description of the subnet group.

      • VpcId (string) –

        Provides the virtual private cloud (VPC) ID of the subnet group.

      • SubnetGroupStatus (string) –

        Provides the status of the subnet group.

      • Subnets (list) –

        Detailed information about one or more subnets within a subnet group.

        • (dict) –

          Detailed information about a subnet.

          • SubnetIdentifier (string) –

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone (dict) –

            Specifies the Availability Zone for the subnet.

            • Name (string) –

              The name of the Availability Zone.

          • SubnetStatus (string) –

            Specifies the status of the subnet.

      • DBSubnetGroupArn (string) –

        The Amazon Resource Name (ARN) for the DB subnet group.

    • PreferredMaintenanceWindow (string) –

      Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • PendingModifiedValues (dict) –

      Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

      • DBInstanceClass (string) –

        Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

      • AllocatedStorage (integer) –

        Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

      • MasterUserPassword (string) –

        Contains the pending or currently in-progress change of the master credentials for the instance.

      • Port (integer) –

        Specifies the pending port for the instance.

      • BackupRetentionPeriod (integer) –

        Specifies the pending number of days for which automated backups are retained.

      • MultiAZ (boolean) –

        Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

      • EngineVersion (string) –

        Indicates the database engine version.

      • LicenseModel (string) –

        The license model for the instance.

        Valid values: license-included, bring-your-own-license, general-public-license

      • Iops (integer) –

        Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

      • DBInstanceIdentifier (string) –

        Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

      • StorageType (string) –

        Specifies the storage type to be associated with the instance.

      • CACertificateIdentifier (string) –

        Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

      • DBSubnetGroupName (string) –

        The new subnet group for the instance.

      • PendingCloudwatchLogsExports (dict) –

        A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

        • LogTypesToEnable (list) –

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.

          • (string) –

        • LogTypesToDisable (list) –

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

          • (string) –

    • LatestRestorableTime (datetime) –

      Specifies the latest time to which a database can be restored with point-in-time restore.

    • EngineVersion (string) –

      Indicates the database engine version.

    • AutoMinorVersionUpgrade (boolean) –

      Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    • PubliclyAccessible (boolean) –

      Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

    • StatusInfos (list) –

      The status of a read replica. If the instance is not a read replica, this is blank.

      • (dict) –

        Provides a list of status information for an instance.

        • StatusType (string) –

          This value is currently “ read replication.”

        • Normal (boolean) –

          A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

        • Status (string) –

          Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

        • Message (string) –

          Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

    • DBClusterIdentifier (string) –

      Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

    • StorageEncrypted (boolean) –

      Specifies whether or not the instance is encrypted.

    • KmsKeyId (string) –

      If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

    • DbiResourceId (string) –

      The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

    • CACertificateIdentifier (string) –

      The identifier of the CA certificate for this DB instance.

    • CopyTagsToSnapshot (boolean) –

      A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    • PromotionTier (integer) –

      A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    • DBInstanceArn (string) –

      The Amazon Resource Name (ARN) for the instance.

    • EnabledCloudwatchLogsExports (list) –

      A list of log types that this instance is configured to export to CloudWatch Logs.

      • (string) –

Exceptions

• DocDB.Client.exceptions.DBInstanceNotFoundFault

• DocDB.Client.exceptions.InvalidDBInstanceStateFault

• DocDB.Client.exceptions.DBSnapshotAlreadyExistsFault

• DocDB.Client.exceptions.SnapshotQuotaExceededFault

• DocDB.Client.exceptions.InvalidDBClusterStateFault