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

get-kx-volume

Description

Retrieves the information about the volume.

See also: AWS API Documentation

Synopsis

  get-kx-volume
--environment-id <value>
--volume-name <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>]

Options

--environment-id (string)

A unique identifier for the kdb environment, whose clusters can attach to the volume.

--volume-name (string)

A unique identifier for the volume.

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

Output

environmentId -> (string)

A unique identifier for the kdb environment, whose clusters can attach to the volume.

volumeName -> (string)

A unique identifier for the volume.

volumeType -> (string)

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

volumeArn -> (string)

The ARN identifier of the volume.

nas1Configuration -> (structure)

Specifies the configuration for the Network attached storage (NAS_1) file system volume.

type -> (string)

The type of the network attached storage.

size -> (integer)

The size of the network attached storage. For storage type SSD_1000 and SSD_250 you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type HDD_12 you can select the minimum size as 6000 GB or increments of 6000 GB.

status -> (string)

The status of volume creation.

  • CREATING – The volume creation is in progress.
  • CREATE_FAILED – The volume creation has failed.
  • ACTIVE – The volume is active.
  • UPDATING – The volume is in the process of being updated.
  • UPDATE_FAILED – The update action failed.
  • UPDATED – The volume is successfully updated.
  • DELETING – The volume is in the process of being deleted.
  • DELETE_FAILED – The system failed to delete the volume.
  • DELETED – The volume is successfully deleted.

statusReason -> (string)

The error message when a failed state occurs.

createdTimestamp -> (timestamp)

The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

description -> (string)

A description of the volume.

azMode -> (string)

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

availabilityZoneIds -> (list)

The identifier of the availability zones.

(string)

lastModifiedTimestamp -> (timestamp)

The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

attachedClusters -> (list)

A list of cluster identifiers that a volume is attached to.

(structure)

The structure containing the metadata of the attached clusters.

clusterName -> (string)

A unique name for the attached cluster.

clusterType -> (string)

Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.

clusterStatus -> (string)

The status of the attached cluster.

  • PENDING – The cluster is pending creation.
  • CREATING – The cluster creation process is in progress.
  • CREATE_FAILED – The cluster creation process has failed.
  • RUNNING – The cluster creation process is running.
  • UPDATING – The cluster is in the process of being updated.
  • DELETING – The cluster is in the process of being deleted.
  • DELETED – The cluster has been deleted.
  • DELETE_FAILED – The cluster failed to delete.