describe_hapg ¶

describe_hapg(
    hapg_arn: HapgArn, *, config_overrides: Optional[CloudHSMClientConfig] = None
) -> DescribeHapgResponse

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.

Parameters:

hapg_arn (HapgArn) –

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

Raises:

CloudHsmInternalException –

Indicates that an internal error occurred.
CloudHsmServiceException –

Indicates that an exception occurred in the AWS CloudHSM service.
InvalidRequestException –

Indicates that one or more of the request parameters are not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cloudhsm/_services/cloud_hsm.py

def describe_hapg(
    self,
    hapg_arn: "capo_cloudhsm.types.hapg_arn.HapgArn",
    *,
    config_overrides: Optional[CloudHSMClientConfig] = None,
) -> "capo_cloudhsm.types.describe_hapg_response.DescribeHapgResponse":
    """<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>Retrieves information about a high-availability partition group.</p>

    Args:
        hapg_arn: <p>The ARN of the high-availability partition group to describe.</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.
    """

    def _handler(
        req: "OperationRequest[capo_cloudhsm.types.describe_hapg_request.DescribeHapgRequest]",
    ) -> OperationResponse[
        "capo_cloudhsm.types.describe_hapg_response.DescribeHapgResponse"
    ]:
        import capo_cloudhsm._operations.cloud_hsm_frontend_service.describe_hapg

        output, http_response = (
            capo_cloudhsm._operations.cloud_hsm_frontend_service.describe_hapg.describe_hapg(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeHapg")
    )
    input_: capo_cloudhsm.types.describe_hapg_request.DescribeHapgRequest = {
        "hapg_arn": hapg_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output