Skip to content

get_lens

get_lens(
    lens_alias: LensAlias,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    lens_version: Optional[LensVersion] = None,
) -> GetLensOutput

Get an existing lens.

Parameters:

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def get_lens(
    self,
    lens_alias: "capo_wellarchitected.types.lens_alias.LensAlias",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    lens_version: Optional[
        "capo_wellarchitected.types.lens_version.LensVersion"
    ] = None,
) -> "capo_wellarchitected.types.get_lens_output.GetLensOutput":
    """<p>Get an existing lens.</p>

    Args:
        lens_version: <p>The lens version to be retrieved.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.get_lens_input.GetLensInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.get_lens_output.GetLensOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.get_lens

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.get_lens.get_lens(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLens")
    )
    input_: capo_wellarchitected.types.get_lens_input.GetLensInput = {
        "lens_alias": lens_alias
    }
    if lens_version is not None:
        input_["lens_version"] = lens_version

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