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 . personalize ]
create-batch-segment-job¶
Description¶
Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments .
See also: AWS API Documentation
Synopsis¶
create-batch-segment-job
--job-name <value>
--solution-version-arn <value>
[--filter-arn <value>]
[--num-results <value>]
--job-input <value>
--job-output <value>
--role-arn <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>]
Options¶
--job-name (string)
The name of the batch segment job to create.
--solution-version-arn (string)
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
--filter-arn (string)
The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations .
--num-results (integer)
The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
--job-input (structure)
The Amazon S3 path for the input data used to generate the batch segment job.
s3DataSource -> (structure)
The configuration details of an Amazon S3 input or output bucket.
path -> (string)
The file path of the Amazon S3 bucket.kmsKeyArn -> (string)
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
Shorthand Syntax:
s3DataSource={path=string,kmsKeyArn=string}
JSON Syntax:
{
"s3DataSource": {
"path": "string",
"kmsKeyArn": "string"
}
}
--job-output (structure)
The Amazon S3 path for the bucket where the job's output will be stored.
s3DataDestination -> (structure)
The configuration details of an Amazon S3 input or output bucket.
path -> (string)
The file path of the Amazon S3 bucket.kmsKeyArn -> (string)
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
Shorthand Syntax:
s3DataDestination={path=string,kmsKeyArn=string}
JSON Syntax:
{
"s3DataDestination": {
"path": "string",
"kmsKeyArn": "string"
}
}
--role-arn (string)
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
--tags (list)
A list of tags to apply to the batch segment job.
(structure)
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize resources .
tagKey -> (string)
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.tagValue -> (string)
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
Shorthand Syntax:
tagKey=string,tagValue=string ...
JSON Syntax:
[
{
"tagKey": "string",
"tagValue": "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.