1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeTimeSeries`](crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`alias(impl Into<String>)`](crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder::alias) / [`set_alias(Option<String>)`](crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder::set_alias):<br>required: **false**<br><p>The alias that identifies the time series.</p><br>
    ///   - [`asset_id(impl Into<String>)`](crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder::asset_id) / [`set_asset_id(Option<String>)`](crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder::set_asset_id):<br>required: **false**<br><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><br>
    ///   - [`property_id(impl Into<String>)`](crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder::property_id) / [`set_property_id(Option<String>)`](crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder::set_property_id):<br>required: **false**<br><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><br>
    /// - On success, responds with [`DescribeTimeSeriesOutput`](crate::operation::describe_time_series::DescribeTimeSeriesOutput) with field(s):
    ///   - [`asset_id(Option<String>)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::asset_id): <p>The ID of the asset in which the asset property was created.</p>
    ///   - [`property_id(Option<String>)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::property_id): <p>The ID of the asset property, in UUID format.</p>
    ///   - [`alias(Option<String>)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::alias): <p>The alias that identifies the time series.</p>
    ///   - [`time_series_id(String)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::time_series_id): <p>The ID of the time series.</p>
    ///   - [`data_type(PropertyDataType)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::data_type): <p>The data type of the time series.</p> <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
    ///   - [`data_type_spec(Option<String>)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::data_type_spec): <p>The data type of the structure for this time series. This parameter is required for time series that have the <code>STRUCT</code> data type.</p> <p>The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
    ///   - [`time_series_creation_date(DateTime)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::time_series_creation_date): <p>The date that the time series was created, in Unix epoch time.</p>
    ///   - [`time_series_last_update_date(DateTime)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::time_series_last_update_date): <p>The date that the time series was last updated, in Unix epoch time.</p>
    ///   - [`time_series_arn(String)`](crate::operation::describe_time_series::DescribeTimeSeriesOutput::time_series_arn): <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p> <p><code>arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}</code></p>
    /// - On failure, responds with [`SdkError<DescribeTimeSeriesError>`](crate::operation::describe_time_series::DescribeTimeSeriesError)
    pub fn describe_time_series(&self) -> crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder {
        crate::operation::describe_time_series::builders::DescribeTimeSeriesFluentBuilder::new(self.handle.clone())
    }
}