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

#include <CampaignUpdateSummary.h>

Public Member Functions

 CampaignUpdateSummary ()
 
 CampaignUpdateSummary (Aws::Utils::Json::JsonView jsonValue)
 
CampaignUpdateSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetSolutionVersionArn () const
 
bool SolutionVersionArnHasBeenSet () const
 
void SetSolutionVersionArn (const Aws::String &value)
 
void SetSolutionVersionArn (Aws::String &&value)
 
void SetSolutionVersionArn (const char *value)
 
CampaignUpdateSummaryWithSolutionVersionArn (const Aws::String &value)
 
CampaignUpdateSummaryWithSolutionVersionArn (Aws::String &&value)
 
CampaignUpdateSummaryWithSolutionVersionArn (const char *value)
 
int GetMinProvisionedTPS () const
 
bool MinProvisionedTPSHasBeenSet () const
 
void SetMinProvisionedTPS (int value)
 
CampaignUpdateSummaryWithMinProvisionedTPS (int value)
 
const CampaignConfigGetCampaignConfig () const
 
bool CampaignConfigHasBeenSet () const
 
void SetCampaignConfig (const CampaignConfig &value)
 
void SetCampaignConfig (CampaignConfig &&value)
 
CampaignUpdateSummaryWithCampaignConfig (const CampaignConfig &value)
 
CampaignUpdateSummaryWithCampaignConfig (CampaignConfig &&value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
CampaignUpdateSummaryWithStatus (const Aws::String &value)
 
CampaignUpdateSummaryWithStatus (Aws::String &&value)
 
CampaignUpdateSummaryWithStatus (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)
 
CampaignUpdateSummaryWithFailureReason (const Aws::String &value)
 
CampaignUpdateSummaryWithFailureReason (Aws::String &&value)
 
CampaignUpdateSummaryWithFailureReason (const char *value)
 
const Aws::Utils::DateTimeGetCreationDateTime () const
 
bool CreationDateTimeHasBeenSet () const
 
void SetCreationDateTime (const Aws::Utils::DateTime &value)
 
void SetCreationDateTime (Aws::Utils::DateTime &&value)
 
CampaignUpdateSummaryWithCreationDateTime (const Aws::Utils::DateTime &value)
 
CampaignUpdateSummaryWithCreationDateTime (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)
 
CampaignUpdateSummaryWithLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
CampaignUpdateSummaryWithLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

See Also:

AWS API Reference

Definition at line 34 of file CampaignUpdateSummary.h.

Constructor & Destructor Documentation

◆ CampaignUpdateSummary() [1/2]

Aws::Personalize::Model::CampaignUpdateSummary::CampaignUpdateSummary ( )

◆ CampaignUpdateSummary() [2/2]

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

Member Function Documentation

◆ CampaignConfigHasBeenSet()

bool Aws::Personalize::Model::CampaignUpdateSummary::CampaignConfigHasBeenSet ( ) const
inline

Definition at line 113 of file CampaignUpdateSummary.h.

◆ CreationDateTimeHasBeenSet()

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

The date and time (in Unix time) that the campaign update was created.

Definition at line 242 of file CampaignUpdateSummary.h.

◆ FailureReasonHasBeenSet()

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

If a campaign update fails, the reason behind the failure.

Definition at line 201 of file CampaignUpdateSummary.h.

◆ GetCampaignConfig()

const CampaignConfig& Aws::Personalize::Model::CampaignUpdateSummary::GetCampaignConfig ( ) const
inline

Definition at line 110 of file CampaignUpdateSummary.h.

◆ GetCreationDateTime()

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

The date and time (in Unix time) that the campaign update was created.

Definition at line 237 of file CampaignUpdateSummary.h.

◆ GetFailureReason()

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

If a campaign update fails, the reason behind the failure.

Definition at line 196 of file CampaignUpdateSummary.h.

◆ GetLastUpdatedDateTime()

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

The date and time (in Unix time) that the campaign update was last updated.

Definition at line 269 of file CampaignUpdateSummary.h.

◆ GetMinProvisionedTPS()

int Aws::Personalize::Model::CampaignUpdateSummary::GetMinProvisionedTPS ( ) const
inline

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

Definition at line 88 of file CampaignUpdateSummary.h.

◆ GetSolutionVersionArn()

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 46 of file CampaignUpdateSummary.h.

◆ GetStatus()

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 134 of file CampaignUpdateSummary.h.

◆ Jsonize()

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

◆ LastUpdatedDateTimeHasBeenSet()

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

The date and time (in Unix time) that the campaign update was last updated.

Definition at line 275 of file CampaignUpdateSummary.h.

◆ MinProvisionedTPSHasBeenSet()

bool Aws::Personalize::Model::CampaignUpdateSummary::MinProvisionedTPSHasBeenSet ( ) const
inline

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

Definition at line 94 of file CampaignUpdateSummary.h.

◆ operator=()

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

◆ SetCampaignConfig() [1/2]

void Aws::Personalize::Model::CampaignUpdateSummary::SetCampaignConfig ( CampaignConfig &&  value)
inline

Definition at line 119 of file CampaignUpdateSummary.h.

◆ SetCampaignConfig() [2/2]

void Aws::Personalize::Model::CampaignUpdateSummary::SetCampaignConfig ( const CampaignConfig value)
inline

Definition at line 116 of file CampaignUpdateSummary.h.

◆ SetCreationDateTime() [1/2]

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

The date and time (in Unix time) that the campaign update was created.

Definition at line 252 of file CampaignUpdateSummary.h.

◆ SetCreationDateTime() [2/2]

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

The date and time (in Unix time) that the campaign update was created.

Definition at line 247 of file CampaignUpdateSummary.h.

◆ SetFailureReason() [1/3]

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

If a campaign update fails, the reason behind the failure.

Definition at line 211 of file CampaignUpdateSummary.h.

◆ SetFailureReason() [2/3]

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

If a campaign update fails, the reason behind the failure.

Definition at line 206 of file CampaignUpdateSummary.h.

◆ SetFailureReason() [3/3]

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

If a campaign update fails, the reason behind the failure.

Definition at line 216 of file CampaignUpdateSummary.h.

◆ SetLastUpdatedDateTime() [1/2]

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

The date and time (in Unix time) that the campaign update was last updated.

Definition at line 287 of file CampaignUpdateSummary.h.

◆ SetLastUpdatedDateTime() [2/2]

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

The date and time (in Unix time) that the campaign update was last updated.

Definition at line 281 of file CampaignUpdateSummary.h.

◆ SetMinProvisionedTPS()

void Aws::Personalize::Model::CampaignUpdateSummary::SetMinProvisionedTPS ( int  value)
inline

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

Definition at line 100 of file CampaignUpdateSummary.h.

◆ SetSolutionVersionArn() [1/3]

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 61 of file CampaignUpdateSummary.h.

◆ SetSolutionVersionArn() [2/3]

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 56 of file CampaignUpdateSummary.h.

◆ SetSolutionVersionArn() [3/3]

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 66 of file CampaignUpdateSummary.h.

◆ SetStatus() [1/3]

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 158 of file CampaignUpdateSummary.h.

◆ SetStatus() [2/3]

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 150 of file CampaignUpdateSummary.h.

◆ SetStatus() [3/3]

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 166 of file CampaignUpdateSummary.h.

◆ SolutionVersionArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 51 of file CampaignUpdateSummary.h.

◆ StatusHasBeenSet()

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 142 of file CampaignUpdateSummary.h.

◆ WithCampaignConfig() [1/2]

CampaignUpdateSummary& Aws::Personalize::Model::CampaignUpdateSummary::WithCampaignConfig ( CampaignConfig &&  value)
inline

Definition at line 125 of file CampaignUpdateSummary.h.

◆ WithCampaignConfig() [2/2]

CampaignUpdateSummary& Aws::Personalize::Model::CampaignUpdateSummary::WithCampaignConfig ( const CampaignConfig value)
inline

Definition at line 122 of file CampaignUpdateSummary.h.

◆ WithCreationDateTime() [1/2]

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

The date and time (in Unix time) that the campaign update was created.

Definition at line 262 of file CampaignUpdateSummary.h.

◆ WithCreationDateTime() [2/2]

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

The date and time (in Unix time) that the campaign update was created.

Definition at line 257 of file CampaignUpdateSummary.h.

◆ WithFailureReason() [1/3]

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

If a campaign update fails, the reason behind the failure.

Definition at line 226 of file CampaignUpdateSummary.h.

◆ WithFailureReason() [2/3]

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

If a campaign update fails, the reason behind the failure.

Definition at line 221 of file CampaignUpdateSummary.h.

◆ WithFailureReason() [3/3]

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

If a campaign update fails, the reason behind the failure.

Definition at line 231 of file CampaignUpdateSummary.h.

◆ WithLastUpdatedDateTime() [1/2]

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

The date and time (in Unix time) that the campaign update was last updated.

Definition at line 299 of file CampaignUpdateSummary.h.

◆ WithLastUpdatedDateTime() [2/2]

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

The date and time (in Unix time) that the campaign update was last updated.

Definition at line 293 of file CampaignUpdateSummary.h.

◆ WithMinProvisionedTPS()

CampaignUpdateSummary& Aws::Personalize::Model::CampaignUpdateSummary::WithMinProvisionedTPS ( int  value)
inline

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

Definition at line 106 of file CampaignUpdateSummary.h.

◆ WithSolutionVersionArn() [1/3]

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 76 of file CampaignUpdateSummary.h.

◆ WithSolutionVersionArn() [2/3]

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 71 of file CampaignUpdateSummary.h.

◆ WithSolutionVersionArn() [3/3]

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

The Amazon Resource Name (ARN) of the deployed solution version.

Definition at line 81 of file CampaignUpdateSummary.h.

◆ WithStatus() [1/3]

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 182 of file CampaignUpdateSummary.h.

◆ WithStatus() [2/3]

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 174 of file CampaignUpdateSummary.h.

◆ WithStatus() [3/3]

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

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 190 of file CampaignUpdateSummary.h.


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