Skip to content

get_resource_policy

get_resource_policy(
    *,
    config_overrides: Optional[CloudHSMV2ClientConfig] = None,
    resource_arn: Optional[CloudHsmArn] = None,
) -> GetResourcePolicyResponse

Retrieves the resource policy document attached to a given resource.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameters:

  • resource_arn (Optional[CloudHsmArn], default: None ) –

    Amazon Resource Name (ARN) of the resource to which a policy is attached.

Raises:

Source code in docs_src/capo_cloudhsm_v2/_services/cloud_hsmv2.py
def get_resource_policy(
    self,
    *,
    config_overrides: Optional[CloudHSMV2ClientConfig] = None,
    resource_arn: Optional[
        "capo_cloudhsm_v2.types.cloud_hsm_arn.CloudHsmArn"
    ] = None,
) -> (
    "capo_cloudhsm_v2.types.get_resource_policy_response.GetResourcePolicyResponse"
):
    """<p> Retrieves the resource policy document attached to a given resource. </p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>

    Args:
        resource_arn: <p>Amazon Resource Name (ARN) of the resource to which a policy is attached.</p>

    Raises:
        capo_cloudhsm_v2.errors.cloud_hsm_access_denied_exception.CloudHsmAccessDeniedException: <p>The request was rejected because the requester does not have permission to perform the requested operation.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_internal_failure_exception.CloudHsmInternalFailureException: <p>The request was rejected because of an CloudHSM internal failure. The request can be retried.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_invalid_request_exception.CloudHsmInvalidRequestException: <p>The request was rejected because it is not a valid request.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_resource_not_found_exception.CloudHsmResourceNotFoundException: <p>The request was rejected because it refers to a resource that cannot be found.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_service_exception.CloudHsmServiceException: <p>The request was rejected because an error occurred.</p>
        capo_cloudhsm_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudhsm_v2.types.get_resource_policy_request.GetResourcePolicyRequest]",
    ) -> OperationResponse[
        "capo_cloudhsm_v2.types.get_resource_policy_response.GetResourcePolicyResponse"
    ]:
        import capo_cloudhsm_v2._operations.baldr_api_service.get_resource_policy

        output, http_response = (
            capo_cloudhsm_v2._operations.baldr_api_service.get_resource_policy.get_resource_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetResourcePolicy")
    )
    input_: capo_cloudhsm_v2.types.get_resource_policy_request.GetResourcePolicyRequest = {}
    if resource_arn is not None:
        input_["resource_arn"] = resource_arn

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