Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateConfiguredAudienceModel

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.

Request Syntax


PATCH /configured-audience-model/configuredAudienceModelArn HTTP/1.1
Content-type: application/json

{
   "audienceModelArn": "string",
   "audienceSizeConfig": { 
      "audienceSizeBins": [ number ],
      "audienceSizeType": "string"
   },
   "description": "string",
   "minMatchingSeedSize": number,
   "outputConfig": { 
      "destination": { 
         "s3Destination": { 
            "s3Uri": "string"
         }
      },
      "roleArn": "string"
   },
   "sharedAudienceMetrics": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

configuredAudienceModelArn

The Amazon Resource Name (ARN) of the configured audience model that you want to update.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

audienceModelArn

The Amazon Resource Name (ARN) of the new audience model that you want to use.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-model/[-a-zA-Z0-9_/.]+

Required: No

audienceSizeConfig

The new audience size configuration.

Type: AudienceSizeConfig object

Required: No

description

The new description of the configured audience model.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: No

minMatchingSeedSize

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

Type: Integer

Valid Range: Minimum value of 25. Maximum value of 500000.

Required: No

outputConfig

The new output configuration.

Type: ConfiguredAudienceModelOutputConfig object

Required: No

sharedAudienceMetrics

The new value for whether to share audience metrics.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: ALL | NONE

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "configuredAudienceModelArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configuredAudienceModelArn

The Amazon Resource Name (ARN) of the configured audience model that was updated.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

You can't complete this action because another resource depends on this resource.

HTTP Status Code: 409

ResourceNotFoundException

The resource you are requesting does not exist.

HTTP Status Code: 404

ValidationException

The request parameters for this request are incorrect.

HTTP Status Code: 400