Skip to content

list_indices

list_indices(
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[QueryMaxResults] = None,
) -> ListIndicesResponse

Lists the search indices.

Requires permission to access the ListIndices action.

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    The token used to get the next set of results, or null if there are no additional results.

  • max_results (Optional[QueryMaxResults], default: None ) –

    The maximum number of results to return at one time.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def list_indices(
    self,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_iot.types.query_max_results.QueryMaxResults"
    ] = None,
) -> "capo_iot.types.list_indices_response.ListIndicesResponse":
    """<p>Lists the search indices.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListIndices</a> action.</p>

    Args:
        next_token: <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
        max_results: <p>The maximum number of results to return at one time.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.list_indices_request.ListIndicesRequest]",
    ) -> OperationResponse[
        "capo_iot.types.list_indices_response.ListIndicesResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_indices

        output, http_response = (
            capo_iot._operations.aws_iot_service.list_indices.list_indices(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListIndices")
    )
    input_: capo_iot.types.list_indices_request.ListIndicesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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