[ aws . personalize ]

describe-batch-segment-job

Description

Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-batch-segment-job
--batch-segment-job-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--batch-segment-job-arn (string)

The ARN of the batch segment job to describe.

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

See ‘aws help’ for descriptions of global parameters.

Output

batchSegmentJob -> (structure)

Information on the specified batch segment job.

jobName -> (string)

The name of the batch segment job.

batchSegmentJobArn -> (string)

The Amazon Resource Name (ARN) of the batch segment job.

filterArn -> (string)

The ARN of the filter used on the batch segment job.

failureReason -> (string)

If the batch segment job failed, the reason for the failure.

solutionVersionArn -> (string)

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

numResults -> (integer)

The number of predicted users generated by the batch segment job for each line of input data.

jobInput -> (structure)

The Amazon S3 path that leads to 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.

jobOutput -> (structure)

The Amazon S3 bucket that contains the output data generated by the batch segment job.

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.

roleArn -> (string)

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

status -> (string)

The status of the batch segment job. The status is one of the following values:

• PENDING

• IN PROGRESS

• ACTIVE

• CREATE FAILED

creationDateTime -> (timestamp)

The time at which the batch segment job was created.

lastUpdatedDateTime -> (timestamp)

The time at which the batch segment job last updated.