list_dataset_data_segments ¶

def list_dataset_data_segments(
    self,
    dataset_id: "capo_iotsitewise.types.id.ID",
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    dataset_version: Optional["capo_iotsitewise.types.version.Version"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
) -> "capo_iotsitewise.types.list_dataset_data_segments_response.ListDatasetDataSegmentsResponse":
    """<p>Retrieves a paginated list of data segments associated with a dataset. Use the <code>nextToken</code> parameter to retrieve additional results.</p>

    Args:
        dataset_id: <p>The ID of the dataset.</p>
        workspace_name: <p>The name of the workspace that contains the dataset.</p>
        dataset_version: <p>The version of the dataset to list data segments for.</p>
        max_results: <p>The maximum number of results to return for each paginated request. Default: 50.</p>
        next_token: <p>The token to be used for the next set of paginated results.</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.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.list_dataset_data_segments_request.ListDatasetDataSegmentsRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.list_dataset_data_segments_response.ListDatasetDataSegmentsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_dataset_data_segments

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.list_dataset_data_segments.list_dataset_data_segments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDatasetDataSegments")
    )
    input_: capo_iotsitewise.types.list_dataset_data_segments_request.ListDatasetDataSegmentsRequest = {
        "dataset_id": dataset_id,
        "workspace_name": workspace_name,
    }
    if dataset_version is not None:
        input_["dataset_version"] = dataset_version
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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