AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::ForecastService::Model::DescribeDatasetImportJobResult Class Reference

#include <DescribeDatasetImportJobResult.h>

Public Member Functions

 DescribeDatasetImportJobResult ()
 
 DescribeDatasetImportJobResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeDatasetImportJobResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetDatasetImportJobName () const
 
void SetDatasetImportJobName (const Aws::String &value)
 
void SetDatasetImportJobName (Aws::String &&value)
 
void SetDatasetImportJobName (const char *value)
 
DescribeDatasetImportJobResultWithDatasetImportJobName (const Aws::String &value)
 
DescribeDatasetImportJobResultWithDatasetImportJobName (Aws::String &&value)
 
DescribeDatasetImportJobResultWithDatasetImportJobName (const char *value)
 
const Aws::StringGetDatasetImportJobArn () const
 
void SetDatasetImportJobArn (const Aws::String &value)
 
void SetDatasetImportJobArn (Aws::String &&value)
 
void SetDatasetImportJobArn (const char *value)
 
DescribeDatasetImportJobResultWithDatasetImportJobArn (const Aws::String &value)
 
DescribeDatasetImportJobResultWithDatasetImportJobArn (Aws::String &&value)
 
DescribeDatasetImportJobResultWithDatasetImportJobArn (const char *value)
 
const Aws::StringGetDatasetArn () const
 
void SetDatasetArn (const Aws::String &value)
 
void SetDatasetArn (Aws::String &&value)
 
void SetDatasetArn (const char *value)
 
DescribeDatasetImportJobResultWithDatasetArn (const Aws::String &value)
 
DescribeDatasetImportJobResultWithDatasetArn (Aws::String &&value)
 
DescribeDatasetImportJobResultWithDatasetArn (const char *value)
 
const Aws::StringGetTimestampFormat () const
 
void SetTimestampFormat (const Aws::String &value)
 
void SetTimestampFormat (Aws::String &&value)
 
void SetTimestampFormat (const char *value)
 
DescribeDatasetImportJobResultWithTimestampFormat (const Aws::String &value)
 
DescribeDatasetImportJobResultWithTimestampFormat (Aws::String &&value)
 
DescribeDatasetImportJobResultWithTimestampFormat (const char *value)
 
const Aws::StringGetTimeZone () const
 
void SetTimeZone (const Aws::String &value)
 
void SetTimeZone (Aws::String &&value)
 
void SetTimeZone (const char *value)
 
DescribeDatasetImportJobResultWithTimeZone (const Aws::String &value)
 
DescribeDatasetImportJobResultWithTimeZone (Aws::String &&value)
 
DescribeDatasetImportJobResultWithTimeZone (const char *value)
 
bool GetUseGeolocationForTimeZone () const
 
void SetUseGeolocationForTimeZone (bool value)
 
DescribeDatasetImportJobResultWithUseGeolocationForTimeZone (bool value)
 
const Aws::StringGetGeolocationFormat () const
 
void SetGeolocationFormat (const Aws::String &value)
 
void SetGeolocationFormat (Aws::String &&value)
 
void SetGeolocationFormat (const char *value)
 
DescribeDatasetImportJobResultWithGeolocationFormat (const Aws::String &value)
 
DescribeDatasetImportJobResultWithGeolocationFormat (Aws::String &&value)
 
DescribeDatasetImportJobResultWithGeolocationFormat (const char *value)
 
const DataSourceGetDataSource () const
 
void SetDataSource (const DataSource &value)
 
void SetDataSource (DataSource &&value)
 
DescribeDatasetImportJobResultWithDataSource (const DataSource &value)
 
DescribeDatasetImportJobResultWithDataSource (DataSource &&value)
 
long long GetEstimatedTimeRemainingInMinutes () const
 
void SetEstimatedTimeRemainingInMinutes (long long value)
 
DescribeDatasetImportJobResultWithEstimatedTimeRemainingInMinutes (long long value)
 
const Aws::Map< Aws::String, Statistics > & GetFieldStatistics () const
 
void SetFieldStatistics (const Aws::Map< Aws::String, Statistics > &value)
 
void SetFieldStatistics (Aws::Map< Aws::String, Statistics > &&value)
 
DescribeDatasetImportJobResultWithFieldStatistics (const Aws::Map< Aws::String, Statistics > &value)
 
DescribeDatasetImportJobResultWithFieldStatistics (Aws::Map< Aws::String, Statistics > &&value)
 
DescribeDatasetImportJobResultAddFieldStatistics (const Aws::String &key, const Statistics &value)
 
DescribeDatasetImportJobResultAddFieldStatistics (Aws::String &&key, const Statistics &value)
 
DescribeDatasetImportJobResultAddFieldStatistics (const Aws::String &key, Statistics &&value)
 
DescribeDatasetImportJobResultAddFieldStatistics (Aws::String &&key, Statistics &&value)
 
DescribeDatasetImportJobResultAddFieldStatistics (const char *key, Statistics &&value)
 
DescribeDatasetImportJobResultAddFieldStatistics (const char *key, const Statistics &value)
 
double GetDataSize () const
 
void SetDataSize (double value)
 
DescribeDatasetImportJobResultWithDataSize (double value)
 
const Aws::StringGetStatus () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
DescribeDatasetImportJobResultWithStatus (const Aws::String &value)
 
DescribeDatasetImportJobResultWithStatus (Aws::String &&value)
 
DescribeDatasetImportJobResultWithStatus (const char *value)
 
const Aws::StringGetMessage () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
DescribeDatasetImportJobResultWithMessage (const Aws::String &value)
 
DescribeDatasetImportJobResultWithMessage (Aws::String &&value)
 
DescribeDatasetImportJobResultWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
DescribeDatasetImportJobResultWithCreationTime (const Aws::Utils::DateTime &value)
 
DescribeDatasetImportJobResultWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastModificationTime () const
 
void SetLastModificationTime (const Aws::Utils::DateTime &value)
 
void SetLastModificationTime (Aws::Utils::DateTime &&value)
 
DescribeDatasetImportJobResultWithLastModificationTime (const Aws::Utils::DateTime &value)
 
DescribeDatasetImportJobResultWithLastModificationTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Definition at line 31 of file DescribeDatasetImportJobResult.h.

Constructor & Destructor Documentation

◆ DescribeDatasetImportJobResult() [1/2]

Aws::ForecastService::Model::DescribeDatasetImportJobResult::DescribeDatasetImportJobResult ( )

◆ DescribeDatasetImportJobResult() [2/2]

Aws::ForecastService::Model::DescribeDatasetImportJobResult::DescribeDatasetImportJobResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddFieldStatistics() [1/6]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::AddFieldStatistics ( Aws::String &&  key,
const Statistics value 
)
inline

Statistical information about each field in the input data.

Definition at line 416 of file DescribeDatasetImportJobResult.h.

◆ AddFieldStatistics() [2/6]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::AddFieldStatistics ( Aws::String &&  key,
Statistics &&  value 
)
inline

Statistical information about each field in the input data.

Definition at line 426 of file DescribeDatasetImportJobResult.h.

◆ AddFieldStatistics() [3/6]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::AddFieldStatistics ( const Aws::String key,
const Statistics value 
)
inline

Statistical information about each field in the input data.

Definition at line 411 of file DescribeDatasetImportJobResult.h.

◆ AddFieldStatistics() [4/6]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::AddFieldStatistics ( const Aws::String key,
Statistics &&  value 
)
inline

Statistical information about each field in the input data.

Definition at line 421 of file DescribeDatasetImportJobResult.h.

◆ AddFieldStatistics() [5/6]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::AddFieldStatistics ( const char *  key,
const Statistics value 
)
inline

Statistical information about each field in the input data.

Definition at line 436 of file DescribeDatasetImportJobResult.h.

◆ AddFieldStatistics() [6/6]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::AddFieldStatistics ( const char *  key,
Statistics &&  value 
)
inline

Statistical information about each field in the input data.

Definition at line 431 of file DescribeDatasetImportJobResult.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetCreationTime ( ) const
inline

When the dataset import job was created.

Definition at line 568 of file DescribeDatasetImportJobResult.h.

◆ GetDatasetArn()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetDatasetArn ( ) const
inline

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

Definition at line 115 of file DescribeDatasetImportJobResult.h.

◆ GetDatasetImportJobArn()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetDatasetImportJobArn ( ) const
inline

The ARN of the dataset import job.

Definition at line 78 of file DescribeDatasetImportJobResult.h.

◆ GetDatasetImportJobName()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetDatasetImportJobName ( ) const
inline

The name of the dataset import job.

Definition at line 42 of file DescribeDatasetImportJobResult.h.

◆ GetDataSize()

double Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetDataSize ( ) const
inline

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

Definition at line 443 of file DescribeDatasetImportJobResult.h.

◆ GetDataSource()

const DataSource& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetDataSource ( ) const
inline

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

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

Definition at line 329 of file DescribeDatasetImportJobResult.h.

◆ GetEstimatedTimeRemainingInMinutes()

long long Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetEstimatedTimeRemainingInMinutes ( ) const
inline

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

Definition at line 368 of file DescribeDatasetImportJobResult.h.

◆ GetFieldStatistics()

const Aws::Map<Aws::String, Statistics>& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetFieldStatistics ( ) const
inline

Statistical information about each field in the input data.

Definition at line 386 of file DescribeDatasetImportJobResult.h.

◆ GetGeolocationFormat()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetGeolocationFormat ( ) const
inline

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

Definition at line 284 of file DescribeDatasetImportJobResult.h.

◆ GetLastModificationTime()

const Aws::Utils::DateTime& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetLastModificationTime ( ) const
inline

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.

Definition at line 600 of file DescribeDatasetImportJobResult.h.

◆ GetMessage()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetMessage ( ) const
inline

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

Definition at line 532 of file DescribeDatasetImportJobResult.h.

◆ GetStatus()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetStatus ( ) const
inline

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

Definition at line 466 of file DescribeDatasetImportJobResult.h.

◆ GetTimestampFormat()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetTimestampFormat ( ) const
inline

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

Definition at line 162 of file DescribeDatasetImportJobResult.h.

◆ GetTimeZone()

const Aws::String& Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetTimeZone ( ) const
inline

The single time zone applied to every item in the dataset

Definition at line 228 of file DescribeDatasetImportJobResult.h.

◆ GetUseGeolocationForTimeZone()

bool Aws::ForecastService::Model::DescribeDatasetImportJobResult::GetUseGeolocationForTimeZone ( ) const
inline

Whether TimeZone is automatically derived from the geolocation attribute.

Definition at line 265 of file DescribeDatasetImportJobResult.h.

◆ operator=()

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetCreationTime() [1/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

When the dataset import job was created.

Definition at line 578 of file DescribeDatasetImportJobResult.h.

◆ SetCreationTime() [2/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetCreationTime ( const Aws::Utils::DateTime value)
inline

When the dataset import job was created.

Definition at line 573 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetArn() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetArn ( Aws::String &&  value)
inline

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

Definition at line 127 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetArn() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetArn ( const Aws::String value)
inline

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

Definition at line 121 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetArn() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetArn ( const char *  value)
inline

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

Definition at line 133 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetImportJobArn() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetImportJobArn ( Aws::String &&  value)
inline

The ARN of the dataset import job.

Definition at line 88 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetImportJobArn() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetImportJobArn ( const Aws::String value)
inline

The ARN of the dataset import job.

Definition at line 83 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetImportJobArn() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetImportJobArn ( const char *  value)
inline

The ARN of the dataset import job.

Definition at line 93 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetImportJobName() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetImportJobName ( Aws::String &&  value)
inline

The name of the dataset import job.

Definition at line 52 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetImportJobName() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetImportJobName ( const Aws::String value)
inline

The name of the dataset import job.

Definition at line 47 of file DescribeDatasetImportJobResult.h.

◆ SetDatasetImportJobName() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDatasetImportJobName ( const char *  value)
inline

The name of the dataset import job.

Definition at line 57 of file DescribeDatasetImportJobResult.h.

◆ SetDataSize()

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDataSize ( double  value)
inline

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

Definition at line 449 of file DescribeDatasetImportJobResult.h.

◆ SetDataSource() [1/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDataSource ( const DataSource value)
inline

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

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

Definition at line 337 of file DescribeDatasetImportJobResult.h.

◆ SetDataSource() [2/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetDataSource ( DataSource &&  value)
inline

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

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

Definition at line 345 of file DescribeDatasetImportJobResult.h.

◆ SetEstimatedTimeRemainingInMinutes()

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetEstimatedTimeRemainingInMinutes ( long long  value)
inline

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

Definition at line 374 of file DescribeDatasetImportJobResult.h.

◆ SetFieldStatistics() [1/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetFieldStatistics ( Aws::Map< Aws::String, Statistics > &&  value)
inline

Statistical information about each field in the input data.

Definition at line 396 of file DescribeDatasetImportJobResult.h.

◆ SetFieldStatistics() [2/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetFieldStatistics ( const Aws::Map< Aws::String, Statistics > &  value)
inline

Statistical information about each field in the input data.

Definition at line 391 of file DescribeDatasetImportJobResult.h.

◆ SetGeolocationFormat() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetGeolocationFormat ( Aws::String &&  value)
inline

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

Definition at line 296 of file DescribeDatasetImportJobResult.h.

◆ SetGeolocationFormat() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetGeolocationFormat ( const Aws::String value)
inline

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

Definition at line 290 of file DescribeDatasetImportJobResult.h.

◆ SetGeolocationFormat() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetGeolocationFormat ( const char *  value)
inline

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

Definition at line 302 of file DescribeDatasetImportJobResult.h.

◆ SetLastModificationTime() [1/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetLastModificationTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 622 of file DescribeDatasetImportJobResult.h.

◆ SetLastModificationTime() [2/2]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetLastModificationTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 611 of file DescribeDatasetImportJobResult.h.

◆ SetMessage() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetMessage ( Aws::String &&  value)
inline

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

Definition at line 542 of file DescribeDatasetImportJobResult.h.

◆ SetMessage() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetMessage ( const Aws::String value)
inline

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

Definition at line 537 of file DescribeDatasetImportJobResult.h.

◆ SetMessage() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetMessage ( const char *  value)
inline

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

Definition at line 547 of file DescribeDatasetImportJobResult.h.

◆ SetStatus() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetStatus ( Aws::String &&  value)
inline

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

Definition at line 486 of file DescribeDatasetImportJobResult.h.

◆ SetStatus() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetStatus ( const Aws::String value)
inline

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

Definition at line 476 of file DescribeDatasetImportJobResult.h.

◆ SetStatus() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetStatus ( const char *  value)
inline

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

Definition at line 496 of file DescribeDatasetImportJobResult.h.

◆ SetTimestampFormat() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetTimestampFormat ( Aws::String &&  value)
inline

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

Definition at line 182 of file DescribeDatasetImportJobResult.h.

◆ SetTimestampFormat() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetTimestampFormat ( const Aws::String value)
inline

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

Definition at line 172 of file DescribeDatasetImportJobResult.h.

◆ SetTimestampFormat() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetTimestampFormat ( const char *  value)
inline

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

Definition at line 192 of file DescribeDatasetImportJobResult.h.

◆ SetTimeZone() [1/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetTimeZone ( Aws::String &&  value)
inline

The single time zone applied to every item in the dataset

Definition at line 238 of file DescribeDatasetImportJobResult.h.

◆ SetTimeZone() [2/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetTimeZone ( const Aws::String value)
inline

The single time zone applied to every item in the dataset

Definition at line 233 of file DescribeDatasetImportJobResult.h.

◆ SetTimeZone() [3/3]

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetTimeZone ( const char *  value)
inline

The single time zone applied to every item in the dataset

Definition at line 243 of file DescribeDatasetImportJobResult.h.

◆ SetUseGeolocationForTimeZone()

void Aws::ForecastService::Model::DescribeDatasetImportJobResult::SetUseGeolocationForTimeZone ( bool  value)
inline

Whether TimeZone is automatically derived from the geolocation attribute.

Definition at line 271 of file DescribeDatasetImportJobResult.h.

◆ WithCreationTime() [1/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

When the dataset import job was created.

Definition at line 588 of file DescribeDatasetImportJobResult.h.

◆ WithCreationTime() [2/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithCreationTime ( const Aws::Utils::DateTime value)
inline

When the dataset import job was created.

Definition at line 583 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetArn() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetArn ( Aws::String &&  value)
inline

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

Definition at line 145 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetArn() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetArn ( const Aws::String value)
inline

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

Definition at line 139 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetArn() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetArn ( const char *  value)
inline

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

Definition at line 151 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetImportJobArn() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetImportJobArn ( Aws::String &&  value)
inline

The ARN of the dataset import job.

Definition at line 103 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetImportJobArn() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetImportJobArn ( const Aws::String value)
inline

The ARN of the dataset import job.

Definition at line 98 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetImportJobArn() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetImportJobArn ( const char *  value)
inline

The ARN of the dataset import job.

Definition at line 108 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetImportJobName() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetImportJobName ( Aws::String &&  value)
inline

The name of the dataset import job.

Definition at line 67 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetImportJobName() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetImportJobName ( const Aws::String value)
inline

The name of the dataset import job.

Definition at line 62 of file DescribeDatasetImportJobResult.h.

◆ WithDatasetImportJobName() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDatasetImportJobName ( const char *  value)
inline

The name of the dataset import job.

Definition at line 72 of file DescribeDatasetImportJobResult.h.

◆ WithDataSize()

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDataSize ( double  value)
inline

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

Definition at line 455 of file DescribeDatasetImportJobResult.h.

◆ WithDataSource() [1/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDataSource ( const DataSource value)
inline

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

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

Definition at line 353 of file DescribeDatasetImportJobResult.h.

◆ WithDataSource() [2/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithDataSource ( DataSource &&  value)
inline

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

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

Definition at line 361 of file DescribeDatasetImportJobResult.h.

◆ WithEstimatedTimeRemainingInMinutes()

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithEstimatedTimeRemainingInMinutes ( long long  value)
inline

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

Definition at line 380 of file DescribeDatasetImportJobResult.h.

◆ WithFieldStatistics() [1/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithFieldStatistics ( Aws::Map< Aws::String, Statistics > &&  value)
inline

Statistical information about each field in the input data.

Definition at line 406 of file DescribeDatasetImportJobResult.h.

◆ WithFieldStatistics() [2/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithFieldStatistics ( const Aws::Map< Aws::String, Statistics > &  value)
inline

Statistical information about each field in the input data.

Definition at line 401 of file DescribeDatasetImportJobResult.h.

◆ WithGeolocationFormat() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithGeolocationFormat ( Aws::String &&  value)
inline

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

Definition at line 314 of file DescribeDatasetImportJobResult.h.

◆ WithGeolocationFormat() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithGeolocationFormat ( const Aws::String value)
inline

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

Definition at line 308 of file DescribeDatasetImportJobResult.h.

◆ WithGeolocationFormat() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithGeolocationFormat ( const char *  value)
inline

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

Definition at line 320 of file DescribeDatasetImportJobResult.h.

◆ WithLastModificationTime() [1/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithLastModificationTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 644 of file DescribeDatasetImportJobResult.h.

◆ WithLastModificationTime() [2/2]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithLastModificationTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 633 of file DescribeDatasetImportJobResult.h.

◆ WithMessage() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithMessage ( Aws::String &&  value)
inline

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

Definition at line 557 of file DescribeDatasetImportJobResult.h.

◆ WithMessage() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithMessage ( const Aws::String value)
inline

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

Definition at line 552 of file DescribeDatasetImportJobResult.h.

◆ WithMessage() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithMessage ( const char *  value)
inline

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

Definition at line 562 of file DescribeDatasetImportJobResult.h.

◆ WithStatus() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithStatus ( Aws::String &&  value)
inline

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

Definition at line 516 of file DescribeDatasetImportJobResult.h.

◆ WithStatus() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithStatus ( const Aws::String value)
inline

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

Definition at line 506 of file DescribeDatasetImportJobResult.h.

◆ WithStatus() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithStatus ( const char *  value)
inline

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

Definition at line 526 of file DescribeDatasetImportJobResult.h.

◆ WithTimestampFormat() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithTimestampFormat ( Aws::String &&  value)
inline

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

Definition at line 212 of file DescribeDatasetImportJobResult.h.

◆ WithTimestampFormat() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithTimestampFormat ( const Aws::String value)
inline

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

Definition at line 202 of file DescribeDatasetImportJobResult.h.

◆ WithTimestampFormat() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithTimestampFormat ( const char *  value)
inline

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

Definition at line 222 of file DescribeDatasetImportJobResult.h.

◆ WithTimeZone() [1/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithTimeZone ( Aws::String &&  value)
inline

The single time zone applied to every item in the dataset

Definition at line 253 of file DescribeDatasetImportJobResult.h.

◆ WithTimeZone() [2/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithTimeZone ( const Aws::String value)
inline

The single time zone applied to every item in the dataset

Definition at line 248 of file DescribeDatasetImportJobResult.h.

◆ WithTimeZone() [3/3]

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithTimeZone ( const char *  value)
inline

The single time zone applied to every item in the dataset

Definition at line 258 of file DescribeDatasetImportJobResult.h.

◆ WithUseGeolocationForTimeZone()

DescribeDatasetImportJobResult& Aws::ForecastService::Model::DescribeDatasetImportJobResult::WithUseGeolocationForTimeZone ( bool  value)
inline

Whether TimeZone is automatically derived from the geolocation attribute.

Definition at line 277 of file DescribeDatasetImportJobResult.h.


The documentation for this class was generated from the following file: