Skip to content

Start Audience Generation Job

cleanroomsml_start_audience_generation_job R Documentation

Information necessary to start the audience generation job

Description

Information necessary to start the audience generation job.

Usage

cleanroomsml_start_audience_generation_job(name,
  configuredAudienceModelArn, seedAudience, includeSeedInOutput,
  collaborationId, description, tags)

Arguments

name

[required] The name of the audience generation job.

configuredAudienceModelArn

[required] The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.

seedAudience

[required] The seed audience that is used to generate the audience.

includeSeedInOutput

Whether the seed audience is included in the audience generation output.

collaborationId

The identifier of the collaboration that contains the audience generation job.

description

The description of the audience generation job.

tags

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

Value

A list with the following syntax: 

list(
  audienceGenerationJobArn = "string"
)

Request syntax

svc$start_audience_generation_job(
  name = "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",
  description = "string",
  tags = list(
    "string"
  )
)