Skip to content

get_analysis_template

get_analysis_template(
    membership_identifier: MembershipIdentifier,
    analysis_template_identifier: AnalysisTemplateIdentifier,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
) -> GetAnalysisTemplateOutput

Retrieves an analysis template.

Parameters:

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def get_analysis_template(
    self,
    membership_identifier: "capo_cleanrooms.types.membership_identifier.MembershipIdentifier",
    analysis_template_identifier: "capo_cleanrooms.types.analysis_template_identifier.AnalysisTemplateIdentifier",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
) -> "capo_cleanrooms.types.get_analysis_template_output.GetAnalysisTemplateOutput":
    """<p>Retrieves an analysis template.</p>

    Args:
        membership_identifier: <p>The identifier for a membership resource.</p>
        analysis_template_identifier: <p>The identifier for the analysis template resource.</p>

    Raises:
        capo_cleanrooms.errors.access_denied_exception.AccessDeniedException: <p>Caller does not have sufficient access to perform this action.</p>
        capo_cleanrooms.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_cleanrooms.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_cleanrooms.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_cleanrooms.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
        capo_cleanrooms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cleanrooms.types.get_analysis_template_input.GetAnalysisTemplateInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.get_analysis_template_output.GetAnalysisTemplateOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.get_analysis_template

        output, http_response = (
            capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.get_analysis_template.get_analysis_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_cleanrooms.types.get_analysis_template_output.GetAnalysisTemplateOutput",
    ) -> dict[str, Any]:
        import capo_cleanrooms.types.get_analysis_template_output

        return capo_cleanrooms.types.get_analysis_template_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetAnalysisTemplate", redact_output=_redact_output),
    )
    input_: capo_cleanrooms.types.get_analysis_template_input.GetAnalysisTemplateInput = {
        "membership_identifier": membership_identifier,
        "analysis_template_identifier": analysis_template_identifier,
    }

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