AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateConfiguredAudienceModel operation. Defines the information necessary to create a configured audience model.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CleanRoomsML.AmazonCleanRoomsMLRequest
      Amazon.CleanRoomsML.Model.CreateConfiguredAudienceModelRequest

Namespace: Amazon.CleanRoomsML.Model
Assembly: AWSSDK.CleanRoomsML.dll
Version: 3.x.y.z

Syntax

C#
public class CreateConfiguredAudienceModelRequest : AmazonCleanRoomsMLRequest
         IAmazonWebServiceRequest

The CreateConfiguredAudienceModelRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AudienceModelArn System.String

Gets and sets the property AudienceModelArn.

The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

Public Property AudienceSizeConfig Amazon.CleanRoomsML.Model.AudienceSizeConfig

Gets and sets the property AudienceSizeConfig.

Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

Public Property ChildResourceTagOnCreatePolicy Amazon.CleanRoomsML.TagOnCreatePolicy

Gets and sets the property 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.

Public Property Description System.String

Gets and sets the property Description.

The description of the configured audience model.

Public Property MinMatchingSeedSize System.Int32

Gets and sets the property MinMatchingSeedSize.

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

Public Property Name System.String

Gets and sets the property Name.

The name of the configured audience model.

Public Property OutputConfig Amazon.CleanRoomsML.Model.ConfiguredAudienceModelOutputConfig

Gets and sets the property OutputConfig.

Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.

Public Property SharedAudienceMetrics System.Collections.Generic.List<System.String>

Gets and sets the property SharedAudienceMetrics.

Whether audience metrics are shared.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5