describe_time_series ¶

def describe_time_series(
    self,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    alias: Optional["capo_iotsitewise.types.property_alias.PropertyAlias"] = None,
    asset_id: Optional["capo_iotsitewise.types.custom_id.CustomID"] = None,
    property_id: Optional["capo_iotsitewise.types.custom_id.CustomID"] = None,
    workspace_name: Optional[
        "capo_iotsitewise.types.workspace_name.WorkspaceName"
    ] = None,
) -> "capo_iotsitewise.types.describe_time_series_response.DescribeTimeSeriesResponse":
    """<p>Retrieves information about a time series (data stream).</p> <p>To identify a time series, do one of the following:</p> <ul> <li> <p>If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series.</p> </li> <li> <p>If the time series is associated with an asset property, specify one of the following: </p> <ul> <li> <p>The <code>alias</code> of the time series.</p> </li> <li> <p>The <code>assetId</code> and <code>propertyId</code> that identifies the asset property.</p> </li> </ul> </li> </ul>

    Args:
        alias: <p>The alias that identifies the time series.</p>
        asset_id: <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
        property_id: <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
        workspace_name: <p>The name of the workspace.</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.describe_time_series_request.DescribeTimeSeriesRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.describe_time_series_response.DescribeTimeSeriesResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_time_series

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTimeSeries")
    )
    input_: capo_iotsitewise.types.describe_time_series_request.DescribeTimeSeriesRequest = {}
    if alias is not None:
        input_["alias"] = alias
    if asset_id is not None:
        input_["asset_id"] = asset_id
    if property_id is not None:
        input_["property_id"] = property_id
    if workspace_name is not None:
        input_["workspace_name"] = workspace_name

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