@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateConfiguredAudienceModelRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateConfiguredAudienceModelRequest() |
Modifier and Type | Method and Description |
---|---|
CreateConfiguredAudienceModelRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateConfiguredAudienceModelRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateConfiguredAudienceModelRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAudienceModelArn()
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
|
AudienceSizeConfig |
getAudienceSizeConfig()
Configure the list of output sizes of audiences that can be created using this configured audience model.
|
String |
getChildResourceTagOnCreatePolicy()
Configure how the service tags audience generation jobs created using this configured audience model.
|
String |
getDescription()
The description of the configured audience model.
|
Integer |
getMinMatchingSeedSize()
The minimum number of users from the seed audience that must match with users in the training data of the
audience model.
|
String |
getName()
The name of the configured audience model.
|
ConfiguredAudienceModelOutputConfig |
getOutputConfig()
Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model.
|
List<String> |
getSharedAudienceMetrics()
Whether audience metrics are shared.
|
Map<String,String> |
getTags()
The optional metadata that you apply to the resource to help you categorize and organize them.
|
int |
hashCode() |
void |
setAudienceModelArn(String audienceModelArn)
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
|
void |
setAudienceSizeConfig(AudienceSizeConfig audienceSizeConfig)
Configure the list of output sizes of audiences that can be created using this configured audience model.
|
void |
setChildResourceTagOnCreatePolicy(String childResourceTagOnCreatePolicy)
Configure how the service tags audience generation jobs created using this configured audience model.
|
void |
setDescription(String description)
The description of the configured audience model.
|
void |
setMinMatchingSeedSize(Integer minMatchingSeedSize)
The minimum number of users from the seed audience that must match with users in the training data of the
audience model.
|
void |
setName(String name)
The name of the configured audience model.
|
void |
setOutputConfig(ConfiguredAudienceModelOutputConfig outputConfig)
Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model.
|
void |
setSharedAudienceMetrics(Collection<String> sharedAudienceMetrics)
Whether audience metrics are shared.
|
void |
setTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them.
|
String |
toString()
Returns a string representation of this object.
|
CreateConfiguredAudienceModelRequest |
withAudienceModelArn(String audienceModelArn)
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
|
CreateConfiguredAudienceModelRequest |
withAudienceSizeConfig(AudienceSizeConfig audienceSizeConfig)
Configure the list of output sizes of audiences that can be created using this configured audience model.
|
CreateConfiguredAudienceModelRequest |
withChildResourceTagOnCreatePolicy(String childResourceTagOnCreatePolicy)
Configure how the service tags audience generation jobs created using this configured audience model.
|
CreateConfiguredAudienceModelRequest |
withChildResourceTagOnCreatePolicy(TagOnCreatePolicy childResourceTagOnCreatePolicy)
Configure how the service tags audience generation jobs created using this configured audience model.
|
CreateConfiguredAudienceModelRequest |
withDescription(String description)
The description of the configured audience model.
|
CreateConfiguredAudienceModelRequest |
withMinMatchingSeedSize(Integer minMatchingSeedSize)
The minimum number of users from the seed audience that must match with users in the training data of the
audience model.
|
CreateConfiguredAudienceModelRequest |
withName(String name)
The name of the configured audience model.
|
CreateConfiguredAudienceModelRequest |
withOutputConfig(ConfiguredAudienceModelOutputConfig outputConfig)
Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model.
|
CreateConfiguredAudienceModelRequest |
withSharedAudienceMetrics(Collection<String> sharedAudienceMetrics)
Whether audience metrics are shared.
|
CreateConfiguredAudienceModelRequest |
withSharedAudienceMetrics(SharedAudienceMetrics... sharedAudienceMetrics)
Whether audience metrics are shared.
|
CreateConfiguredAudienceModelRequest |
withSharedAudienceMetrics(String... sharedAudienceMetrics)
Whether audience metrics are shared.
|
CreateConfiguredAudienceModelRequest |
withTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them.
|
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
public CreateConfiguredAudienceModelRequest()
public void setName(String name)
The name of the configured audience model.
name
- The name of the configured audience model.public String getName()
The name of the configured audience model.
public CreateConfiguredAudienceModelRequest withName(String name)
The name of the configured audience model.
name
- The name of the configured audience model.public void setAudienceModelArn(String audienceModelArn)
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
audienceModelArn
- The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.public String getAudienceModelArn()
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
public CreateConfiguredAudienceModelRequest withAudienceModelArn(String audienceModelArn)
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
audienceModelArn
- The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.public void setOutputConfig(ConfiguredAudienceModelOutputConfig outputConfig)
Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each
audience will have a unique location. The IAM Role must have s3:PutObject
permission on the
destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also
have the required KMS permissions.
outputConfig
- Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model.
Each audience will have a unique location. The IAM Role must have s3:PutObject
permission on
the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role
must also have the required KMS permissions.public ConfiguredAudienceModelOutputConfig getOutputConfig()
Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each
audience will have a unique location. The IAM Role must have s3:PutObject
permission on the
destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also
have the required KMS permissions.
s3:PutObject
permission on
the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role
must also have the required KMS permissions.public CreateConfiguredAudienceModelRequest withOutputConfig(ConfiguredAudienceModelOutputConfig outputConfig)
Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each
audience will have a unique location. The IAM Role must have s3:PutObject
permission on the
destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also
have the required KMS permissions.
outputConfig
- Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model.
Each audience will have a unique location. The IAM Role must have s3:PutObject
permission on
the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role
must also have the required KMS permissions.public void setDescription(String description)
The description of the configured audience model.
description
- The description of the configured audience model.public String getDescription()
The description of the configured audience model.
public CreateConfiguredAudienceModelRequest withDescription(String description)
The description of the configured audience model.
description
- The description of the configured audience model.public List<String> getSharedAudienceMetrics()
Whether audience metrics are shared.
SharedAudienceMetrics
public void setSharedAudienceMetrics(Collection<String> sharedAudienceMetrics)
Whether audience metrics are shared.
sharedAudienceMetrics
- Whether audience metrics are shared.SharedAudienceMetrics
public CreateConfiguredAudienceModelRequest withSharedAudienceMetrics(String... sharedAudienceMetrics)
Whether audience metrics are shared.
NOTE: This method appends the values to the existing list (if any). Use
setSharedAudienceMetrics(java.util.Collection)
or
withSharedAudienceMetrics(java.util.Collection)
if you want to override the existing values.
sharedAudienceMetrics
- Whether audience metrics are shared.SharedAudienceMetrics
public CreateConfiguredAudienceModelRequest withSharedAudienceMetrics(Collection<String> sharedAudienceMetrics)
Whether audience metrics are shared.
sharedAudienceMetrics
- Whether audience metrics are shared.SharedAudienceMetrics
public CreateConfiguredAudienceModelRequest withSharedAudienceMetrics(SharedAudienceMetrics... sharedAudienceMetrics)
Whether audience metrics are shared.
sharedAudienceMetrics
- Whether audience metrics are shared.SharedAudienceMetrics
public void setMinMatchingSeedSize(Integer minMatchingSeedSize)
The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.
minMatchingSeedSize
- The minimum number of users from the seed audience that must match with users in the training data of the
audience model. The default value is 500.public Integer getMinMatchingSeedSize()
The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.
public CreateConfiguredAudienceModelRequest withMinMatchingSeedSize(Integer minMatchingSeedSize)
The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.
minMatchingSeedSize
- The minimum number of users from the seed audience that must match with users in the training data of the
audience model. The default value is 500.public void setAudienceSizeConfig(AudienceSizeConfig audienceSizeConfig)
Configure the list of output sizes of audiences that can be created using this configured audience model. A
request to StartAudienceGenerationJob that uses this configured audience model must have an
audienceSize
selected from this list. You can use the ABSOLUTE
AudienceSize to
configure out audience sizes using the count of identifiers in the output. You can use the
Percentage
AudienceSize to configure sizes in the range 1-100 percent.
audienceSizeConfig
- Configure the list of output sizes of audiences that can be created using this configured audience model.
A request to StartAudienceGenerationJob that uses this configured audience model must have an
audienceSize
selected from this list. You can use the ABSOLUTE
AudienceSize to configure out audience sizes using the count of identifiers in the output. You can
use the Percentage
AudienceSize to configure sizes in the range 1-100 percent.public AudienceSizeConfig getAudienceSizeConfig()
Configure the list of output sizes of audiences that can be created using this configured audience model. A
request to StartAudienceGenerationJob that uses this configured audience model must have an
audienceSize
selected from this list. You can use the ABSOLUTE
AudienceSize to
configure out audience sizes using the count of identifiers in the output. You can use the
Percentage
AudienceSize to configure sizes in the range 1-100 percent.
audienceSize
selected from this list. You can use the ABSOLUTE
AudienceSize to configure out audience sizes using the count of identifiers in the output. You can
use the Percentage
AudienceSize to configure sizes in the range 1-100 percent.public CreateConfiguredAudienceModelRequest withAudienceSizeConfig(AudienceSizeConfig audienceSizeConfig)
Configure the list of output sizes of audiences that can be created using this configured audience model. A
request to StartAudienceGenerationJob that uses this configured audience model must have an
audienceSize
selected from this list. You can use the ABSOLUTE
AudienceSize to
configure out audience sizes using the count of identifiers in the output. You can use the
Percentage
AudienceSize to configure sizes in the range 1-100 percent.
audienceSizeConfig
- Configure the list of output sizes of audiences that can be created using this configured audience model.
A request to StartAudienceGenerationJob that uses this configured audience model must have an
audienceSize
selected from this list. You can use the ABSOLUTE
AudienceSize to configure out audience sizes using the count of identifiers in the output. You can
use the Percentage
AudienceSize to configure sizes in the range 1-100 percent.public Map<String,String> getTags()
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
public void setTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
tags
- The optional metadata that you apply to the resource to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
public CreateConfiguredAudienceModelRequest withTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
tags
- The optional metadata that you apply to the resource to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
public CreateConfiguredAudienceModelRequest addTagsEntry(String key, String value)
public CreateConfiguredAudienceModelRequest clearTagsEntries()
public void setChildResourceTagOnCreatePolicy(String childResourceTagOnCreatePolicy)
Configure how the service tags audience generation jobs created using this configured audience model. If you
specify NONE
, the tags from the StartAudienceGenerationJob request determine the tags of the
audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience generation job inherits
the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will
override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
childResourceTagOnCreatePolicy
- Configure how the service tags audience generation jobs created using this configured audience model. If
you specify NONE
, the tags from the StartAudienceGenerationJob request determine the
tags of the audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience
generation job inherits the tags from the configured audience model, by default. Tags in the
StartAudienceGenerationJob will override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
TagOnCreatePolicy
public String getChildResourceTagOnCreatePolicy()
Configure how the service tags audience generation jobs created using this configured audience model. If you
specify NONE
, the tags from the StartAudienceGenerationJob request determine the tags of the
audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience generation job inherits
the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will
override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
NONE
, the tags from the StartAudienceGenerationJob request determine the
tags of the audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience
generation job inherits the tags from the configured audience model, by default. Tags in the
StartAudienceGenerationJob will override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
TagOnCreatePolicy
public CreateConfiguredAudienceModelRequest withChildResourceTagOnCreatePolicy(String childResourceTagOnCreatePolicy)
Configure how the service tags audience generation jobs created using this configured audience model. If you
specify NONE
, the tags from the StartAudienceGenerationJob request determine the tags of the
audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience generation job inherits
the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will
override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
childResourceTagOnCreatePolicy
- Configure how the service tags audience generation jobs created using this configured audience model. If
you specify NONE
, the tags from the StartAudienceGenerationJob request determine the
tags of the audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience
generation job inherits the tags from the configured audience model, by default. Tags in the
StartAudienceGenerationJob will override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
TagOnCreatePolicy
public CreateConfiguredAudienceModelRequest withChildResourceTagOnCreatePolicy(TagOnCreatePolicy childResourceTagOnCreatePolicy)
Configure how the service tags audience generation jobs created using this configured audience model. If you
specify NONE
, the tags from the StartAudienceGenerationJob request determine the tags of the
audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience generation job inherits
the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will
override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
childResourceTagOnCreatePolicy
- Configure how the service tags audience generation jobs created using this configured audience model. If
you specify NONE
, the tags from the StartAudienceGenerationJob request determine the
tags of the audience generation job. If you specify FROM_PARENT_RESOURCE
, the audience
generation job inherits the tags from the configured audience model, by default. Tags in the
StartAudienceGenerationJob will override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
TagOnCreatePolicy
public String toString()
toString
in class Object
Object.toString()
public CreateConfiguredAudienceModelRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()