list_dataset_data_segment_relationships ¶

list_dataset_data_segment_relationships(
    dataset_id: ID,
    workspace_name: WorkspaceName,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListDatasetDataSegmentRelationshipsResponse

Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results.

Parameters:

dataset_id (ID) –

The ID of the session dataset to list data segment relationships for.
workspace_name (WorkspaceName) –

The name of the workspace that contains the dataset.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return for each paginated request. Default: 50.
next_token (Optional[NextToken], default: None ) –

The token to be used for the next set of paginated results.

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/io_t_site_wise.py

def list_dataset_data_segment_relationships(
    self,
    dataset_id: "capo_iotsitewise.types.id.ID",
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = 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_segment_relationships_response.ListDatasetDataSegmentRelationshipsResponse":
    """<p>Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the <code>nextToken</code> parameter to retrieve additional results.</p>

    Args:
        dataset_id: <p>The ID of the session dataset to list data segment relationships for.</p>
        workspace_name: <p>The name of the workspace that contains the dataset.</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_segment_relationships_request.ListDatasetDataSegmentRelationshipsRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.list_dataset_data_segment_relationships_response.ListDatasetDataSegmentRelationshipsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_dataset_data_segment_relationships

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDatasetDataSegmentRelationships")
    )
    input_: capo_iotsitewise.types.list_dataset_data_segment_relationships_request.ListDatasetDataSegmentRelationshipsRequest = {
        "dataset_id": dataset_id,
        "workspace_name": workspace_name,
    }
    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