CleanRoomsML / Client / list_configured_audience_models

list_configured_audience_models

CleanRoomsML.Client.list_configured_audience_models(**kwargs)

Returns a list of the configured audience models.

See also: AWS API Documentation

Request Syntax

response = client.list_configured_audience_models(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The maximum size of the results that is returned per call.

• nextToken (string) – The token value retrieved from a previous call to access the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'configuredAudienceModels': [
        {
            'audienceModelArn': 'string',
            'configuredAudienceModelArn': 'string',
            'createTime': datetime(2015, 1, 1),
            'description': 'string',
            'name': 'string',
            'outputConfig': {
                'destination': {
                    's3Destination': {
                        's3Uri': 'string'
                    }
                },
                'roleArn': 'string'
            },
            'status': 'ACTIVE',
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • configuredAudienceModels (list) –

    The configured audience models.

    • (dict) –

      Information about the configured audience model.

      • audienceModelArn (string) –

        The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.

      • configuredAudienceModelArn (string) –

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

      • createTime (datetime) –

        The time at which the configured audience model was created.

      • description (string) –

        The description of the configured audience model.

      • name (string) –

        The name of the 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.

      • status (string) –

        The status of the configured audience model.

      • updateTime (datetime) –

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

  • nextToken (string) –

    The token value retrieved from a previous call to access the next page of results.

Exceptions

• CleanRoomsML.Client.exceptions.ValidationException

• CleanRoomsML.Client.exceptions.AccessDeniedException