[ aws . cloudhsm ]

describe-hapg

Description

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

For information about the current version of AWS CloudHSM , see AWS CloudHSM , the AWS CloudHSM User Guide , and the AWS CloudHSM API Reference .

Retrieves information about a high-availability partition group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-hapg
--hapg-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--hapg-arn (string)

The ARN of the high-availability partition group to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

HapgArn -> (string)

The ARN of the high-availability partition group.

HapgSerial -> (string)

The serial number of the high-availability partition group.

HsmsLastActionFailed -> (list)

(string)

An ARN that identifies an HSM.

HsmsPendingDeletion -> (list)

(string)

An ARN that identifies an HSM.

HsmsPendingRegistration -> (list)

(string)

An ARN that identifies an HSM.

Label -> (string)

The label for the high-availability partition group.

LastModifiedTimestamp -> (string)

The date and time the high-availability partition group was last modified.

PartitionSerialList -> (list)

The list of partition serial numbers that belong to the high-availability partition group.

(string)

State -> (string)

The state of the high-availability partition group.