Table Of Contents

Feedback

User Guide

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

[ aws . iotevents ]

describe-input

Description

Describes an input.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-input
--input-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--input-name (string)

The name of the input.

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

Output

input -> (structure)

Information about the input.

inputConfiguration -> (structure)

Information about the configuration of an 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.

inputDefinition -> (structure)

The definition of the input.

attributes -> (list)

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage . Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the "condition" expressions used by detectors that monitor this input.

(structure)

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage . Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors.

jsonPath -> (string)

An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events system (BatchPutMessage ). Each such message contains a JSON payload, and the attribute (and its paired value) specified here are available for use in the "condition" expressions used by detectors.

Syntax: field-name.field-name...