odb

Restores the specified Autonomous Database to a point in time.

See also: AWS API Documentation

Request Syntax

client.restore_autonomous_database(
    autonomousDatabaseId='string',
    timestamp=datetime(2015, 1, 1)
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to restore.

type timestamp:

datetime

param timestamp:

[REQUIRED]

The date and time to which to restore the Autonomous Database.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was restored.

  • displayName (string) --

    The user-friendly name of the Autonomous Database.

  • status (string) --

    The current status of the Autonomous Database after the restore operation.

  • statusReason (string) --

    Additional information about the status of the Autonomous Database after the restore operation.

Gets information about a specific Autonomous Database backup.

See also: AWS API Documentation

Request Syntax

client.get_autonomous_database_backup(
    autonomousDatabaseBackupId='string'
)

type autonomousDatabaseBackupId:

string

param autonomousDatabaseBackupId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseBackup': {
        'autonomousDatabaseBackupId': 'string',
        'autonomousDatabaseBackupArn': 'string',
        'autonomousDatabaseId': 'string',
        'ocid': 'string',
        'displayName': 'string',
        'dbVersion': 'string',
        'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
        'statusReason': 'string',
        'isAutomatic': True|False,
        'retentionPeriodInDays': 123,
        'sizeInTBs': 123.0,
        'timeAvailableTill': datetime(2015, 1, 1),
        'timeStarted': datetime(2015, 1, 1),
        'timeEnded': datetime(2015, 1, 1),
        'type': 'INCREMENTAL'|'FULL'|'LONGTERM'|'VIRTUAL_FULL'|'CUMULATIVE_INCREMENTAL'|'ROLL_FORWARD_IMAGE_COPY'
    }
}

Response Structure

• (dict) --

  • autonomousDatabaseBackup (dict) --

    The details of the requested Autonomous Database backup.

    • autonomousDatabaseBackupId (string) --

      The unique identifier of the Autonomous Database backup.

    • autonomousDatabaseBackupArn (string) --

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

    • autonomousDatabaseId (string) --

      The unique identifier of the Autonomous Database that the backup was created from.

    • ocid (string) --

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

    • displayName (string) --

      The user-friendly name of the Autonomous Database backup.

    • dbVersion (string) --

      The Oracle Database software version of the Autonomous Database backup.

    • status (string) --

      The current status of the Autonomous Database backup.

    • statusReason (string) --

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

    • isAutomatic (boolean) --

      Indicates whether the backup was created automatically.

    • retentionPeriodInDays (integer) --

      The retention period, in days, for the Autonomous Database backup.

    • sizeInTBs (float) --

      The size of the Autonomous Database backup, in terabytes (TB).

    • timeAvailableTill (datetime) --

      The date and time until which the Autonomous Database backup is available for restore.

    • timeStarted (datetime) --

      The date and time when the Autonomous Database backup started.

    • timeEnded (datetime) --

      The date and time when the Autonomous Database backup ended.

    • type (string) --

      The type of the Autonomous Database backup.

Creates a new wallet for the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.create_autonomous_database_wallet(
    autonomousDatabaseId='string',
    walletType='REGIONAL'|'INSTANCE',
    password='string',
    clientToken='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to create a wallet for.

type walletType:

string

param walletType:

The type of wallet to create, either a regional wallet or an instance wallet.

type password:

string

param password:

[REQUIRED]

The password to encrypt the keys inside the wallet.

type clientToken:

string

param clientToken:

A client-provided token to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseWalletFile': b'bytes'
}

Response Structure

• (dict) --

  • autonomousDatabaseWalletFile (bytes) --

    The generated wallet file for the Autonomous Database, returned as a compressed archive.

Initiates a failover of the specified Autonomous Database to a standby peer database.

See also: AWS API Documentation

Request Syntax

client.failover_autonomous_database(
    autonomousDatabaseId='string',
    peerDbArn='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to fail over.

type peerDbArn:

string

param peerDbArn:

The Amazon Resource Name (ARN) of the peer Autonomous Database to fail over to.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was failed over.

  • displayName (string) --

    The user-friendly name of the Autonomous Database.

  • status (string) --

    The current status of the Autonomous Database after the failover operation.

  • statusReason (string) --

    Additional information about the status of the Autonomous Database after the failover operation.

Creates a new Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.create_autonomous_database(
    odbNetworkId='string',
    displayName='string',
    dbName='string',
    adminPassword='string',
    computeCount=123.0,
    dataStorageSizeInTBs=123,
    dataStorageSizeInGBs=123,
    dbWorkload='OLTP'|'AJD'|'APEX'|'LH',
    isAutoScalingEnabled=True|False,
    isAutoScalingForStorageEnabled=True|False,
    licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
    characterSet='string',
    ncharacterSet='string',
    dbVersion='string',
    databaseEdition='STANDARD_EDITION'|'ENTERPRISE_EDITION',
    standbyAllowlistedIpsSource='PRIMARY'|'SEPARATE'|'NOT_APPLICABLE',
    autonomousMaintenanceScheduleType='EARLY'|'REGULAR',
    backupRetentionPeriodInDays=123,
    byolComputeCountLimit=123.0,
    cpuCoreCount=123,
    customerContactsToSendToOCI=[
        {
            'email': 'string'
        },
    ],
    privateEndpointIp='string',
    privateEndpointLabel='string',
    resourcePoolLeaderId='string',
    resourcePoolSummary={
        'isDisabled': True|False,
        'poolSize': 123,
        'poolStorageSizeInTBs': 123,
        'availableStorageCapacityInTBs': 123.0,
        'totalComputeCapacity': 123,
        'availableComputeCapacity': 123
    },
    scheduledOperations=[
        {
            'dayOfWeek': {
                'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
            },
            'scheduledStartTime': 'string',
            'scheduledStopTime': 'string'
        },
    ],
    standbyAllowlistedIps=[
        'string',
    ],
    allowlistedIps=[
        'string',
    ],
    transportableTablespace={
        'ttsBundleUrl': 'string'
    },
    isBackupRetentionLocked=True|False,
    isLocalDataGuardEnabled=True|False,
    isMtlsConnectionRequired=True|False,
    dbToolsDetails=[
        {
            'isEnabled': True|False,
            'name': 'string',
            'computeCount': 123.0,
            'maxIdleTimeInMinutes': 123
        },
    ],
    source='NONE'|'DATABASE'|'BACKUP_FROM_ID'|'BACKUP_FROM_TIMESTAMP'|'CROSS_REGION_DATAGUARD'|'CROSS_REGION_DISASTER_RECOVERY'|'CLONE_TO_REFRESHABLE',
    sourceConfiguration={
        'databaseClone': {
            'sourceAutonomousDatabaseId': 'string',
            'cloneType': 'FULL'|'METADATA'|'PARTIAL'
        },
        'restoreFromBackup': {
            'autonomousDatabaseBackupId': 'string',
            'cloneType': 'FULL'|'METADATA'|'PARTIAL',
            'cloneTableSpaceList': [
                123,
            ]
        },
        'pointInTimeRestore': {
            'sourceAutonomousDatabaseId': 'string',
            'cloneType': 'FULL'|'METADATA'|'PARTIAL',
            'timestamp': datetime(2015, 1, 1),
            'useLatestAvailableBackupTimestamp': True|False,
            'cloneTableSpaceList': [
                123,
            ]
        },
        'crossRegionDataGuard': {
            'sourceAutonomousDatabaseArn': 'string'
        },
        'crossRegionDisasterRecovery': {
            'sourceAutonomousDatabaseArn': 'string',
            'remoteDisasterRecoveryType': 'ADG'|'BACKUP_BASED',
            'isReplicateAutomaticBackups': True|False
        },
        'cloneToRefreshable': {
            'sourceAutonomousDatabaseId': 'string',
            'refreshableMode': 'AUTOMATIC'|'MANUAL',
            'autoRefreshFrequencyInSeconds': 123,
            'autoRefreshPointLagInSeconds': 123,
            'timeOfAutoRefreshStart': datetime(2015, 1, 1),
            'openMode': 'READ_ONLY'|'READ_WRITE',
            'cloneType': 'FULL'|'METADATA'|'PARTIAL'
        }
    },
    encryptionKeyProvider='ORACLE_MANAGED'|'AWS_KMS',
    encryptionKeyConfiguration={
        'awsEncryptionKey': {
            'iamRoleArn': 'string',
            'externalIdType': 'database_ocid'|'compartment_ocid'|'tenant_ocid',
            'kmsKeyId': 'string'
        }
    },
    clientToken='string',
    tags={
        'string': 'string'
    }
)

type odbNetworkId:

string

param odbNetworkId:

The unique identifier of the ODB network to be used for the Autonomous Database.

type displayName:

string

param displayName:

The user-friendly name for the Autonomous Database. The name does not have to be unique.

type dbName:

string

param dbName:

The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account.

type adminPassword:

string

param adminPassword:

The password for the ADMIN user of the Autonomous Database.

type computeCount:

float

param computeCount:

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

type dataStorageSizeInTBs:

integer

param dataStorageSizeInTBs:

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

type dataStorageSizeInGBs:

integer

param dataStorageSizeInGBs:

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

type dbWorkload:

string

param dbWorkload:

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

type isAutoScalingEnabled:

boolean

param isAutoScalingEnabled:

Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

type isAutoScalingForStorageEnabled:

boolean

param isAutoScalingForStorageEnabled:

Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

type licenseModel:

string

param licenseModel:

The Oracle license model to apply to the Autonomous Database.

type characterSet:

string

param characterSet:

The character set to use for the Autonomous Database.

type ncharacterSet:

string

param ncharacterSet:

The national character set to use for the Autonomous Database.

type dbVersion:

string

param dbVersion:

The Oracle Database software version to use for the Autonomous Database.

type databaseEdition:

string

param databaseEdition:

The Oracle Database edition to apply to the Autonomous Database.

type standbyAllowlistedIpsSource:

string

param standbyAllowlistedIpsSource:

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

type autonomousMaintenanceScheduleType:

string

param autonomousMaintenanceScheduleType:

The maintenance schedule type for the Autonomous Database.

type backupRetentionPeriodInDays:

integer

param backupRetentionPeriodInDays:

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

type byolComputeCountLimit:

float

param byolComputeCountLimit:

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

type cpuCoreCount:

integer

param cpuCoreCount:

The number of CPU cores to allocate to the Autonomous Database.

type customerContactsToSendToOCI:

list

param customerContactsToSendToOCI:

The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (OCI) 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.

type privateEndpointIp:

string

param privateEndpointIp:

The private endpoint IP address for the Autonomous Database.

type privateEndpointLabel:

string

param privateEndpointLabel:

The private endpoint label for the Autonomous Database.

type resourcePoolLeaderId:

string

param resourcePoolLeaderId:

The unique identifier of the resource pool leader Autonomous Database.

type resourcePoolSummary:

dict

param resourcePoolSummary:

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.

type scheduledOperations:

list

param scheduledOperations:

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) -- [REQUIRED]

    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.

type standbyAllowlistedIps:

list

param standbyAllowlistedIps:

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

• (string) --

type allowlistedIps:

list

param allowlistedIps:

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

• (string) --

type transportableTablespace:

dict

param transportableTablespace:

The transportable tablespace configuration to use when creating the Autonomous Database.

• ttsBundleUrl (string) --

  The URL of the transportable tablespace bundle to use when creating the Autonomous Database.

type isBackupRetentionLocked:

boolean

param isBackupRetentionLocked:

Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

type isLocalDataGuardEnabled:

boolean

param isLocalDataGuardEnabled:

Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

type isMtlsConnectionRequired:

boolean

param isMtlsConnectionRequired:

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

type dbToolsDetails:

list

param dbToolsDetails:

The list of database management tools to enable 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.

type source:

string

param source:

The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy.

type sourceConfiguration:

dict

param sourceConfiguration:

The configuration details for the source used to create the Autonomous Database.

• databaseClone (dict) --

  The configuration for creating the Autonomous Database as a clone of an existing database.

  • sourceAutonomousDatabaseId (string) -- [REQUIRED]

    The unique identifier of the source Autonomous Database to clone.

  • cloneType (string) -- [REQUIRED]

    The type of clone to create, either a full clone, a metadata clone, or a partial clone.

• restoreFromBackup (dict) --

  The configuration for creating the Autonomous Database by restoring from a backup.

  • autonomousDatabaseBackupId (string) -- [REQUIRED]

    The unique identifier of the Autonomous Database backup to restore from.

  • cloneType (string) -- [REQUIRED]

    The type of clone to create from the backup.

  • cloneTableSpaceList (list) --

    The list of tablespace identifiers to clone from the backup.

    • (integer) --

• pointInTimeRestore (dict) --

  The configuration for creating the Autonomous Database by restoring to a point in time.

  • sourceAutonomousDatabaseId (string) -- [REQUIRED]

    The unique identifier of the source Autonomous Database to restore from.

  • cloneType (string) -- [REQUIRED]

    The type of clone to create from the point-in-time restore.

  • timestamp (datetime) --

    The date and time to which to restore the Autonomous Database.

  • useLatestAvailableBackupTimestamp (boolean) --

    Indicates whether to use the latest available backup timestamp for the restore.

  • cloneTableSpaceList (list) --

    The list of tablespace identifiers to clone from the point-in-time restore.

    • (integer) --

• crossRegionDataGuard (dict) --

  The configuration for creating the Autonomous Database as a cross-Region Oracle Data Guard peer.

  • sourceAutonomousDatabaseArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the source Autonomous Database for the cross-Region Oracle Data Guard configuration.

• crossRegionDisasterRecovery (dict) --

  The configuration for creating the Autonomous Database as a cross-Region disaster recovery peer.

  • sourceAutonomousDatabaseArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the source Autonomous Database for the cross-Region disaster recovery configuration.

  • remoteDisasterRecoveryType (string) -- [REQUIRED]

    The type of remote disaster recovery to configure, either Autonomous Data Guard or backup-based.

  • isReplicateAutomaticBackups (boolean) --

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

• cloneToRefreshable (dict) --

  The configuration for creating the Autonomous Database as a refreshable clone.

  • sourceAutonomousDatabaseId (string) -- [REQUIRED]

    The unique identifier of the source Autonomous Database to create the refreshable clone from.

  • refreshableMode (string) --

    The refresh mode of the refreshable clone, either automatic or manual.

  • autoRefreshFrequencyInSeconds (integer) --

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

  • autoRefreshPointLagInSeconds (integer) --

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

  • timeOfAutoRefreshStart (datetime) --

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

  • openMode (string) --

    The mode in which to open the refreshable clone, either read-only or read/write.

  • cloneType (string) --

    The type of clone to create.

type encryptionKeyProvider:

string

param encryptionKeyProvider:

The provider of the encryption key to use for the Autonomous Database.

type encryptionKeyConfiguration:

dict

param encryptionKeyConfiguration:

The configuration of the encryption key to use for the Autonomous Database.

• awsEncryptionKey (dict) --

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

  • 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 to use for encryption.

type clientToken:

string

param clientToken:

A client-provided token to ensure the idempotency of the request.

This field is autopopulated if not provided.

type tags:

dict

param tags:

The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was created.

  • displayName (string) --

    The user-friendly name of the Autonomous Database that 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.

Starts the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.start_autonomous_database(
    autonomousDatabaseId='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to start.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was started.

  • displayName (string) --

    The user-friendly name of the Autonomous Database.

  • status (string) --

    The current status of the Autonomous Database after the start operation.

  • statusReason (string) --

    Additional information about the status of the Autonomous Database after the start operation.

Deletes the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.delete_autonomous_database(
    autonomousDatabaseId='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists the clones of the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.list_autonomous_database_clones(
    maxResults=123,
    nextToken='string',
    autonomousDatabaseId='string'
)

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the source Autonomous Database whose clones you want to list.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'autonomousDatabaseClones': [
        {
            '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) --

  • nextToken (string) --

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • autonomousDatabaseClones (list) --

    The list of Autonomous Database clones along with their properties.

    • (dict) --

      A summary of an 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.

          • 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.

Updates the properties of an Autonomous Database backup.

See also: AWS API Documentation

Request Syntax

client.update_autonomous_database_backup(
    autonomousDatabaseBackupId='string',
    retentionPeriodInDays=123
)

type autonomousDatabaseBackupId:

string

param autonomousDatabaseBackupId:

[REQUIRED]

The unique identifier of the Autonomous Database backup to update.

type retentionPeriodInDays:

integer

param retentionPeriodInDays:

The retention period, in days, for the Autonomous Database backup.

rtype:

dict

returns:

Response Syntax

{
    'displayName': 'string',
    'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
    'statusReason': 'string',
    'autonomousDatabaseBackupId': 'string'
}

Response Structure

• (dict) --

  • displayName (string) --

    The user-friendly name of the Autonomous Database backup.

  • status (string) --

    The current status of the Autonomous Database backup.

  • statusReason (string) --

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

  • autonomousDatabaseBackupId (string) --

    The unique identifier of the Autonomous Database backup that was updated.

Shrinks the storage of the specified Autonomous Database to reclaim unused space.

See also: AWS API Documentation

Request Syntax

client.shrink_autonomous_database(
    autonomousDatabaseId='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to shrink.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was shrunk.

  • displayName (string) --

    The user-friendly name of the Autonomous Database.

  • status (string) --

    The current status of the Autonomous Database after the shrink operation.

  • statusReason (string) --

    Additional information about the status of the Autonomous Database after the shrink operation.

Returns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

client.list_autonomous_databases(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'autonomousDatabases': [
        {
            '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) --

  • nextToken (string) --

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • autonomousDatabases (list) --

    The list of Autonomous Databases along with their properties.

    • (dict) --

      A summary of an 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.

          • 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.

Stops the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.stop_autonomous_database(
    autonomousDatabaseId='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to stop.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was stopped.

  • displayName (string) --

    The user-friendly name of the Autonomous Database.

  • status (string) --

    The current status of the Autonomous Database after the stop operation.

  • statusReason (string) --

    Additional information about the status of the Autonomous Database after the stop operation.

Lists the available Oracle Database software versions for Autonomous Databases.

See also: AWS API Documentation

Request Syntax

client.list_autonomous_database_versions(
    maxResults=123,
    nextToken='string',
    dbWorkload='OLTP'|'AJD'|'APEX'|'LH'
)

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type dbWorkload:

string

param dbWorkload:

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

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'autonomousDatabaseVersions': [
        {
            'dbWorkload': 'OLTP'|'AJD'|'APEX'|'LH',
            'details': 'string',
            'version': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • autonomousDatabaseVersions (list) --

    The list of available Autonomous Database software versions.

    • (dict) --

      A summary of an available Oracle Database software version for Autonomous Databases.

      • dbWorkload (string) --

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

      • details (string) --

        Additional details about the Autonomous Database software version.

      • version (string) --

        The Oracle Database software version.

Creates a new backup of the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.create_autonomous_database_backup(
    autonomousDatabaseId='string',
    displayName='string',
    retentionPeriodInDays=123,
    clientToken='string',
    tags={
        'string': 'string'
    }
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to back up.

type displayName:

string

param displayName:

The user-friendly name for the Autonomous Database backup.

type retentionPeriodInDays:

integer

param retentionPeriodInDays:

The retention period, in days, for the Autonomous Database backup.

type clientToken:

string

param clientToken:

A client-provided token to ensure the idempotency of the request.

This field is autopopulated if not provided.

type tags:

dict

param tags:

The list of resource tags to apply to the Autonomous Database backup. Each tag is a key-value pair with no predefined name, type, or namespace.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'displayName': 'string',
    'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
    'statusReason': 'string',
    'autonomousDatabaseBackupId': 'string'
}

Response Structure

• (dict) --

  • displayName (string) --

    The user-friendly name of the Autonomous Database backup that was created.

  • status (string) --

    The current status of the Autonomous Database backup.

  • statusReason (string) --

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

  • autonomousDatabaseBackupId (string) --

    The unique identifier of the Autonomous Database backup that was created.

Deletes the specified Autonomous Database backup.

See also: AWS API Documentation

Request Syntax

client.delete_autonomous_database_backup(
    autonomousDatabaseBackupId='string'
)

type autonomousDatabaseBackupId:

string

param autonomousDatabaseBackupId:

[REQUIRED]

The unique identifier of the Autonomous Database backup to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Reboots the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.reboot_autonomous_database(
    autonomousDatabaseId='string',
    isOnlineReboot=True|False
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to reboot.

type isOnlineReboot:

boolean

param isOnlineReboot:

Specifies whether to perform an online reboot of the Autonomous Database without interrupting active connections.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was rebooted.

  • displayName (string) --

    The user-friendly name of the Autonomous Database.

  • status (string) --

    The current status of the Autonomous Database after the reboot operation.

  • statusReason (string) --

    Additional information about the status of the Autonomous Database after the reboot operation.

Lists the backups of the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.list_autonomous_database_backups(
    maxResults=123,
    nextToken='string',
    autonomousDatabaseId='string',
    status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
    type='INCREMENTAL'|'FULL'|'LONGTERM'|'VIRTUAL_FULL'|'CUMULATIVE_INCREMENTAL'|'ROLL_FORWARD_IMAGE_COPY'
)

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database whose backups you want to list.

type status:

string

param status:

The status of the Autonomous Database backups to return results for.

type type:

string

param type:

The type of the Autonomous Database backups to return results for.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'autonomousDatabaseBackups': [
        {
            'autonomousDatabaseBackupId': 'string',
            'autonomousDatabaseBackupArn': 'string',
            'autonomousDatabaseId': 'string',
            'ocid': 'string',
            'displayName': 'string',
            'dbVersion': 'string',
            'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
            'statusReason': 'string',
            'isAutomatic': True|False,
            'retentionPeriodInDays': 123,
            'sizeInTBs': 123.0,
            'timeAvailableTill': datetime(2015, 1, 1),
            'timeStarted': datetime(2015, 1, 1),
            'timeEnded': datetime(2015, 1, 1),
            'type': 'INCREMENTAL'|'FULL'|'LONGTERM'|'VIRTUAL_FULL'|'CUMULATIVE_INCREMENTAL'|'ROLL_FORWARD_IMAGE_COPY'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • autonomousDatabaseBackups (list) --

    The list of Autonomous Database backups along with their properties.

    • (dict) --

      A summary of an Autonomous Database backup.

      • autonomousDatabaseBackupId (string) --

        The unique identifier of the Autonomous Database backup.

      • autonomousDatabaseBackupArn (string) --

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

      • autonomousDatabaseId (string) --

        The unique identifier of the Autonomous Database that the backup was created from.

      • ocid (string) --

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

      • displayName (string) --

        The user-friendly name of the Autonomous Database backup.

      • dbVersion (string) --

        The Oracle Database software version of the Autonomous Database backup.

      • status (string) --

        The current status of the Autonomous Database backup.

      • statusReason (string) --

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

      • isAutomatic (boolean) --

        Indicates whether the backup was created automatically.

      • retentionPeriodInDays (integer) --

        The retention period, in days, for the Autonomous Database backup.

      • sizeInTBs (float) --

        The size of the Autonomous Database backup, in terabytes (TB).

      • timeAvailableTill (datetime) --

        The date and time until which the Autonomous Database backup is available for restore.

      • timeStarted (datetime) --

        The date and time when the Autonomous Database backup started.

      • timeEnded (datetime) --

        The date and time when the Autonomous Database backup ended.

      • type (string) --

        The type of the Autonomous Database backup.

Gets information about a specific Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.get_autonomous_database(
    autonomousDatabaseId='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

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

rtype:

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.

        • 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.

Performs a switchover of the specified Autonomous Database to a standby peer database.

See also: AWS API Documentation

Request Syntax

client.switchover_autonomous_database(
    autonomousDatabaseId='string',
    peerDbArn='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to switch over.

type peerDbArn:

string

param peerDbArn:

The Amazon Resource Name (ARN) of the peer Autonomous Database to switch over to.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was switched over.

  • displayName (string) --

    The user-friendly name of the Autonomous Database.

  • status (string) --

    The current status of the Autonomous Database after the switchover operation.

  • statusReason (string) --

    Additional information about the status of the Autonomous Database after the switchover operation.

Lists the available character sets for Autonomous Databases.

See also: AWS API Documentation

Request Syntax

client.list_autonomous_database_character_sets(
    maxResults=123,
    nextToken='string',
    characterSetType='DATABASE'|'NATIONAL'
)

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type characterSetType:

string

param characterSetType:

The type of character set to return results for, either the database character set or the national character set.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'autonomousDatabaseCharacterSets': [
        {
            'characterSet': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • autonomousDatabaseCharacterSets (list) --

    The list of available Autonomous Database character sets.

    • (dict) --

      A summary of an available character set for Autonomous Databases.

      • characterSet (string) --

        The name of the character set.

Gets the wallet details for the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.get_autonomous_database_wallet_details(
    autonomousDatabaseId='string'
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to retrieve wallet details for.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseWalletDetails': {
        'status': 'ACTIVE'|'UPDATING',
        'timeRotated': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • autonomousDatabaseWalletDetails (dict) --

    The wallet details for the Autonomous Database.

    • status (string) --

      The current status of the Autonomous Database wallet.

    • timeRotated (datetime) --

      The date and time when the Autonomous Database wallet was last rotated.

Updates the properties of an Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.update_autonomous_database(
    autonomousDatabaseId='string',
    adminPassword='string',
    computeCount=123.0,
    cpuCoreCount=123,
    dataStorageSizeInTBs=123,
    dataStorageSizeInGBs=123,
    displayName='string',
    dbName='string',
    dbVersion='string',
    dbWorkload='OLTP'|'AJD'|'APEX'|'LH',
    dbToolsDetails=[
        {
            'isEnabled': True|False,
            'name': 'string',
            'computeCount': 123.0,
            'maxIdleTimeInMinutes': 123
        },
    ],
    databaseEdition='STANDARD_EDITION'|'ENTERPRISE_EDITION',
    licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
    isAutoScalingEnabled=True|False,
    isAutoScalingForStorageEnabled=True|False,
    isBackupRetentionLocked=True|False,
    isLocalDataGuardEnabled=True|False,
    isMtlsConnectionRequired=True|False,
    isRefreshableClone=True|False,
    isDisconnectPeer=True|False,
    backupRetentionPeriodInDays=123,
    byolComputeCountLimit=123.0,
    localAdgAutoFailoverMaxDataLossLimit=123,
    autonomousMaintenanceScheduleType='EARLY'|'REGULAR',
    customerContactsToSendToOCI=[
        {
            'email': 'string'
        },
    ],
    scheduledOperations=[
        {
            'dayOfWeek': {
                'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
            },
            'scheduledStartTime': 'string',
            'scheduledStopTime': 'string'
        },
    ],
    longTermBackupSchedule={
        'isDisabled': True|False,
        'repeatCadence': 'ONE_TIME'|'WEEKLY'|'MONTHLY'|'YEARLY',
        'retentionPeriodInDays': 123,
        'timeOfBackup': datetime(2015, 1, 1)
    },
    openMode='READ_ONLY'|'READ_WRITE',
    permissionLevel='RESTRICTED'|'UNRESTRICTED',
    refreshableMode='AUTOMATIC'|'MANUAL',
    privateEndpointIp='string',
    privateEndpointLabel='string',
    peerDbId='string',
    resourcePoolLeaderId='string',
    resourcePoolSummary={
        'isDisabled': True|False,
        'poolSize': 123,
        'poolStorageSizeInTBs': 123,
        'availableStorageCapacityInTBs': 123.0,
        'totalComputeCapacity': 123,
        'availableComputeCapacity': 123
    },
    standbyAllowlistedIpsSource='PRIMARY'|'SEPARATE'|'NOT_APPLICABLE',
    standbyAllowlistedIps=[
        'string',
    ],
    allowlistedIps=[
        'string',
    ],
    autoRefreshFrequencyInSeconds=123,
    autoRefreshPointLagInSeconds=123,
    timeOfAutoRefreshStart=datetime(2015, 1, 1),
    encryptionKeyProvider='ORACLE_MANAGED'|'AWS_KMS',
    encryptionKeyConfiguration={
        'awsEncryptionKey': {
            'iamRoleArn': 'string',
            'externalIdType': 'database_ocid'|'compartment_ocid'|'tenant_ocid',
            'kmsKeyId': 'string'
        }
    }
)

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database to update.

type adminPassword:

string

param adminPassword:

The new password for the ADMIN user of the Autonomous Database.

type computeCount:

float

param computeCount:

The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.

type cpuCoreCount:

integer

param cpuCoreCount:

The number of CPU cores to allocate to the Autonomous Database.

type dataStorageSizeInTBs:

integer

param dataStorageSizeInTBs:

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

type dataStorageSizeInGBs:

integer

param dataStorageSizeInGBs:

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

type displayName:

string

param displayName:

The new user-friendly name for the Autonomous Database.

type dbName:

string

param dbName:

The new name of the Autonomous Database.

type dbVersion:

string

param dbVersion:

The Oracle Database software version to use for the Autonomous Database.

type dbWorkload:

string

param dbWorkload:

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

type dbToolsDetails:

list

param dbToolsDetails:

The list of database management tools to enable 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.

type databaseEdition:

string

param databaseEdition:

The Oracle Database edition to apply to the Autonomous Database.

type licenseModel:

string

param licenseModel:

The Oracle license model to apply to the Autonomous Database.

type isAutoScalingEnabled:

boolean

param isAutoScalingEnabled:

Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

type isAutoScalingForStorageEnabled:

boolean

param isAutoScalingForStorageEnabled:

Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

type isBackupRetentionLocked:

boolean

param isBackupRetentionLocked:

Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

type isLocalDataGuardEnabled:

boolean

param isLocalDataGuardEnabled:

Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

type isMtlsConnectionRequired:

boolean

param isMtlsConnectionRequired:

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

type isRefreshableClone:

boolean

param isRefreshableClone:

Specifies whether the Autonomous Database is a refreshable clone.

type isDisconnectPeer:

boolean

param isDisconnectPeer:

Specifies whether to disconnect the Autonomous Database from its peer database.

type backupRetentionPeriodInDays:

integer

param backupRetentionPeriodInDays:

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

type byolComputeCountLimit:

float

param byolComputeCountLimit:

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

type localAdgAutoFailoverMaxDataLossLimit:

integer

param localAdgAutoFailoverMaxDataLossLimit:

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

type autonomousMaintenanceScheduleType:

string

param autonomousMaintenanceScheduleType:

The maintenance schedule type for the Autonomous Database.

type customerContactsToSendToOCI:

list

param customerContactsToSendToOCI:

The list of customer contacts to receive operational notifications from OCI 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.

type scheduledOperations:

list

param scheduledOperations:

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) -- [REQUIRED]

    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.

type longTermBackupSchedule:

dict

param longTermBackupSchedule:

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.

type openMode:

string

param openMode:

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

type permissionLevel:

string

param permissionLevel:

The permission level of the Autonomous Database.

type refreshableMode:

string

param refreshableMode:

The refresh mode of the refreshable clone Autonomous Database.

type privateEndpointIp:

string

param privateEndpointIp:

The private endpoint IP address for the Autonomous Database.

type privateEndpointLabel:

string

param privateEndpointLabel:

The private endpoint label for the Autonomous Database.

type peerDbId:

string

param peerDbId:

The unique identifier of the peer Autonomous Database.

type resourcePoolLeaderId:

string

param resourcePoolLeaderId:

The unique identifier of the resource pool leader Autonomous Database.

type resourcePoolSummary:

dict

param resourcePoolSummary:

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.

type standbyAllowlistedIpsSource:

string

param standbyAllowlistedIpsSource:

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

type standbyAllowlistedIps:

list

param standbyAllowlistedIps:

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

• (string) --

type allowlistedIps:

list

param allowlistedIps:

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

• (string) --

type autoRefreshFrequencyInSeconds:

integer

param autoRefreshFrequencyInSeconds:

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

type autoRefreshPointLagInSeconds:

integer

param autoRefreshPointLagInSeconds:

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

type timeOfAutoRefreshStart:

datetime

param timeOfAutoRefreshStart:

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

type encryptionKeyProvider:

string

param encryptionKeyProvider:

The provider of the encryption key to use for the Autonomous Database.

type encryptionKeyConfiguration:

dict

param encryptionKeyConfiguration:

The configuration of the encryption key to use for the Autonomous Database.

• awsEncryptionKey (dict) --

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

  • 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 to use for encryption.

rtype:

dict

returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': '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'
}

Response Structure

• (dict) --

  • autonomousDatabaseId (string) --

    The unique identifier of the Autonomous Database that was updated.

  • displayName (string) --

    The user-friendly name of the Autonomous Database that was updated.

  • status (string) --

    The current status of the Autonomous Database.

  • statusReason (string) --

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

Lists the peer databases of the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

client.list_autonomous_database_peers(
    maxResults=123,
    nextToken='string',
    autonomousDatabaseId='string'
)

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type autonomousDatabaseId:

string

param autonomousDatabaseId:

[REQUIRED]

The unique identifier of the Autonomous Database whose peer databases you want to list.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'autonomousDatabasePeers': [
        {
            'autonomousDatabaseId': 'string',
            'autonomousDatabaseArn': 'string',
            'ocid': 'string',
            'region': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • autonomousDatabasePeers (list) --

    The list of peer databases for the Autonomous Database.

    • (dict) --

      A summary of a peer database of an Autonomous Database.

      • autonomousDatabaseId (string) --

        The unique identifier of the peer Autonomous Database.

      • autonomousDatabaseArn (string) --

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

      • ocid (string) --

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

      • region (string) --

        The Amazon Web Services Region where the peer Autonomous Database is located.

{'autonomousDatabaseOciIntegrationIamRoles': [{'awsIntegration': 'KmsTde',
                                               'iamRoleArn': 'string'}],
 'linkedOciCompartmentId': 'string',
 'linkedOciTenancyId': 'string',
 'subscriptionErrors': [{'errorMessage': 'string'}]}

Returns the tenancy activation link and onboarding status for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.get_oci_onboarding_status()

rtype:

dict

returns:

Response Syntax

{
    'status': 'NOT_STARTED'|'PENDING_LINK_GENERATION'|'PENDING_CUSTOMER_ACTION'|'PENDING_INITIALIZATION'|'ACTIVATING'|'ACTIVE_IN_HOME_REGION'|'ACTIVE'|'ACTIVE_LIMITED'|'FAILED'|'PUBLIC_OFFER_UNSUPPORTED'|'SUSPENDED'|'CANCELED',
    'existingTenancyActivationLink': 'string',
    'newTenancyActivationLink': 'string',
    'ociIdentityDomain': {
        'ociIdentityDomainId': 'string',
        'ociIdentityDomainResourceUrl': 'string',
        'ociIdentityDomainUrl': 'string',
        'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
        'statusReason': 'string',
        'accountSetupCloudFormationUrl': 'string'
    },
    'autonomousDatabaseOciIntegrationIamRoles': [
        {
            'iamRoleArn': 'string',
            'awsIntegration': 'KmsTde'
        },
    ],
    'linkedOciTenancyId': 'string',
    'linkedOciCompartmentId': 'string',
    'subscriptionErrors': [
        {
            'errorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • status (string) --

  • existingTenancyActivationLink (string) --

    The existing OCI tenancy activation link for your Amazon Web Services account.

  • newTenancyActivationLink (string) --

    A new OCI tenancy activation link for your Amazon Web Services account.

  • ociIdentityDomain (dict) --

    The Oracle Cloud Infrastructure (OCI) identity domain information in the onboarding status response.

    • ociIdentityDomainId (string) --

      The unique identifier of the OCI identity domain.

    • ociIdentityDomainResourceUrl (string) --

      The resource URL for accessing the OCI identity domain.

    • ociIdentityDomainUrl (string) --

      The URL of the OCI identity domain.

    • status (string) --

      The current status of the OCI identity domain.

    • statusReason (string) --

      Additional information about the current status of the OCI identity domain, if applicable.

    • accountSetupCloudFormationUrl (string) --

      The Amazon Web Services CloudFormation URL for setting up the account integration with the OCI identity domain.

  • autonomousDatabaseOciIntegrationIamRoles (list) --

    The list of Amazon Web Services Identity and Access Management (IAM) service roles used for Autonomous Database integration with Oracle Cloud Infrastructure (OCI).

    • (dict) --

      Information about an Amazon Web Services Identity and Access Management (IAM) service role used for Autonomous Database integration with Oracle Cloud Infrastructure (OCI).

      • iamRoleArn (string) --

        The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.

      • awsIntegration (string) --

        The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.

  • linkedOciTenancyId (string) --

    The unique identifier of the Oracle Cloud Infrastructure (OCI) tenancy that is linked to your Amazon Web Services account.

  • linkedOciCompartmentId (string) --

    The unique identifier of the Oracle Cloud Infrastructure (OCI) compartment that is linked to your Amazon Web Services account.

  • subscriptionErrors (list) --

    The list of errors that occurred during the subscription process for your Amazon Web Services account, if any.

    • (dict) --

      Information about an error that occurred during the subscription process.

      • errorMessage (string) --

        A human-readable message that describes the subscription error.