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(
    nextToken='string',
    maxResults=123
)
Parameters:

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

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      The token value used to access the next page of results.

    • configuredAudienceModels (list) –

      The configured audience models.

      • (dict) –

        Information about the configured audience model.

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

        • name (string) –

          The name of the configured audience model.

        • audienceModelArn (string) –

          The Amazon Resource Name (ARN) of the audience model that was used to create 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.

        • description (string) –

          The description of the configured audience model.

        • configuredAudienceModelArn (string) –

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

        • status (string) –

          The status of the configured audience model.

Exceptions

  • CleanRoomsML.Client.exceptions.ValidationException

  • CleanRoomsML.Client.exceptions.AccessDeniedException