AWS Clean Rooms ML 2023-09-06
- Client: Aws\CleanRoomsML\CleanRoomsMLClient
- Service ID: cleanroomsml
- Version: 2023-09-06
This page describes the parameters and results for the operations of the AWS Clean Rooms ML (2023-09-06), and shows how to use the Aws\CleanRoomsML\CleanRoomsMLClient object to call the described operations. This documentation is specific to the 2023-09-06 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateAudienceModel ( array $params = [] )
- Defines the information necessary to create an audience model.
- CreateConfiguredAudienceModel ( array $params = [] )
- Defines the information necessary to create a configured audience model.
- CreateTrainingDataset ( array $params = [] )
- Defines the information necessary to create a training dataset.
- DeleteAudienceGenerationJob ( array $params = [] )
- Deletes the specified audience generation job, and removes all data associated with the job.
- DeleteAudienceModel ( array $params = [] )
- Specifies an audience model that you want to delete.
- DeleteConfiguredAudienceModel ( array $params = [] )
- Deletes the specified configured audience model.
- DeleteConfiguredAudienceModelPolicy ( array $params = [] )
- Deletes the specified configured audience model policy.
- DeleteTrainingDataset ( array $params = [] )
- Specifies a training dataset that you want to delete.
- GetAudienceGenerationJob ( array $params = [] )
- Returns information about an audience generation job.
- GetAudienceModel ( array $params = [] )
- Returns information about an audience model
- GetConfiguredAudienceModel ( array $params = [] )
- Returns information about a specified configured audience model.
- GetConfiguredAudienceModelPolicy ( array $params = [] )
- Returns information about a configured audience model policy.
- GetTrainingDataset ( array $params = [] )
- Returns information about a training dataset.
- ListAudienceExportJobs ( array $params = [] )
- Returns a list of the audience export jobs.
- ListAudienceGenerationJobs ( array $params = [] )
- Returns a list of audience generation jobs.
- ListAudienceModels ( array $params = [] )
- Returns a list of audience models.
- ListConfiguredAudienceModels ( array $params = [] )
- Returns a list of the configured audience models.
- ListTagsForResource ( array $params = [] )
- Returns a list of tags for a provided resource.
- ListTrainingDatasets ( array $params = [] )
- Returns a list of training datasets.
- PutConfiguredAudienceModelPolicy ( array $params = [] )
- Create or update the resource policy for a configured audience model.
- StartAudienceExportJob ( array $params = [] )
- Export an audience of a specified size after you have generated an audience.
- StartAudienceGenerationJob ( array $params = [] )
- Information necessary to start the audience generation job.
- TagResource ( array $params = [] )
- Adds metadata tags to a specified resource.
- UntagResource ( array $params = [] )
- Removes metadata tags from a specified resource.
- UpdateConfiguredAudienceModel ( array $params = [] )
- Provides the information necessary to update a configured audience model.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListAudienceExportJobs
- ListAudienceGenerationJobs
- ListAudienceModels
- ListConfiguredAudienceModels
- ListTrainingDatasets
Operations
CreateAudienceModel
$result = $client->createAudienceModel
([/* ... */]); $promise = $client->createAudienceModelAsync
([/* ... */]);
Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.
Parameter Syntax
$result = $client->createAudienceModel([ 'description' => '<string>', 'kmsKeyArn' => '<string>', 'name' => '<string>', // REQUIRED 'tags' => ['<string>', ...], 'trainingDataEndTime' => <integer || string || DateTime>, 'trainingDataStartTime' => <integer || string || DateTime>, 'trainingDatasetArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- description
-
- Type: string
The description of the audience model.
- kmsKeyArn
-
- Type: string
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.
- name
-
- Required: Yes
- Type: string
The name of the audience model resource.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
- trainingDataEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end date and time of the training window.
- trainingDataStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start date and time of the training window.
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset for this audience model.
Result Syntax
[ 'audienceModelArn' => '<string>', ]
Result Details
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model.
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
- ServiceQuotaExceededException:
You have exceeded your service quota.
CreateConfiguredAudienceModel
$result = $client->createConfiguredAudienceModel
([/* ... */]); $promise = $client->createConfiguredAudienceModelAsync
([/* ... */]);
Defines the information necessary to create a configured audience model.
Parameter Syntax
$result = $client->createConfiguredAudienceModel([ 'audienceModelArn' => '<string>', // REQUIRED 'audienceSizeConfig' => [ 'audienceSizeBins' => [<integer>, ...], // REQUIRED 'audienceSizeType' => 'ABSOLUTE|PERCENTAGE', // REQUIRED ], 'childResourceTagOnCreatePolicy' => 'FROM_PARENT_RESOURCE|NONE', 'description' => '<string>', 'minMatchingSeedSize' => <integer>, 'name' => '<string>', // REQUIRED 'outputConfig' => [ // REQUIRED 'destination' => [ // REQUIRED 's3Destination' => [ // REQUIRED 's3Uri' => '<string>', // REQUIRED ], ], 'roleArn' => '<string>', // REQUIRED ], 'sharedAudienceMetrics' => ['<string>', ...], // REQUIRED 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
- audienceSizeConfig
-
- Type: AudienceSizeConfig structure
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 theABSOLUTE
AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use thePercentage
AudienceSize to configure sizes in the range 1-100 percent. - childResourceTagOnCreatePolicy
-
- Type: string
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 specifyFROM_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.
- description
-
- Type: string
The description of the configured audience model.
- minMatchingSeedSize
-
- Type: int
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.
- name
-
- Required: Yes
- Type: string
The name of the configured audience model.
- outputConfig
-
- Required: Yes
- Type: ConfiguredAudienceModelOutputConfig structure
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. - sharedAudienceMetrics
-
- Required: Yes
- Type: Array of strings
Whether audience metrics are shared.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'configuredAudienceModelArn' => '<string>', ]
Result Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model.
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
- ServiceQuotaExceededException:
You have exceeded your service quota.
CreateTrainingDataset
$result = $client->createTrainingDataset
([/* ... */]); $promise = $client->createTrainingDatasetAsync
([/* ... */]);
Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset
is metadata that points to a Glue table, which is read only during AudienceModel
creation.
Parameter Syntax
$result = $client->createTrainingDataset([ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'roleArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], 'trainingData' => [ // REQUIRED [ 'inputConfig' => [ // REQUIRED 'dataSource' => [ // REQUIRED 'glueDataSource' => [ // REQUIRED 'catalogId' => '<string>', 'databaseName' => '<string>', // REQUIRED 'tableName' => '<string>', // REQUIRED ], ], 'schema' => [ // REQUIRED [ 'columnName' => '<string>', // REQUIRED 'columnTypes' => ['<string>', ...], // REQUIRED ], // ... ], ], 'type' => 'INTERACTIONS', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- description
-
- Type: string
The description of the training dataset.
- name
-
- Required: Yes
- Type: string
The name of the training dataset. This name must be unique in your account and region.
- roleArn
-
- Required: Yes
- Type: string
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. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
- trainingData
-
- Required: Yes
- Type: Array of Dataset structures
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.
Result Syntax
[ 'trainingDatasetArn' => '<string>', ]
Result Details
Members
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset resource.
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
DeleteAudienceGenerationJob
$result = $client->deleteAudienceGenerationJob
([/* ... */]); $promise = $client->deleteAudienceGenerationJobAsync
([/* ... */]);
Deletes the specified audience generation job, and removes all data associated with the job.
Parameter Syntax
$result = $client->deleteAudienceGenerationJob([ 'audienceGenerationJobArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- audienceGenerationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience generation job that you want to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
DeleteAudienceModel
$result = $client->deleteAudienceModel
([/* ... */]); $promise = $client->deleteAudienceModelAsync
([/* ... */]);
Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.
Parameter Syntax
$result = $client->deleteAudienceModel([ 'audienceModelArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model that you want to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
DeleteConfiguredAudienceModel
$result = $client->deleteConfiguredAudienceModel
([/* ... */]); $promise = $client->deleteConfiguredAudienceModelAsync
([/* ... */]);
Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.
Parameter Syntax
$result = $client->deleteConfiguredAudienceModel([ 'configuredAudienceModelArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that you want to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
DeleteConfiguredAudienceModelPolicy
$result = $client->deleteConfiguredAudienceModelPolicy
([/* ... */]); $promise = $client->deleteConfiguredAudienceModelPolicyAsync
([/* ... */]);
Deletes the specified configured audience model policy.
Parameter Syntax
$result = $client->deleteConfiguredAudienceModelPolicy([ 'configuredAudienceModelArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
DeleteTrainingDataset
$result = $client->deleteTrainingDataset
([/* ... */]); $promise = $client->deleteTrainingDatasetAsync
([/* ... */]);
Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset
is metadata that points to a Glue table, which is read only during AudienceModel
creation. This action deletes the metadata.
Parameter Syntax
$result = $client->deleteTrainingDataset([ 'trainingDatasetArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset that you want to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
GetAudienceGenerationJob
$result = $client->getAudienceGenerationJob
([/* ... */]); $promise = $client->getAudienceGenerationJobAsync
([/* ... */]);
Returns information about an audience generation job.
Parameter Syntax
$result = $client->getAudienceGenerationJob([ 'audienceGenerationJobArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- audienceGenerationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
Result Syntax
[ 'audienceGenerationJobArn' => '<string>', 'collaborationId' => '<string>', 'configuredAudienceModelArn' => '<string>', 'createTime' => <DateTime>, 'description' => '<string>', 'includeSeedInOutput' => true || false, 'metrics' => [ 'recallMetric' => <float>, 'relevanceMetrics' => [ [ 'audienceSize' => [ 'type' => 'ABSOLUTE|PERCENTAGE', 'value' => <integer>, ], 'score' => <float>, ], // ... ], ], 'name' => '<string>', 'protectedQueryIdentifier' => '<string>', 'seedAudience' => [ 'dataSource' => [ 's3Uri' => '<string>', ], 'roleArn' => '<string>', 'sqlParameters' => [ 'analysisTemplateArn' => '<string>', 'parameters' => ['<string>', ...], 'queryString' => '<string>', ], ], 'startedBy' => '<string>', 'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED', 'statusDetails' => [ 'message' => '<string>', 'statusCode' => '<string>', ], 'tags' => ['<string>', ...], 'updateTime' => <DateTime>, ]
Result Details
Members
- audienceGenerationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience generation job.
- collaborationId
-
- Type: string
The identifier of the collaboration that this audience generation job is associated with.
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the audience generation job was created.
- description
-
- Type: string
The description of the audience generation job.
- includeSeedInOutput
-
- Type: boolean
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 firstminimumSeedSize
count of users are from the seed. - metrics
-
- Type: AudienceQualityMetrics structure
The relevance scores for different audience sizes and the recall score of the generated audience.
- name
-
- Required: Yes
- Type: string
The name of the audience generation job.
- protectedQueryIdentifier
-
- Type: string
The unique identifier of the protected query for this audience generation job.
- seedAudience
-
- Type: AudienceGenerationJobDataSource structure
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.
- startedBy
-
- Type: string
The AWS account that started this audience generation job.
- status
-
- Required: Yes
- Type: string
The status of the audience generation job.
- statusDetails
-
- Type: StatusDetails structure
Details about the status of the audience generation job.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags that are associated to this audience generation job.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the audience generation job was updated.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
GetAudienceModel
$result = $client->getAudienceModel
([/* ... */]); $promise = $client->getAudienceModelAsync
([/* ... */]);
Returns information about an audience model
Parameter Syntax
$result = $client->getAudienceModel([ 'audienceModelArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model that you are interested in.
Result Syntax
[ 'audienceModelArn' => '<string>', 'createTime' => <DateTime>, 'description' => '<string>', 'kmsKeyArn' => '<string>', 'name' => '<string>', 'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED', 'statusDetails' => [ 'message' => '<string>', 'statusCode' => '<string>', ], 'tags' => ['<string>', ...], 'trainingDataEndTime' => <DateTime>, 'trainingDataStartTime' => <DateTime>, 'trainingDatasetArn' => '<string>', 'updateTime' => <DateTime>, ]
Result Details
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the audience model was created.
- description
-
- Type: string
The description of the audience model.
- kmsKeyArn
-
- Type: string
The KMS key ARN used for the audience model.
- name
-
- Required: Yes
- Type: string
The name of the audience model.
- status
-
- Required: Yes
- Type: string
The status of the audience model.
- statusDetails
-
- Type: StatusDetails structure
Details about the status of the audience model.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags that are assigned to the audience model.
- trainingDataEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end date specified for the training window.
- trainingDataStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start date specified for the training window.
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the audience model was updated.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
GetConfiguredAudienceModel
$result = $client->getConfiguredAudienceModel
([/* ... */]); $promise = $client->getConfiguredAudienceModelAsync
([/* ... */]);
Returns information about a specified configured audience model.
Parameter Syntax
$result = $client->getConfiguredAudienceModel([ 'configuredAudienceModelArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
Result Syntax
[ 'audienceModelArn' => '<string>', 'audienceSizeConfig' => [ 'audienceSizeBins' => [<integer>, ...], 'audienceSizeType' => 'ABSOLUTE|PERCENTAGE', ], 'childResourceTagOnCreatePolicy' => 'FROM_PARENT_RESOURCE|NONE', 'configuredAudienceModelArn' => '<string>', 'createTime' => <DateTime>, 'description' => '<string>', 'minMatchingSeedSize' => <integer>, 'name' => '<string>', 'outputConfig' => [ 'destination' => [ 's3Destination' => [ 's3Uri' => '<string>', ], ], 'roleArn' => '<string>', ], 'sharedAudienceMetrics' => ['<string>', ...], 'status' => 'ACTIVE', 'tags' => ['<string>', ...], 'updateTime' => <DateTime>, ]
Result Details
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model used for this configured audience model.
- audienceSizeConfig
-
- Type: AudienceSizeConfig structure
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 theABSOLUTE
AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use thePercentage
AudienceSize to configure sizes in the range 1-100 percent. - childResourceTagOnCreatePolicy
-
- Type: string
Provides the
childResourceTagOnCreatePolicy
that was used for this configured audience model. - configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the configured audience model was created.
- description
-
- Type: string
The description of the configured audience model.
- minMatchingSeedSize
-
- Type: int
The minimum number of users from the seed audience that must match with users in the training data of the audience model.
- name
-
- Required: Yes
- Type: string
The name of the configured audience model.
- outputConfig
-
- Required: Yes
- Type: ConfiguredAudienceModelOutputConfig structure
The output configuration of the configured audience model
- sharedAudienceMetrics
-
- Required: Yes
- Type: Array of strings
Whether audience metrics are shared.
- status
-
- Required: Yes
- Type: string
The status of the configured audience model.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags that are associated to this configured audience model.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the configured audience model was updated.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
GetConfiguredAudienceModelPolicy
$result = $client->getConfiguredAudienceModelPolicy
([/* ... */]); $promise = $client->getConfiguredAudienceModelPolicyAsync
([/* ... */]);
Returns information about a configured audience model policy.
Parameter Syntax
$result = $client->getConfiguredAudienceModelPolicy([ 'configuredAudienceModelArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
Result Syntax
[ 'configuredAudienceModelArn' => '<string>', 'configuredAudienceModelPolicy' => '<string>', 'policyHash' => '<string>', ]
Result Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model.
- configuredAudienceModelPolicy
-
- Required: Yes
- Type: string
The configured audience model policy. This is a JSON IAM resource policy.
- policyHash
-
- Required: Yes
- Type: string
A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
GetTrainingDataset
$result = $client->getTrainingDataset
([/* ... */]); $promise = $client->getTrainingDatasetAsync
([/* ... */]);
Returns information about a training dataset.
Parameter Syntax
$result = $client->getTrainingDataset([ 'trainingDatasetArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset that you are interested in.
Result Syntax
[ 'createTime' => <DateTime>, 'description' => '<string>', 'name' => '<string>', 'roleArn' => '<string>', 'status' => 'ACTIVE', 'tags' => ['<string>', ...], 'trainingData' => [ [ 'inputConfig' => [ 'dataSource' => [ 'glueDataSource' => [ 'catalogId' => '<string>', 'databaseName' => '<string>', 'tableName' => '<string>', ], ], 'schema' => [ [ 'columnName' => '<string>', 'columnTypes' => ['<string>', ...], ], // ... ], ], 'type' => 'INTERACTIONS', ], // ... ], 'trainingDatasetArn' => '<string>', 'updateTime' => <DateTime>, ]
Result Details
Members
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the training dataset was created.
- description
-
- Type: string
The description of the training dataset.
- name
-
- Required: Yes
- Type: string
The name of the training dataset.
- roleArn
-
- Required: Yes
- Type: string
The IAM role used to read the training data.
- status
-
- Required: Yes
- Type: string
The status of the training dataset.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags that are assigned to this training dataset.
- trainingData
-
- Required: Yes
- Type: Array of Dataset structures
Metadata about the requested training data.
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the training dataset was updated.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
ListAudienceExportJobs
$result = $client->listAudienceExportJobs
([/* ... */]); $promise = $client->listAudienceExportJobsAsync
([/* ... */]);
Returns a list of the audience export jobs.
Parameter Syntax
$result = $client->listAudienceExportJobs([ 'audienceGenerationJobArn' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- audienceGenerationJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[ 'audienceExportJobs' => [ [ 'audienceGenerationJobArn' => '<string>', 'audienceSize' => [ 'type' => 'ABSOLUTE|PERCENTAGE', 'value' => <integer>, ], 'createTime' => <DateTime>, 'description' => '<string>', 'name' => '<string>', 'outputLocation' => '<string>', 'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE', 'statusDetails' => [ 'message' => '<string>', 'statusCode' => '<string>', ], 'updateTime' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- audienceExportJobs
-
- Required: Yes
- Type: Array of AudienceExportJobSummary structures
The audience export jobs that match the request.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
ListAudienceGenerationJobs
$result = $client->listAudienceGenerationJobs
([/* ... */]); $promise = $client->listAudienceGenerationJobsAsync
([/* ... */]);
Returns a list of audience generation jobs.
Parameter Syntax
$result = $client->listAudienceGenerationJobs([ 'collaborationId' => '<string>', 'configuredAudienceModelArn' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- collaborationId
-
- Type: string
The identifier of the collaboration that contains the audience generation jobs that you are interested in.
- configuredAudienceModelArn
-
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[ 'audienceGenerationJobs' => [ [ 'audienceGenerationJobArn' => '<string>', 'collaborationId' => '<string>', 'configuredAudienceModelArn' => '<string>', 'createTime' => <DateTime>, 'description' => '<string>', 'name' => '<string>', 'startedBy' => '<string>', 'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED', 'updateTime' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- audienceGenerationJobs
-
- Required: Yes
- Type: Array of AudienceGenerationJobSummary structures
The audience generation jobs that match the request.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
ListAudienceModels
$result = $client->listAudienceModels
([/* ... */]); $promise = $client->listAudienceModelsAsync
([/* ... */]);
Returns a list of audience models.
Parameter Syntax
$result = $client->listAudienceModels([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[ 'audienceModels' => [ [ 'audienceModelArn' => '<string>', 'createTime' => <DateTime>, 'description' => '<string>', 'name' => '<string>', 'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED', 'trainingDatasetArn' => '<string>', 'updateTime' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- audienceModels
-
- Required: Yes
- Type: Array of AudienceModelSummary structures
The audience models that match the request.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
ListConfiguredAudienceModels
$result = $client->listConfiguredAudienceModels
([/* ... */]); $promise = $client->listConfiguredAudienceModelsAsync
([/* ... */]);
Returns a list of the configured audience models.
Parameter Syntax
$result = $client->listConfiguredAudienceModels([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[ 'configuredAudienceModels' => [ [ 'audienceModelArn' => '<string>', 'configuredAudienceModelArn' => '<string>', 'createTime' => <DateTime>, 'description' => '<string>', 'name' => '<string>', 'outputConfig' => [ 'destination' => [ 's3Destination' => [ 's3Uri' => '<string>', ], ], 'roleArn' => '<string>', ], 'status' => 'ACTIVE', 'updateTime' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- configuredAudienceModels
-
- Required: Yes
- Type: Array of ConfiguredAudienceModelSummary structures
The configured audience models.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Returns a list of tags for a provided resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource that you are interested in.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
The tags that are associated with the resource.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
ListTrainingDatasets
$result = $client->listTrainingDatasets
([/* ... */]); $promise = $client->listTrainingDatasetsAsync
([/* ... */]);
Returns a list of training datasets.
Parameter Syntax
$result = $client->listTrainingDatasets([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[ 'nextToken' => '<string>', 'trainingDatasets' => [ [ 'createTime' => <DateTime>, 'description' => '<string>', 'name' => '<string>', 'status' => 'ACTIVE', 'trainingDatasetArn' => '<string>', 'updateTime' => <DateTime>, ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- trainingDatasets
-
- Required: Yes
- Type: Array of TrainingDatasetSummary structures
The training datasets that match the request.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
PutConfiguredAudienceModelPolicy
$result = $client->putConfiguredAudienceModelPolicy
([/* ... */]); $promise = $client->putConfiguredAudienceModelPolicyAsync
([/* ... */]);
Create or update the resource policy for a configured audience model.
Parameter Syntax
$result = $client->putConfiguredAudienceModelPolicy([ 'configuredAudienceModelArn' => '<string>', // REQUIRED 'configuredAudienceModelPolicy' => '<string>', // REQUIRED 'policyExistenceCondition' => 'POLICY_MUST_EXIST|POLICY_MUST_NOT_EXIST', 'previousPolicyHash' => '<string>', ]);
Parameter Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.
- configuredAudienceModelPolicy
-
- Required: Yes
- Type: string
The IAM resource policy.
- policyExistenceCondition
-
- Type: string
Use this to prevent unexpected concurrent modification of the policy.
- previousPolicyHash
-
- Type: string
A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
Result Syntax
[ 'configuredAudienceModelPolicy' => '<string>', 'policyHash' => '<string>', ]
Result Details
Members
- configuredAudienceModelPolicy
-
- Required: Yes
- Type: string
The IAM resource policy.
- policyHash
-
- Required: Yes
- Type: string
A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
StartAudienceExportJob
$result = $client->startAudienceExportJob
([/* ... */]); $promise = $client->startAudienceExportJobAsync
([/* ... */]);
Export an audience of a specified size after you have generated an audience.
Parameter Syntax
$result = $client->startAudienceExportJob([ 'audienceGenerationJobArn' => '<string>', // REQUIRED 'audienceSize' => [ // REQUIRED 'type' => 'ABSOLUTE|PERCENTAGE', // REQUIRED 'value' => <integer>, // REQUIRED ], 'description' => '<string>', 'name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- audienceGenerationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience generation job that you want to export.
- audienceSize
-
- Required: Yes
- Type: AudienceSize structure
The size of the generated audience. Must match one of the sizes in the configured audience model.
- description
-
- Type: string
The description of the audience export job.
- name
-
- Required: Yes
- Type: string
The name of the audience export job.
Result Syntax
[]
Result Details
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
- ServiceQuotaExceededException:
You have exceeded your service quota.
StartAudienceGenerationJob
$result = $client->startAudienceGenerationJob
([/* ... */]); $promise = $client->startAudienceGenerationJobAsync
([/* ... */]);
Information necessary to start the audience generation job.
Parameter Syntax
$result = $client->startAudienceGenerationJob([ 'collaborationId' => '<string>', 'configuredAudienceModelArn' => '<string>', // REQUIRED 'description' => '<string>', 'includeSeedInOutput' => true || false, 'name' => '<string>', // REQUIRED 'seedAudience' => [ // REQUIRED 'dataSource' => [ 's3Uri' => '<string>', // REQUIRED ], 'roleArn' => '<string>', // REQUIRED 'sqlParameters' => [ 'analysisTemplateArn' => '<string>', 'parameters' => ['<string>', ...], 'queryString' => '<string>', ], ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- collaborationId
-
- Type: string
The identifier of the collaboration that contains the audience generation job.
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
- description
-
- Type: string
The description of the audience generation job.
- includeSeedInOutput
-
- Type: boolean
Whether the seed audience is included in the audience generation output.
- name
-
- Required: Yes
- Type: string
The name of the audience generation job.
- seedAudience
-
- Required: Yes
- Type: AudienceGenerationJobDataSource structure
The seed audience that is used to generate the audience.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'audienceGenerationJobArn' => '<string>', ]
Result Details
Members
- audienceGenerationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience generation job.
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
- ServiceQuotaExceededException:
You have exceeded your service quota.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds metadata tags to a specified resource.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource that you want to assign tags.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes metadata tags from a specified resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The key values of tags that you want to remove.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
UpdateConfiguredAudienceModel
$result = $client->updateConfiguredAudienceModel
([/* ... */]); $promise = $client->updateConfiguredAudienceModelAsync
([/* ... */]);
Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.
Parameter Syntax
$result = $client->updateConfiguredAudienceModel([ 'audienceModelArn' => '<string>', 'audienceSizeConfig' => [ 'audienceSizeBins' => [<integer>, ...], // REQUIRED 'audienceSizeType' => 'ABSOLUTE|PERCENTAGE', // REQUIRED ], 'configuredAudienceModelArn' => '<string>', // REQUIRED 'description' => '<string>', 'minMatchingSeedSize' => <integer>, 'outputConfig' => [ 'destination' => [ // REQUIRED 's3Destination' => [ // REQUIRED 's3Uri' => '<string>', // REQUIRED ], ], 'roleArn' => '<string>', // REQUIRED ], 'sharedAudienceMetrics' => ['<string>', ...], ]);
Parameter Details
Members
- audienceModelArn
-
- Type: string
The Amazon Resource Name (ARN) of the new audience model that you want to use.
- audienceSizeConfig
-
- Type: AudienceSizeConfig structure
The new audience size configuration.
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that you want to update.
- description
-
- Type: string
The new description of the configured audience model.
- minMatchingSeedSize
-
- Type: int
The minimum number of users from the seed audience that must match with users in the training data of the audience model.
- outputConfig
-
- Type: ConfiguredAudienceModelOutputConfig structure
The new output configuration.
- sharedAudienceMetrics
-
- Type: Array of strings
The new value for whether to share audience metrics.
Result Syntax
[ 'configuredAudienceModelArn' => '<string>', ]
Result Details
Members
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that was updated.
Errors
- ConflictException:
You can't complete this action because another resource depends on this resource.
- ValidationException:
The request parameters for this request are incorrect.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The resource you are requesting does not exist.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Required: Yes
- Type: string
AudienceDestination
Description
Defines the Amazon S3 bucket where the configured audience is stored.
Members
- s3Destination
-
- Required: Yes
- Type: S3ConfigMap structure
The Amazon S3 bucket and path for the configured audience.
AudienceExportJobSummary
Description
Provides information about the audience export job.
Members
- audienceGenerationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience generation job that was exported.
- audienceSize
-
- Required: Yes
- Type: AudienceSize structure
The size of the generated audience. Must match one of the sizes in the configured audience model.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the audience export job was created.
- description
-
- Type: string
The description of the audience export job.
- name
-
- Required: Yes
- Type: string
The name of the audience export job.
- outputLocation
-
- Type: string
The Amazon S3 bucket where the audience export is stored.
- status
-
- Required: Yes
- Type: string
The status of the audience export job.
- statusDetails
-
- Type: StatusDetails structure
Details about the status of a resource.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the audience export job was updated.
AudienceGenerationJobDataSource
Description
Defines the Amazon S3 bucket where the seed audience for the generating audience is stored.
Members
- dataSource
-
- Type: S3ConfigMap structure
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"}
...
- roleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that can read the Amazon S3 bucket where the seed audience is stored.
- sqlParameters
-
- Type: ProtectedQuerySQLParameters structure
The protected SQL query parameters.
AudienceGenerationJobSummary
Description
Provides information about the configured audience generation job.
Members
- audienceGenerationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience generation job.
- collaborationId
-
- Type: string
The identifier of the collaboration that contains this audience generation job.
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that was used for this audience generation job.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the audience generation job was created.
- description
-
- Type: string
The description of the audience generation job.
- name
-
- Required: Yes
- Type: string
The name of the audience generation job.
- startedBy
-
- Type: string
The AWS Account that submitted the job.
- status
-
- Required: Yes
- Type: string
The status of the audience generation job.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the audience generation job was updated.
AudienceModelSummary
Description
Information about the audience model.
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the audience model was created.
- description
-
- Type: string
The description of the audience model.
- name
-
- Required: Yes
- Type: string
The name of the audience model.
- status
-
- Required: Yes
- Type: string
The status of the audience model.
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the audience model was updated.
AudienceQualityMetrics
Description
Metrics that describe the quality of the generated audience.
Members
- recallMetric
-
- Type: double
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.
- relevanceMetrics
-
- Required: Yes
- Type: Array of RelevanceMetric structures
The relevance scores of the generated audience.
AudienceSize
Description
The size of the generated audience. Must match one of the sizes in the configured audience model.
Members
- type
-
- Required: Yes
- Type: string
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 thePercentage
AudienceSize to configure sizes in the range 1-100 percent. - value
-
- Required: Yes
- Type: int
Specify an audience size value.
AudienceSizeConfig
Description
Returns the relevance scores at these audience sizes when used in the GetAudienceGenerationJob for a specified audience generation job and configured audience model.
Specifies the list of allowed audienceSize
values when used in the StartAudienceExportJob for an audience generation job. 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.
Members
- audienceSizeBins
-
- Required: Yes
- Type: Array of ints
An array of the different audience output sizes.
- audienceSizeType
-
- Required: Yes
- Type: string
Whether the audience output sizes are defined as an absolute number or a percentage.
ColumnSchema
Description
Metadata for a column.
Members
- columnName
-
- Required: Yes
- Type: string
The name of a column.
- columnTypes
-
- Required: Yes
- Type: Array of strings
The data type of column.
ConfiguredAudienceModelOutputConfig
Description
Configuration information necessary for the configure audience model output.
Members
- destination
-
- Required: Yes
- Type: AudienceDestination structure
Defines the Amazon S3 bucket where the configured audience is stored.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that can write the Amazon S3 bucket.
ConfiguredAudienceModelSummary
Description
Information about the configured audience model.
Members
- audienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.
- configuredAudienceModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the configured audience model was created.
- description
-
- Type: string
The description of the configured audience model.
- name
-
- Required: Yes
- Type: string
The name of the configured audience model.
- outputConfig
-
- Required: Yes
- Type: ConfiguredAudienceModelOutputConfig structure
The output configuration of the configured audience model.
- status
-
- Required: Yes
- Type: string
The status of the configured audience model.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the configured audience model was updated.
ConflictException
Description
You can't complete this action because another resource depends on this resource.
Members
- message
-
- Required: Yes
- Type: string
DataSource
Description
Defines information about the Glue data source that contains the training data.
Members
- glueDataSource
-
- Required: Yes
- Type: GlueDataSource structure
A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.
Dataset
Description
Defines where the training dataset is located, what type of data it contains, and how to access the data.
Members
- inputConfig
-
- Required: Yes
- Type: DatasetInputConfig structure
A DatasetInputConfig object that defines the data source and schema mapping.
- type
-
- Required: Yes
- Type: string
What type of information is found in the dataset.
DatasetInputConfig
Description
Defines the Glue data source and schema mapping information.
Members
- dataSource
-
- Required: Yes
- Type: DataSource structure
A DataSource object that specifies the Glue data source for the training data.
- schema
-
- Required: Yes
- Type: Array of ColumnSchema structures
The schema information for the training data.
GlueDataSource
Description
Defines the Glue data source that contains the training data.
Members
- catalogId
-
- Type: string
The Glue catalog that contains the training data.
- databaseName
-
- Required: Yes
- Type: string
The Glue database that contains the training data.
- tableName
-
- Required: Yes
- Type: string
The Glue table that contains the training data.
ProtectedQuerySQLParameters
Description
The parameters for the SQL type Protected Query.
Members
- analysisTemplateArn
-
- Type: string
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
- parameters
-
- Type: Associative array of custom strings keys (ParameterKey) to strings
The protected query SQL parameters.
- queryString
-
- Type: string
The query string to be submitted.
RelevanceMetric
Description
The relevance score of a generated audience.
Members
- audienceSize
-
- Required: Yes
- Type: AudienceSize structure
The size of the generated audience. Must match one of the sizes in the configured audience model.
- score
-
- Type: double
The relevance score of the generated audience.
ResourceNotFoundException
Description
The resource you are requesting does not exist.
Members
- message
-
- Required: Yes
- Type: string
S3ConfigMap
Description
Provides information about an Amazon S3 bucket and path.
Members
- s3Uri
-
- Required: Yes
- Type: string
The Amazon S3 location URI.
ServiceQuotaExceededException
Description
You have exceeded your service quota.
Members
- message
-
- Required: Yes
- Type: string
StatusDetails
Description
Details about the status of a resource.
Members
- message
-
- Type: string
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. - statusCode
-
- Type: string
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.
TrainingDatasetSummary
Description
Provides information about the training dataset.
Members
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the training dataset was created.
- description
-
- Type: string
The description of the training dataset.
- name
-
- Required: Yes
- Type: string
The name of the training dataset.
- status
-
- Required: Yes
- Type: string
The status of the training dataset.
- trainingDatasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training dataset.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time at which the training dataset was updated.
ValidationException
Description
The request parameters for this request are incorrect.
Members
- message
-
- Required: Yes
- Type: string