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

{
    'createTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'trainingDataStartTime': datetime(2015, 1, 1),
    'trainingDataEndTime': datetime(2015, 1, 1),
    'audienceModelArn': 'string',
    'name': 'string',
    'trainingDatasetArn': 'string',
    'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
    'statusDetails': {
        'statusCode': 'string',
        'message': 'string'
    },
    'kmsKeyArn': 'string',
    'tags': {
        'string': 'string'
    },
    'description': 'string'
}

Response Structure

  • (dict) –

    • createTime (datetime) –

      The time at which the audience model was created.

    • updateTime (datetime) –

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

    • trainingDataStartTime (datetime) –

      The start date specified for the training window.

    • trainingDataEndTime (datetime) –

      The end date specified for the training window.

    • audienceModelArn (string) –

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

    • name (string) –

      The name of the audience model.

    • trainingDatasetArn (string) –

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

    • status (string) –

      The status of the audience model.

    • statusDetails (dict) –

      Details about the status of the audience model.

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

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

    • kmsKeyArn (string) –

      The KMS key ARN used for the audience model.

    • tags (dict) –

      The tags that are assigned to the audience model.

      • (string) –

        • (string) –

    • description (string) –

      The description of the audience model.

Exceptions