Class: AWS.CleanRoomsML

var params = {
  audienceModelArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  outputConfig: { /* required */
    destination: { /* required */
      s3Destination: { /* required */
        s3Uri: 'STRING_VALUE' /* required */
      }
    },
    roleArn: 'STRING_VALUE' /* required */
  },
  sharedAudienceMetrics: [ /* required */
    ALL | NONE,
    /* more items */
  ],
  audienceSizeConfig: {
    audienceSizeBins: [ /* required */
      'NUMBER_VALUE',
      /* more items */
    ],
    audienceSizeType: ABSOLUTE | PERCENTAGE /* required */
  },
  childResourceTagOnCreatePolicy: FROM_PARENT_RESOURCE | NONE,
  description: 'STRING_VALUE',
  minMatchingSeedSize: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanroomsml.createConfiguredAudienceModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceModelArn — (String)

    The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

  • audienceSizeConfig — (map)

    Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

    • audienceSizeBins — required — (Array<Integer>)

      An array of the different audience output sizes.

    • audienceSizeType — required — (String)

      Whether the audience output sizes are defined as an absolute number or a percentage.

      Possible values include:
      • "ABSOLUTE"
      • "PERCENTAGE"
  • childResourceTagOnCreatePolicy — (String)

    Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

    When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.

    Possible values include:
    • "FROM_PARENT_RESOURCE"
    • "NONE"
  • description — (String)

    The description of the configured audience model.

  • minMatchingSeedSize — (Integer)

    The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.

  • name — (String)

    The name of the configured audience model.

  • outputConfig — (map)

    Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.

    • destination — required — (map)

      Defines the Amazon S3 bucket where the configured audience is stored.

      • s3Destination — required — (map)

        The Amazon S3 bucket and path for the configured audience.

        • s3Uri — required — (String)

          The Amazon S3 location URI.

    • roleArn — required — (String)

      The ARN of the IAM role that can write the Amazon S3 bucket.

  • sharedAudienceMetrics — (Array<String>)

    Whether audience metrics are shared.

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredAudienceModelArn — (String)

      The Amazon Resource Name (ARN) of the configured audience model.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  trainingData: [ /* required */
    {
      inputConfig: { /* required */
        dataSource: { /* required */
          glueDataSource: { /* required */
            databaseName: 'STRING_VALUE', /* required */
            tableName: 'STRING_VALUE', /* required */
            catalogId: 'STRING_VALUE'
          }
        },
        schema: [ /* required */
          {
            columnName: 'STRING_VALUE', /* required */
            columnTypes: [ /* required */
              USER_ID | ITEM_ID | TIMESTAMP | CATEGORICAL_FEATURE | NUMERICAL_FEATURE,
              /* more items */
            ]
          },
          /* more items */
        ]
      },
      type: INTERACTIONS /* required */
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanroomsml.createTrainingDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    The description of the training dataset.

  • name — (String)

    The name of the training dataset. This name must be unique in your account and region.

  • roleArn — (String)

    The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.

  • tags — (map<String>)

    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.

  • trainingData — (Array<map>)

    An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.

    • inputConfig — required — (map)

      A DatasetInputConfig object that defines the data source and schema mapping.

      • dataSource — required — (map)

        A DataSource object that specifies the Glue data source for the training data.

        • glueDataSource — required — (map)

          A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.

          • catalogId — (String)

            The Glue catalog that contains the training data.

          • databaseName — required — (String)

            The Glue database that contains the training data.

          • tableName — required — (String)

            The Glue table that contains the training data.

      • schema — required — (Array<map>)

        The schema information for the training data.

        • columnName — required — (String)

          The name of a column.

        • columnTypes — required — (Array<String>)

          The data type of column.

    • type — required — (String)

      What type of information is found in the dataset.

      Possible values include:
      • "INTERACTIONS"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • trainingDatasetArn — (String)

      The Amazon Resource Name (ARN) of the training dataset resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  audienceGenerationJobArn: 'STRING_VALUE' /* required */
};
cleanroomsml.deleteAudienceGenerationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceGenerationJobArn — (String)

    The Amazon Resource Name (ARN) of the audience generation job that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  audienceModelArn: 'STRING_VALUE' /* required */
};
cleanroomsml.deleteAudienceModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceModelArn — (String)

    The Amazon Resource Name (ARN) of the audience model that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredAudienceModelArn: 'STRING_VALUE' /* required */
};
cleanroomsml.deleteConfiguredAudienceModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredAudienceModelArn — (String)

    The Amazon Resource Name (ARN) of the configured audience model that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredAudienceModelArn: 'STRING_VALUE' /* required */
};
cleanroomsml.deleteConfiguredAudienceModelPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredAudienceModelArn — (String)

    The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  trainingDatasetArn: 'STRING_VALUE' /* required */
};
cleanroomsml.deleteTrainingDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • trainingDatasetArn — (String)

    The Amazon Resource Name (ARN) of the training dataset that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  audienceGenerationJobArn: 'STRING_VALUE' /* required */
};
cleanroomsml.getAudienceGenerationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceGenerationJobArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • audienceGenerationJobArn — (String)

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

    • collaborationId — (String)

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

    • configuredAudienceModelArn — (String)

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

    • createTime — (Date)

      The time at which the audience generation job was created.

    • description — (String)

      The description of the audience generation job.

    • includeSeedInOutput — (Boolean)

      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.

    • metrics — (map)

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

      • recallMetric — (Float)

        The recall score of the generated audience. Recall is the percentage of the most similar users (by default, the most similar 20%) from a sample of the training data that are included in the seed audience by the audience generation job. Values range from 0-1, larger values indicate a better audience. A recall value approximately equal to the maximum bin size indicates that the audience model is equivalent to random selection.

      • relevanceMetrics — required — (Array<map>)

        The relevance scores of the generated audience.

        • audienceSize — required — (map)

          The size of the generated audience. Must match one of the sizes in the configured audience model.

          • type — required — (String)

            Whether the audience size is defined in absolute terms or as a percentage. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

            Possible values include:
            • "ABSOLUTE"
            • "PERCENTAGE"
          • value — required — (Integer)

            Specify an audience size value.

        • score — (Float)

          The relevance score of the generated audience.

    • name — (String)

      The name of the audience generation job.

    • seedAudience — (map)

      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.

      • dataSource — required — (map)

        Defines the Amazon S3 bucket where the seed audience for the generating audience is stored. A valid data source is a JSON line file in the following format:

        {"user_id": "111111"}

        {"user_id": "222222"}

        ...

        • s3Uri — required — (String)

          The Amazon S3 location URI.

      • roleArn — required — (String)

        The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.

    • startedBy — (String)

      The AWS account that started this audience generation job.

    • status — (String)

      The status of the audience generation job.

      Possible values include:
      • "CREATE_PENDING"
      • "CREATE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "ACTIVE"
      • "DELETE_PENDING"
      • "DELETE_IN_PROGRESS"
      • "DELETE_FAILED"
    • statusDetails — (map)

      Details about the status of the audience generation job.

      • message — (String)

        The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.

      • statusCode — (String)

        The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.

    • tags — (map<String>)

      The tags that are associated to this audience generation job.

    • updateTime — (Date)

      The most recent time at which the audience generation job was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  audienceModelArn: 'STRING_VALUE' /* required */
};
cleanroomsml.getAudienceModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceModelArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • audienceModelArn — (String)

      The Amazon Resource Name (ARN) of the audience model.

    • createTime — (Date)

      The time at which the audience model was created.

    • description — (String)

      The description of the audience model.

    • kmsKeyArn — (String)

      The KMS key ARN used for the audience model.

    • name — (String)

      The name of the audience model.

    • status — (String)

      The status of the audience model.

      Possible values include:
      • "CREATE_PENDING"
      • "CREATE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "ACTIVE"
      • "DELETE_PENDING"
      • "DELETE_IN_PROGRESS"
      • "DELETE_FAILED"
    • statusDetails — (map)

      Details about the status of the audience model.

      • message — (String)

        The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.

      • statusCode — (String)

        The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.

    • tags — (map<String>)

      The tags that are assigned to the audience model.

    • trainingDataEndTime — (Date)

      The end date specified for the training window.

    • trainingDataStartTime — (Date)

      The start date specified for the training window.

    • trainingDatasetArn — (String)

      The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.

    • updateTime — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredAudienceModelArn: 'STRING_VALUE' /* required */
};
cleanroomsml.getConfiguredAudienceModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredAudienceModelArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • audienceModelArn — (String)

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

    • audienceSizeConfig — (map)

      The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

      • audienceSizeBins — required — (Array<Integer>)

        An array of the different audience output sizes.

      • audienceSizeType — required — (String)

        Whether the audience output sizes are defined as an absolute number or a percentage.

        Possible values include:
        • "ABSOLUTE"
        • "PERCENTAGE"
    • childResourceTagOnCreatePolicy — (String)

      Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

      Possible values include:
      • "FROM_PARENT_RESOURCE"
      • "NONE"
    • configuredAudienceModelArn — (String)

      The Amazon Resource Name (ARN) of the configured audience model.

    • createTime — (Date)

      The time at which the configured audience model was created.

    • description — (String)

      The description of the configured audience model.

    • minMatchingSeedSize — (Integer)

      The minimum number of users from the seed audience that must match with users in the training data of the audience model.

    • name — (String)

      The name of the configured audience model.

    • outputConfig — (map)

      The output configuration of the configured audience model

      • destination — required — (map)

        Defines the Amazon S3 bucket where the configured audience is stored.

        • s3Destination — required — (map)

          The Amazon S3 bucket and path for the configured audience.

          • s3Uri — required — (String)

            The Amazon S3 location URI.

      • roleArn — required — (String)

        The ARN of the IAM role that can write the Amazon S3 bucket.

    • sharedAudienceMetrics — (Array<String>)

      Whether audience metrics are shared.

    • status — (String)

      The status of the configured audience model.

      Possible values include:
      • "ACTIVE"
    • tags — (map<String>)

      The tags that are associated to this configured audience model.

    • updateTime — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredAudienceModelArn: 'STRING_VALUE' /* required */
};
cleanroomsml.getConfiguredAudienceModelPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredAudienceModelArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredAudienceModelArn — (String)

      The Amazon Resource Name (ARN) of the configured audience model.

    • configuredAudienceModelPolicy — (String)

      The configured audience model policy. This is a JSON IAM resource policy.

    • policyHash — (String)

      A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  trainingDatasetArn: 'STRING_VALUE' /* required */
};
cleanroomsml.getTrainingDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • trainingDatasetArn — (String)

    The Amazon Resource Name (ARN) of the training dataset that you are interested in.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createTime — (Date)

      The time at which the training dataset was created.

    • description — (String)

      The description of the training dataset.

    • name — (String)

      The name of the training dataset.

    • roleArn — (String)

      The IAM role used to read the training data.

    • status — (String)

      The status of the training dataset.

      Possible values include:
      • "ACTIVE"
    • tags — (map<String>)

      The tags that are assigned to this training dataset.

    • trainingData — (Array<map>)

      Metadata about the requested training data.

      • inputConfig — required — (map)

        A DatasetInputConfig object that defines the data source and schema mapping.

        • dataSource — required — (map)

          A DataSource object that specifies the Glue data source for the training data.

          • glueDataSource — required — (map)

            A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.

            • catalogId — (String)

              The Glue catalog that contains the training data.

            • databaseName — required — (String)

              The Glue database that contains the training data.

            • tableName — required — (String)

              The Glue table that contains the training data.

        • schema — required — (Array<map>)

          The schema information for the training data.

          • columnName — required — (String)

            The name of a column.

          • columnTypes — required — (Array<String>)

            The data type of column.

      • type — required — (String)

        What type of information is found in the dataset.

        Possible values include:
        • "INTERACTIONS"
    • trainingDatasetArn — (String)

      The Amazon Resource Name (ARN) of the training dataset.

    • updateTime — (Date)

      The most recent time at which the training dataset was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  audienceGenerationJobArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanroomsml.listAudienceExportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceGenerationJobArn — (String)

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • audienceExportJobs — (Array<map>)

      The audience export jobs that match the request.

      • audienceGenerationJobArn — required — (String)

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

      • audienceSize — required — (map)

        The size of the generated audience. Must match one of the sizes in the configured audience model.

        • type — required — (String)

          Whether the audience size is defined in absolute terms or as a percentage. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

          Possible values include:
          • "ABSOLUTE"
          • "PERCENTAGE"
        • value — required — (Integer)

          Specify an audience size value.

      • createTime — required — (Date)

        The time at which the audience export job was created.

      • description — (String)

        The description of the audience export job.

      • name — required — (String)

        The name of the audience export job.

      • outputLocation — (String)

        The Amazon S3 bucket where the audience export is stored.

      • status — required — (String)

        The status of the audience export job.

        Possible values include:
        • "CREATE_PENDING"
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
      • statusDetails — (map)

        Details about the status of a resource.

        • message — (String)

          The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.

        • statusCode — (String)

          The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.

      • updateTime — required — (Date)

        The most recent time at which the audience export job was updated.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationId: 'STRING_VALUE',
  configuredAudienceModelArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanroomsml.listAudienceGenerationJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationId — (String)

    The identifier of the collaboration that contains the audience generation jobs that you are interested in.

  • configuredAudienceModelArn — (String)

    The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • audienceGenerationJobs — (Array<map>)

      The audience generation jobs that match the request.

      • audienceGenerationJobArn — required — (String)

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

      • collaborationId — (String)

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

      • configuredAudienceModelArn — required — (String)

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

      • createTime — required — (Date)

        The time at which the audience generation job was created.

      • description — (String)

        The description of the audience generation job.

      • name — required — (String)

        The name of the audience generation job.

      • startedBy — (String)

        The AWS Account that submitted the job.

      • status — required — (String)

        The status of the audience generation job.

        Possible values include:
        • "CREATE_PENDING"
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_PENDING"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
      • updateTime — required — (Date)

        The most recent time at which the audience generation job was updated.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanroomsml.listAudienceModels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • audienceModels — (Array<map>)

      The audience models that match the request.

      • audienceModelArn — required — (String)

        The Amazon Resource Name (ARN) of the audience model.

      • createTime — required — (Date)

        The time at which the audience model was created.

      • description — (String)

        The description of the audience model.

      • name — required — (String)

        The name of the audience model.

      • status — required — (String)

        The status of the audience model.

        Possible values include:
        • "CREATE_PENDING"
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_PENDING"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
      • trainingDatasetArn — required — (String)

        The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.

      • updateTime — required — (Date)

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

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanroomsml.listConfiguredAudienceModels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredAudienceModels — (Array<map>)

      The configured audience models.

      • audienceModelArn — required — (String)

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

      • configuredAudienceModelArn — required — (String)

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

      • createTime — required — (Date)

        The time at which the configured audience model was created.

      • description — (String)

        The description of the configured audience model.

      • name — required — (String)

        The name of the configured audience model.

      • outputConfig — required — (map)

        The output configuration of the configured audience model.

        • destination — required — (map)

          Defines the Amazon S3 bucket where the configured audience is stored.

          • s3Destination — required — (map)

            The Amazon S3 bucket and path for the configured audience.

            • s3Uri — required — (String)

              The Amazon S3 location URI.

        • roleArn — required — (String)

          The ARN of the IAM role that can write the Amazon S3 bucket.

      • status — required — (String)

        The status of the configured audience model.

        Possible values include:
        • "ACTIVE"
      • updateTime — required — (Date)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
cleanroomsml.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource that you are interested in.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The tags that are associated with the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanroomsml.listTrainingDatasets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

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

    • trainingDatasets — (Array<map>)

      The training datasets that match the request.

      • createTime — required — (Date)

        The time at which the training dataset was created.

      • description — (String)

        The description of the training dataset.

      • name — required — (String)

        The name of the training dataset.

      • status — required — (String)

        The status of the training dataset.

        Possible values include:
        • "ACTIVE"
      • trainingDatasetArn — required — (String)

        The Amazon Resource Name (ARN) of the training dataset.

      • updateTime — required — (Date)

        The most recent time at which the training dataset was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredAudienceModelArn: 'STRING_VALUE', /* required */
  configuredAudienceModelPolicy: 'STRING_VALUE', /* required */
  policyExistenceCondition: POLICY_MUST_EXIST | POLICY_MUST_NOT_EXIST,
  previousPolicyHash: 'STRING_VALUE'
};
cleanroomsml.putConfiguredAudienceModelPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredAudienceModelArn — (String)

    The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.

  • configuredAudienceModelPolicy — (String)

    The IAM resource policy.

  • policyExistenceCondition — (String)

    Use this to prevent unexpected concurrent modification of the policy.

    Possible values include:
    • "POLICY_MUST_EXIST"
    • "POLICY_MUST_NOT_EXIST"
  • previousPolicyHash — (String)

    A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredAudienceModelPolicy — (String)

      The IAM resource policy.

    • policyHash — (String)

      A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  audienceGenerationJobArn: 'STRING_VALUE', /* required */
  audienceSize: { /* required */
    type: ABSOLUTE | PERCENTAGE, /* required */
    value: 'NUMBER_VALUE' /* required */
  },
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
cleanroomsml.startAudienceExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceGenerationJobArn — (String)

    The Amazon Resource Name (ARN) of the audience generation job that you want to export.

  • audienceSize — (map)

    The size of the generated audience. Must match one of the sizes in the configured audience model.

    • type — required — (String)

      Whether the audience size is defined in absolute terms or as a percentage. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

      Possible values include:
      • "ABSOLUTE"
      • "PERCENTAGE"
    • value — required — (Integer)

      Specify an audience size value.

  • description — (String)

    The description of the audience export job.

  • name — (String)

    The name of the audience export job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredAudienceModelArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  seedAudience: { /* required */
    dataSource: { /* required */
      s3Uri: 'STRING_VALUE' /* required */
    },
    roleArn: 'STRING_VALUE' /* required */
  },
  collaborationId: 'STRING_VALUE',
  description: 'STRING_VALUE',
  includeSeedInOutput: true || false,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanroomsml.startAudienceGenerationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationId — (String)

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

  • configuredAudienceModelArn — (String)

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

  • description — (String)

    The description of the audience generation job.

  • includeSeedInOutput — (Boolean)

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

  • name — (String)

    The name of the audience generation job.

  • seedAudience — (map)

    The seed audience that is used to generate the audience.

    • dataSource — required — (map)

      Defines the Amazon S3 bucket where the seed audience for the generating audience is stored. A valid data source is a JSON line file in the following format:

      {"user_id": "111111"}

      {"user_id": "222222"}

      ...

      • s3Uri — required — (String)

        The Amazon S3 location URI.

    • roleArn — required — (String)

      The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • audienceGenerationJobArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanroomsml.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource that you want to assign tags.

  • tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cleanroomsml.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

  • tagKeys — (Array<String>)

    The key values of tags that you want to remove.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredAudienceModelArn: 'STRING_VALUE', /* required */
  audienceModelArn: 'STRING_VALUE',
  audienceSizeConfig: {
    audienceSizeBins: [ /* required */
      'NUMBER_VALUE',
      /* more items */
    ],
    audienceSizeType: ABSOLUTE | PERCENTAGE /* required */
  },
  description: 'STRING_VALUE',
  minMatchingSeedSize: 'NUMBER_VALUE',
  outputConfig: {
    destination: { /* required */
      s3Destination: { /* required */
        s3Uri: 'STRING_VALUE' /* required */
      }
    },
    roleArn: 'STRING_VALUE' /* required */
  },
  sharedAudienceMetrics: [
    ALL | NONE,
    /* more items */
  ]
};
cleanroomsml.updateConfiguredAudienceModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • audienceModelArn — (String)

    The Amazon Resource Name (ARN) of the new audience model that you want to use.

  • audienceSizeConfig — (map)

    The new audience size configuration.

    • audienceSizeBins — required — (Array<Integer>)

      An array of the different audience output sizes.

    • audienceSizeType — required — (String)

      Whether the audience output sizes are defined as an absolute number or a percentage.

      Possible values include:
      • "ABSOLUTE"
      • "PERCENTAGE"
  • configuredAudienceModelArn — (String)

    The Amazon Resource Name (ARN) of the configured audience model that you want to update.

  • description — (String)

    The new description of the configured audience model.

  • minMatchingSeedSize — (Integer)

    The minimum number of users from the seed audience that must match with users in the training data of the audience model.

  • outputConfig — (map)

    The new output configuration.

    • destination — required — (map)

      Defines the Amazon S3 bucket where the configured audience is stored.

      • s3Destination — required — (map)

        The Amazon S3 bucket and path for the configured audience.

        • s3Uri — required — (String)

          The Amazon S3 location URI.

    • roleArn — required — (String)

      The ARN of the IAM role that can write the Amazon S3 bucket.

  • sharedAudienceMetrics — (Array<String>)

    The new value for whether to share audience metrics.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredAudienceModelArn — (String)

      The Amazon Resource Name (ARN) of the configured audience model that was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.