Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . odb ]

get-autonomous-database

Description

Gets information about a specific Autonomous Database.

See also: AWS API Documentation

Synopsis

  get-autonomous-database
--autonomous-database-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--autonomous-database-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

autonomousDatabase -> (structure)

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 -> (structure)

The connection string details for the Autonomous Database.

allConnectionStrings -> (map)

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

key -> (string)

value -> (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.

(structure)

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.

(structure)

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

email -> (string)

The email address of the contact.

apexDetails -> (structure)

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 -> (structure)

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 -> (timestamp)

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

timeDisasterRecoveryRoleChanged -> (timestamp)

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

timeMaintenanceBegin -> (timestamp)

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

timeMaintenanceEnd -> (timestamp)

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

localStandbyDb -> (structure)

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 -> (timestamp)

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

timeDisasterRecoveryRoleChanged -> (timestamp)

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

timeMaintenanceBegin -> (timestamp)

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

timeMaintenanceEnd -> (timestamp)

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 -> (structure)

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.

(structure)

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 -> (double)

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.

(structure)

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

dayOfWeek -> (structure)

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 -> (double)

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 -> (double)

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 -> (double)

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

allocatedStorageSizeInTBs -> (double)

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 -> (structure)

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 -> (timestamp)

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 -> (structure)

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 -> (timestamp)

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 -> (double)

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

resourcePoolSummary -> (structure)

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 -> (double)

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 -> (structure)

The encryption configuration for the Autonomous Database.

encryptionKeyProvider -> (string)

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

encryptionKeyConfiguration -> (tagged union structure)

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: awsEncryptionKey, ociEncryptionKey, okvEncryptionKey.

awsEncryptionKey -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (timestamp)

The date and time when the Autonomous Database was created.

timeOfLastBackup -> (timestamp)

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

timeMaintenanceBegin -> (timestamp)

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

timeMaintenanceEnd -> (timestamp)

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

timeLocalDataGuardEnabled -> (timestamp)

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

timeDataGuardRoleChanged -> (timestamp)

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

timeOfLastSwitchover -> (timestamp)

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

timeOfLastFailover -> (timestamp)

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

timeOfLastRefresh -> (timestamp)

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

timeOfLastRefreshPoint -> (timestamp)

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

timeOfNextRefresh -> (timestamp)

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

timeOfAutoRefreshStart -> (timestamp)

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

timeDeletionOfFreeAutonomousDatabase -> (timestamp)

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

timeReclamationOfFreeAutonomousDatabase -> (timestamp)

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

timeDisasterRecoveryRoleChanged -> (timestamp)

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

timeUntilReconnectCloneEnabled -> (timestamp)

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

nextLongTermBackupTimeStamp -> (timestamp)

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

timeUndeleted -> (timestamp)

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

adminPasswordSourceSummary -> (structure)

The summary of the admin password source configuration for the Autonomous Database.

adminPasswordSource -> (string)

The source of the admin password for the Autonomous Database.

adminPasswordSourceConfiguration -> (tagged union structure)

The configuration of the admin password source for the Autonomous Database.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: customerManagedAwsSecret.

customerManagedAwsSecret -> (structure)

The configuration for a customer-managed Amazon Web Services Secrets Manager secret used as the admin password source.

iamRoleArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that OCI assumes to retrieve the secret value.

secretId -> (string)

The identifier or ARN of the Amazon Web Services Secrets Manager secret that contains the password.

externalIdType -> (string)

The type of Oracle Cloud Identifier (OCID) used as the external ID when assuming the IAM role.