Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

update-input

Description

Updates an input.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-input
--input-name <value>
[--input-description <value>]
--input-definition <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--input-name (string)

The name of the input you want to update.

--input-description (string)

A brief description of the input.

--input-definition (structure)

The definition of the input.

Shorthand Syntax:

attributes=[{jsonPath=string},{jsonPath=string}]

JSON Syntax:

{
  "attributes": [
    {
      "jsonPath": "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.

See 'aws help' for descriptions of global parameters.

Examples

To update an input

The following update-input example updates the specified input with a new description and definition.

aws iotevents update-input \
    --cli-input-json file://pressureInput.json

Contents of pressureInput.json:

{
    "inputName": "PressureInput",
    "inputDescription": "Pressure readings from a motor",
    "inputDefinition": {
        "attributes": [
            { "jsonPath": "sensorData.pressure" },
            { "jsonPath": "motorid" }
        ]
    }
}

Output:

{
    "inputConfiguration": {
        "status": "ACTIVE",
        "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput",
        "lastUpdateTime": 1560795976.458,
        "creationTime": 1560795312.542,
        "inputName": "PressureInput",
        "inputDescription": "Pressure readings from a motor"
    }
}

For more information, see UpdateInput in the AWS IoT Events API Reference.

Output

inputConfiguration -> (structure)

Information about the configuration of the input.

inputName -> (string)

The name of the input.

inputDescription -> (string)

A brief description of the input.

inputArn -> (string)

The ARN of the input.

creationTime -> (timestamp)

The time the input was created.

lastUpdateTime -> (timestamp)

The last time the input was updated.

status -> (string)

The status of the input.