Module Values_1.DescribeDBSnapshotTenantDatabasesMessageSource

Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration. You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.

Sourcetype nonrec t = {
  1. dBInstanceIdentifier : Values_0.String_.t option;
    (*

    The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance.

    *)
  2. dBSnapshotIdentifier : Values_0.String_.t option;
    (*

    The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string. Constraints: If you specify this parameter, the value must match the ID of an existing DB snapshot. If you specify an automatic snapshot, you must also specify SnapshotType.

    *)
  3. snapshotType : Values_0.String_.t option;
    (*

    The type of DB snapshots to be returned. You can specify one of the following values: automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. manual – All DB snapshots that have been taken by my Amazon Web Services account. shared – All manual DB snapshots that have been shared to my Amazon Web Services account. public – All DB snapshots that have been marked as public. awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.

    *)
  4. filters : Values_0.FilterList.t option;
    (*

    A filter that specifies one or more tenant databases to describe. Supported filters: tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots. dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). db-snapshot-id - Accepts DB snapshot identifiers. snapshot-type - Accepts types of DB snapshots.

    *)
  5. maxRecords : Values_0.IntegerOptional.t option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    *)
  6. marker : Values_0.String_.t option;
    (*

    An optional pagination token provided by a previous DescribeDBSnapshotTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  7. dbiResourceId : Values_0.String_.t option;
    (*

    A specific DB resource identifier to describe.

    *)
}
Sourceval make : ?dBInstanceIdentifier:??? -> ?dBSnapshotIdentifier:??? -> ?snapshotType:??? -> ?filters:??? -> ?maxRecords:??? -> ?marker:??? -> ?dbiResourceId:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Values_0.IntegerOptional.t | `List of [> `Structure of (string * [> `List of [> `String of string ] list | `String of string ]) list ] list | `String of Values_0.String_.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t