Skip to content

list_datasets async

list_datasets(
    source_type: DatasetSourceType,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    workspace_name: Optional[WorkspaceName] = None,
    dataset_type: Optional[DatasetTypeEnum] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDatasetsResponse

Retrieves a paginated list of datasets for a specific target resource.

Parameters:

  • source_type (DatasetSourceType) –

    The type of data source for the dataset.

  • workspace_name (Optional[WorkspaceName], default: None ) –

    The name of the workspace to filter datasets by.

  • dataset_type (Optional[DatasetTypeEnum], default: None ) –

    The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource.

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

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

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

    The maximum number of results to return for each paginated request.

Raises:

  • InternalFailureException –

    IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException –

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException –

    The requested resource can't be found.

  • ThrottlingException –

    Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

    For more information, see Quotas in the IoT SiteWise User Guide.

  • UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py
async def list_datasets(
    self,
    source_type: "capo_iotsitewise.types.dataset_source_type.DatasetSourceType",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    workspace_name: Optional[
        "capo_iotsitewise.types.workspace_name.WorkspaceName"
    ] = None,
    dataset_type: Optional[
        "capo_iotsitewise.types.dataset_type_enum.DatasetTypeEnum"
    ] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
) -> "capo_iotsitewise.types.list_datasets_response.ListDatasetsResponse":
    """<p>Retrieves a paginated list of datasets for a specific target resource.</p>

    Args:
        source_type: <p>The type of data source for the dataset.</p>
        workspace_name: <p>The name of the workspace to filter datasets by.</p>
        dataset_type: <p>The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource.</p>
        next_token: <p>The token for the next set of results, or null if there are no additional results.</p>
        max_results: <p>The maximum number of results to return for each paginated request.</p>

    Raises:
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.list_datasets_request.ListDatasetsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.list_datasets_response.ListDatasetsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_datasets

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.list_datasets.async_list_datasets(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output