odb / Client / list_exascale_db_storage_vaults

list_exascale_db_storage_vaults¶

odb.Client.list_exascale_db_storage_vaults(**kwargs)¶

Returns information about the Exascale storage vaults owned by your Amazon Web Services account.

Request Syntax

response = client.list_exascale_db_storage_vaults(
    maxResults=123,
    nextToken='string',
    cloudExadataInfrastructureId='string',
    vaultType='EXASCALE_INFRASTRUCTURE'|'DEDICATED_INFRASTRUCTURE'
)

Parameters:

maxResults (integer) – 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.
nextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
cloudExadataInfrastructureId (string) – 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 Amazon Web Services Resource Access Manager (Amazon Web Services RAM). You can’t combine this filter with a vaultType of EXASCALE_INFRASTRUCTURE.
vaultType (string) – The type of Exascale storage vaults to return. Specify DEDICATED_INFRASTRUCTURE to return Exascale storage vaults on dedicated Exadata infrastructure, or EXASCALE_INFRASTRUCTURE to return Exascale storage vaults for Exascale VM clusters. If you don’t specify a value, the operation returns both types. You can’t combine EXASCALE_INFRASTRUCTURE with the cloudExadataInfrastructureId filter.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'exascaleDbStorageVaults': [
        {
            'exascaleDbStorageVaultId': 'string',
            'additionalFlashCacheInPercent': 123,
            'attachedShapeAttributes': [
                'SMART_STORAGE'|'BLOCK_STORAGE',
            ],
            'autoscaleLimitInGBs': 123,
            'availabilityZone': 'string',
            'availabilityZoneId': 'string',
            'cloudExadataInfrastructureArn': 'string',
            'cloudExadataInfrastructureId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'displayName': 'string',
            'vmClusterArns': [
                'string',
            ],
            'vmClusterCount': 123,
            'vmClusterIds': [
                'string',
            ],
            'exascaleDbStorageVaultArn': 'string',
            'highCapacityDatabaseStorage': {
                'availableSizeInGBs': 123,
                'totalSizeInGBs': 123
            },
            'isAutoscaleEnabled': True|False,
            'ocid': 'string',
            'ociResourceAnchorName': 'string',
            'ociUrl': 'string',
            'percentProgress': ...,
            'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
            'statusReason': 'string',
            'timeZone': 'string',
            'vaultType': 'EXASCALE_INFRASTRUCTURE'|'DEDICATED_INFRASTRUCTURE'
        },
    ]
}

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.
- exascaleDbStorageVaults (list) –
  
  The list of Exascale storage vaults.
  - (dict) –
    
    Summary information about an Exascale storage vault.
    - exascaleDbStorageVaultId (string) –
      
      The unique identifier of the Exascale storage vault.
    - additionalFlashCacheInPercent (integer) –
      
      The additional flash cache percentage for the Exascale storage vault.
    - attachedShapeAttributes (list) –
      
      The list of shape attributes attached to the Exascale storage vault.
      - (string) –
    - autoscaleLimitInGBs (integer) –
      
      The autoscale limit in gigabytes (GB) for the Exascale storage vault.
    - availabilityZone (string) –
      
      The Availability Zone for the Exascale storage vault.
    - availabilityZoneId (string) –
      
      The Availability Zone ID for the Exascale storage vault.
    - cloudExadataInfrastructureArn (string) –
      
      The Amazon Resource Name (ARN) of the Exadata infrastructure that hosts the Exascale storage vault. This value is present only for vaults on dedicated Exadata infrastructure.
    - cloudExadataInfrastructureId (string) –
      
      The unique identifier of the Exadata infrastructure that hosts the Exascale storage vault. This value is present only for vaults on dedicated Exadata infrastructure.
    - createdAt (datetime) –
      
      The date and time when the Exascale storage vault was created.
    - description (string) –
      
      The description of the Exascale storage vault.
    - displayName (string) –
      
      The user-friendly name for the Exascale storage vault.
    - vmClusterArns (list) –
      
      The list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault.
      - (string) –
    - vmClusterCount (integer) –
      
      The number of VM clusters associated with this Exascale storage vault.
    - vmClusterIds (list) –
      
      The list of unique identifiers of the VM clusters associated with this Exascale storage vault.
      - (string) –
    - exascaleDbStorageVaultArn (string) –
      
      The Amazon Resource Name (ARN) of the Exascale storage vault.
    - highCapacityDatabaseStorage (dict) –
      
      The high-capacity database storage details for the Exascale storage vault.
      - availableSizeInGBs (integer) –
        
        The available storage size, in gigabytes (GB).
      - totalSizeInGBs (integer) –
        
        The total storage size, in gigabytes (GB).
    - isAutoscaleEnabled (boolean) –
      
      Specifies whether autoscaling is enabled for the Exascale storage vault.
    - ocid (string) –
      
      The OCID of the Exascale storage vault.
    - ociResourceAnchorName (string) –
      
      The name of the OCI resource anchor for the Exascale storage vault.
    - ociUrl (string) –
      
      The HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI).
    - percentProgress (float) –
      
      The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage.
    - status (string) –
      
      The current status of the Exascale storage vault.
    - statusReason (string) –
      
      Additional information about the status of the Exascale storage vault.
    - timeZone (string) –
      
      The time zone of the Exascale storage vault.
    - vaultType (string) –
      
      The type of infrastructure that hosts the Exascale storage vault.

list_exascale_db_storage_vaults¶

Request Syntax

Response Syntax

Response Structure

Exceptions