Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetAudienceGenerationJob

Returns information about an audience generation job.

Request Syntax


GET /audience-generation-job/audienceGenerationJobArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

audienceGenerationJobArn

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-generation-job/[-a-zA-Z0-9_/.]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "audienceGenerationJobArn": "string",
   "collaborationId": "string",
   "configuredAudienceModelArn": "string",
   "createTime": "string",
   "description": "string",
   "includeSeedInOutput": boolean,
   "metrics": { 
      "recallMetric": number,
      "relevanceMetrics": [ 
         { 
            "audienceSize": { 
               "type": "string",
               "value": number
            },
            "score": number
         }
      ]
   },
   "name": "string",
   "protectedQueryIdentifier": "string",
   "seedAudience": { 
      "dataSource": { 
         "s3Uri": "string"
      },
      "roleArn": "string",
      "sqlComputeConfiguration": { ... },
      "sqlParameters": { 
         "analysisTemplateArn": "string",
         "parameters": { 
            "string" : "string" 
         },
         "queryString": "string"
      }
   },
   "startedBy": "string",
   "status": "string",
   "statusDetails": { 
      "message": "string",
      "statusCode": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "updateTime": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

audienceGenerationJobArn

The Amazon Resource Name (ARN) of the audience generation job.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-generation-job/[-a-zA-Z0-9_/.]+

collaborationId

The identifier of the collaboration that this audience generation job is associated with.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

configuredAudienceModelArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+

createTime

The time at which the audience generation job was created.

Type: Timestamp

description

The description of the audience generation job.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

includeSeedInOutput

Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.

Type: Boolean

metrics

The relevance scores for different audience sizes and the recall score of the generated audience.

Type: AudienceQualityMetrics object

name

The name of the audience generation job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

protectedQueryIdentifier

The unique identifier of the protected query for this audience generation job.

Type: String

seedAudience

The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.

Type: AudienceGenerationJobDataSource object

startedBy