Skip to content

Get Audience Generation Job

cleanroomsml_get_audience_generation_job R Documentation

Returns information about an audience generation job

Description

Returns information about an audience generation job.

Usage

cleanroomsml_get_audience_generation_job(audienceGenerationJobArn)

Arguments

audienceGenerationJobArn

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

Value

A list with the following syntax:

list(
  createTime = as.POSIXct(
    "2015-01-01"
  ),
  updateTime = as.POSIXct(
    "2015-01-01"
  ),
  audienceGenerationJobArn = "string",
  name = "string",
  description = "string",
  status = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_PENDING"|"DELETE_IN_PROGRESS"|"DELETE_FAILED",
  statusDetails = list(
    statusCode = "string",
    message = "string"
  ),
  configuredAudienceModelArn = "string",
  seedAudience = list(
    dataSource = list(
      s3Uri = "string"
    ),
    roleArn = "string",
    sqlParameters = list(
      queryString = "string",
      analysisTemplateArn = "string",
      parameters = list(
        "string"
      )
    ),
    sqlComputeConfiguration = list(
      worker = list(
        type = "CR.1X"|"CR.4X",
        number = 123
      )
    )
  ),
  includeSeedInOutput = TRUE|FALSE,
  collaborationId = "string",
  metrics = list(
    relevanceMetrics = list(
      list(
        audienceSize = list(
          type = "ABSOLUTE"|"PERCENTAGE",
          value = 123
        ),
        score = 123.0
      )
    ),
    recallMetric = 123.0
  ),
  startedBy = "string",
  tags = list(
    "string"
  ),
  protectedQueryIdentifier = "string"
)

Request syntax

svc$get_audience_generation_job(
  audienceGenerationJobArn = "string"
)