CleanRoomsML / Client / create_audience_model

create_audience_model#

CleanRoomsML.Client.create_audience_model(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_audience_model(
    trainingDataStartTime=datetime(2015, 1, 1),
    trainingDataEndTime=datetime(2015, 1, 1),
    name='string',
    trainingDatasetArn='string',
    kmsKeyArn='string',
    tags={
        'string': 'string'
    },
    description='string'
)
Parameters:

  • trainingDataStartTime (datetime) – The start date and time of the training window.

  • trainingDataEndTime (datetime) – The end date and time of the training window.

  • name (string) –

    [REQUIRED]

    The name of the audience model resource.

  • trainingDatasetArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the training dataset for this audience model.

  • kmsKeyArn (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.

  • tags (dict) –

    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) –

      • (string) –

  • description (string) – The description of the audience model.

Return type:

dict

Returns:

Response Syntax

{
    'audienceModelArn': 'string'
}

Response Structure

  • (dict) –

    • audienceModelArn (string) –

      The Amazon Resource Name (ARN) of the audience model.

Exceptions

  • CleanRoomsML.Client.exceptions.ConflictException

  • CleanRoomsML.Client.exceptions.ValidationException

  • CleanRoomsML.Client.exceptions.AccessDeniedException

  • CleanRoomsML.Client.exceptions.ResourceNotFoundException

  • CleanRoomsML.Client.exceptions.ServiceQuotaExceededException