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

#include <Campaign.h>

Public Member Functions

 Campaign ()
 
 Campaign (Aws::Utils::Json::JsonView jsonValue)
 
Campaignoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CampaignWithName (const Aws::String &value)
 
CampaignWithName (Aws::String &&value)
 
CampaignWithName (const char *value)
 
const Aws::StringGetCampaignArn () const
 
bool CampaignArnHasBeenSet () const
 
void SetCampaignArn (const Aws::String &value)
 
void SetCampaignArn (Aws::String &&value)
 
void SetCampaignArn (const char *value)
 
CampaignWithCampaignArn (const Aws::String &value)
 
CampaignWithCampaignArn (Aws::String &&value)
 
CampaignWithCampaignArn (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)
 
CampaignWithSolutionVersionArn (const Aws::String &value)
 
CampaignWithSolutionVersionArn (Aws::String &&value)
 
CampaignWithSolutionVersionArn (const char *value)
 
int GetMinProvisionedTPS () const
 
bool MinProvisionedTPSHasBeenSet () const
 
void SetMinProvisionedTPS (int value)
 
CampaignWithMinProvisionedTPS (int value)
 
const CampaignConfigGetCampaignConfig () const
 
bool CampaignConfigHasBeenSet () const
 
void SetCampaignConfig (const CampaignConfig &value)
 
void SetCampaignConfig (CampaignConfig &&value)
 
CampaignWithCampaignConfig (const CampaignConfig &value)
 
CampaignWithCampaignConfig (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)
 
CampaignWithStatus (const Aws::String &value)
 
CampaignWithStatus (Aws::String &&value)
 
CampaignWithStatus (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)
 
CampaignWithFailureReason (const Aws::String &value)
 
CampaignWithFailureReason (Aws::String &&value)
 
CampaignWithFailureReason (const char *value)
 
const Aws::Utils::DateTimeGetCreationDateTime () const
 
bool CreationDateTimeHasBeenSet () const
 
void SetCreationDateTime (const Aws::Utils::DateTime &value)
 
void SetCreationDateTime (Aws::Utils::DateTime &&value)
 
CampaignWithCreationDateTime (const Aws::Utils::DateTime &value)
 
CampaignWithCreationDateTime (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)
 
CampaignWithLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
CampaignWithLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 
const CampaignUpdateSummaryGetLatestCampaignUpdate () const
 
bool LatestCampaignUpdateHasBeenSet () const
 
void SetLatestCampaignUpdate (const CampaignUpdateSummary &value)
 
void SetLatestCampaignUpdate (CampaignUpdateSummary &&value)
 
CampaignWithLatestCampaignUpdate (const CampaignUpdateSummary &value)
 
CampaignWithLatestCampaignUpdate (CampaignUpdateSummary &&value)
 

Detailed Description

Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

Definition at line 36 of file Campaign.h.

Constructor & Destructor Documentation

◆ Campaign() [1/2]

Aws::Personalize::Model::Campaign::Campaign ( )

◆ Campaign() [2/2]

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

Member Function Documentation

◆ CampaignArnHasBeenSet()

bool Aws::Personalize::Model::Campaign::CampaignArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 94 of file Campaign.h.

◆ CampaignConfigHasBeenSet()

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

The configuration details of a campaign.

Definition at line 201 of file Campaign.h.

◆ CreationDateTimeHasBeenSet()

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

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

Definition at line 338 of file Campaign.h.

◆ FailureReasonHasBeenSet()

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

If a campaign fails, the reason behind the failure.

Definition at line 297 of file Campaign.h.

◆ GetCampaignArn()

const Aws::String& Aws::Personalize::Model::Campaign::GetCampaignArn ( ) const
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 89 of file Campaign.h.

◆ GetCampaignConfig()

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

The configuration details of a campaign.

Definition at line 196 of file Campaign.h.

◆ GetCreationDateTime()

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

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

Definition at line 333 of file Campaign.h.

◆ GetFailureReason()

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

If a campaign fails, the reason behind the failure.

Definition at line 292 of file Campaign.h.

◆ GetLastUpdatedDateTime()

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

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

Definition at line 364 of file Campaign.h.

◆ GetLatestCampaignUpdate()

const CampaignUpdateSummary& Aws::Personalize::Model::Campaign::GetLatestCampaignUpdate ( ) const
inline

Definition at line 393 of file Campaign.h.

◆ GetMinProvisionedTPS()

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

Specifies the requested minimum provisioned transactions (recommendations) per second.

Definition at line 172 of file Campaign.h.

◆ GetName()

const Aws::String& Aws::Personalize::Model::Campaign::GetName ( ) const
inline

The name of the campaign.

Definition at line 48 of file Campaign.h.

◆ GetSolutionVersionArn()

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

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

Definition at line 130 of file Campaign.h.

◆ GetStatus()

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

The status of the campaign.

A campaign 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 230 of file Campaign.h.

◆ Jsonize()

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

◆ LastUpdatedDateTimeHasBeenSet()

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

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

Definition at line 369 of file Campaign.h.

◆ LatestCampaignUpdateHasBeenSet()

bool Aws::Personalize::Model::Campaign::LatestCampaignUpdateHasBeenSet ( ) const
inline

Definition at line 396 of file Campaign.h.

◆ MinProvisionedTPSHasBeenSet()

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

Specifies the requested minimum provisioned transactions (recommendations) per second.

Definition at line 178 of file Campaign.h.

◆ NameHasBeenSet()

bool Aws::Personalize::Model::Campaign::NameHasBeenSet ( ) const
inline

The name of the campaign.

Definition at line 53 of file Campaign.h.

◆ operator=()

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

◆ SetCampaignArn() [1/3]

void Aws::Personalize::Model::Campaign::SetCampaignArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 104 of file Campaign.h.

◆ SetCampaignArn() [2/3]

void Aws::Personalize::Model::Campaign::SetCampaignArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 99 of file Campaign.h.

◆ SetCampaignArn() [3/3]

void Aws::Personalize::Model::Campaign::SetCampaignArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 109 of file Campaign.h.

◆ SetCampaignConfig() [1/2]

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

The configuration details of a campaign.

Definition at line 211 of file Campaign.h.

◆ SetCampaignConfig() [2/2]

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

The configuration details of a campaign.

Definition at line 206 of file Campaign.h.

◆ SetCreationDateTime() [1/2]

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

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

Definition at line 348 of file Campaign.h.

◆ SetCreationDateTime() [2/2]

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

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

Definition at line 343 of file Campaign.h.

◆ SetFailureReason() [1/3]

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

If a campaign fails, the reason behind the failure.

Definition at line 307 of file Campaign.h.

◆ SetFailureReason() [2/3]

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

If a campaign fails, the reason behind the failure.

Definition at line 302 of file Campaign.h.

◆ SetFailureReason() [3/3]

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

If a campaign fails, the reason behind the failure.

Definition at line 312 of file Campaign.h.

◆ SetLastUpdatedDateTime() [1/2]

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

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

Definition at line 379 of file Campaign.h.

◆ SetLastUpdatedDateTime() [2/2]

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

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

Definition at line 374 of file Campaign.h.

◆ SetLatestCampaignUpdate() [1/2]

void Aws::Personalize::Model::Campaign::SetLatestCampaignUpdate ( CampaignUpdateSummary &&  value)
inline

Definition at line 402 of file Campaign.h.

◆ SetLatestCampaignUpdate() [2/2]

void Aws::Personalize::Model::Campaign::SetLatestCampaignUpdate ( const CampaignUpdateSummary value)
inline

Definition at line 399 of file Campaign.h.

◆ SetMinProvisionedTPS()

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

Specifies the requested minimum provisioned transactions (recommendations) per second.

Definition at line 184 of file Campaign.h.

◆ SetName() [1/3]

void Aws::Personalize::Model::Campaign::SetName ( Aws::String &&  value)
inline

The name of the campaign.

Definition at line 63 of file Campaign.h.

◆ SetName() [2/3]

void Aws::Personalize::Model::Campaign::SetName ( const Aws::String value)
inline

The name of the campaign.

Definition at line 58 of file Campaign.h.

◆ SetName() [3/3]

void Aws::Personalize::Model::Campaign::SetName ( const char *  value)
inline

The name of the campaign.

Definition at line 68 of file Campaign.h.

◆ SetSolutionVersionArn() [1/3]

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

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

Definition at line 145 of file Campaign.h.

◆ SetSolutionVersionArn() [2/3]

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

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

Definition at line 140 of file Campaign.h.

◆ SetSolutionVersionArn() [3/3]

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

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

Definition at line 150 of file Campaign.h.

◆ SetStatus() [1/3]

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

The status of the campaign.

A campaign 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 254 of file Campaign.h.

◆ SetStatus() [2/3]

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

The status of the campaign.

A campaign 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 246 of file Campaign.h.

◆ SetStatus() [3/3]

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

The status of the campaign.

A campaign 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 262 of file Campaign.h.

◆ SolutionVersionArnHasBeenSet()

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

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

Definition at line 135 of file Campaign.h.

◆ StatusHasBeenSet()

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

The status of the campaign.

A campaign 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 238 of file Campaign.h.

◆ WithCampaignArn() [1/3]

Campaign& Aws::Personalize::Model::Campaign::WithCampaignArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 119 of file Campaign.h.

◆ WithCampaignArn() [2/3]

Campaign& Aws::Personalize::Model::Campaign::WithCampaignArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 114 of file Campaign.h.

◆ WithCampaignArn() [3/3]

Campaign& Aws::Personalize::Model::Campaign::WithCampaignArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 124 of file Campaign.h.

◆ WithCampaignConfig() [1/2]

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

The configuration details of a campaign.

Definition at line 221 of file Campaign.h.

◆ WithCampaignConfig() [2/2]

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

The configuration details of a campaign.

Definition at line 216 of file Campaign.h.

◆ WithCreationDateTime() [1/2]

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

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

Definition at line 358 of file Campaign.h.

◆ WithCreationDateTime() [2/2]

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

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

Definition at line 353 of file Campaign.h.

◆ WithFailureReason() [1/3]

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

If a campaign fails, the reason behind the failure.

Definition at line 322 of file Campaign.h.

◆ WithFailureReason() [2/3]

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

If a campaign fails, the reason behind the failure.

Definition at line 317 of file Campaign.h.

◆ WithFailureReason() [3/3]

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

If a campaign fails, the reason behind the failure.

Definition at line 327 of file Campaign.h.

◆ WithLastUpdatedDateTime() [1/2]

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

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

Definition at line 389 of file Campaign.h.

◆ WithLastUpdatedDateTime() [2/2]

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

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

Definition at line 384 of file Campaign.h.

◆ WithLatestCampaignUpdate() [1/2]

Campaign& Aws::Personalize::Model::Campaign::WithLatestCampaignUpdate ( CampaignUpdateSummary &&  value)
inline

Definition at line 408 of file Campaign.h.

◆ WithLatestCampaignUpdate() [2/2]

Campaign& Aws::Personalize::Model::Campaign::WithLatestCampaignUpdate ( const CampaignUpdateSummary value)
inline

Definition at line 405 of file Campaign.h.

◆ WithMinProvisionedTPS()

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

Specifies the requested minimum provisioned transactions (recommendations) per second.

Definition at line 190 of file Campaign.h.

◆ WithName() [1/3]

Campaign& Aws::Personalize::Model::Campaign::WithName ( Aws::String &&  value)
inline

The name of the campaign.

Definition at line 78 of file Campaign.h.

◆ WithName() [2/3]

Campaign& Aws::Personalize::Model::Campaign::WithName ( const Aws::String value)
inline

The name of the campaign.

Definition at line 73 of file Campaign.h.

◆ WithName() [3/3]

Campaign& Aws::Personalize::Model::Campaign::WithName ( const char *  value)
inline

The name of the campaign.

Definition at line 83 of file Campaign.h.

◆ WithSolutionVersionArn() [1/3]

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

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

Definition at line 160 of file Campaign.h.

◆ WithSolutionVersionArn() [2/3]

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

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

Definition at line 155 of file Campaign.h.

◆ WithSolutionVersionArn() [3/3]

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

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

Definition at line 165 of file Campaign.h.

◆ WithStatus() [1/3]

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

The status of the campaign.

A campaign 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 278 of file Campaign.h.

◆ WithStatus() [2/3]

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

The status of the campaign.

A campaign 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 270 of file Campaign.h.

◆ WithStatus() [3/3]

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

The status of the campaign.

A campaign 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 286 of file Campaign.h.


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