com.amazonaws.services.personalize.model

Class CreateCampaignRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.personalize.model.CreateCampaignRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCampaignRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateCampaignRequest()

Method Summary

Modifier and Type	Method and Description
CreateCampaignRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
CampaignConfig	getCampaignConfig() The configuration details of a campaign.
Integer	getMinProvisionedTPS() Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
String	getName() A name for the new campaign.
String	getSolutionVersionArn() The Amazon Resource Name (ARN) of the trained model to deploy with the campaign.
List<Tag>	getTags() A list of tags to apply to the campaign.
int	hashCode()
void	setCampaignConfig(CampaignConfig campaignConfig) The configuration details of a campaign.
void	setMinProvisionedTPS(Integer minProvisionedTPS) Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
void	setName(String name) A name for the new campaign.
void	setSolutionVersionArn(String solutionVersionArn) The Amazon Resource Name (ARN) of the trained model to deploy with the campaign.
void	setTags(Collection<Tag> tags) A list of tags to apply to the campaign.
String	toString() Returns a string representation of this object.
CreateCampaignRequest	withCampaignConfig(CampaignConfig campaignConfig) The configuration details of a campaign.
CreateCampaignRequest	withMinProvisionedTPS(Integer minProvisionedTPS) Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
CreateCampaignRequest	withName(String name) A name for the new campaign.
CreateCampaignRequest	withSolutionVersionArn(String solutionVersionArn) The Amazon Resource Name (ARN) of the trained model to deploy with the campaign.
CreateCampaignRequest	withTags(Collection<Tag> tags) A list of tags to apply to the campaign.
CreateCampaignRequest	withTags(Tag... tags) A list of tags to apply to the campaign.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCampaignRequest

public CreateCampaignRequest()

Method Detail

setName

public void setName(String name)

A name for the new campaign. The campaign name must be unique within your account.

Parameters:

name - A name for the new campaign. The campaign name must be unique within your account.

getName

public String getName()

A name for the new campaign. The campaign name must be unique within your account.

Returns:

A name for the new campaign. The campaign name must be unique within your account.

withName

public CreateCampaignRequest withName(String name)

A name for the new campaign. The campaign name must be unique within your account.

Parameters:

name - A name for the new campaign. The campaign name must be unique within your account.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSolutionVersionArn

public void setSolutionVersionArn(String solutionVersionArn)

The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Parameters:

solutionVersionArn - The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

getSolutionVersionArn

public String getSolutionVersionArn()

The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Returns:

The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

withSolutionVersionArn

public CreateCampaignRequest withSolutionVersionArn(String solutionVersionArn)

The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Parameters:

solutionVersionArn - The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMinProvisionedTPS

public void setMinProvisionedTPS(Integer minProvisionedTPS)

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

Parameters:

minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

getMinProvisionedTPS

public Integer getMinProvisionedTPS()

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

Returns:

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

withMinProvisionedTPS

public CreateCampaignRequest withMinProvisionedTPS(Integer minProvisionedTPS)

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

Parameters:

minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCampaignConfig

public void setCampaignConfig(CampaignConfig campaignConfig)

The configuration details of a campaign.

Parameters:

campaignConfig - The configuration details of a campaign.

getCampaignConfig

public CampaignConfig getCampaignConfig()

The configuration details of a campaign.

Returns:

The configuration details of a campaign.

withCampaignConfig

public CreateCampaignRequest withCampaignConfig(CampaignConfig campaignConfig)

The configuration details of a campaign.

Parameters:

campaignConfig - The configuration details of a campaign.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

A list of tags to apply to the campaign.

Returns:

A list of tags to apply to the campaign.

setTags

public void setTags(Collection<Tag> tags)

A list of tags to apply to the campaign.

Parameters:

tags - A list of tags to apply to the campaign.

withTags

public CreateCampaignRequest withTags(Tag... tags)

A list of tags to apply to the campaign.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of tags to apply to the campaign.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateCampaignRequest withTags(Collection<Tag> tags)

A list of tags to apply to the campaign.

Parameters:

tags - A list of tags to apply to the campaign.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateCampaignRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()