CreateInput - Amazon IoT Events
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Creates an input.

Request Syntax

POST /inputs HTTP/1.1 Content-type: application/json { "inputDefinition": { "attributes": [ { "jsonPath": "string" } ] }, "inputDescription": "string", "inputName": "string", "tags": [ { "key": "string", "value": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The definition of the input.

Type: InputDefinition object

Required: Yes


A brief description of the input.

Type: String

Length Constraints: Maximum length of 1024.

Required: No


The name you want to give to the input.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

Required: Yes


Metadata that can be used to manage the input.

Type: Array of Tag objects

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "inputConfiguration": { "creationTime": number, "inputArn": "string", "inputDescription": "string", "inputName": "string", "lastUpdateTime": number, "status": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.


Information about the configuration of the input.

Type: InputConfiguration object


For information about the errors that are common to all actions, see Common Errors.


An internal failure occurred.

HTTP Status Code: 500


The request was invalid.

HTTP Status Code: 400


The resource already exists.

HTTP Status Code: 409


The service is currently unavailable.

HTTP Status Code: 503


The request could not be completed due to throttling.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: