Skip to content

list_lenses

list_lenses(
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    lens_type: Optional[LensType] = None,
    lens_status: Optional[LensStatusType] = None,
    lens_name: Optional[LensName] = None,
) -> ListLensesOutput

List the available lenses.

Parameters:

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def list_lenses(
    self,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    next_token: Optional["capo_wellarchitected.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_wellarchitected.types.max_results.MaxResults"
    ] = None,
    lens_type: Optional["capo_wellarchitected.types.lens_type.LensType"] = None,
    lens_status: Optional[
        "capo_wellarchitected.types.lens_status_type.LensStatusType"
    ] = None,
    lens_name: Optional["capo_wellarchitected.types.lens_name.LensName"] = None,
) -> "capo_wellarchitected.types.list_lenses_output.ListLensesOutput":
    """<p>List the available lenses.</p>

    Args:
        lens_type: <p>The type of lenses to be returned.</p>
        lens_status: <p>The status of lenses to be returned.</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.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.list_lenses_input.ListLensesInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.list_lenses_output.ListLensesOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.list_lenses

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLenses")
    )
    input_: capo_wellarchitected.types.list_lenses_input.ListLensesInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if lens_type is not None:
        input_["lens_type"] = lens_type
    if lens_status is not None:
        input_["lens_status"] = lens_status
    if lens_name is not None:
        input_["lens_name"] = lens_name

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