Struct aws_sdk_forecast::operation::describe_dataset::DescribeDatasetOutput

#[non_exhaustive]
pub struct DescribeDatasetOutput {
    pub dataset_arn: Option<String>,
    pub dataset_name: Option<String>,
    pub domain: Option<Domain>,
    pub dataset_type: Option<DatasetType>,
    pub data_frequency: Option<String>,
    pub schema: Option<Schema>,
    pub encryption_config: Option<EncryptionConfig>,
    pub status: Option<String>,
    pub creation_time: Option<DateTime>,
    pub last_modification_time: Option<DateTime>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dataset_arn: Option<String>

The Amazon Resource Name (ARN) of the dataset.

dataset_name: Option<String>

The name of the dataset.

domain: Option<Domain>

The domain associated with the dataset.

dataset_type: Option<DatasetType>

The dataset type.

data_frequency: Option<String>

The frequency of data collection.

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.

schema: Option<Schema>

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

encryption_config: Option<EncryptionConfig>

The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

status: Option<String>

The status of the dataset. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.

The Status of the dataset must be ACTIVE before you can import training data.

creation_time: Option<DateTime>

When the dataset was created.

last_modification_time: Option<DateTime>

When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the DescribeDataset call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

Implementations

impl DescribeDatasetOutput

pub fn dataset_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the dataset.

pub fn dataset_name(&self) -> Option<&str>

The name of the dataset.

pub fn domain(&self) -> Option<&Domain>

The domain associated with the dataset.

pub fn dataset_type(&self) -> Option<&DatasetType>

The dataset type.

pub fn data_frequency(&self) -> Option<&str>

The frequency of data collection.

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.

pub fn schema(&self) -> Option<&Schema>

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

pub fn encryption_config(&self) -> Option<&EncryptionConfig>

The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

pub fn status(&self) -> Option<&str>

The status of the dataset. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.

The Status of the dataset must be ACTIVE before you can import training data.

pub fn creation_time(&self) -> Option<&DateTime>

When the dataset was created.

pub fn last_modification_time(&self) -> Option<&DateTime>

When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the DescribeDataset call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

impl DescribeDatasetOutput

pub fn builder() -> DescribeDatasetOutputBuilder

Creates a new builder-style object to manufacture DescribeDatasetOutput.

Trait Implementations

impl Clone for DescribeDatasetOutput

fn clone(&self) -> DescribeDatasetOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeDatasetOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeDatasetOutput

fn eq(&self, other: &DescribeDatasetOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeDatasetOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeDatasetOutput