updateConfiguredAudienceModel method

Future<UpdateConfiguredAudienceModelResponse> updateConfiguredAudienceModel({
  1. required String configuredAudienceModelArn,
  2. String? audienceModelArn,
  3. AudienceSizeConfig? audienceSizeConfig,
  4. String? description,
  5. int? minMatchingSeedSize,
  6. ConfiguredAudienceModelOutputConfig? outputConfig,
  7. List<SharedAudienceMetrics>? sharedAudienceMetrics,
})

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.

May throw AccessDeniedException. May throw ConflictException. May throw ResourceNotFoundException. May throw ValidationException.

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

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

Parameter audienceSizeConfig : The new audience size configuration.

Parameter description : The new description of the configured audience model.

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

Parameter outputConfig : The new output configuration.

Parameter sharedAudienceMetrics : The new value for whether to share audience metrics.

Implementation

Future<UpdateConfiguredAudienceModelResponse> updateConfiguredAudienceModel({
  required String configuredAudienceModelArn,
  String? audienceModelArn,
  AudienceSizeConfig? audienceSizeConfig,
  String? description,
  int? minMatchingSeedSize,
  ConfiguredAudienceModelOutputConfig? outputConfig,
  List<SharedAudienceMetrics>? sharedAudienceMetrics,
}) async {
  _s.validateNumRange(
    'minMatchingSeedSize',
    minMatchingSeedSize,
    25,
    500000,
  );
  final $payload = <String, dynamic>{
    if (audienceModelArn != null) 'audienceModelArn': audienceModelArn,
    if (audienceSizeConfig != null) 'audienceSizeConfig': audienceSizeConfig,
    if (description != null) 'description': description,
    if (minMatchingSeedSize != null)
      'minMatchingSeedSize': minMatchingSeedSize,
    if (outputConfig != null) 'outputConfig': outputConfig,
    if (sharedAudienceMetrics != null)
      'sharedAudienceMetrics':
          sharedAudienceMetrics.map((e) => e.value).toList(),
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PATCH',
    requestUri:
        '/configured-audience-model/${Uri.encodeComponent(configuredAudienceModelArn)}',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateConfiguredAudienceModelResponse.fromJson(response);
}