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

start-data-ingestion-job

Description

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

See also: AWS API Documentation

Synopsis

  start-data-ingestion-job
--dataset-name <value>
--ingestion-input-configuration <value>
--role-arn <value>
[--client-token <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

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

KeyPattern -> (string)

The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)

Shorthand Syntax:

S3InputConfiguration={Bucket=string,Prefix=string,KeyPattern=string}

JSON Syntax:

{
  "S3InputConfiguration": {
    "Bucket": "string",
    "Prefix": "string",
    "KeyPattern": "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 (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.

Output

JobId -> (string)

Indicates the job ID of the data ingestion job.

Status -> (string)

Indicates the status of the StartDataIngestionJob operation.