Skip to content

list_datasets

list_datasets(
    *,
    config_overrides: Optional[LookoutEquipmentClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    dataset_name_begins_with: Optional[DatasetName] = None,
) -> ListDatasetsResponse

Lists all datasets currently available in your account, filtering on the dataset name.

Parameters:

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

    An opaque pagination token indicating where to continue the listing of datasets.

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

    Specifies the maximum number of datasets to list.

  • dataset_name_begins_with (Optional[DatasetName], default: None ) –

    The beginning of the name of the datasets to be listed.

Raises:

  • AccessDeniedException –

    The request could not be completed because you do not have access to the resource.

  • InternalServerException –

    Processing of the request has failed because of an unknown error, exception or failure.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_lookoutequipment/_services/lookout_equipment.py
def list_datasets(
    self,
    *,
    config_overrides: Optional[LookoutEquipmentClientConfig] = None,
    next_token: Optional["capo_lookoutequipment.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_lookoutequipment.types.max_results.MaxResults"
    ] = None,
    dataset_name_begins_with: Optional[
        "capo_lookoutequipment.types.dataset_name.DatasetName"
    ] = None,
) -> "capo_lookoutequipment.types.list_datasets_response.ListDatasetsResponse":
    """<p>Lists all datasets currently available in your account, filtering on the dataset name. </p>

    Args:
        next_token: <p> An opaque pagination token indicating where to continue the listing of datasets. </p>
        max_results: <p> Specifies the maximum number of datasets to list. </p>
        dataset_name_begins_with: <p>The beginning of the name of the datasets to be listed. </p>

    Raises:
        capo_lookoutequipment.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have access to the resource. </p>
        capo_lookoutequipment.errors.internal_server_exception.InternalServerException: <p> Processing of the request has failed because of an unknown error, exception or failure. </p>
        capo_lookoutequipment.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_lookoutequipment.errors.validation_exception.ValidationException: <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. </p>
        capo_lookoutequipment.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lookoutequipment.types.list_datasets_request.ListDatasetsRequest]",
    ) -> OperationResponse[
        "capo_lookoutequipment.types.list_datasets_response.ListDatasetsResponse"
    ]:
        import capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_datasets

        output, http_response = (
            capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_datasets.list_datasets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDatasets")
    )
    input_: capo_lookoutequipment.types.list_datasets_request.ListDatasetsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if dataset_name_begins_with is not None:
        input_["dataset_name_begins_with"] = dataset_name_begins_with

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