S3ConfigMap s3Destination
The Amazon S3 bucket and path for the configured audience.
Date createTime
The time at which the audience export job was created.
Date updateTime
The most recent time at which the audience export job was updated.
String name
The name of the audience export job.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job that was exported.
AudienceSize audienceSize
String description
The description of the audience export job.
String status
The status of the audience export job.
StatusDetails statusDetails
String outputLocation
The Amazon S3 bucket where the audience export is stored.
S3ConfigMap dataSource
Defines the Amazon S3 bucket where the seed audience for the generating audience is stored. A valid data source is a JSON line file in the following format:
{"user_id": "111111"}
{"user_id": "222222"}
...
String roleArn
The ARN of the IAM role that can read the Amazon S3 bucket where the seed audience is stored.
ProtectedQuerySQLParameters sqlParameters
The protected SQL query parameters.
Date createTime
The time at which the audience generation job was created.
Date updateTime
The most recent time at which the audience generation job was updated.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job.
String name
The name of the audience generation job.
String description
The description of the audience generation job.
String status
The status of the audience generation job.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that was used for this audience generation job.
String collaborationId
The identifier of the collaboration that contains this audience generation job.
String startedBy
The AWS Account that submitted the job.
Date createTime
The time at which the audience model was created.
Date updateTime
The most recent time at which the audience model was updated.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model.
String name
The name of the audience model.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.
String status
The status of the audience model.
String description
The description of the audience model.
List<E> relevanceMetrics
The relevance scores of the generated audience.
Double recallMetric
The recall score of the generated audience. Recall is the percentage of the most similar users (by default, the most similar 20%) from a sample of the training data that are included in the seed audience by the audience generation job. Values range from 0-1, larger values indicate a better audience. A recall value approximately equal to the maximum bin size indicates that the audience model is equivalent to random selection.
String type
Whether the audience size is defined in absolute terms or as a percentage. 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.
Integer value
Specify an audience size value.
AudienceDestination destination
String roleArn
The ARN of the IAM role that can write the Amazon S3 bucket.
Date createTime
The time at which the configured audience model was created.
Date updateTime
The most recent time at which the configured audience model was updated.
String name
The name of the configured audience model.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.
ConfiguredAudienceModelOutputConfig outputConfig
The output configuration of the configured audience model.
String description
The description of the configured audience model.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
String status
The status of the configured audience model.
Date trainingDataStartTime
The start date and time of the training window.
Date trainingDataEndTime
The end date and time of the training window.
String name
The name of the audience model resource.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset for this audience model.
String kmsKeyArn
The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
Map<K,V> 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.
String description
The description of the audience model.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model.
String name
The name of the configured audience model.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
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.
String description
The description of the configured audience model.
List<E> sharedAudienceMetrics
Whether audience metrics are shared.
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.
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.
Map<K,V> 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.
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.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model.
String name
The name of the training dataset. This name must be unique in your account and region.
String roleArn
The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the
dataSource field of each dataset.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an
AccessDeniedException error.
List<E> trainingData
An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.
Map<K,V> 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.
String description
The description of the training dataset.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset resource.
String type
What type of information is found in the dataset.
DatasetInputConfig inputConfig
A DatasetInputConfig object that defines the data source and schema mapping.
List<E> schema
The schema information for the training data.
DataSource dataSource
A DataSource object that specifies the Glue data source for the training data.
GlueDataSource glueDataSource
A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job that you want to delete.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model that you want to delete.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that you want to delete.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset that you want to delete.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
Date createTime
The time at which the audience generation job was created.
Date updateTime
The most recent time at which the audience generation job was updated.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job.
String name
The name of the audience generation job.
String description
The description of the audience generation job.
String status
The status of the audience generation job.
StatusDetails statusDetails
Details about the status of the audience generation job.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
AudienceGenerationJobDataSource seedAudience
The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
Boolean includeSeedInOutput
Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed
users from the output audience. If you specify TRUE, the seed users will appear first in the output.
Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will
know that the first minimumSeedSize count of users are from the seed.
String collaborationId
The identifier of the collaboration that this audience generation job is associated with.
AudienceQualityMetrics metrics
The relevance scores for different audience sizes and the recall score of the generated audience.
String startedBy
The AWS account that started this audience generation job.
Map<K,V> tags
The tags that are associated to this audience generation job.
String protectedQueryIdentifier
The unique identifier of the protected query for this audience generation job.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model that you are interested in.
Date createTime
The time at which the audience model was created.
Date updateTime
The most recent time at which the audience model was updated.
Date trainingDataStartTime
The start date specified for the training window.
Date trainingDataEndTime
The end date specified for the training window.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model.
String name
The name of the audience model.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.
String status
The status of the audience model.
StatusDetails statusDetails
Details about the status of the audience model.
String kmsKeyArn
The KMS key ARN used for the audience model.
Map<K,V> tags
The tags that are assigned to the audience model.
String description
The description of the audience model.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model.
String configuredAudienceModelPolicy
The configured audience model policy. This is a JSON IAM resource policy.
String policyHash
A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
Date createTime
The time at which the configured audience model was created.
Date updateTime
The most recent time at which the configured audience model was updated.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model.
String name
The name of the configured audience model.
String audienceModelArn
The Amazon Resource Name (ARN) of the audience model used for this configured audience model.
ConfiguredAudienceModelOutputConfig outputConfig
The output configuration of the configured audience model
String description
The description of the configured audience model.
String status
The status of the configured audience model.
List<E> sharedAudienceMetrics
Whether audience metrics are shared.
Integer minMatchingSeedSize
The minimum number of users from the seed audience that must match with users in the training data of the audience model.
AudienceSizeConfig audienceSizeConfig
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.
Map<K,V> tags
The tags that are associated to this configured audience model.
String childResourceTagOnCreatePolicy
Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset that you are interested in.
Date createTime
The time at which the training dataset was created.
Date updateTime
The most recent time at which the training dataset was updated.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset.
String name
The name of the training dataset.
List<E> trainingData
Metadata about the requested training data.
String status
The status of the training dataset.
String roleArn
The IAM role used to read the training data.
Map<K,V> tags
The tags that are assigned to this training dataset.
String description
The description of the training dataset.
String nextToken
The token value retrieved from a previous call to access the next page of results.
Integer maxResults
The maximum size of the results that is returned per call.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
String nextToken
The token value retrieved from a previous call to access the next page of results.
Integer maxResults
The maximum size of the results that is returned per call.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.
String collaborationId
The identifier of the collaboration that contains the audience generation jobs that you are interested in.
String resourceArn
The Amazon Resource Name (ARN) of the resource that you are interested in.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.
String configuredAudienceModelPolicy
The IAM resource policy.
String previousPolicyHash
A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
String policyExistenceCondition
Use this to prevent unexpected concurrent modification of the policy.
AudienceSize audienceSize
Double score
The relevance score of the generated audience.
String s3Uri
The Amazon S3 location URI.
String name
The name of the audience export job.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job that you want to export.
AudienceSize audienceSize
String description
The description of the audience export job.
String name
The name of the audience generation job.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
AudienceGenerationJobDataSource seedAudience
The seed audience that is used to generate the audience.
Boolean includeSeedInOutput
Whether the seed audience is included in the audience generation output.
String collaborationId
The identifier of the collaboration that contains the audience generation job.
String description
The description of the audience generation job.
Map<K,V> 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.
String audienceGenerationJobArn
The Amazon Resource Name (ARN) of the audience generation job.
String statusCode
The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.
String message
The error message that was returned. The message is intended for human consumption and can change at any time.
Use the statusCode for programmatic error handling.
String resourceArn
The Amazon Resource Name (ARN) of the resource that you want to assign tags.
Map<K,V> 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 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.
Date createTime
The time at which the training dataset was created.
Date updateTime
The most recent time at which the training dataset was updated.
String trainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset.
String name
The name of the training dataset.
String status
The status of the training dataset.
String description
The description of the training dataset.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that you want to update.
ConfiguredAudienceModelOutputConfig outputConfig
The new output configuration.
String audienceModelArn
The Amazon Resource Name (ARN) of the new audience model that you want to use.
List<E> sharedAudienceMetrics
The new value for whether to share audience metrics.
Integer minMatchingSeedSize
The minimum number of users from the seed audience that must match with users in the training data of the audience model.
AudienceSizeConfig audienceSizeConfig
The new audience size configuration.
String description
The new description of the configured audience model.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that was updated.
Copyright © 2024. All rights reserved.