ListExascaleDbStorageVaults
Returns information about the Exascale storage vaults owned by your AWS account.
Request Syntax
{
"cloudExadataInfrastructureId": "string",
"maxResults": number,
"nextToken": "string",
"vaultType": "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.
- cloudExadataInfrastructureId
-
The unique identifier or Amazon Resource Name (ARN) of an Exadata infrastructure. If you specify this value, the operation returns only the Exascale storage vaults on that infrastructure that you own or that are shared with you. The infrastructure can be one that's shared with you through AWS Resource Access Manager (AWS RAM). You can't combine this filter with a
vaultTypeofEXASCALE_INFRASTRUCTURE.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: No
- 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: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- nextToken
-
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Required: No
- vaultType
-
The type of Exascale storage vaults to return. Specify
DEDICATED_INFRASTRUCTUREto return Exascale storage vaults on dedicated Exadata infrastructure, orEXASCALE_INFRASTRUCTUREto return Exascale storage vaults for Exascale VM clusters. If you don't specify a value, the operation returns both types. You can't combineEXASCALE_INFRASTRUCTUREwith thecloudExadataInfrastructureIdfilter.Type: String
Valid Values:
EXASCALE_INFRASTRUCTURE | DEDICATED_INFRASTRUCTURERequired: No
Response Syntax
{
"exascaleDbStorageVaults": [
{
"additionalFlashCacheInPercent": number,
"attachedShapeAttributes": [ "string" ],
"autoscaleLimitInGBs": number,
"availabilityZone": "string",
"availabilityZoneId": "string",
"cloudExadataInfrastructureArn": "string",
"cloudExadataInfrastructureId": "string",
"createdAt": "string",
"description": "string",
"displayName": "string",
"exascaleDbStorageVaultArn": "string",
"exascaleDbStorageVaultId": "string",
"highCapacityDatabaseStorage": {
"availableSizeInGBs": number,
"totalSizeInGBs": number
},
"isAutoscaleEnabled": boolean,
"ocid": "string",
"ociResourceAnchorName": "string",
"ociUrl": "string",
"percentProgress": number,
"status": "string",
"statusReason": "string",
"timeZone": "string",
"vaultType": "string",
"vmClusterArns": [ "string" ],
"vmClusterCount": number,
"vmClusterIds": [ "string" ]
}
],
"nextToken": "string"
}
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.
- exascaleDbStorageVaults
-
The list of Exascale storage vaults.
Type: Array of ExascaleDbStorageVaultSummary objects
- nextToken
-
The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.Type: String
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: