list_time_series_data_points ¶

def list_time_series_data_points(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    entity_identifier: "capo_datazone.types.entity_identifier.EntityIdentifier",
    entity_type: "capo_datazone.types.time_series_entity_type.TimeSeriesEntityType",
    form_name: "capo_datazone.types.time_series_form_name.TimeSeriesFormName",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    started_at: Optional[datetime.datetime] = None,
    ended_at: Optional[datetime.datetime] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
) -> "capo_datazone.types.list_time_series_data_points_output.ListTimeSeriesDataPointsOutput":
    """<p>Lists time series data points.</p>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.</p>
        entity_identifier: <p>The ID of the asset for which you want to list data points.</p>
        entity_type: <p>The type of the asset for which you want to list data points.</p>
        form_name: <p>The name of the time series data points form.</p>
        started_at: <p>The timestamp at which the data points that you want to list started.</p>
        ended_at: <p>The timestamp at which the data points that you wanted to list ended.</p>
        next_token: <p>When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
        max_results: <p>The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.list_time_series_data_points_input.ListTimeSeriesDataPointsInput]",
    ) -> OperationResponse[
        "capo_datazone.types.list_time_series_data_points_output.ListTimeSeriesDataPointsOutput"
    ]:
        import capo_datazone._operations.data_zone.list_time_series_data_points

        output, http_response = (
            capo_datazone._operations.data_zone.list_time_series_data_points.list_time_series_data_points(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTimeSeriesDataPoints")
    )
    input_: capo_datazone.types.list_time_series_data_points_input.ListTimeSeriesDataPointsInput = {
        "domain_identifier": domain_identifier,
        "entity_identifier": entity_identifier,
        "entity_type": entity_type,
        "form_name": form_name,
    }
    if started_at is not None:
        input_["started_at"] = started_at
    if ended_at is not None:
        input_["ended_at"] = ended_at
    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