Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cleanroomsml ]

update-configured-audience-model

Description

Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

See also: AWS API Documentation

Synopsis

  update-configured-audience-model
--configured-audience-model-arn <value>
[--output-config <value>]
[--audience-model-arn <value>]
[--shared-audience-metrics <value>]
[--min-matching-seed-size <value>]
[--audience-size-config <value>]
[--description <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--configured-audience-model-arn (string)

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

--output-config (structure)

The new output configuration.

destination -> (structure)

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

s3Destination -> (structure)

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.

Shorthand Syntax:

destination={s3Destination={s3Uri=string}},roleArn=string

JSON Syntax:

{
  "destination": {
    "s3Destination": {
      "s3Uri": "string"
    }
  },
  "roleArn": "string"
}

--audience-model-arn (string)

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

--shared-audience-metrics (list)

The new value for whether to share audience metrics.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  ALL
  NONE

--min-matching-seed-size (integer)

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

--audience-size-config (structure)

The new audience size configuration.

audienceSizeType -> (string)

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

audienceSizeBins -> (list)

An array of the different audience output sizes.

(integer)

Shorthand Syntax:

audienceSizeType=string,audienceSizeBins=integer,integer

JSON Syntax:

{
  "audienceSizeType": "ABSOLUTE"|"PERCENTAGE",
  "audienceSizeBins": [integer, ...]
}

--description (string)

The new description of the configured audience model.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

configuredAudienceModelArn -> (string)

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