AWS SDK for C++  1.9.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::Personalize::Model::BatchInferenceJob Class Reference

#include <BatchInferenceJob.h>

Public Member Functions

 BatchInferenceJob ()
 
 BatchInferenceJob (Aws::Utils::Json::JsonView jsonValue)
 
BatchInferenceJoboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
BatchInferenceJobWithJobName (const Aws::String &value)
 
BatchInferenceJobWithJobName (Aws::String &&value)
 
BatchInferenceJobWithJobName (const char *value)
 
const Aws::StringGetBatchInferenceJobArn () const
 
bool BatchInferenceJobArnHasBeenSet () const
 
void SetBatchInferenceJobArn (const Aws::String &value)
 
void SetBatchInferenceJobArn (Aws::String &&value)
 
void SetBatchInferenceJobArn (const char *value)
 
BatchInferenceJobWithBatchInferenceJobArn (const Aws::String &value)
 
BatchInferenceJobWithBatchInferenceJobArn (Aws::String &&value)
 
BatchInferenceJobWithBatchInferenceJobArn (const char *value)
 
const Aws::StringGetFilterArn () const
 
bool FilterArnHasBeenSet () const
 
void SetFilterArn (const Aws::String &value)
 
void SetFilterArn (Aws::String &&value)
 
void SetFilterArn (const char *value)
 
BatchInferenceJobWithFilterArn (const Aws::String &value)
 
BatchInferenceJobWithFilterArn (Aws::String &&value)
 
BatchInferenceJobWithFilterArn (const char *value)
 
const Aws::StringGetFailureReason () const
 
bool FailureReasonHasBeenSet () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
BatchInferenceJobWithFailureReason (const Aws::String &value)
 
BatchInferenceJobWithFailureReason (Aws::String &&value)
 
BatchInferenceJobWithFailureReason (const char *value)
 
const Aws::StringGetSolutionVersionArn () const
 
bool SolutionVersionArnHasBeenSet () const
 
void SetSolutionVersionArn (const Aws::String &value)
 
void SetSolutionVersionArn (Aws::String &&value)
 
void SetSolutionVersionArn (const char *value)
 
BatchInferenceJobWithSolutionVersionArn (const Aws::String &value)
 
BatchInferenceJobWithSolutionVersionArn (Aws::String &&value)
 
BatchInferenceJobWithSolutionVersionArn (const char *value)
 
int GetNumResults () const
 
bool NumResultsHasBeenSet () const
 
void SetNumResults (int value)
 
BatchInferenceJobWithNumResults (int value)
 
const BatchInferenceJobInputGetJobInput () const
 
bool JobInputHasBeenSet () const
 
void SetJobInput (const BatchInferenceJobInput &value)
 
void SetJobInput (BatchInferenceJobInput &&value)
 
BatchInferenceJobWithJobInput (const BatchInferenceJobInput &value)
 
BatchInferenceJobWithJobInput (BatchInferenceJobInput &&value)
 
const BatchInferenceJobOutputGetJobOutput () const
 
bool JobOutputHasBeenSet () const
 
void SetJobOutput (const BatchInferenceJobOutput &value)
 
void SetJobOutput (BatchInferenceJobOutput &&value)
 
BatchInferenceJobWithJobOutput (const BatchInferenceJobOutput &value)
 
BatchInferenceJobWithJobOutput (BatchInferenceJobOutput &&value)
 
const BatchInferenceJobConfigGetBatchInferenceJobConfig () const
 
bool BatchInferenceJobConfigHasBeenSet () const
 
void SetBatchInferenceJobConfig (const BatchInferenceJobConfig &value)
 
void SetBatchInferenceJobConfig (BatchInferenceJobConfig &&value)
 
BatchInferenceJobWithBatchInferenceJobConfig (const BatchInferenceJobConfig &value)
 
BatchInferenceJobWithBatchInferenceJobConfig (BatchInferenceJobConfig &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
BatchInferenceJobWithRoleArn (const Aws::String &value)
 
BatchInferenceJobWithRoleArn (Aws::String &&value)
 
BatchInferenceJobWithRoleArn (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
BatchInferenceJobWithStatus (const Aws::String &value)
 
BatchInferenceJobWithStatus (Aws::String &&value)
 
BatchInferenceJobWithStatus (const char *value)
 
const Aws::Utils::DateTimeGetCreationDateTime () const
 
bool CreationDateTimeHasBeenSet () const
 
void SetCreationDateTime (const Aws::Utils::DateTime &value)
 
void SetCreationDateTime (Aws::Utils::DateTime &&value)
 
BatchInferenceJobWithCreationDateTime (const Aws::Utils::DateTime &value)
 
BatchInferenceJobWithCreationDateTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedDateTime () const
 
bool LastUpdatedDateTimeHasBeenSet () const
 
void SetLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 
BatchInferenceJobWithLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
BatchInferenceJobWithLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Contains information on a batch inference job.

See Also:

AWS API Reference

Definition at line 35 of file BatchInferenceJob.h.

Constructor & Destructor Documentation

◆ BatchInferenceJob() [1/2]

Aws::Personalize::Model::BatchInferenceJob::BatchInferenceJob ( )

◆ BatchInferenceJob() [2/2]

Aws::Personalize::Model::BatchInferenceJob::BatchInferenceJob ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BatchInferenceJobArnHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::BatchInferenceJobArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 93 of file BatchInferenceJob.h.

◆ BatchInferenceJobConfigHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::BatchInferenceJobConfigHasBeenSet ( ) const
inline

A string to string map of the configuration details of a batch inference job.

Definition at line 366 of file BatchInferenceJob.h.

◆ CreationDateTimeHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::CreationDateTimeHasBeenSet ( ) const
inline

The time at which the batch inference job was created.

Definition at line 507 of file BatchInferenceJob.h.

◆ FailureReasonHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::FailureReasonHasBeenSet ( ) const
inline

If the batch inference job failed, the reason for the failure.

Definition at line 175 of file BatchInferenceJob.h.

◆ FilterArnHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::FilterArnHasBeenSet ( ) const
inline

The ARN of the filter used on the batch inference job.

Definition at line 134 of file BatchInferenceJob.h.

◆ GetBatchInferenceJobArn()

const Aws::String& Aws::Personalize::Model::BatchInferenceJob::GetBatchInferenceJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 88 of file BatchInferenceJob.h.

◆ GetBatchInferenceJobConfig()

const BatchInferenceJobConfig& Aws::Personalize::Model::BatchInferenceJob::GetBatchInferenceJobConfig ( ) const
inline

A string to string map of the configuration details of a batch inference job.

Definition at line 360 of file BatchInferenceJob.h.

◆ GetCreationDateTime()

const Aws::Utils::DateTime& Aws::Personalize::Model::BatchInferenceJob::GetCreationDateTime ( ) const
inline

The time at which the batch inference job was created.

Definition at line 502 of file BatchInferenceJob.h.

◆ GetFailureReason()

const Aws::String& Aws::Personalize::Model::BatchInferenceJob::GetFailureReason ( ) const
inline

If the batch inference job failed, the reason for the failure.

Definition at line 170 of file BatchInferenceJob.h.

◆ GetFilterArn()

const Aws::String& Aws::Personalize::Model::BatchInferenceJob::GetFilterArn ( ) const
inline

The ARN of the filter used on the batch inference job.

Definition at line 129 of file BatchInferenceJob.h.

◆ GetJobInput()

const BatchInferenceJobInput& Aws::Personalize::Model::BatchInferenceJob::GetJobInput ( ) const
inline

The Amazon S3 path that leads to the input data used to generate the batch inference job.

Definition at line 286 of file BatchInferenceJob.h.

◆ GetJobName()

const Aws::String& Aws::Personalize::Model::BatchInferenceJob::GetJobName ( ) const
inline

The name of the batch inference job.

Definition at line 47 of file BatchInferenceJob.h.

◆ GetJobOutput()

const BatchInferenceJobOutput& Aws::Personalize::Model::BatchInferenceJob::GetJobOutput ( ) const
inline

The Amazon S3 bucket that contains the output data generated by the batch inference job.

Definition at line 323 of file BatchInferenceJob.h.

◆ GetLastUpdatedDateTime()

const Aws::Utils::DateTime& Aws::Personalize::Model::BatchInferenceJob::GetLastUpdatedDateTime ( ) const
inline

The time at which the batch inference job was last updated.

Definition at line 533 of file BatchInferenceJob.h.

◆ GetNumResults()

int Aws::Personalize::Model::BatchInferenceJob::GetNumResults ( ) const
inline

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

Definition at line 261 of file BatchInferenceJob.h.

◆ GetRoleArn()

const Aws::String& Aws::Personalize::Model::BatchInferenceJob::GetRoleArn ( ) const
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 397 of file BatchInferenceJob.h.

◆ GetSolutionVersionArn()

const Aws::String& Aws::Personalize::Model::BatchInferenceJob::GetSolutionVersionArn ( ) const
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 212 of file BatchInferenceJob.h.

◆ GetStatus()

const Aws::String& Aws::Personalize::Model::BatchInferenceJob::GetStatus ( ) const
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 447 of file BatchInferenceJob.h.

◆ JobInputHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::JobInputHasBeenSet ( ) const
inline

The Amazon S3 path that leads to the input data used to generate the batch inference job.

Definition at line 292 of file BatchInferenceJob.h.

◆ JobNameHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::JobNameHasBeenSet ( ) const
inline

The name of the batch inference job.

Definition at line 52 of file BatchInferenceJob.h.

◆ JobOutputHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::JobOutputHasBeenSet ( ) const
inline

The Amazon S3 bucket that contains the output data generated by the batch inference job.

Definition at line 329 of file BatchInferenceJob.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Personalize::Model::BatchInferenceJob::Jsonize ( ) const

◆ LastUpdatedDateTimeHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::LastUpdatedDateTimeHasBeenSet ( ) const
inline

The time at which the batch inference job was last updated.

Definition at line 538 of file BatchInferenceJob.h.

◆ NumResultsHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::NumResultsHasBeenSet ( ) const
inline

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

Definition at line 267 of file BatchInferenceJob.h.

◆ operator=()

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::RoleArnHasBeenSet ( ) const
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 403 of file BatchInferenceJob.h.

◆ SetBatchInferenceJobArn() [1/3]

void Aws::Personalize::Model::BatchInferenceJob::SetBatchInferenceJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 103 of file BatchInferenceJob.h.

◆ SetBatchInferenceJobArn() [2/3]

void Aws::Personalize::Model::BatchInferenceJob::SetBatchInferenceJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 98 of file BatchInferenceJob.h.

◆ SetBatchInferenceJobArn() [3/3]

void Aws::Personalize::Model::BatchInferenceJob::SetBatchInferenceJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 108 of file BatchInferenceJob.h.

◆ SetBatchInferenceJobConfig() [1/2]

void Aws::Personalize::Model::BatchInferenceJob::SetBatchInferenceJobConfig ( BatchInferenceJobConfig &&  value)
inline

A string to string map of the configuration details of a batch inference job.

Definition at line 378 of file BatchInferenceJob.h.

◆ SetBatchInferenceJobConfig() [2/2]

void Aws::Personalize::Model::BatchInferenceJob::SetBatchInferenceJobConfig ( const BatchInferenceJobConfig value)
inline

A string to string map of the configuration details of a batch inference job.

Definition at line 372 of file BatchInferenceJob.h.

◆ SetCreationDateTime() [1/2]

void Aws::Personalize::Model::BatchInferenceJob::SetCreationDateTime ( Aws::Utils::DateTime &&  value)
inline

The time at which the batch inference job was created.

Definition at line 517 of file BatchInferenceJob.h.

◆ SetCreationDateTime() [2/2]

void Aws::Personalize::Model::BatchInferenceJob::SetCreationDateTime ( const Aws::Utils::DateTime value)
inline

The time at which the batch inference job was created.

Definition at line 512 of file BatchInferenceJob.h.

◆ SetFailureReason() [1/3]

void Aws::Personalize::Model::BatchInferenceJob::SetFailureReason ( Aws::String &&  value)
inline

If the batch inference job failed, the reason for the failure.

Definition at line 185 of file BatchInferenceJob.h.

◆ SetFailureReason() [2/3]

void Aws::Personalize::Model::BatchInferenceJob::SetFailureReason ( const Aws::String value)
inline

If the batch inference job failed, the reason for the failure.

Definition at line 180 of file BatchInferenceJob.h.

◆ SetFailureReason() [3/3]

void Aws::Personalize::Model::BatchInferenceJob::SetFailureReason ( const char *  value)
inline

If the batch inference job failed, the reason for the failure.

Definition at line 190 of file BatchInferenceJob.h.

◆ SetFilterArn() [1/3]

void Aws::Personalize::Model::BatchInferenceJob::SetFilterArn ( Aws::String &&  value)
inline

The ARN of the filter used on the batch inference job.

Definition at line 144 of file BatchInferenceJob.h.

◆ SetFilterArn() [2/3]

void Aws::Personalize::Model::BatchInferenceJob::SetFilterArn ( const Aws::String value)
inline

The ARN of the filter used on the batch inference job.

Definition at line 139 of file BatchInferenceJob.h.

◆ SetFilterArn() [3/3]

void Aws::Personalize::Model::BatchInferenceJob::SetFilterArn ( const char *  value)
inline

The ARN of the filter used on the batch inference job.

Definition at line 149 of file BatchInferenceJob.h.

◆ SetJobInput() [1/2]

void Aws::Personalize::Model::BatchInferenceJob::SetJobInput ( BatchInferenceJobInput &&  value)
inline

The Amazon S3 path that leads to the input data used to generate the batch inference job.

Definition at line 304 of file BatchInferenceJob.h.

◆ SetJobInput() [2/2]

void Aws::Personalize::Model::BatchInferenceJob::SetJobInput ( const BatchInferenceJobInput value)
inline

The Amazon S3 path that leads to the input data used to generate the batch inference job.

Definition at line 298 of file BatchInferenceJob.h.

◆ SetJobName() [1/3]

void Aws::Personalize::Model::BatchInferenceJob::SetJobName ( Aws::String &&  value)
inline

The name of the batch inference job.

Definition at line 62 of file BatchInferenceJob.h.

◆ SetJobName() [2/3]

void Aws::Personalize::Model::BatchInferenceJob::SetJobName ( const Aws::String value)
inline

The name of the batch inference job.

Definition at line 57 of file BatchInferenceJob.h.

◆ SetJobName() [3/3]

void Aws::Personalize::Model::BatchInferenceJob::SetJobName ( const char *  value)
inline

The name of the batch inference job.

Definition at line 67 of file BatchInferenceJob.h.

◆ SetJobOutput() [1/2]

void Aws::Personalize::Model::BatchInferenceJob::SetJobOutput ( BatchInferenceJobOutput &&  value)
inline

The Amazon S3 bucket that contains the output data generated by the batch inference job.

Definition at line 341 of file BatchInferenceJob.h.

◆ SetJobOutput() [2/2]

void Aws::Personalize::Model::BatchInferenceJob::SetJobOutput ( const BatchInferenceJobOutput value)
inline

The Amazon S3 bucket that contains the output data generated by the batch inference job.

Definition at line 335 of file BatchInferenceJob.h.

◆ SetLastUpdatedDateTime() [1/2]

void Aws::Personalize::Model::BatchInferenceJob::SetLastUpdatedDateTime ( Aws::Utils::DateTime &&  value)
inline

The time at which the batch inference job was last updated.

Definition at line 548 of file BatchInferenceJob.h.

◆ SetLastUpdatedDateTime() [2/2]

void Aws::Personalize::Model::BatchInferenceJob::SetLastUpdatedDateTime ( const Aws::Utils::DateTime value)
inline

The time at which the batch inference job was last updated.

Definition at line 543 of file BatchInferenceJob.h.

◆ SetNumResults()

void Aws::Personalize::Model::BatchInferenceJob::SetNumResults ( int  value)
inline

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

Definition at line 273 of file BatchInferenceJob.h.

◆ SetRoleArn() [1/3]

void Aws::Personalize::Model::BatchInferenceJob::SetRoleArn ( Aws::String &&  value)
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 415 of file BatchInferenceJob.h.

◆ SetRoleArn() [2/3]

void Aws::Personalize::Model::BatchInferenceJob::SetRoleArn ( const Aws::String value)
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 409 of file BatchInferenceJob.h.

◆ SetRoleArn() [3/3]

void Aws::Personalize::Model::BatchInferenceJob::SetRoleArn ( const char *  value)
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 421 of file BatchInferenceJob.h.

◆ SetSolutionVersionArn() [1/3]

void Aws::Personalize::Model::BatchInferenceJob::SetSolutionVersionArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 230 of file BatchInferenceJob.h.

◆ SetSolutionVersionArn() [2/3]

void Aws::Personalize::Model::BatchInferenceJob::SetSolutionVersionArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 224 of file BatchInferenceJob.h.

◆ SetSolutionVersionArn() [3/3]

void Aws::Personalize::Model::BatchInferenceJob::SetSolutionVersionArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 236 of file BatchInferenceJob.h.

◆ SetStatus() [1/3]

void Aws::Personalize::Model::BatchInferenceJob::SetStatus ( Aws::String &&  value)
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 468 of file BatchInferenceJob.h.

◆ SetStatus() [2/3]

void Aws::Personalize::Model::BatchInferenceJob::SetStatus ( const Aws::String value)
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 461 of file BatchInferenceJob.h.

◆ SetStatus() [3/3]

void Aws::Personalize::Model::BatchInferenceJob::SetStatus ( const char *  value)
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 475 of file BatchInferenceJob.h.

◆ SolutionVersionArnHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::SolutionVersionArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 218 of file BatchInferenceJob.h.

◆ StatusHasBeenSet()

bool Aws::Personalize::Model::BatchInferenceJob::StatusHasBeenSet ( ) const
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 454 of file BatchInferenceJob.h.

◆ WithBatchInferenceJobArn() [1/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithBatchInferenceJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 118 of file BatchInferenceJob.h.

◆ WithBatchInferenceJobArn() [2/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithBatchInferenceJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 113 of file BatchInferenceJob.h.

◆ WithBatchInferenceJobArn() [3/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithBatchInferenceJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the batch inference job.

Definition at line 123 of file BatchInferenceJob.h.

◆ WithBatchInferenceJobConfig() [1/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithBatchInferenceJobConfig ( BatchInferenceJobConfig &&  value)
inline

A string to string map of the configuration details of a batch inference job.

Definition at line 390 of file BatchInferenceJob.h.

◆ WithBatchInferenceJobConfig() [2/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithBatchInferenceJobConfig ( const BatchInferenceJobConfig value)
inline

A string to string map of the configuration details of a batch inference job.

Definition at line 384 of file BatchInferenceJob.h.

◆ WithCreationDateTime() [1/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithCreationDateTime ( Aws::Utils::DateTime &&  value)
inline

The time at which the batch inference job was created.

Definition at line 527 of file BatchInferenceJob.h.

◆ WithCreationDateTime() [2/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithCreationDateTime ( const Aws::Utils::DateTime value)
inline

The time at which the batch inference job was created.

Definition at line 522 of file BatchInferenceJob.h.

◆ WithFailureReason() [1/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithFailureReason ( Aws::String &&  value)
inline

If the batch inference job failed, the reason for the failure.

Definition at line 200 of file BatchInferenceJob.h.

◆ WithFailureReason() [2/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithFailureReason ( const Aws::String value)
inline

If the batch inference job failed, the reason for the failure.

Definition at line 195 of file BatchInferenceJob.h.

◆ WithFailureReason() [3/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithFailureReason ( const char *  value)
inline

If the batch inference job failed, the reason for the failure.

Definition at line 205 of file BatchInferenceJob.h.

◆ WithFilterArn() [1/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithFilterArn ( Aws::String &&  value)
inline

The ARN of the filter used on the batch inference job.

Definition at line 159 of file BatchInferenceJob.h.

◆ WithFilterArn() [2/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithFilterArn ( const Aws::String value)
inline

The ARN of the filter used on the batch inference job.

Definition at line 154 of file BatchInferenceJob.h.

◆ WithFilterArn() [3/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithFilterArn ( const char *  value)
inline

The ARN of the filter used on the batch inference job.

Definition at line 164 of file BatchInferenceJob.h.

◆ WithJobInput() [1/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithJobInput ( BatchInferenceJobInput &&  value)
inline

The Amazon S3 path that leads to the input data used to generate the batch inference job.

Definition at line 316 of file BatchInferenceJob.h.

◆ WithJobInput() [2/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithJobInput ( const BatchInferenceJobInput value)
inline

The Amazon S3 path that leads to the input data used to generate the batch inference job.

Definition at line 310 of file BatchInferenceJob.h.

◆ WithJobName() [1/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithJobName ( Aws::String &&  value)
inline

The name of the batch inference job.

Definition at line 77 of file BatchInferenceJob.h.

◆ WithJobName() [2/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithJobName ( const Aws::String value)
inline

The name of the batch inference job.

Definition at line 72 of file BatchInferenceJob.h.

◆ WithJobName() [3/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithJobName ( const char *  value)
inline

The name of the batch inference job.

Definition at line 82 of file BatchInferenceJob.h.

◆ WithJobOutput() [1/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithJobOutput ( BatchInferenceJobOutput &&  value)
inline

The Amazon S3 bucket that contains the output data generated by the batch inference job.

Definition at line 353 of file BatchInferenceJob.h.

◆ WithJobOutput() [2/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithJobOutput ( const BatchInferenceJobOutput value)
inline

The Amazon S3 bucket that contains the output data generated by the batch inference job.

Definition at line 347 of file BatchInferenceJob.h.

◆ WithLastUpdatedDateTime() [1/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithLastUpdatedDateTime ( Aws::Utils::DateTime &&  value)
inline

The time at which the batch inference job was last updated.

Definition at line 558 of file BatchInferenceJob.h.

◆ WithLastUpdatedDateTime() [2/2]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithLastUpdatedDateTime ( const Aws::Utils::DateTime value)
inline

The time at which the batch inference job was last updated.

Definition at line 553 of file BatchInferenceJob.h.

◆ WithNumResults()

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithNumResults ( int  value)
inline

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

Definition at line 279 of file BatchInferenceJob.h.

◆ WithRoleArn() [1/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithRoleArn ( Aws::String &&  value)
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 433 of file BatchInferenceJob.h.

◆ WithRoleArn() [2/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithRoleArn ( const Aws::String value)
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 427 of file BatchInferenceJob.h.

◆ WithRoleArn() [3/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithRoleArn ( const char *  value)
inline

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

Definition at line 439 of file BatchInferenceJob.h.

◆ WithSolutionVersionArn() [1/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithSolutionVersionArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 248 of file BatchInferenceJob.h.

◆ WithSolutionVersionArn() [2/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithSolutionVersionArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 242 of file BatchInferenceJob.h.

◆ WithSolutionVersionArn() [3/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithSolutionVersionArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

Definition at line 254 of file BatchInferenceJob.h.

◆ WithStatus() [1/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithStatus ( Aws::String &&  value)
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 489 of file BatchInferenceJob.h.

◆ WithStatus() [2/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithStatus ( const Aws::String value)
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 482 of file BatchInferenceJob.h.

◆ WithStatus() [3/3]

BatchInferenceJob& Aws::Personalize::Model::BatchInferenceJob::WithStatus ( const char *  value)
inline

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Definition at line 496 of file BatchInferenceJob.h.


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