CloudHSM / Client / get_config

get_config#

CloudHSM.Client.get_config(**kwargs)#

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.

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.get_config(
    ClientArn='string',
    ClientVersion='5.1'|'5.3',
    HapgList=[
        'string',
    ]
)
Parameters:

  • ClientArn (string) –

    [REQUIRED]

    The ARN of the client.

  • ClientVersion (string) –

    [REQUIRED]

    The client version.

  • HapgList (list) –

    [REQUIRED]

    A list of ARNs that identify the high-availability partition groups that are associated with the client.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ConfigType': 'string',
    'ConfigFile': 'string',
    'ConfigCred': 'string'
}

Response Structure

  • (dict) –

    • ConfigType (string) –

      The type of credentials.

    • ConfigFile (string) –

      The chrystoki.conf configuration file.

    • ConfigCred (string) –

      The certificate file containing the server.pem files of the HSMs.

Exceptions

  • CloudHSM.Client.exceptions.CloudHsmServiceException

  • CloudHSM.Client.exceptions.CloudHsmInternalException

  • CloudHSM.Client.exceptions.InvalidRequestException