AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . odb ]

list-cloud-autonomous-vm-clusters

Description

Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.

See also: AWS API Documentation

list-cloud-autonomous-vm-clusters is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: cloudAutonomousVmClusters

Synopsis

  list-cloud-autonomous-vm-clusters
[--cloud-exadata-infrastructure-id <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]

Options

--cloud-exadata-infrastructure-id (string)

The unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Output

nextToken -> (string)

The pagination token to continue listing from.

cloudAutonomousVmClusters -> (list)

The list of Autonomous VM clusters in the specified Cloud Exadata Infrastructure.

(structure)

A summary of an Autonomous VM cluster.

cloudAutonomousVmClusterId -> (string)

The unique identifier of the Autonomous VM cluster.

cloudAutonomousVmClusterArn -> (string)

The Amazon Resource Name (ARN) for the Autonomous VM cluster.

odbNetworkId -> (string)

The unique identifier of the ODB network associated with this Autonomous VM cluster.

ociResourceAnchorName -> (string)

The name of the OCI resource anchor associated with this Autonomous VM cluster.

percentProgress -> (float)

The progress of the current operation on the Autonomous VM cluster, as a percentage.

displayName -> (string)

The user-friendly name for the Autonomous VM cluster.

status -> (string)

The current status of the Autonomous VM cluster.

statusReason -> (string)

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

cloudExadataInfrastructureId -> (string)

The unique identifier of the Exadata infrastructure containing this Autonomous VM cluster.

autonomousDataStoragePercentage -> (float)

The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.

autonomousDataStorageSizeInTBs -> (double)

The total data storage allocated for Autonomous Databases in the Autonomous VM cluster, in TB.

availableAutonomousDataStorageSizeInTBs -> (double)

The available data storage for Autonomous Databases in the Autonomous VM cluster, in TB.

availableContainerDatabases -> (integer)

The number of Autonomous Container Databases that you can create with the currently available storage.

availableCpus -> (float)

The number of CPU cores available for allocation to Autonomous Databases.

computeModel -> (string)

The compute model of the Autonomous VM cluster: ECPU or OCPU.

cpuCoreCount -> (integer)

The total number of CPU cores in the Autonomous VM cluster.

cpuCoreCountPerNode -> (integer)

The number of CPU cores per node in the Autonomous VM cluster.

cpuPercentage -> (float)

The percentage of total CPU cores currently in use in the Autonomous VM cluster.

dataStorageSizeInGBs -> (double)

The total data storage allocated to the Autonomous VM cluster, in GB.

dataStorageSizeInTBs -> (double)

The total data storage allocated to the Autonomous VM cluster, in TB.

dbNodeStorageSizeInGBs -> (integer)

The local node storage allocated to the Autonomous VM cluster, in GB.

dbServers -> (list)

The list of database servers associated with the Autonomous VM cluster.

(string)

description -> (string)

The user-provided description of the Autonomous VM cluster.

domain -> (string)

The domain name for the Autonomous VM cluster.

exadataStorageInTBsLowestScaledValue -> (double)

The lowest value to which Exadata storage can be scaled down, in TB.

hostname -> (string)

The host name for the Autonomous VM cluster.

ocid -> (string)

The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.

ociUrl -> (string)

The URL for accessing the OCI console page for this Autonomous VM cluster.

isMtlsEnabledVmCluster -> (boolean)

Indicates if mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.

licenseModel -> (string)

The Oracle license model that applies to the Autonomous VM cluster.

maintenanceWindow -> (structure)

The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

customActionTimeoutInMins -> (integer)

The custom action timeout in minutes for the maintenance window.

daysOfWeek -> (list)

The days of the week when maintenance can be performed.

(structure)

An enumeration of days of the week used for scheduling maintenance windows.

name -> (string)

The name of the day of the week.

hoursOfDay -> (list)

The hours of the day when maintenance can be performed.

(integer)

isCustomActionTimeoutEnabled -> (boolean)

Indicates whether custom action timeout is enabled for the maintenance window.

leadTimeInWeeks -> (integer)

The lead time in weeks before the maintenance window.

months -> (list)

The months when maintenance can be performed.

(structure)

An enumeration of months used for scheduling maintenance windows.

name -> (string)

The name of the month.

patchingMode -> (string)

The patching mode for the maintenance window.

preference -> (string)

The preference for the maintenance window scheduling.

skipRu -> (boolean)

Indicates whether to skip release updates during maintenance.

weeksOfMonth -> (list)

The weeks of the month when maintenance can be performed.

(integer)

maxAcdsLowestScaledValue -> (integer)

The lowest value to which you can scale down the maximum number of Autonomous CDBs.

memoryPerOracleComputeUnitInGBs -> (integer)

The amount of memory allocated per Oracle Compute Unit (OCU), in GB.

memorySizeInGBs -> (integer)

The total amount of memory allocated to the Autonomous VM cluster, in GB.

nodeCount -> (integer)

The number of database server nodes in the Autonomous VM cluster.

nonProvisionableAutonomousContainerDatabases -> (integer)

The number of Autonomous CDBs that can’t be provisioned because of resource constraints.

provisionableAutonomousContainerDatabases -> (integer)

The number of Autonomous CDBs that you can provision in the Autonomous VM cluster.

provisionedAutonomousContainerDatabases -> (integer)

The number of Autonomous Container Databases currently provisioned in the Autonomous VM cluster.

provisionedCpus -> (float)

The number of CPUs currently provisioned in the Autonomous VM cluster.

reclaimableCpus -> (float)

The number of CPUs that can be reclaimed from terminated or scaled-down Autonomous Databases.

reservedCpus -> (float)

The number of CPUs reserved for system operations and redundancy.

scanListenerPortNonTls -> (integer)

The SCAN listener port for non-TLS (TCP) protocol.

scanListenerPortTls -> (integer)

The SCAN listener port for TLS (TCP) protocol.

shape -> (string)

The shape of the Exadata infrastructure for the Autonomous VM cluster.

createdAt -> (timestamp)

The date and time when the Autonomous VM cluster was created.

timeDatabaseSslCertificateExpires -> (timestamp)

The expiration date and time of the database SSL certificate.

timeOrdsCertificateExpires -> (timestamp)

The expiration date and time of the Oracle REST Data Services (ORDS) certificate.

timeZone -> (string)

The time zone of the Autonomous VM cluster.

totalContainerDatabases -> (integer)

The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster.