CleanRoomsML / Client / get_configured_audience_model

get_configured_audience_model

CleanRoomsML.Client.get_configured_audience_model(**kwargs)

Returns information about a specified configured audience model.

See also: AWS API Documentation

Request Syntax

response = client.get_configured_audience_model(
    configuredAudienceModelArn='string'
)

Parameters:

configuredAudienceModelArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'createTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'configuredAudienceModelArn': 'string',
    'name': 'string',
    'audienceModelArn': 'string',
    'outputConfig': {
        'destination': {
            's3Destination': {
                's3Uri': 'string'
            }
        },
        'roleArn': 'string'
    },
    'description': 'string',
    'status': 'ACTIVE',
    'sharedAudienceMetrics': [
        'ALL'|'NONE',
    ],
    'minMatchingSeedSize': 123,
    'audienceSizeConfig': {
        'audienceSizeType': 'ABSOLUTE'|'PERCENTAGE',
        'audienceSizeBins': [
            123,
        ]
    },
    'tags': {
        'string': 'string'
    },
    'childResourceTagOnCreatePolicy': 'FROM_PARENT_RESOURCE'|'NONE'
}

Response Structure

• (dict) –

  • createTime (datetime) –

    The time at which the configured audience model was created.

  • updateTime (datetime) –

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

  • configuredAudienceModelArn (string) –

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

  • name (string) –

    The name of the configured audience model.

  • audienceModelArn (string) –

    The Amazon Resource Name (ARN) of the audience model used for this configured audience model.

  • outputConfig (dict) –

    The output configuration of the configured audience model

    • destination (dict) –

      Defines the Amazon S3 bucket where the configured audience is stored.

      • s3Destination (dict) –

        The Amazon S3 bucket and path for the configured audience.

        • s3Uri (string) –

          The Amazon S3 location URI.

    • roleArn (string) –

      The ARN of the IAM role that can write the Amazon S3 bucket.

  • description (string) –

    The description of the configured audience model.

  • status (string) –

    The status of the configured audience model.

  • sharedAudienceMetrics (list) –

    Whether audience metrics are shared.

    • (string) –

  • minMatchingSeedSize (integer) –

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

  • audienceSizeConfig (dict) –

    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.

    • audienceSizeType (string) –

      Whether the audience output sizes are defined as an absolute number or a percentage.

    • audienceSizeBins (list) –

      An array of the different audience output sizes.

      • (integer) –

  • tags (dict) –

    The tags that are associated to this configured audience model.

    • (string) –

      • (string) –

  • childResourceTagOnCreatePolicy (string) –

    Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

Exceptions

• CleanRoomsML.Client.exceptions.ValidationException

• CleanRoomsML.Client.exceptions.AccessDeniedException

• CleanRoomsML.Client.exceptions.ResourceNotFoundException