GetAutonomousDatabase
Gets information about a specific Autonomous Database.
Request Syntax
{
"autonomousDatabaseId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- autonomousDatabaseId
-
The unique identifier of the Autonomous Database to retrieve information about.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 2048.
Pattern:
(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})Required: Yes
Response Syntax
{
"autonomousDatabase": {
"actualUsedDataStorageSizeInTBs": number,
"allocatedStorageSizeInTBs": number,
"allowlistedIps": [ "string" ],
"apexDetails": {
"apexVersion": "string",
"ordsVersion": "string"
},
"autonomousDatabaseArn": "string",
"autonomousDatabaseId": "string",
"autonomousMaintenanceScheduleType": "string",
"autoRefreshFrequencyInSeconds": number,
"autoRefreshPointLagInSeconds": number,
"availabilityZone": "string",
"availabilityZoneId": "string",
"availableUpgradeVersions": [ "string" ],
"backupRetentionPeriodInDays": number,
"byolComputeCountLimit": number,
"characterSet": "string",
"cloneTableSpaceList": [ number ],
"computeCount": number,
"computeModel": "string",
"connectionStringDetails": {
"allConnectionStrings": {
"string" : "string"
},
"dedicated": "string",
"high": "string",
"low": "string",
"medium": "string",
"profiles": [
{
"consumerGroup": "string",
"displayName": "string",
"hostFormat": "string",
"isRegional": boolean,
"protocol": "string",
"sessionMode": "string",
"syntaxFormat": "string",
"tlsAuthentication": "string",
"value": "string"
}
]
},
"connectionUrls": {
"apexUrl": "string",
"databaseTransformsUrl": "string",
"graphStudioUrl": "string",
"machineLearningNotebookUrl": "string",
"machineLearningUserManagementUrl": "string",
"mongoDbUrl": "string",
"ordsUrl": "string",
"spatialStudioUrl": "string",
"sqlDevWebUrl": "string"
},
"cpuCoreCount": number,
"createdAt": "string",
"customerContacts": [
{
"email": "string"
}
],
"databaseEdition": "string",
"databaseManagementStatus": "string",
"databaseType": "string",
"dataSafeStatus": "string",
"dataStorageSizeInGBs": number,
"dataStorageSizeInTBs": number,
"dbName": "string",
"dbToolsDetails": [
{
"computeCount": number,
"isEnabled": boolean,
"maxIdleTimeInMinutes": number,
"name": "string"
}
],
"dbVersion": "string",
"dbWorkload": "string",
"displayName": "string",
"encryptionSummary": {
"encryptionKeyConfiguration": { ... },
"encryptionKeyProvider": "string"
},
"failedDataRecoveryInSeconds": number,
"inMemoryAreaInGBs": number,
"isAutoScalingEnabled": boolean,
"isAutoScalingForStorageEnabled": boolean,
"isBackupRetentionLocked": boolean,
"isLocalDataGuardEnabled": boolean,
"isMtlsConnectionRequired": boolean,
"isReconnectCloneEnabled": boolean,
"isRefreshableClone": boolean,
"isRemoteDataGuardEnabled": boolean,
"licenseModel": "string",
"localAdgAutoFailoverMaxDataLossLimit": number,
"localDisasterRecoveryType": "string",
"localStandbyDb": {
"availabilityDomain": "string",
"lagTimeInSeconds": number,
"maintenanceTargetComponent": "string",
"status": "string",
"statusReason": "string",
"timeDataGuardRoleChanged": "string",
"timeDisasterRecoveryRoleChanged": "string",
"timeMaintenanceBegin": "string",
"timeMaintenanceEnd": "string"
},
"longTermBackupSchedule": {
"isDisabled": boolean,
"repeatCadence": "string",
"retentionPeriodInDays": number,
"timeOfBackup": "string"
},
"maintenanceTargetComponent": "string",
"memoryPerOracleComputeUnitInGBs": number,
"ncharacterSet": "string",
"netServicesArchitecture": "string",
"nextLongTermBackupTimeStamp": "string",
"ocid": "string",
"ociResourceAnchorName": "string",
"ociUrl": "string",
"odbNetworkArn": "string",
"odbNetworkId": "string",
"openMode": "string",
"operationsInsightsStatus": "string",
"peerDbIds": [ "string" ],
"percentProgress": number,
"permissionLevel": "string",
"privateEndpoint": "string",
"privateEndpointIp": "string",
"privateEndpointLabel": "string",
"provisionableCpus": [ number ],
"refreshableMode": "string",
"refreshableStatus": "string",
"remoteDisasterRecoveryConfiguration": {
"disasterRecoveryType": "string",
"isReplicateAutomaticBackups": boolean,
"isSnapshotStandby": boolean,
"timeSnapshotStandbyEnabledTill": "string"
},
"resourcePoolLeaderId": "string",
"resourcePoolSummary": {
"availableComputeCapacity": number,
"availableStorageCapacityInTBs": number,
"isDisabled": boolean,
"poolSize": number,
"poolStorageSizeInTBs": number,
"totalComputeCapacity": number
},
"role": "string",
"scheduledOperations": [
{
"dayOfWeek": {
"name": "string"
},
"scheduledStartTime": "string",
"scheduledStopTime": "string"
}
],
"serviceConsoleUrl": "string",
"sourceId": "string",
"sqlWebDeveloperUrl": "string",
"standbyAllowlistedIps": [ "string" ],
"standbyAllowlistedIpsSource": "string",
"standbyDb": {
"availabilityDomain": "string",
"lagTimeInSeconds": number,
"maintenanceTargetComponent": "string",
"status": "string",
"statusReason": "string",
"timeDataGuardRoleChanged": "string",
"timeDisasterRecoveryRoleChanged": "string",
"timeMaintenanceBegin": "string",
"timeMaintenanceEnd": "string"
},
"status": "string",
"statusReason": "string",
"timeDataGuardRoleChanged": "string",
"timeDeletionOfFreeAutonomousDatabase": "string",
"timeDisasterRecoveryRoleChanged": "string",
"timeLocalDataGuardEnabled": "string",
"timeMaintenanceBegin": "string",
"timeMaintenanceEnd": "string",
"timeOfAutoRefreshStart": "string",
"timeOfLastBackup": "string",
"timeOfLastFailover": "string",
"timeOfLastRefresh": "string",
"timeOfLastRefreshPoint": "string",
"timeOfLastSwitchover": "string",
"timeOfNextRefresh": "string",
"timeReclamationOfFreeAutonomousDatabase": "string",
"timeUndeleted": "string",
"timeUntilReconnectCloneEnabled": "string",
"totalBackupStorageSizeInGBs": number,
"usedDataStorageSizeInGBs": number,
"usedDataStorageSizeInTBs": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- autonomousDatabase
-
The details of the requested Autonomous Database.
Type: AutonomousDatabase object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.
HTTP Status Code: 400
- InternalServerException
-
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.
- resourceId
-
The identifier of the resource that was not found.
- resourceType
-
The type of resource that was not found.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400
- ValidationException
-
The request has failed validation because it is missing required fields or has invalid inputs.
- fieldList
-
A list of fields that failed validation.
- reason
-
The reason why the validation failed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
