/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Personalize { namespace Model { /** *

Describes a job that exports a dataset to an Amazon S3 bucket. For more * information, see CreateDatasetExportJob.

*

A dataset export job can be in one of the following states:

  • *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    *

See Also:

AWS * API Reference

*/ class DatasetExportJob { public: AWS_PERSONALIZE_API DatasetExportJob(); AWS_PERSONALIZE_API DatasetExportJob(Aws::Utils::Json::JsonView jsonValue); AWS_PERSONALIZE_API DatasetExportJob& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PERSONALIZE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the export job.

*/ inline const Aws::String& GetJobName() const{ return m_jobName; } /** *

The name of the export job.

*/ inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; } /** *

The name of the export job.

*/ inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; } /** *

The name of the export job.

*/ inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); } /** *

The name of the export job.

*/ inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); } /** *

The name of the export job.

*/ inline DatasetExportJob& WithJobName(const Aws::String& value) { SetJobName(value); return *this;} /** *

The name of the export job.

*/ inline DatasetExportJob& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;} /** *

The name of the export job.

*/ inline DatasetExportJob& WithJobName(const char* value) { SetJobName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline const Aws::String& GetDatasetExportJobArn() const{ return m_datasetExportJobArn; } /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline bool DatasetExportJobArnHasBeenSet() const { return m_datasetExportJobArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline void SetDatasetExportJobArn(const Aws::String& value) { m_datasetExportJobArnHasBeenSet = true; m_datasetExportJobArn = value; } /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline void SetDatasetExportJobArn(Aws::String&& value) { m_datasetExportJobArnHasBeenSet = true; m_datasetExportJobArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline void SetDatasetExportJobArn(const char* value) { m_datasetExportJobArnHasBeenSet = true; m_datasetExportJobArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline DatasetExportJob& WithDatasetExportJobArn(const Aws::String& value) { SetDatasetExportJobArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline DatasetExportJob& WithDatasetExportJobArn(Aws::String&& value) { SetDatasetExportJobArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset export job.

*/ inline DatasetExportJob& WithDatasetExportJobArn(const char* value) { SetDatasetExportJobArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline const Aws::String& GetDatasetArn() const{ return m_datasetArn; } /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline bool DatasetArnHasBeenSet() const { return m_datasetArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline void SetDatasetArn(const Aws::String& value) { m_datasetArnHasBeenSet = true; m_datasetArn = value; } /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline void SetDatasetArn(Aws::String&& value) { m_datasetArnHasBeenSet = true; m_datasetArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline void SetDatasetArn(const char* value) { m_datasetArnHasBeenSet = true; m_datasetArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline DatasetExportJob& WithDatasetArn(const Aws::String& value) { SetDatasetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline DatasetExportJob& WithDatasetArn(Aws::String&& value) { SetDatasetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset to export.

*/ inline DatasetExportJob& WithDatasetArn(const char* value) { SetDatasetArn(value); return *this;} /** *

The data to export, based on how you imported the data. You can choose to * export BULK data that you imported using a dataset import job, * PUT data that you imported incrementally (using the console, * PutEvents, PutUsers and PutItems operations), or ALL for both * types. The default value is PUT.

*/ inline const IngestionMode& GetIngestionMode() const{ return m_ingestionMode; } /** *

The data to export, based on how you imported the data. You can choose to * export BULK data that you imported using a dataset import job, * PUT data that you imported incrementally (using the console, * PutEvents, PutUsers and PutItems operations), or ALL for both * types. The default value is PUT.

*/ inline bool IngestionModeHasBeenSet() const { return m_ingestionModeHasBeenSet; } /** *

The data to export, based on how you imported the data. You can choose to * export BULK data that you imported using a dataset import job, * PUT data that you imported incrementally (using the console, * PutEvents, PutUsers and PutItems operations), or ALL for both * types. The default value is PUT.

*/ inline void SetIngestionMode(const IngestionMode& value) { m_ingestionModeHasBeenSet = true; m_ingestionMode = value; } /** *

The data to export, based on how you imported the data. You can choose to * export BULK data that you imported using a dataset import job, * PUT data that you imported incrementally (using the console, * PutEvents, PutUsers and PutItems operations), or ALL for both * types. The default value is PUT.

*/ inline void SetIngestionMode(IngestionMode&& value) { m_ingestionModeHasBeenSet = true; m_ingestionMode = std::move(value); } /** *

The data to export, based on how you imported the data. You can choose to * export BULK data that you imported using a dataset import job, * PUT data that you imported incrementally (using the console, * PutEvents, PutUsers and PutItems operations), or ALL for both * types. The default value is PUT.

*/ inline DatasetExportJob& WithIngestionMode(const IngestionMode& value) { SetIngestionMode(value); return *this;} /** *

The data to export, based on how you imported the data. You can choose to * export BULK data that you imported using a dataset import job, * PUT data that you imported incrementally (using the console, * PutEvents, PutUsers and PutItems operations), or ALL for both * types. The default value is PUT.

*/ inline DatasetExportJob& WithIngestionMode(IngestionMode&& value) { SetIngestionMode(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline DatasetExportJob& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline DatasetExportJob& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM service role that has permissions * to add data to your output Amazon S3 bucket.

*/ inline DatasetExportJob& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); } /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline DatasetExportJob& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline DatasetExportJob& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

The status of the dataset export job.

A dataset export job can be in * one of the following states:

  • CREATE PENDING > CREATE * IN_PROGRESS > ACTIVE -or- CREATE FAILED

*/ inline DatasetExportJob& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

The path to the Amazon S3 bucket where the job's output is stored. For * example:

s3://bucket-name/folder-name/

*/ inline const DatasetExportJobOutput& GetJobOutput() const{ return m_jobOutput; } /** *

The path to the Amazon S3 bucket where the job's output is stored. For * example:

s3://bucket-name/folder-name/

*/ inline bool JobOutputHasBeenSet() const { return m_jobOutputHasBeenSet; } /** *

The path to the Amazon S3 bucket where the job's output is stored. For * example:

s3://bucket-name/folder-name/

*/ inline void SetJobOutput(const DatasetExportJobOutput& value) { m_jobOutputHasBeenSet = true; m_jobOutput = value; } /** *

The path to the Amazon S3 bucket where the job's output is stored. For * example:

s3://bucket-name/folder-name/

*/ inline void SetJobOutput(DatasetExportJobOutput&& value) { m_jobOutputHasBeenSet = true; m_jobOutput = std::move(value); } /** *

The path to the Amazon S3 bucket where the job's output is stored. For * example:

s3://bucket-name/folder-name/

*/ inline DatasetExportJob& WithJobOutput(const DatasetExportJobOutput& value) { SetJobOutput(value); return *this;} /** *

The path to the Amazon S3 bucket where the job's output is stored. For * example:

s3://bucket-name/folder-name/

*/ inline DatasetExportJob& WithJobOutput(DatasetExportJobOutput&& value) { SetJobOutput(std::move(value)); return *this;} /** *

The creation date and time (in Unix time) of the dataset export job.

*/ inline const Aws::Utils::DateTime& GetCreationDateTime() const{ return m_creationDateTime; } /** *

The creation date and time (in Unix time) of the dataset export job.

*/ inline bool CreationDateTimeHasBeenSet() const { return m_creationDateTimeHasBeenSet; } /** *

The creation date and time (in Unix time) of the dataset export job.

*/ inline void SetCreationDateTime(const Aws::Utils::DateTime& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = value; } /** *

The creation date and time (in Unix time) of the dataset export job.

*/ inline void SetCreationDateTime(Aws::Utils::DateTime&& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = std::move(value); } /** *

The creation date and time (in Unix time) of the dataset export job.

*/ inline DatasetExportJob& WithCreationDateTime(const Aws::Utils::DateTime& value) { SetCreationDateTime(value); return *this;} /** *

The creation date and time (in Unix time) of the dataset export job.

*/ inline DatasetExportJob& WithCreationDateTime(Aws::Utils::DateTime&& value) { SetCreationDateTime(std::move(value)); return *this;} /** *

The date and time (in Unix time) the status of the dataset export job was * last updated.

*/ inline const Aws::Utils::DateTime& GetLastUpdatedDateTime() const{ return m_lastUpdatedDateTime; } /** *

The date and time (in Unix time) the status of the dataset export job was * last updated.

*/ inline bool LastUpdatedDateTimeHasBeenSet() const { return m_lastUpdatedDateTimeHasBeenSet; } /** *

The date and time (in Unix time) the status of the dataset export job was * last updated.

*/ inline void SetLastUpdatedDateTime(const Aws::Utils::DateTime& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = value; } /** *

The date and time (in Unix time) the status of the dataset export job was * last updated.

*/ inline void SetLastUpdatedDateTime(Aws::Utils::DateTime&& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = std::move(value); } /** *

The date and time (in Unix time) the status of the dataset export job was * last updated.

*/ inline DatasetExportJob& WithLastUpdatedDateTime(const Aws::Utils::DateTime& value) { SetLastUpdatedDateTime(value); return *this;} /** *

The date and time (in Unix time) the status of the dataset export job was * last updated.

*/ inline DatasetExportJob& WithLastUpdatedDateTime(Aws::Utils::DateTime&& value) { SetLastUpdatedDateTime(std::move(value)); return *this;} /** *

If a dataset export job fails, provides the reason why.

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

If a dataset export job fails, provides the reason why.

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

If a dataset export job fails, provides the reason why.

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

If a dataset export job fails, provides the reason why.

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

If a dataset export job fails, provides the reason why.

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

If a dataset export job fails, provides the reason why.

*/ inline DatasetExportJob& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

If a dataset export job fails, provides the reason why.

*/ inline DatasetExportJob& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

If a dataset export job fails, provides the reason why.

*/ inline DatasetExportJob& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} private: Aws::String m_jobName; bool m_jobNameHasBeenSet = false; Aws::String m_datasetExportJobArn; bool m_datasetExportJobArnHasBeenSet = false; Aws::String m_datasetArn; bool m_datasetArnHasBeenSet = false; IngestionMode m_ingestionMode; bool m_ingestionModeHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; DatasetExportJobOutput m_jobOutput; bool m_jobOutputHasBeenSet = false; Aws::Utils::DateTime m_creationDateTime; bool m_creationDateTimeHasBeenSet = false; Aws::Utils::DateTime m_lastUpdatedDateTime; bool m_lastUpdatedDateTimeHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; }; } // namespace Model } // namespace Personalize } // namespace Aws