IoTEvents / Client / describe_input

describe_input

IoTEvents.Client.describe_input(**kwargs)

Describes an input.

See also: AWS API Documentation

Request Syntax

response = client.describe_input(
    inputName='string'
)

Parameters:

inputName (string) –

[REQUIRED]

The name of the input.

Return type:

dict

Returns:

Response Syntax

{
    'input': {
        'inputConfiguration': {
            'inputName': 'string',
            'inputDescription': 'string',
            'inputArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'
        },
        'inputDefinition': {
            'attributes': [
                {
                    'jsonPath': 'string'
                },
            ]
        }
    }
}

Response Structure

• (dict) –

  • input (dict) –

    Information about the input.

    • inputConfiguration (dict) –

      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 (datetime) –

        The time the input was created.

      • lastUpdateTime (datetime) –

        The last time the input was updated.

      • status (string) –

        The status of the input.

    • inputDefinition (dict) –

      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.

        • (dict) –

          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. 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 AWS IoT Events ( BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.

            Syntax: <field-name>.<field-name>...

Exceptions

• IoTEvents.Client.exceptions.InvalidRequestException

• IoTEvents.Client.exceptions.ResourceNotFoundException

• IoTEvents.Client.exceptions.ThrottlingException

• IoTEvents.Client.exceptions.InternalFailureException

• IoTEvents.Client.exceptions.ServiceUnavailableException