Skip to content

get_config async

get_config(
    client_arn: ClientArn,
    client_version: ClientVersion,
    hapg_list: HapgList,
    *,
    config_overrides: Optional[AsyncCloudHSMClientConfig] = None,
) -> GetConfigResponse

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.

Parameters:

  • client_arn (ClientArn) –

    The ARN of the client.

  • client_version (ClientVersion) –

    The client version.

  • hapg_list (HapgList) –

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

Raises:

Source code in docs_src/capo_cloudhsm/_services/async_cloud_hsm.py
async def get_config(
    self,
    client_arn: "capo_cloudhsm.types.client_arn.ClientArn",
    client_version: "capo_cloudhsm.types.client_version.ClientVersion",
    hapg_list: "capo_cloudhsm.types.hapg_list.HapgList",
    *,
    config_overrides: Optional[AsyncCloudHSMClientConfig] = None,
) -> "capo_cloudhsm.types.get_config_response.GetConfigResponse":
    """<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href="http://aws.amazon.com/cloudhsm/faqs-classic/">AWS CloudHSM Classic FAQs</a>, the <a href="https://docs.aws.amazon.com/cloudhsm/classic/userguide/">AWS CloudHSM Classic User Guide</a>, and the <a href="https://docs.aws.amazon.com/cloudhsm/classic/APIReference/">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href="http://aws.amazon.com/cloudhsm/">AWS CloudHSM</a>, the <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/">AWS CloudHSM User Guide</a>, and the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/">AWS CloudHSM API Reference</a>.</p> <p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>

    Args:
        client_arn: <p>The ARN of the client.</p>
        client_version: <p>The client version.</p>
        hapg_list: <p>A list of ARNs that identify the high-availability partition groups that are associated with the client.</p>

    Raises:
        capo_cloudhsm.errors.cloud_hsm_internal_exception.CloudHsmInternalException: <p>Indicates that an internal error occurred.</p>
        capo_cloudhsm.errors.cloud_hsm_service_exception.CloudHsmServiceException: <p>Indicates that an exception occurred in the AWS CloudHSM service.</p>
        capo_cloudhsm.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that one or more of the request parameters are not valid.</p>
        capo_cloudhsm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudhsm.types.get_config_request.GetConfigRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudhsm.types.get_config_response.GetConfigResponse"
    ]:
        import capo_cloudhsm._operations.cloud_hsm_frontend_service.get_config

        (
            output,
            http_response,
        ) = await capo_cloudhsm._operations.cloud_hsm_frontend_service.get_config.async_get_config(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetConfig")
    )
    input_: capo_cloudhsm.types.get_config_request.GetConfigRequest = {
        "client_arn": client_arn,
        "client_version": client_version,
        "hapg_list": hapg_list,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output