AWS CLI Command Reference

[ aws . cleanroomsml ]

get-configured-audience-model

Description

Returns information about a specified configured audience model.

See also: AWS API Documentation

Synopsis

  get-configured-audience-model
--configured-audience-model-arn <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

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

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

audienceModelArn -> (string)

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

audienceSizeConfig -> (structure)

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 -> (list)

An array of the different audience output sizes.

(integer)

audienceSizeType -> (string)

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

childResourceTagOnCreatePolicy -> (string)

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

configuredAudienceModelArn -> (string)

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

createTime -> (timestamp)

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 -> (structure)

The output configuration of the configured audience model

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.

sharedAudienceMetrics -> (list)

Whether audience metrics are shared.

(string)

status -> (string)

The status of the configured audience model.

tags -> (map)

The tags that are associated to this configured audience model.

key -> (string)

value -> (string)

updateTime -> (timestamp)

The most recent time at which the configured audience model was updated.
© Copyright 2018, Amazon Web Services. Created using Sphinx.