Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . customer-profiles ]

create-recommender-schema¶

Description¶

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

Synopsis¶

  create-recommender-schema
--domain-name <value>
--recommender-schema-name <value>
--fields <value>
[--tags <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>]
[--v2-debug]

Options¶

--domain-name (string)

The unique name of the domain.

--recommender-schema-name (string)

The name of the recommender schema. The name must be unique within the domain.

--fields (map)

A map of dataset type to column definitions that specifies which data columns to include in the schema. Currently only the _webAnalytics key is supported.

key -> (string)

value -> (list)

(structure)

Defines a column in a recommender schema, including the target field name and optional feature and content type settings for training.

TargetFieldName -> (string)

The name of the target field in the dataset, such as Location.City or Attributes.MealTime .

ContentType -> (string)

The data type of the column value. Valid values are String and Number . The default value is String .

FeatureType -> (string)

How the column is treated for model training. Valid values are CATEGORICAL and TEXTUAL .

Shorthand Syntax:

KeyName1=[{TargetFieldName=string,ContentType=string,FeatureType=string},{TargetFieldName=string,ContentType=string,FeatureType=string}],KeyName2=[{TargetFieldName=string,ContentType=string,FeatureType=string},{TargetFieldName=string,ContentType=string,FeatureType=string}]

JSON Syntax:

{"string": [
      {
        "TargetFieldName": "string",
        "ContentType": "STRING"|"NUMBER",
        "FeatureType": "TEXTUAL"|"CATEGORICAL"
      }
      ...
    ]
  ...}

--tags (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output¶

RecommenderSchemaArn -> (string)

The Amazon Resource Name (ARN) of the recommender schema.

RecommenderSchemaName -> (string)

The name of the recommender schema.

Fields -> (map)

A map of dataset type to column definitions included in the schema.

key -> (string)

value -> (list)

(structure)

Defines a column in a recommender schema, including the target field name and optional feature and content type settings for training.

TargetFieldName -> (string)

The name of the target field in the dataset, such as Location.City or Attributes.MealTime .

ContentType -> (string)

The data type of the column value. Valid values are String and Number . The default value is String .

FeatureType -> (string)

How the column is treated for model training. Valid values are CATEGORICAL and TEXTUAL .

CreatedAt -> (timestamp)

The timestamp of when the recommender schema was created.

Status -> (string)

The status of the recommender schema.

Tags -> (map)