1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDataset`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dataset_arn(impl Into<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::dataset_arn) / [`set_dataset_arn(Option<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::set_dataset_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the dataset.</p><br>
    /// - On success, responds with [`DescribeDatasetOutput`](crate::operation::describe_dataset::DescribeDatasetOutput) with field(s):
    ///   - [`dataset_arn(Option<String>)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_arn): <p>The Amazon Resource Name (ARN) of the dataset.</p>
    ///   - [`dataset_name(Option<String>)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_name): <p>The name of the dataset.</p>
    ///   - [`domain(Option<Domain>)`](crate::operation::describe_dataset::DescribeDatasetOutput::domain): <p>The domain associated with the dataset.</p>
    ///   - [`dataset_type(Option<DatasetType>)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_type): <p>The dataset type.</p>
    ///   - [`data_frequency(Option<String>)`](crate::operation::describe_dataset::DescribeDatasetOutput::data_frequency): <p>The frequency of data collection.</p> <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.</p>
    ///   - [`schema(Option<Schema>)`](crate::operation::describe_dataset::DescribeDatasetOutput::schema): <p>An array of <code>SchemaAttribute</code> objects that specify the dataset fields. Each <code>SchemaAttribute</code> specifies the name and data type of a field.</p>
    ///   - [`encryption_config(Option<EncryptionConfig>)`](crate::operation::describe_dataset::DescribeDatasetOutput::encryption_config): <p>The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.</p>
    ///   - [`status(Option<String>)`](crate::operation::describe_dataset::DescribeDatasetOutput::status): <p>The status of the dataset. States include:</p> <ul>  <li>   <p><code>ACTIVE</code></p></li>  <li>   <p><code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code></p></li>  <li>   <p><code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code></p></li>  <li>   <p><code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code></p></li> </ul> <p>The <code>UPDATE</code> states apply while data is imported to the dataset from a call to the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation and reflect the status of the dataset import job. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the dataset is <code>UPDATE_IN_PROGRESS</code>.</p><note>  <p>The <code>Status</code> of the dataset must be <code>ACTIVE</code> before you can import training data.</p> </note>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_dataset::DescribeDatasetOutput::creation_time): <p>When the dataset was created.</p>
    ///   - [`last_modification_time(Option<DateTime>)`](crate::operation::describe_dataset::DescribeDatasetOutput::last_modification_time): <p>When you create a dataset, <code>LastModificationTime</code> is the same as <code>CreationTime</code>. While data is being imported to the dataset, <code>LastModificationTime</code> is the current time of the <code>DescribeDataset</code> call. After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation has finished, <code>LastModificationTime</code> is when the import job completed or failed.</p>
    /// - On failure, responds with [`SdkError<DescribeDatasetError>`](crate::operation::describe_dataset::DescribeDatasetError)
    pub fn describe_dataset(&self) -> crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder {
        crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::new(self.handle.clone())
    }
}