/** * 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 SageMaker { namespace Model { /** *

A structure that contains a list of recommendation jobs.

See * Also:

AWS * API Reference

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

The name of the job.

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

The name of the job.

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

The name of the job.

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

The name of the job.

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

The name of the job.

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

The name of the job.

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

The name of the job.

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

The name of the job.

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

The job description.

*/ inline const Aws::String& GetJobDescription() const{ return m_jobDescription; } /** *

The job description.

*/ inline bool JobDescriptionHasBeenSet() const { return m_jobDescriptionHasBeenSet; } /** *

The job description.

*/ inline void SetJobDescription(const Aws::String& value) { m_jobDescriptionHasBeenSet = true; m_jobDescription = value; } /** *

The job description.

*/ inline void SetJobDescription(Aws::String&& value) { m_jobDescriptionHasBeenSet = true; m_jobDescription = std::move(value); } /** *

The job description.

*/ inline void SetJobDescription(const char* value) { m_jobDescriptionHasBeenSet = true; m_jobDescription.assign(value); } /** *

The job description.

*/ inline InferenceRecommendationsJob& WithJobDescription(const Aws::String& value) { SetJobDescription(value); return *this;} /** *

The job description.

*/ inline InferenceRecommendationsJob& WithJobDescription(Aws::String&& value) { SetJobDescription(std::move(value)); return *this;} /** *

The job description.

*/ inline InferenceRecommendationsJob& WithJobDescription(const char* value) { SetJobDescription(value); return *this;} /** *

The recommendation job type.

*/ inline const RecommendationJobType& GetJobType() const{ return m_jobType; } /** *

The recommendation job type.

*/ inline bool JobTypeHasBeenSet() const { return m_jobTypeHasBeenSet; } /** *

The recommendation job type.

*/ inline void SetJobType(const RecommendationJobType& value) { m_jobTypeHasBeenSet = true; m_jobType = value; } /** *

The recommendation job type.

*/ inline void SetJobType(RecommendationJobType&& value) { m_jobTypeHasBeenSet = true; m_jobType = std::move(value); } /** *

The recommendation job type.

*/ inline InferenceRecommendationsJob& WithJobType(const RecommendationJobType& value) { SetJobType(value); return *this;} /** *

The recommendation job type.

*/ inline InferenceRecommendationsJob& WithJobType(RecommendationJobType&& value) { SetJobType(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline const Aws::String& GetJobArn() const{ return m_jobArn; } /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline bool JobArnHasBeenSet() const { return m_jobArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline void SetJobArn(const Aws::String& value) { m_jobArnHasBeenSet = true; m_jobArn = value; } /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline void SetJobArn(Aws::String&& value) { m_jobArnHasBeenSet = true; m_jobArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline void SetJobArn(const char* value) { m_jobArnHasBeenSet = true; m_jobArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline InferenceRecommendationsJob& WithJobArn(const Aws::String& value) { SetJobArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline InferenceRecommendationsJob& WithJobArn(Aws::String&& value) { SetJobArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the recommendation job.

*/ inline InferenceRecommendationsJob& WithJobArn(const char* value) { SetJobArn(value); return *this;} /** *

The status of the job.

*/ inline const RecommendationJobStatus& GetStatus() const{ return m_status; } /** *

The status of the job.

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

The status of the job.

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

The status of the job.

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

The status of the job.

*/ inline InferenceRecommendationsJob& WithStatus(const RecommendationJobStatus& value) { SetStatus(value); return *this;} /** *

The status of the job.

*/ inline InferenceRecommendationsJob& WithStatus(RecommendationJobStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

A timestamp that shows when the job was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

A timestamp that shows when the job was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

A timestamp that shows when the job was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

A timestamp that shows when the job was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

A timestamp that shows when the job was created.

*/ inline InferenceRecommendationsJob& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

A timestamp that shows when the job was created.

*/ inline InferenceRecommendationsJob& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

A timestamp that shows when the job completed.

*/ inline const Aws::Utils::DateTime& GetCompletionTime() const{ return m_completionTime; } /** *

A timestamp that shows when the job completed.

*/ inline bool CompletionTimeHasBeenSet() const { return m_completionTimeHasBeenSet; } /** *

A timestamp that shows when the job completed.

*/ inline void SetCompletionTime(const Aws::Utils::DateTime& value) { m_completionTimeHasBeenSet = true; m_completionTime = value; } /** *

A timestamp that shows when the job completed.

*/ inline void SetCompletionTime(Aws::Utils::DateTime&& value) { m_completionTimeHasBeenSet = true; m_completionTime = std::move(value); } /** *

A timestamp that shows when the job completed.

*/ inline InferenceRecommendationsJob& WithCompletionTime(const Aws::Utils::DateTime& value) { SetCompletionTime(value); return *this;} /** *

A timestamp that shows when the job completed.

*/ inline InferenceRecommendationsJob& WithCompletionTime(Aws::Utils::DateTime&& value) { SetCompletionTime(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

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

A timestamp that shows when the job was last modified.

*/ inline const Aws::Utils::DateTime& GetLastModifiedTime() const{ return m_lastModifiedTime; } /** *

A timestamp that shows when the job was last modified.

*/ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** *

A timestamp that shows when the job was last modified.

*/ inline void SetLastModifiedTime(const Aws::Utils::DateTime& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = value; } /** *

A timestamp that shows when the job was last modified.

*/ inline void SetLastModifiedTime(Aws::Utils::DateTime&& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = std::move(value); } /** *

A timestamp that shows when the job was last modified.

*/ inline InferenceRecommendationsJob& WithLastModifiedTime(const Aws::Utils::DateTime& value) { SetLastModifiedTime(value); return *this;} /** *

A timestamp that shows when the job was last modified.

*/ inline InferenceRecommendationsJob& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} /** *

If the job fails, provides information why the job failed.

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

If the job fails, provides information why the job failed.

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

If the job fails, provides information why the job failed.

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

If the job fails, provides information why the job failed.

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

If the job fails, provides information why the job failed.

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

If the job fails, provides information why the job failed.

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

If the job fails, provides information why the job failed.

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

If the job fails, provides information why the job failed.

*/ inline InferenceRecommendationsJob& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

The name of the created model.

*/ inline const Aws::String& GetModelName() const{ return m_modelName; } /** *

The name of the created model.

*/ inline bool ModelNameHasBeenSet() const { return m_modelNameHasBeenSet; } /** *

The name of the created model.

*/ inline void SetModelName(const Aws::String& value) { m_modelNameHasBeenSet = true; m_modelName = value; } /** *

The name of the created model.

*/ inline void SetModelName(Aws::String&& value) { m_modelNameHasBeenSet = true; m_modelName = std::move(value); } /** *

The name of the created model.

*/ inline void SetModelName(const char* value) { m_modelNameHasBeenSet = true; m_modelName.assign(value); } /** *

The name of the created model.

*/ inline InferenceRecommendationsJob& WithModelName(const Aws::String& value) { SetModelName(value); return *this;} /** *

The name of the created model.

*/ inline InferenceRecommendationsJob& WithModelName(Aws::String&& value) { SetModelName(std::move(value)); return *this;} /** *

The name of the created model.

*/ inline InferenceRecommendationsJob& WithModelName(const char* value) { SetModelName(value); return *this;} /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline const Aws::String& GetSamplePayloadUrl() const{ return m_samplePayloadUrl; } /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline bool SamplePayloadUrlHasBeenSet() const { return m_samplePayloadUrlHasBeenSet; } /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline void SetSamplePayloadUrl(const Aws::String& value) { m_samplePayloadUrlHasBeenSet = true; m_samplePayloadUrl = value; } /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline void SetSamplePayloadUrl(Aws::String&& value) { m_samplePayloadUrlHasBeenSet = true; m_samplePayloadUrl = std::move(value); } /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline void SetSamplePayloadUrl(const char* value) { m_samplePayloadUrlHasBeenSet = true; m_samplePayloadUrl.assign(value); } /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline InferenceRecommendationsJob& WithSamplePayloadUrl(const Aws::String& value) { SetSamplePayloadUrl(value); return *this;} /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline InferenceRecommendationsJob& WithSamplePayloadUrl(Aws::String&& value) { SetSamplePayloadUrl(std::move(value)); return *this;} /** *

The Amazon Simple Storage Service (Amazon S3) path where the sample payload * is stored. This path must point to a single gzip compressed tar archive (.tar.gz * suffix).

*/ inline InferenceRecommendationsJob& WithSamplePayloadUrl(const char* value) { SetSamplePayloadUrl(value); return *this;} /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline const Aws::String& GetModelPackageVersionArn() const{ return m_modelPackageVersionArn; } /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline bool ModelPackageVersionArnHasBeenSet() const { return m_modelPackageVersionArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline void SetModelPackageVersionArn(const Aws::String& value) { m_modelPackageVersionArnHasBeenSet = true; m_modelPackageVersionArn = value; } /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline void SetModelPackageVersionArn(Aws::String&& value) { m_modelPackageVersionArnHasBeenSet = true; m_modelPackageVersionArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline void SetModelPackageVersionArn(const char* value) { m_modelPackageVersionArnHasBeenSet = true; m_modelPackageVersionArn.assign(value); } /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline InferenceRecommendationsJob& WithModelPackageVersionArn(const Aws::String& value) { SetModelPackageVersionArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline InferenceRecommendationsJob& WithModelPackageVersionArn(Aws::String&& value) { SetModelPackageVersionArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of a versioned model package.

*/ inline InferenceRecommendationsJob& WithModelPackageVersionArn(const char* value) { SetModelPackageVersionArn(value); return *this;} private: Aws::String m_jobName; bool m_jobNameHasBeenSet = false; Aws::String m_jobDescription; bool m_jobDescriptionHasBeenSet = false; RecommendationJobType m_jobType; bool m_jobTypeHasBeenSet = false; Aws::String m_jobArn; bool m_jobArnHasBeenSet = false; RecommendationJobStatus m_status; bool m_statusHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_completionTime; bool m_completionTimeHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; Aws::String m_modelName; bool m_modelNameHasBeenSet = false; Aws::String m_samplePayloadUrl; bool m_samplePayloadUrlHasBeenSet = false; Aws::String m_modelPackageVersionArn; bool m_modelPackageVersionArnHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws