Struct aws_sdk_forecast::operation::describe_dataset_import_job::DescribeDatasetImportJobOutput

#[non_exhaustive]
pub struct DescribeDatasetImportJobOutput {

    pub dataset_import_job_name: Option<String>,
    pub dataset_import_job_arn: Option<String>,
    pub dataset_arn: Option<String>,
    pub timestamp_format: Option<String>,
    pub time_zone: Option<String>,
    pub use_geolocation_for_time_zone: bool,
    pub geolocation_format: Option<String>,
    pub data_source: Option<DataSource>,
    pub estimated_time_remaining_in_minutes: Option<i64>,
    pub field_statistics: Option<HashMap<String, Statistics>>,
    pub data_size: Option<f64>,
    pub status: Option<String>,
    pub message: Option<String>,
    pub creation_time: Option<DateTime>,
    pub last_modification_time: Option<DateTime>,
    pub format: Option<String>,
    pub import_mode: Option<ImportMode>,
    /* 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_import_job_name: Option<String>

The name of the dataset import job.

dataset_import_job_arn: Option<String>

The ARN of the dataset import job.

dataset_arn: Option<String>

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

timestamp_format: Option<String>

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

• "yyyy-MM-dd"

  For the following data frequencies: Y, M, W, and D

• "yyyy-MM-dd HH:mm:ss"

  For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

time_zone: Option<String>

The single time zone applied to every item in the dataset

use_geolocation_for_time_zone: bool

Whether TimeZone is automatically derived from the geolocation attribute.

geolocation_format: Option<String>

The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

data_source: Option<DataSource>

The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an Key Management Service (KMS) key.

estimated_time_remaining_in_minutes: Option<i64>

The estimated time remaining in minutes for the dataset import job to complete.

field_statistics: Option<HashMap<String, Statistics>>

Statistical information about each field in the input data.

data_size: Option<f64>

The size of the dataset in gigabytes (GB) after the import job has finished.

status: Option<String>

The status of the dataset import job. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

message: Option<String>

If an error occurred, an informational message about the error.

creation_time: Option<DateTime>

When the dataset import job was created.

last_modification_time: Option<DateTime>

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

format: Option<String>

The format of the imported data, CSV or PARQUET.

import_mode: Option<ImportMode>

The import mode of the dataset import job, FULL or INCREMENTAL.

Implementations

impl DescribeDatasetImportJobOutput

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

The name of the dataset import job.

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

The ARN of the dataset import job.

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

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

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

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

• "yyyy-MM-dd"

  For the following data frequencies: Y, M, W, and D

• "yyyy-MM-dd HH:mm:ss"

  For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

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

The single time zone applied to every item in the dataset

pub fn use_geolocation_for_time_zone(&self) -> bool

Whether TimeZone is automatically derived from the geolocation attribute.

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

The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

pub fn data_source(&self) -> Option<&DataSource>

The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an Key Management Service (KMS) key.

pub fn estimated_time_remaining_in_minutes(&self) -> Option<i64>

The estimated time remaining in minutes for the dataset import job to complete.

pub fn field_statistics(&self) -> Option<&HashMap<String, Statistics>>

Statistical information about each field in the input data.

pub fn data_size(&self) -> Option<f64>

The size of the dataset in gigabytes (GB) after the import job has finished.

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

The status of the dataset import job. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

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

If an error occurred, an informational message about the error.

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

When the dataset import job was created.

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

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

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

The format of the imported data, CSV or PARQUET.

pub fn import_mode(&self) -> Option<&ImportMode>

The import mode of the dataset import job, FULL or INCREMENTAL.

impl DescribeDatasetImportJobOutput

pub fn builder() -> DescribeDatasetImportJobOutputBuilder

Creates a new builder-style object to manufacture DescribeDatasetImportJobOutput.

Trait Implementations

impl Clone for DescribeDatasetImportJobOutput

fn clone(&self) -> DescribeDatasetImportJobOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDatasetImportJobOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeDatasetImportJobOutput

fn eq(&self, other: &DescribeDatasetImportJobOutput) -> 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 DescribeDatasetImportJobOutput

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

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

impl StructuralPartialEq for DescribeDatasetImportJobOutput