odb / Client / get_autonomous_database

get_autonomous_database

odb.Client.get_autonomous_database(**kwargs)

Gets information about a specific Autonomous Database.

See also: AWS API Documentation

Request Syntax

response = client.get_autonomous_database(
    autonomousDatabaseId='string'
)
Parameters:

autonomousDatabaseId (string) –

[REQUIRED]

The unique identifier of the Autonomous Database to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'autonomousDatabase': {
        'autonomousDatabaseId': 'string',
        'autonomousDatabaseArn': 'string',
        'ociResourceAnchorName': 'string',
        'percentProgress': ...,
        'ocid': 'string',
        'ociUrl': 'string',
        'displayName': 'string',
        'dbName': 'string',
        'sourceId': 'string',
        'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS'|'STOPPING'|'STOPPED'|'STARTING'|'UNAVAILABLE'|'RESTORE_IN_PROGRESS'|'RESTORE_FAILED'|'BACKUP_IN_PROGRESS'|'SCALE_IN_PROGRESS'|'AVAILABLE_NEEDS_ATTENTION'|'RESTARTING'|'RECREATING'|'ROLE_CHANGE_IN_PROGRESS'|'UPGRADING'|'INACCESSIBLE'|'STANDBY',
        'statusReason': 'string',
        'databaseType': 'REGULAR'|'CLONE',
        'dbVersion': 'string',
        'dbWorkload': 'OLTP'|'AJD'|'APEX'|'LH',
        'characterSet': 'string',
        'ncharacterSet': 'string',
        'databaseEdition': 'STANDARD_EDITION'|'ENTERPRISE_EDITION',
        'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
        'openMode': 'READ_ONLY'|'READ_WRITE',
        'permissionLevel': 'RESTRICTED'|'UNRESTRICTED',
        'isMtlsConnectionRequired': True|False,
        'autonomousMaintenanceScheduleType': 'EARLY'|'REGULAR',
        'netServicesArchitecture': 'DEDICATED'|'SHARED',
        'availableUpgradeVersions': [
            'string',
        ],
        'byolComputeCountLimit': 123,
        'connectionStringDetails': {
            'allConnectionStrings': {
                'string': 'string'
            },
            'dedicated': 'string',
            'high': 'string',
            'medium': 'string',
            'low': 'string',
            'profiles': [
                {
                    'consumerGroup': 'string',
                    'displayName': 'string',
                    'hostFormat': 'string',
                    'isRegional': True|False,
                    'protocol': 'string',
                    'sessionMode': 'string',
                    'syntaxFormat': 'string',
                    'tlsAuthentication': 'string',
                    'value': 'string'
                },
            ]
        },
        'serviceConsoleUrl': 'string',
        'sqlWebDeveloperUrl': 'string',
        'customerContacts': [
            {
                'email': 'string'
            },
        ],
        'apexDetails': {
            'apexVersion': 'string',
            'ordsVersion': 'string'
        },
        'standbyDb': {
            'availabilityDomain': 'string',
            'lagTimeInSeconds': 123,
            'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS'|'STOPPING'|'STOPPED'|'STARTING'|'UNAVAILABLE'|'RESTORE_IN_PROGRESS'|'RESTORE_FAILED'|'BACKUP_IN_PROGRESS'|'SCALE_IN_PROGRESS'|'AVAILABLE_NEEDS_ATTENTION'|'RESTARTING'|'RECREATING'|'ROLE_CHANGE_IN_PROGRESS'|'UPGRADING'|'INACCESSIBLE'|'STANDBY',
            'statusReason': 'string',
            'maintenanceTargetComponent': 'string',
            'timeDataGuardRoleChanged': datetime(2015, 1, 1),
            'timeDisasterRecoveryRoleChanged': datetime(2015, 1, 1),
            'timeMaintenanceBegin': datetime(2015, 1, 1),
            'timeMaintenanceEnd': datetime(2015, 1, 1)
        },
        'localStandbyDb': {
            'availabilityDomain': 'string',
            'lagTimeInSeconds': 123,
            'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS'|'STOPPING'|'STOPPED'|'STARTING'|'UNAVAILABLE'|'RESTORE_IN_PROGRESS'|'RESTORE_FAILED'|'BACKUP_IN_PROGRESS'|'SCALE_IN_PROGRESS'|'AVAILABLE_NEEDS_ATTENTION'|'RESTARTING'|'RECREATING'|'ROLE_CHANGE_IN_PROGRESS'|'UPGRADING'|'INACCESSIBLE'|'STANDBY',
            'statusReason': 'string',
            'maintenanceTargetComponent': 'string',
            'timeDataGuardRoleChanged': datetime(2015, 1, 1),
            'timeDisasterRecoveryRoleChanged': datetime(2015, 1, 1),
            'timeMaintenanceBegin': datetime(2015, 1, 1),
            'timeMaintenanceEnd': datetime(2015, 1, 1)
        },
        'dataSafeStatus': 'REGISTERING'|'REGISTERED'|'DEREGISTERING'|'NOT_REGISTERED'|'FAILED',
        'databaseManagementStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'NOT_ENABLED'|'FAILED_ENABLING'|'FAILED_DISABLING',
        'operationsInsightsStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'NOT_ENABLED'|'FAILED_ENABLING'|'FAILED_DISABLING',
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'maintenanceTargetComponent': 'string',
        'connectionUrls': {
            'apexUrl': 'string',
            'databaseTransformsUrl': 'string',
            'graphStudioUrl': 'string',
            'machineLearningNotebookUrl': 'string',
            'machineLearningUserManagementUrl': 'string',
            'mongoDbUrl': 'string',
            'ordsUrl': 'string',
            'spatialStudioUrl': 'string',
            'sqlDevWebUrl': 'string'
        },
        'dbToolsDetails': [
            {
                'isEnabled': True|False,
                'name': 'string',
                'computeCount': 123.0,
                'maxIdleTimeInMinutes': 123
            },
        ],
        'scheduledOperations': [
            {
                'dayOfWeek': {
                    'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
                },
                'scheduledStartTime': 'string',
                'scheduledStopTime': 'string'
            },
        ],
        'resourcePoolLeaderId': 'string',
        'computeCount': ...,
        'computeModel': 'ECPU'|'OCPU',
        'cpuCoreCount': 123,
        'memoryPerOracleComputeUnitInGBs': 123,
        'provisionableCpus': [
            123,
        ],
        'isAutoScalingEnabled': True|False,
        'dataStorageSizeInTBs': 123.0,
        'dataStorageSizeInGBs': 123,
        'usedDataStorageSizeInTBs': 123.0,
        'usedDataStorageSizeInGBs': 123,
        'actualUsedDataStorageSizeInTBs': 123.0,
        'allocatedStorageSizeInTBs': 123.0,
        'inMemoryAreaInGBs': 123,
        'isAutoScalingForStorageEnabled': True|False,
        'odbNetworkId': 'string',
        'odbNetworkArn': 'string',
        'privateEndpoint': 'string',
        'privateEndpointIp': 'string',
        'privateEndpointLabel': 'string',
        'allowlistedIps': [
            'string',
        ],
        'standbyAllowlistedIps': [
            'string',
        ],
        'standbyAllowlistedIpsSource': 'PRIMARY'|'SEPARATE'|'NOT_APPLICABLE',
        'isLocalDataGuardEnabled': True|False,
        'isRemoteDataGuardEnabled': True|False,
        'localDisasterRecoveryType': 'ADG'|'BACKUP_BASED',
        'role': 'PRIMARY'|'STANDBY'|'DISABLED_STANDBY'|'BACKUP_COPY'|'SNAPSHOT_STANDBY',
        'peerDbIds': [
            'string',
        ],
        'failedDataRecoveryInSeconds': 123,
        'localAdgAutoFailoverMaxDataLossLimit': 123,
        'remoteDisasterRecoveryConfiguration': {
            'disasterRecoveryType': 'ADG'|'BACKUP_BASED',
            'isReplicateAutomaticBackups': True|False,
            'isSnapshotStandby': True|False,
            'timeSnapshotStandbyEnabledTill': datetime(2015, 1, 1)
        },
        'isRefreshableClone': True|False,
        'refreshableMode': 'AUTOMATIC'|'MANUAL',
        'refreshableStatus': 'REFRESHING'|'NOT_REFRESHING',
        'autoRefreshFrequencyInSeconds': 123,
        'autoRefreshPointLagInSeconds': 123,
        'isReconnectCloneEnabled': True|False,
        'cloneTableSpaceList': [
            123,
        ],
        'backupRetentionPeriodInDays': 123,
        'longTermBackupSchedule': {
            'isDisabled': True|False,
            'repeatCadence': 'ONE_TIME'|'WEEKLY'|'MONTHLY'|'YEARLY',
            'retentionPeriodInDays': 123,
            'timeOfBackup': datetime(2015, 1, 1)
        },
        'isBackupRetentionLocked': True|False,
        'totalBackupStorageSizeInGBs': 123.0,
        'resourcePoolSummary': {
            'isDisabled': True|False,
            'poolSize': 123,
            'poolStorageSizeInTBs': 123,
            'availableStorageCapacityInTBs': 123.0,
            'totalComputeCapacity': 123,
            'availableComputeCapacity': 123
        },
        'encryptionSummary': {
            'encryptionKeyProvider': 'ORACLE_MANAGED'|'AWS_KMS'|'OKV'|'OCI',
            'encryptionKeyConfiguration': {
                'awsEncryptionKey': {
                    'iamRoleArn': 'string',
                    'externalIdType': 'database_ocid'|'compartment_ocid'|'tenant_ocid',
                    'kmsKeyId': 'string'
                },
                'ociEncryptionKey': {
                    'kmsKeyId': 'string',
                    'vaultId': 'string'
                },
                'okvEncryptionKey': {
                    'certificateDirectoryName': 'string',
                    'certificateId': 'string',
                    'directoryName': 'string',
                    'okvKmsKey': 'string',
                    'okvUri': 'string'
                }
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'timeOfLastBackup': datetime(2015, 1, 1),
        'timeMaintenanceBegin': datetime(2015, 1, 1),
        'timeMaintenanceEnd': datetime(2015, 1, 1),
        'timeLocalDataGuardEnabled': datetime(2015, 1, 1),
        'timeDataGuardRoleChanged': datetime(2015, 1, 1),
        'timeOfLastSwitchover': datetime(2015, 1, 1),
        'timeOfLastFailover': datetime(2015, 1, 1),
        'timeOfLastRefresh': datetime(2015, 1, 1),
        'timeOfLastRefreshPoint': datetime(2015, 1, 1),
        'timeOfNextRefresh': datetime(2015, 1, 1),
        'timeOfAutoRefreshStart': datetime(2015, 1, 1),
        'timeDeletionOfFreeAutonomousDatabase': datetime(2015, 1, 1),
        'timeReclamationOfFreeAutonomousDatabase': datetime(2015, 1, 1),
        'timeDisasterRecoveryRoleChanged': datetime(2015, 1, 1),
        'timeUntilReconnectCloneEnabled': datetime(2015, 1, 1),
        'nextLongTermBackupTimeStamp': datetime(2015, 1, 1),
        'timeUndeleted': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • autonomousDatabase (dict) –

      The details of the requested Autonomous Database.

      • autonomousDatabaseId (string) –

        The unique identifier of the Autonomous Database.

      • autonomousDatabaseArn (string) –

        The Amazon Resource Name (ARN) of the Autonomous Database.

      • ociResourceAnchorName (string) –

        The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with the Autonomous Database.

      • percentProgress (float) –

        The progress of the current operation on the Autonomous Database, as a percentage.

      • ocid (string) –

        The Oracle Cloud Identifier (OCID) of the Autonomous Database.

      • ociUrl (string) –

        The URL for accessing the OCI console page for the Autonomous Database.

      • displayName (string) –

        The user-friendly name of the Autonomous Database.

      • dbName (string) –

        The name of the Autonomous Database.

      • sourceId (string) –

        The unique identifier of the source from which the Autonomous Database was created.

      • status (string) –

        The current status of the Autonomous Database.

      • statusReason (string) –

        Additional information about the current status of the Autonomous Database, if applicable.

      • databaseType (string) –

        The type of the Autonomous Database, either a regular database or a clone.

      • dbVersion (string) –

        The Oracle Database software version of the Autonomous Database.

      • dbWorkload (string) –

        The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.

      • characterSet (string) –

        The character set of the Autonomous Database.

      • ncharacterSet (string) –

        The national character set of the Autonomous Database.

      • databaseEdition (string) –

        The Oracle Database edition of the Autonomous Database.

      • licenseModel (string) –

        The Oracle license model that applies to the Autonomous Database.

      • openMode (string) –

        The mode in which the Autonomous Database is open, either read-only or read/write.

      • permissionLevel (string) –

        The permission level of the Autonomous Database.

      • isMtlsConnectionRequired (boolean) –

        Indicates whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.

      • autonomousMaintenanceScheduleType (string) –

        The maintenance schedule type for the Autonomous Database.

      • netServicesArchitecture (string) –

        The Oracle Net Services architecture of the Autonomous Database, either dedicated or shared.

      • availableUpgradeVersions (list) –

        The list of Oracle Database software versions to which the Autonomous Database can be upgraded.

        • (string) –

      • byolComputeCountLimit (integer) –

        The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.

      • connectionStringDetails (dict) –

        The connection string details for the Autonomous Database.

        • allConnectionStrings (dict) –

          The list of all connection strings that you can use to connect to the Autonomous Database.

          • (string) –

            • (string) –

        • dedicated (string) –

          The connection string for connecting to the Autonomous Database with a dedicated service.

        • high (string) –

          The connection string for the high-priority database service.

        • medium (string) –

          The connection string for the medium-priority database service.

        • low (string) –

          The connection string for the low-priority database service.

        • profiles (list) –

          The list of connection string profiles for the Autonomous Database.

          • (dict) –

            A connection string profile for an Autonomous Database.

            • consumerGroup (string) –

              The consumer group associated with the connection string profile.

            • displayName (string) –

              The user-friendly name of the connection string profile.

            • hostFormat (string) –

              The host name format used in the connection string.

            • isRegional (boolean) –

              Indicates whether the connection string profile is regional.

            • protocol (string) –

              The protocol used by the connection string profile.

            • sessionMode (string) –

              The session mode of the connection string profile.

            • syntaxFormat (string) –

              The syntax format of the connection string profile.

            • tlsAuthentication (string) –

              The TLS authentication method used by the connection string profile.

            • value (string) –

              The connection string value of the profile.

      • serviceConsoleUrl (string) –

        The URL for accessing the Oracle service console for the Autonomous Database.

      • sqlWebDeveloperUrl (string) –

        The URL for accessing Oracle SQL Developer Web for the Autonomous Database.

      • customerContacts (list) –

        The list of customer contacts that receive operational notifications from Oracle for the Autonomous Database.

        • (dict) –

          A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.

          • email (string) –

            The email address of the contact.

      • apexDetails (dict) –

        The Oracle Application Express (APEX) details for the Autonomous Database.

        • apexVersion (string) –

          The Oracle Application Express (APEX) version of the Autonomous Database.

        • ordsVersion (string) –

          The Oracle REST Data Services (ORDS) version of the Autonomous Database.

      • standbyDb (dict) –

        The details of the standby Autonomous Database in a cross-Region Oracle Data Guard configuration.

        • availabilityDomain (string) –

          The availability domain of the standby Autonomous Database.

        • lagTimeInSeconds (integer) –

          The time lag, in seconds, between the standby database and the primary database.

        • status (string) –

          The current status of the standby Autonomous Database.

        • statusReason (string) –

          Additional information about the current status of the standby Autonomous Database, if applicable.

        • maintenanceTargetComponent (string) –

          The component on the standby Autonomous Database that the current maintenance is being applied to.

        • timeDataGuardRoleChanged (datetime) –

          The date and time when the Oracle Data Guard role of the standby database last changed.

        • timeDisasterRecoveryRoleChanged (datetime) –

          The date and time when the disaster recovery role of the standby database last changed.

        • timeMaintenanceBegin (datetime) –

          The date and time when the next maintenance of the standby database begins.

        • timeMaintenanceEnd (datetime) –

          The date and time when the next maintenance of the standby database ends.

      • localStandbyDb (dict) –

        The details of the local standby Autonomous Database in an Oracle Data Guard configuration.

        • availabilityDomain (string) –

          The availability domain of the standby Autonomous Database.

        • lagTimeInSeconds (integer) –

          The time lag, in seconds, between the standby database and the primary database.

        • status (string) –

          The current status of the standby Autonomous Database.

        • statusReason (string) –

          Additional information about the current status of the standby Autonomous Database, if applicable.

        • maintenanceTargetComponent (string) –

          The component on the standby Autonomous Database that the current maintenance is being applied to.

        • timeDataGuardRoleChanged (datetime) –

          The date and time when the Oracle Data Guard role of the standby database last changed.

        • timeDisasterRecoveryRoleChanged (datetime) –

          The date and time when the disaster recovery role of the standby database last changed.

        • timeMaintenanceBegin (datetime) –

          The date and time when the next maintenance of the standby database begins.

        • timeMaintenanceEnd (datetime) –

          The date and time when the next maintenance of the standby database ends.

      • dataSafeStatus (string) –

        The status of the Oracle Data Safe registration for the Autonomous Database.

      • databaseManagementStatus (string) –

        The status of Oracle Database Management for the Autonomous Database.

      • operationsInsightsStatus (string) –

        The status of Oracle Operations Insights for the Autonomous Database.

      • availabilityZone (string) –

        The Availability Zone where the Autonomous Database is located.

      • availabilityZoneId (string) –

        The unique identifier of the Availability Zone where the Autonomous Database is located.

      • maintenanceTargetComponent (string) –

        The component on the Autonomous Database that the current maintenance is being applied to.

      • connectionUrls (dict) –

        The connection URLs for accessing tools and services for the Autonomous Database.

        • apexUrl (string) –

          The URL for accessing Oracle Application Express (APEX) for the Autonomous Database.

        • databaseTransformsUrl (string) –

          The URL for accessing Oracle Database Transforms for the Autonomous Database.

        • graphStudioUrl (string) –

          The URL for accessing Oracle Graph Studio for the Autonomous Database.

        • machineLearningNotebookUrl (string) –

          The URL for accessing the Oracle Machine Learning notebook for the Autonomous Database.

        • machineLearningUserManagementUrl (string) –

          The URL for accessing Oracle Machine Learning user management for the Autonomous Database.

        • mongoDbUrl (string) –

          The URL for accessing the MongoDB API for the Autonomous Database.

        • ordsUrl (string) –

          The URL for accessing Oracle REST Data Services (ORDS) for the Autonomous Database.

        • spatialStudioUrl (string) –

          The URL for accessing Oracle Spatial Studio for the Autonomous Database.

        • sqlDevWebUrl (string) –

          The URL for accessing Oracle SQL Developer Web for the Autonomous Database.

      • dbToolsDetails (list) –

        The list of database management tools enabled for the Autonomous Database.

        • (dict) –

          Information about a database management tool for an Autonomous Database.

          • isEnabled (boolean) –

            Indicates whether the database management tool is enabled.

          • name (string) –

            The name of the database management tool.

          • computeCount (float) –

            The compute capacity allocated to the database management tool.

          • maxIdleTimeInMinutes (integer) –

            The maximum amount of time, in minutes, that the database management tool can be idle before it is shut down.

      • scheduledOperations (list) –

        The list of scheduled start and stop times for the Autonomous Database.

        • (dict) –

          The scheduled start and stop times for an Autonomous Database on a specific day of the week.

          • dayOfWeek (dict) –

            The day of the week on which the scheduled operation occurs.

            • name (string) –

              The name of the day of the week.

          • scheduledStartTime (string) –

            The scheduled start time for the Autonomous Database, in UTC.

          • scheduledStopTime (string) –

            The scheduled stop time for the Autonomous Database, in UTC.

      • resourcePoolLeaderId (string) –

        The unique identifier of the resource pool leader Autonomous Database.

      • computeCount (float) –

        The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), assigned to the Autonomous Database.

      • computeModel (string) –

        The compute model of the Autonomous Database, either ECPU or OCPU.

      • cpuCoreCount (integer) –

        The number of CPU cores allocated to the Autonomous Database.

      • memoryPerOracleComputeUnitInGBs (integer) –

        The amount of memory allocated per Oracle Compute Unit, in GB.

      • provisionableCpus (list) –

        The list of CPU core counts that you can provision for the Autonomous Database.

        • (integer) –

      • isAutoScalingEnabled (boolean) –

        Indicates whether automatic scaling of the compute resources is enabled for the Autonomous Database.

      • dataStorageSizeInTBs (float) –

        The size, in terabytes (TB), of the data volume allocated for the Autonomous Database.

      • dataStorageSizeInGBs (integer) –

        The size, in gigabytes (GB), of the data volume allocated for the Autonomous Database.

      • usedDataStorageSizeInTBs (float) –

        The amount of data storage currently in use by the Autonomous Database, in TB.

      • usedDataStorageSizeInGBs (integer) –

        The amount of data storage currently in use by the Autonomous Database, in GB.

      • actualUsedDataStorageSizeInTBs (float) –

        The actual amount of data storage currently in use by the Autonomous Database, in TB.

      • allocatedStorageSizeInTBs (float) –

        The amount of storage currently allocated to the Autonomous Database, in TB.

      • inMemoryAreaInGBs (integer) –

        The size of the in-memory area of the Autonomous Database, in GB.

      • isAutoScalingForStorageEnabled (boolean) –

        Indicates whether automatic scaling of the storage is enabled for the Autonomous Database.

      • odbNetworkId (string) –

        The unique identifier of the ODB network associated with the Autonomous Database.

      • odbNetworkArn (string) –

        The Amazon Resource Name (ARN) of the ODB network associated with the Autonomous Database.

      • privateEndpoint (string) –

        The private endpoint for the Autonomous Database.

      • privateEndpointIp (string) –

        The private endpoint IP address for the Autonomous Database.

      • privateEndpointLabel (string) –

        The private endpoint label for the Autonomous Database.

      • allowlistedIps (list) –

        The list of IP addresses that are allowed to access the Autonomous Database.

        • (string) –

      • standbyAllowlistedIps (list) –

        The list of IP addresses that are allowed to access the standby Autonomous Database.

        • (string) –

      • standbyAllowlistedIpsSource (string) –

        The source of the allowlisted IP addresses for the standby Autonomous Database.

      • isLocalDataGuardEnabled (boolean) –

        Indicates whether local Oracle Data Guard is enabled for the Autonomous Database.

      • isRemoteDataGuardEnabled (boolean) –

        Indicates whether remote Oracle Data Guard is enabled for the Autonomous Database.

      • localDisasterRecoveryType (string) –

        The type of local disaster recovery configured for the Autonomous Database.

      • role (string) –

        The Oracle Data Guard role of the Autonomous Database.

      • peerDbIds (list) –

        The list of unique identifiers of the peer Autonomous Databases.

        • (string) –

      • failedDataRecoveryInSeconds (integer) –

        The amount of time, in seconds, that the data in the Autonomous Database is behind the data in the primary database.

      • localAdgAutoFailoverMaxDataLossLimit (integer) –

        The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.

      • remoteDisasterRecoveryConfiguration (dict) –

        The configuration of the remote disaster recovery for the Autonomous Database.

        • disasterRecoveryType (string) –

          The type of disaster recovery configured for the Autonomous Database.

        • isReplicateAutomaticBackups (boolean) –

          Indicates whether automatic backups are replicated to the disaster recovery database.

        • isSnapshotStandby (boolean) –

          Indicates whether the standby database is a snapshot standby.

        • timeSnapshotStandbyEnabledTill (datetime) –

          The date and time until which the snapshot standby database remains enabled.

      • isRefreshableClone (boolean) –

        Indicates whether the Autonomous Database is a refreshable clone.

      • refreshableMode (string) –

        The refresh mode of the refreshable clone Autonomous Database.

      • refreshableStatus (string) –

        The refresh status of the refreshable clone Autonomous Database.

      • autoRefreshFrequencyInSeconds (integer) –

        The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.

      • autoRefreshPointLagInSeconds (integer) –

        The time lag, in seconds, between the refreshable clone and its source Autonomous Database.

      • isReconnectCloneEnabled (boolean) –

        Indicates whether reconnecting the refreshable clone to its source Autonomous Database is enabled.

      • cloneTableSpaceList (list) –

        The list of tablespace identifiers to clone for the Autonomous Database.

        • (integer) –

      • backupRetentionPeriodInDays (integer) –

        The retention period, in days, for automatic backups of the Autonomous Database.

      • longTermBackupSchedule (dict) –

        The long-term backup schedule for the Autonomous Database.

        • isDisabled (boolean) –

          Indicates whether the long-term backup schedule is disabled.

        • repeatCadence (string) –

          The cadence at which long-term backups are taken.

        • retentionPeriodInDays (integer) –

          The retention period, in days, for long-term backups.

        • timeOfBackup (datetime) –

          The date and time at which the long-term backup is taken.

      • isBackupRetentionLocked (boolean) –

        Indicates whether the backup retention period of the Autonomous Database is locked.

      • totalBackupStorageSizeInGBs (float) –

        The total amount of backup storage used by the Autonomous Database, in GB.

      • resourcePoolSummary (dict) –

        The configuration of the resource pool for the Autonomous Database.

        • isDisabled (boolean) –

          Indicates whether the resource pool is disabled.

        • poolSize (integer) –

          The number of Autonomous Databases that the resource pool can contain.

        • poolStorageSizeInTBs (integer) –

          The total storage size of the resource pool, in terabytes (TB).

        • availableStorageCapacityInTBs (float) –

          The available storage capacity in the resource pool, in TB.

        • totalComputeCapacity (integer) –

          The total compute capacity of the resource pool.

        • availableComputeCapacity (integer) –

          The available compute capacity in the resource pool.

      • encryptionSummary (dict) –

        The encryption configuration for the Autonomous Database.

        • encryptionKeyProvider (string) –

          The provider of the encryption key used for the Autonomous Database.

        • encryptionKeyConfiguration (dict) –

          The configuration of the encryption key used for the Autonomous Database.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: awsEncryptionKey, ociEncryptionKey, okvEncryptionKey. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • awsEncryptionKey (dict) –

            The configuration of the Amazon Web Services Key Management Service (KMS) encryption key.

            • iamRoleArn (string) –

              The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants access to the KMS key.

            • externalIdType (string) –

              The type of external identifier associated with the encryption key.

            • kmsKeyId (string) –

              The identifier or ARN of the Amazon Web Services KMS key used for encryption.

          • ociEncryptionKey (dict) –

            The configuration of the Oracle Cloud Infrastructure (OCI) Vault encryption key.

            • kmsKeyId (string) –

              The Oracle Cloud Identifier (OCID) of the OCI Vault key to use for encryption.

            • vaultId (string) –

              The Oracle Cloud Identifier (OCID) of the OCI Vault that contains the encryption key.

          • okvEncryptionKey (dict) –

            The configuration of the Oracle Key Vault (OKV) encryption key.

            • certificateDirectoryName (string) –

              The name of the directory that contains the Oracle Key Vault (OKV) certificate.

            • certificateId (string) –

              The identifier of the Oracle Key Vault (OKV) certificate.

            • directoryName (string) –

              The name of the directory where the Oracle Key Vault (OKV) configuration is stored.

            • okvKmsKey (string) –

              The identifier of the Oracle Key Vault (OKV) key to use for encryption.

            • okvUri (string) –

              The URI of the Oracle Key Vault (OKV) server.

      • createdAt (datetime) –

        The date and time when the Autonomous Database was created.

      • timeOfLastBackup (datetime) –

        The date and time of the last backup of the Autonomous Database.

      • timeMaintenanceBegin (datetime) –

        The date and time when the next maintenance of the Autonomous Database begins.

      • timeMaintenanceEnd (datetime) –

        The date and time when the next maintenance of the Autonomous Database ends.

      • timeLocalDataGuardEnabled (datetime) –

        The date and time when local Oracle Data Guard was enabled for the Autonomous Database.

      • timeDataGuardRoleChanged (datetime) –

        The date and time when the Oracle Data Guard role of the Autonomous Database last changed.

      • timeOfLastSwitchover (datetime) –

        The date and time of the last switchover operation for the Autonomous Database.

      • timeOfLastFailover (datetime) –

        The date and time of the last failover operation for the Autonomous Database.

      • timeOfLastRefresh (datetime) –

        The date and time of the last refresh of the refreshable clone Autonomous Database.

      • timeOfLastRefreshPoint (datetime) –

        The date and time as of which the data in the refreshable clone Autonomous Database is current.

      • timeOfNextRefresh (datetime) –

        The date and time of the next scheduled refresh of the refreshable clone Autonomous Database.

      • timeOfAutoRefreshStart (datetime) –

        The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.

      • timeDeletionOfFreeAutonomousDatabase (datetime) –

        The date and time when the inactive Always Free Autonomous Database is scheduled to be automatically deleted.

      • timeReclamationOfFreeAutonomousDatabase (datetime) –

        The date and time when the Always Free Autonomous Database is scheduled to be stopped because of inactivity.

      • timeDisasterRecoveryRoleChanged (datetime) –

        The date and time when the disaster recovery role of the Autonomous Database last changed.

      • timeUntilReconnectCloneEnabled (datetime) –

        The date and time until which reconnecting the refreshable clone to its source Autonomous Database is allowed.

      • nextLongTermBackupTimeStamp (datetime) –

        The date and time of the next scheduled long-term backup of the Autonomous Database.

      • timeUndeleted (datetime) –

        The date and time when the Autonomous Database was restored after deletion.

Exceptions

  • odb.Client.exceptions.ThrottlingException

  • odb.Client.exceptions.ValidationException

  • odb.Client.exceptions.AccessDeniedException

  • odb.Client.exceptions.InternalServerException

  • odb.Client.exceptions.ResourceNotFoundException