cleanroomsml / Client / get_audience_model

get_audience_model

cleanroomsml.Client.get_audience_model(**kwargs)

Returns information about an audience model

See also: AWS API Documentation

Request Syntax

response = client.get_audience_model(
    audienceModelArn='string'
)

Parameters:

audienceModelArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the audience model that you are interested in.

Return type:

dict

Returns:

Response Syntax

{
    'audienceModelArn': 'string',
    'createTime': datetime(2015, 1, 1),
    'description': 'string',
    'kmsKeyArn': 'string',
    'metrics': [
        {
            'forTopKItemPredictions': 123,
            'type': 'NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN'|'MEAN_RECIPROCAL_RANK'|'PRECISION'|'RECALL',
            'value': 123.0
        },
    ],
    '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': 'string'
    },
    'trainingDataEndTime': datetime(2015, 1, 1),
    'trainingDataStartTime': datetime(2015, 1, 1),
    'trainingDatasetArn': 'string',
    'updateTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • audienceModelArn (string) –

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

  • createTime (datetime) –

    The time at which the audience model was created.

  • description (string) –

    The description of the audience model.

  • kmsKeyArn (string) –

    The KMS key ARN used for the audience model.

  • metrics (list) –

    Accuracy metrics for the model.

    • (dict) –

      The audience model metrics.

      • forTopKItemPredictions (integer) –

        The number of users that were used to generate these model metrics.

      • type (string) –

        The audience model metric.

      • value (float) –

        The value of the audience model metric

  • name (string) –

    The name of the audience model.

  • status (string) –

    The status of the audience model.

  • statusDetails (dict) –

    Details about the status of the audience model.

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

  • tags (dict) –

    The tags that are assigned to the audience model.

    • (string) –

      • (string) –

  • trainingDataEndTime (datetime) –

    The end date specified for the training window.

  • trainingDataStartTime (datetime) –

    The start date specified for the training window.

  • trainingDatasetArn (string) –

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

  • updateTime (datetime) –

    The most recent time at which the audience model was updated.

Exceptions

• cleanroomsml.Client.exceptions.ValidationException

• cleanroomsml.Client.exceptions.AccessDeniedException

• cleanroomsml.Client.exceptions.ResourceNotFoundException