[ aws . lookoutequipment ]

start-data-ingestion-job

Description

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-data-ingestion-job
--dataset-name <value>
--ingestion-input-configuration <value>
--role-arn <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-name (string)

The name of the dataset being used by the data ingestion job.

--ingestion-input-configuration (structure)

Specifies information for the input data for the data ingestion job, including dataset S3 location.

S3InputConfiguration -> (structure)

The location information for the S3 bucket used for input data for the data ingestion.

Bucket -> (string)

The name of the S3 bucket used for the input data for the data ingestion.

Prefix -> (string)

The prefix for the S3 location being used for the input data for the data ingestion.

Shorthand Syntax:

S3InputConfiguration={Bucket=string,Prefix=string}

JSON Syntax:

{
  "S3InputConfiguration": {
    "Bucket": "string",
    "Prefix": "string"
  }
}

--role-arn (string)

The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

--client-token (string)

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

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

JobId -> (string)

Indicates the job ID of the data ingestion job.

Status -> (string)

Indicates the status of the StartDataIngestionJob operation.