SDK for PHP 3.x
AWS IoT Events 2018-07-27
- Client: Aws\IoTEvents\IoTEventsClient
- Service ID: iotevents
- Version: 2018-07-27
This page describes the parameters and results for the operations of the AWS IoT Events (2018-07-27), and shows how to use the Aws\IoTEvents\IoTEventsClient object to call the described operations. This documentation is specific to the 2018-07-27 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateAlarmModel ( array $params = [] )
- Creates an alarm model to monitor an AWS IoT Events input attribute.
- CreateDetectorModel ( array $params = [] )
- Creates a detector model.
- CreateInput ( array $params = [] )
- Creates an input.
- DeleteAlarmModel ( array $params = [] )
- Deletes an alarm model.
- DeleteDetectorModel ( array $params = [] )
- Deletes a detector model.
- DeleteInput ( array $params = [] )
- Deletes an input.
- DescribeAlarmModel ( array $params = [] )
- Retrieves information about an alarm model.
- DescribeDetectorModel ( array $params = [] )
- Describes a detector model.
- DescribeDetectorModelAnalysis ( array $params = [] )
- Retrieves runtime information about a detector model analysis.
- DescribeInput ( array $params = [] )
- Describes an input.
- DescribeLoggingOptions ( array $params = [] )
- Retrieves the current settings of the AWS IoT Events logging options.
- GetDetectorModelAnalysisResults ( array $params = [] )
- Retrieves one or more analysis results of the detector model.
- ListAlarmModelVersions ( array $params = [] )
- Lists all the versions of an alarm model.
- ListAlarmModels ( array $params = [] )
- Lists the alarm models that you created.
- ListDetectorModelVersions ( array $params = [] )
- Lists all the versions of a detector model.
- ListDetectorModels ( array $params = [] )
- Lists the detector models you have created.
- ListInputRoutings ( array $params = [] )
- Lists one or more input routings.
- ListInputs ( array $params = [] )
- Lists the inputs you have created.
- ListTagsForResource ( array $params = [] )
- Lists the tags (metadata) you have assigned to the resource.
- PutLoggingOptions ( array $params = [] )
- Sets or updates the AWS IoT Events logging options.
- StartDetectorModelAnalysis ( array $params = [] )
- Performs an analysis of your detector model.
- TagResource ( array $params = [] )
- Adds to or modifies the tags of the given resource.
- UntagResource ( array $params = [] )
- Removes the given tags (metadata) from the resource.
- UpdateAlarmModel ( array $params = [] )
- Updates an alarm model.
- UpdateDetectorModel ( array $params = [] )
- Updates a detector model.
- UpdateInput ( array $params = [] )
- Updates an input.
Operations
CreateAlarmModel
$result = $client->createAlarmModel([/* ... */]); $promise = $client->createAlarmModelAsync([/* ... */]);
Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.
Parameter Syntax
$result = $client->createAlarmModel([
'alarmCapabilities' => [
'acknowledgeFlow' => [
'enabled' => true || false, // REQUIRED
],
'initializationConfiguration' => [
'disabledOnInitialization' => true || false, // REQUIRED
],
],
'alarmEventActions' => [
'alarmActions' => [
[
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
],
'alarmModelDescription' => '<string>',
'alarmModelName' => '<string>', // REQUIRED
'alarmNotification' => [
'notificationActions' => [
[
'action' => [ // REQUIRED
'lambdaAction' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
],
'emailConfigurations' => [
[
'content' => [
'additionalMessage' => '<string>',
'subject' => '<string>',
],
'from' => '<string>', // REQUIRED
'recipients' => [ // REQUIRED
'to' => [
[
'ssoIdentity' => [
'identityStoreId' => '<string>', // REQUIRED
'userId' => '<string>',
],
],
// ...
],
],
],
// ...
],
'smsConfigurations' => [
[
'additionalMessage' => '<string>',
'recipients' => [ // REQUIRED
[
'ssoIdentity' => [
'identityStoreId' => '<string>', // REQUIRED
'userId' => '<string>',
],
],
// ...
],
'senderId' => '<string>',
],
// ...
],
],
// ...
],
],
'alarmRule' => [ // REQUIRED
'simpleRule' => [
'comparisonOperator' => 'GREATER|GREATER_OR_EQUAL|LESS|LESS_OR_EQUAL|EQUAL|NOT_EQUAL', // REQUIRED
'inputProperty' => '<string>', // REQUIRED
'threshold' => '<string>', // REQUIRED
],
],
'key' => '<string>',
'roleArn' => '<string>', // REQUIRED
'severity' => <integer>,
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- alarmCapabilities
-
- Type: AlarmCapabilities structure
Contains the configuration information of alarm state changes.
- alarmEventActions
-
- Type: AlarmEventActions structure
Contains information about one or more alarm actions.
- alarmModelDescription
-
- Type: string
A description that tells you what the alarm model detects.
- alarmModelName
-
- Required: Yes
- Type: string
A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.
- alarmNotification
-
- Type: AlarmNotification structure
Contains information about one or more notification actions.
- alarmRule
-
- Required: Yes
- Type: AlarmRule structure
Defines when your alarm is invoked.
- key
-
- Type: string
An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- severity
-
- Type: int
A non-negative integer that reflects the severity level of the alarm.
- tags
-
- Type: Array of Tag structures
A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.
You can create up to 50 tags for one alarm model.
Result Syntax
[
'alarmModelArn' => '<string>',
'alarmModelVersion' => '<string>',
'creationTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'status' => 'ACTIVE|ACTIVATING|INACTIVE|FAILED',
]
Result Details
Members
- alarmModelArn
-
- Type: string
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- alarmModelVersion
-
- Type: string
The version of the alarm model.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was created, in the Unix epoch format.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was last updated, in the Unix epoch format.
- status
-
- Type: string
The status of the alarm model. The status can be one of the following values:
-
ACTIVE- The alarm model is active and it's ready to evaluate data. -
ACTIVATING- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. -
INACTIVE- The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. -
FAILED- You couldn't create or update the alarm model. Check your alarm model information and try again.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceInUseException:
The resource is in use.
- ResourceAlreadyExistsException:
The resource already exists.
- LimitExceededException:
A limit was exceeded.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
CreateDetectorModel
$result = $client->createDetectorModel([/* ... */]); $promise = $client->createDetectorModelAsync([/* ... */]);
Creates a detector model.
Parameter Syntax
$result = $client->createDetectorModel([
'detectorModelDefinition' => [ // REQUIRED
'initialStateName' => '<string>', // REQUIRED
'states' => [ // REQUIRED
[
'onEnter' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onExit' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onInput' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
'transitionEvents' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>', // REQUIRED
'eventName' => '<string>', // REQUIRED
'nextState' => '<string>', // REQUIRED
],
// ...
],
],
'stateName' => '<string>', // REQUIRED
],
// ...
],
],
'detectorModelDescription' => '<string>',
'detectorModelName' => '<string>', // REQUIRED
'evaluationMethod' => 'BATCH|SERIAL',
'key' => '<string>',
'roleArn' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- detectorModelDefinition
-
- Required: Yes
- Type: DetectorModelDefinition structure
Information that defines how the detectors operate.
- detectorModelDescription
-
- Type: string
A brief description of the detector model.
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model.
- evaluationMethod
-
- Type: string
Information about the order in which events are evaluated and how actions are executed.
- key
-
- Type: string
The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
- tags
-
- Type: Array of Tag structures
Metadata that can be used to manage the detector model.
Result Syntax
[
'detectorModelConfiguration' => [
'creationTime' => <DateTime>,
'detectorModelArn' => '<string>',
'detectorModelDescription' => '<string>',
'detectorModelName' => '<string>',
'detectorModelVersion' => '<string>',
'evaluationMethod' => 'BATCH|SERIAL',
'key' => '<string>',
'lastUpdateTime' => <DateTime>,
'roleArn' => '<string>',
'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
],
]
Result Details
Members
- detectorModelConfiguration
-
- Type: DetectorModelConfiguration structure
Information about how the detector model is configured.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceInUseException:
The resource is in use.
- ResourceAlreadyExistsException:
The resource already exists.
- LimitExceededException:
A limit was exceeded.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
CreateInput
$result = $client->createInput([/* ... */]); $promise = $client->createInputAsync([/* ... */]);
Creates an input.
Parameter Syntax
$result = $client->createInput([
'inputDefinition' => [ // REQUIRED
'attributes' => [ // REQUIRED
[
'jsonPath' => '<string>', // REQUIRED
],
// ...
],
],
'inputDescription' => '<string>',
'inputName' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- inputDefinition
-
- Required: Yes
- Type: InputDefinition structure
The definition of the input.
- inputDescription
-
- Type: string
A brief description of the input.
- inputName
-
- Required: Yes
- Type: string
The name you want to give to the input.
- tags
-
- Type: Array of Tag structures
Metadata that can be used to manage the input.
Result Syntax
[
'inputConfiguration' => [
'creationTime' => <DateTime>,
'inputArn' => '<string>',
'inputDescription' => '<string>',
'inputName' => '<string>',
'lastUpdateTime' => <DateTime>,
'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
],
]
Result Details
Members
- inputConfiguration
-
- Type: InputConfiguration structure
Information about the configuration of the input.
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
- ResourceAlreadyExistsException:
The resource already exists.
DeleteAlarmModel
$result = $client->deleteAlarmModel([/* ... */]); $promise = $client->deleteAlarmModelAsync([/* ... */]);
Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
Parameter Syntax
$result = $client->deleteAlarmModel([
'alarmModelName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request was invalid.
- ResourceInUseException:
The resource is in use.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
DeleteDetectorModel
$result = $client->deleteDetectorModel([/* ... */]); $promise = $client->deleteDetectorModelAsync([/* ... */]);
Deletes a detector model. Any active instances of the detector model are also deleted.
Parameter Syntax
$result = $client->deleteDetectorModel([
'detectorModelName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model to be deleted.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request was invalid.
- ResourceInUseException:
The resource is in use.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
DeleteInput
$result = $client->deleteInput([/* ... */]); $promise = $client->deleteInputAsync([/* ... */]);
Deletes an input.
Parameter Syntax
$result = $client->deleteInput([
'inputName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- inputName
-
- Required: Yes
- Type: string
The name of the input to delete.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
- ResourceInUseException:
The resource is in use.
DescribeAlarmModel
$result = $client->describeAlarmModel([/* ... */]); $promise = $client->describeAlarmModelAsync([/* ... */]);
Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.
Parameter Syntax
$result = $client->describeAlarmModel([
'alarmModelName' => '<string>', // REQUIRED
'alarmModelVersion' => '<string>',
]);
Parameter Details
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- alarmModelVersion
-
- Type: string
The version of the alarm model.
Result Syntax
[
'alarmCapabilities' => [
'acknowledgeFlow' => [
'enabled' => true || false,
],
'initializationConfiguration' => [
'disabledOnInitialization' => true || false,
],
],
'alarmEventActions' => [
'alarmActions' => [
[
'dynamoDB' => [
'hashKeyField' => '<string>',
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>',
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>',
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'tableName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>',
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'lambda' => [
'functionArn' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'sns' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'targetArn' => '<string>',
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
],
'alarmModelArn' => '<string>',
'alarmModelDescription' => '<string>',
'alarmModelName' => '<string>',
'alarmModelVersion' => '<string>',
'alarmNotification' => [
'notificationActions' => [
[
'action' => [
'lambdaAction' => [
'functionArn' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
],
'emailConfigurations' => [
[
'content' => [
'additionalMessage' => '<string>',
'subject' => '<string>',
],
'from' => '<string>',
'recipients' => [
'to' => [
[
'ssoIdentity' => [
'identityStoreId' => '<string>',
'userId' => '<string>',
],
],
// ...
],
],
],
// ...
],
'smsConfigurations' => [
[
'additionalMessage' => '<string>',
'recipients' => [
[
'ssoIdentity' => [
'identityStoreId' => '<string>',
'userId' => '<string>',
],
],
// ...
],
'senderId' => '<string>',
],
// ...
],
],
// ...
],
],
'alarmRule' => [
'simpleRule' => [
'comparisonOperator' => 'GREATER|GREATER_OR_EQUAL|LESS|LESS_OR_EQUAL|EQUAL|NOT_EQUAL',
'inputProperty' => '<string>',
'threshold' => '<string>',
],
],
'creationTime' => <DateTime>,
'key' => '<string>',
'lastUpdateTime' => <DateTime>,
'roleArn' => '<string>',
'severity' => <integer>,
'status' => 'ACTIVE|ACTIVATING|INACTIVE|FAILED',
'statusMessage' => '<string>',
]
Result Details
Members
- alarmCapabilities
-
- Type: AlarmCapabilities structure
Contains the configuration information of alarm state changes.
- alarmEventActions
-
- Type: AlarmEventActions structure
Contains information about one or more alarm actions.
- alarmModelArn
-
- Type: string
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- alarmModelDescription
-
- Type: string
The description of the alarm model.
- alarmModelName
-
- Type: string
The name of the alarm model.
- alarmModelVersion
-
- Type: string
The version of the alarm model.
- alarmNotification
-
- Type: AlarmNotification structure
Contains information about one or more notification actions.
- alarmRule
-
- Type: AlarmRule structure
Defines when your alarm is invoked.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was created, in the Unix epoch format.
- key
-
- Type: string
An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was last updated, in the Unix epoch format.
- roleArn
-
- Type: string
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- severity
-
- Type: int
A non-negative integer that reflects the severity level of the alarm.
- status
-
- Type: string
The status of the alarm model. The status can be one of the following values:
-
ACTIVE- The alarm model is active and it's ready to evaluate data. -
ACTIVATING- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. -
INACTIVE- The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. -
FAILED- You couldn't create or update the alarm model. Check your alarm model information and try again.
- statusMessage
-
- Type: string
Contains information about the status of the alarm model.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
DescribeDetectorModel
$result = $client->describeDetectorModel([/* ... */]); $promise = $client->describeDetectorModelAsync([/* ... */]);
Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
Parameter Syntax
$result = $client->describeDetectorModel([
'detectorModelName' => '<string>', // REQUIRED
'detectorModelVersion' => '<string>',
]);
Parameter Details
Members
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model.
- detectorModelVersion
-
- Type: string
The version of the detector model.
Result Syntax
[
'detectorModel' => [
'detectorModelConfiguration' => [
'creationTime' => <DateTime>,
'detectorModelArn' => '<string>',
'detectorModelDescription' => '<string>',
'detectorModelName' => '<string>',
'detectorModelVersion' => '<string>',
'evaluationMethod' => 'BATCH|SERIAL',
'key' => '<string>',
'lastUpdateTime' => <DateTime>,
'roleArn' => '<string>',
'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
],
'detectorModelDefinition' => [
'initialStateName' => '<string>',
'states' => [
[
'onEnter' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>',
],
'dynamoDB' => [
'hashKeyField' => '<string>',
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>',
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>',
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'tableName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>',
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'lambda' => [
'functionArn' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'targetArn' => '<string>',
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>',
],
// ...
],
],
'onExit' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>',
],
'dynamoDB' => [
'hashKeyField' => '<string>',
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>',
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>',
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'tableName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>',
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'lambda' => [
'functionArn' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'targetArn' => '<string>',
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>',
],
// ...
],
],
'onInput' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>',
],
'dynamoDB' => [
'hashKeyField' => '<string>',
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>',
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>',
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'tableName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>',
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'lambda' => [
'functionArn' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'targetArn' => '<string>',
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>',
],
// ...
],
'transitionEvents' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>',
],
'dynamoDB' => [
'hashKeyField' => '<string>',
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>',
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>',
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'tableName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>',
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'lambda' => [
'functionArn' => '<string>',
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'targetArn' => '<string>',
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>',
'type' => 'STRING|JSON',
],
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>',
'nextState' => '<string>',
],
// ...
],
],
'stateName' => '<string>',
],
// ...
],
],
],
]
Result Details
Members
- detectorModel
-
- Type: DetectorModel structure
Information about the detector model.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
DescribeDetectorModelAnalysis
$result = $client->describeDetectorModelAnalysis([/* ... */]); $promise = $client->describeDetectorModelAnalysisAsync([/* ... */]);
Retrieves runtime information about a detector model analysis.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
Parameter Syntax
$result = $client->describeDetectorModelAnalysis([
'analysisId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- analysisId
-
- Required: Yes
- Type: string
The ID of the analysis result that you want to retrieve.
Result Syntax
[
'status' => 'RUNNING|COMPLETE|FAILED',
]
Result Details
Members
- status
-
- Type: string
The status of the analysis activity. The status can be one of the following values:
-
RUNNING- AWS IoT Events is analyzing your detector model. This process can take several minutes to complete. -
COMPLETE- AWS IoT Events finished analyzing your detector model. -
FAILED- AWS IoT Events couldn't analyze your detector model. Try again later.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
DescribeInput
$result = $client->describeInput([/* ... */]); $promise = $client->describeInputAsync([/* ... */]);
Describes an input.
Parameter Syntax
$result = $client->describeInput([
'inputName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- inputName
-
- Required: Yes
- Type: string
The name of the input.
Result Syntax
[
'input' => [
'inputConfiguration' => [
'creationTime' => <DateTime>,
'inputArn' => '<string>',
'inputDescription' => '<string>',
'inputName' => '<string>',
'lastUpdateTime' => <DateTime>,
'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
],
'inputDefinition' => [
'attributes' => [
[
'jsonPath' => '<string>',
],
// ...
],
],
],
]
Result Details
Members
- input
-
- Type: Input structure
Information about the input.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
DescribeLoggingOptions
$result = $client->describeLoggingOptions([/* ... */]); $promise = $client->describeLoggingOptionsAsync([/* ... */]);
Retrieves the current settings of the AWS IoT Events logging options.
Parameter Syntax
$result = $client->describeLoggingOptions([ ]);
Parameter Details
Members
Result Syntax
[
'loggingOptions' => [
'detectorDebugOptions' => [
[
'detectorModelName' => '<string>',
'keyValue' => '<string>',
],
// ...
],
'enabled' => true || false,
'level' => 'ERROR|INFO|DEBUG',
'roleArn' => '<string>',
],
]
Result Details
Members
- loggingOptions
-
- Type: LoggingOptions structure
The current settings of the AWS IoT Events logging options.
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ResourceNotFoundException:
The resource was not found.
- ServiceUnavailableException:
The service is currently unavailable.
- UnsupportedOperationException:
The requested operation is not supported.
GetDetectorModelAnalysisResults
$result = $client->getDetectorModelAnalysisResults([/* ... */]); $promise = $client->getDetectorModelAnalysisResultsAsync([/* ... */]);
Retrieves one or more analysis results of the detector model.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
Parameter Syntax
$result = $client->getDetectorModelAnalysisResults([
'analysisId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- analysisId
-
- Required: Yes
- Type: string
The ID of the analysis result that you want to retrieve.
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
Result Syntax
[
'analysisResults' => [
[
'level' => 'INFO|WARNING|ERROR',
'locations' => [
[
'path' => '<string>',
],
// ...
],
'message' => '<string>',
'type' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- analysisResults
-
- Type: Array of AnalysisResult structures
Contains information about one or more analysis results.
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
ListAlarmModelVersions
$result = $client->listAlarmModelVersions([/* ... */]); $promise = $client->listAlarmModelVersionsAsync([/* ... */]);
Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
Parameter Syntax
$result = $client->listAlarmModelVersions([
'alarmModelName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
Result Syntax
[
'alarmModelVersionSummaries' => [
[
'alarmModelArn' => '<string>',
'alarmModelName' => '<string>',
'alarmModelVersion' => '<string>',
'creationTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'roleArn' => '<string>',
'status' => 'ACTIVE|ACTIVATING|INACTIVE|FAILED',
'statusMessage' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- alarmModelVersionSummaries
-
- Type: Array of AlarmModelVersionSummary structures
A list that summarizes each alarm model version.
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
ListAlarmModels
$result = $client->listAlarmModels([/* ... */]); $promise = $client->listAlarmModelsAsync([/* ... */]);
Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
Parameter Syntax
$result = $client->listAlarmModels([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
Result Syntax
[
'alarmModelSummaries' => [
[
'alarmModelDescription' => '<string>',
'alarmModelName' => '<string>',
'creationTime' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- alarmModelSummaries
-
- Type: Array of AlarmModelSummary structures
A list that summarizes each alarm model.
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
ListDetectorModelVersions
$result = $client->listDetectorModelVersions([/* ... */]); $promise = $client->listDetectorModelVersionsAsync([/* ... */]);
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
Parameter Syntax
$result = $client->listDetectorModelVersions([
'detectorModelName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model whose versions are returned.
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
Result Syntax
[
'detectorModelVersionSummaries' => [
[
'creationTime' => <DateTime>,
'detectorModelArn' => '<string>',
'detectorModelName' => '<string>',
'detectorModelVersion' => '<string>',
'evaluationMethod' => 'BATCH|SERIAL',
'lastUpdateTime' => <DateTime>,
'roleArn' => '<string>',
'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- detectorModelVersionSummaries
-
- Type: Array of DetectorModelVersionSummary structures
Summary information about the detector model versions.
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
ListDetectorModels
$result = $client->listDetectorModels([/* ... */]); $promise = $client->listDetectorModelsAsync([/* ... */]);
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
Parameter Syntax
$result = $client->listDetectorModels([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
Result Syntax
[
'detectorModelSummaries' => [
[
'creationTime' => <DateTime>,
'detectorModelDescription' => '<string>',
'detectorModelName' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- detectorModelSummaries
-
- Type: Array of DetectorModelSummary structures
Summary information about the detector models.
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
ListInputRoutings
$result = $client->listInputRoutings([/* ... */]); $promise = $client->listInputRoutingsAsync([/* ... */]);
Lists one or more input routings.
Parameter Syntax
$result = $client->listInputRoutings([
'inputIdentifier' => [ // REQUIRED
'iotEventsInputIdentifier' => [
'inputName' => '<string>', // REQUIRED
],
'iotSiteWiseInputIdentifier' => [
'iotSiteWiseAssetModelPropertyIdentifier' => [
'assetModelId' => '<string>', // REQUIRED
'propertyId' => '<string>', // REQUIRED
],
],
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- inputIdentifier
-
- Required: Yes
- Type: InputIdentifier structure
The identifer of the routed input.
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
Result Syntax
[
'nextToken' => '<string>',
'routedResources' => [
[
'arn' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results. - routedResources
-
- Type: Array of RoutedResource structures
Summary information about the routed resources.
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
- ResourceNotFoundException:
The resource was not found.
ListInputs
$result = $client->listInputs([/* ... */]); $promise = $client->listInputsAsync([/* ... */]);
Lists the inputs you have created.
Parameter Syntax
$result = $client->listInputs([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
Result Syntax
[
'inputSummaries' => [
[
'creationTime' => <DateTime>,
'inputArn' => '<string>',
'inputDescription' => '<string>',
'inputName' => '<string>',
'lastUpdateTime' => <DateTime>,
'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- inputSummaries
-
- Type: Array of InputSummary structures
Summary information about the inputs.
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags (metadata) you have assigned to the resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
Result Syntax
[
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The list of tags assigned to the resource.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ResourceInUseException:
The resource is in use.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
PutLoggingOptions
$result = $client->putLoggingOptions([/* ... */]); $promise = $client->putLoggingOptionsAsync([/* ... */]);
Sets or updates the AWS IoT Events logging options.
If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
Parameter Syntax
$result = $client->putLoggingOptions([
'loggingOptions' => [ // REQUIRED
'detectorDebugOptions' => [
[
'detectorModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
],
// ...
],
'enabled' => true || false, // REQUIRED
'level' => 'ERROR|INFO|DEBUG', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- loggingOptions
-
- Required: Yes
- Type: LoggingOptions structure
The new values of the AWS IoT Events logging options.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
- UnsupportedOperationException:
The requested operation is not supported.
- ResourceInUseException:
The resource is in use.
StartDetectorModelAnalysis
$result = $client->startDetectorModelAnalysis([/* ... */]); $promise = $client->startDetectorModelAnalysisAsync([/* ... */]);
Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
Parameter Syntax
$result = $client->startDetectorModelAnalysis([
'detectorModelDefinition' => [ // REQUIRED
'initialStateName' => '<string>', // REQUIRED
'states' => [ // REQUIRED
[
'onEnter' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onExit' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onInput' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
'transitionEvents' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>', // REQUIRED
'eventName' => '<string>', // REQUIRED
'nextState' => '<string>', // REQUIRED
],
// ...
],
],
'stateName' => '<string>', // REQUIRED
],
// ...
],
],
]);
Parameter Details
Members
- detectorModelDefinition
-
- Required: Yes
- Type: DetectorModelDefinition structure
Information that defines how a detector operates.
Result Syntax
[
'analysisId' => '<string>',
]
Result Details
Members
- analysisId
-
- Type: string
The ID that you can use to retrieve the analysis result.
Errors
- InvalidRequestException:
The request was invalid.
- LimitExceededException:
A limit was exceeded.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => [ // REQUIRED
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The new or modified tags for the resource.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ResourceInUseException:
The resource is in use.
- ThrottlingException:
The request could not be completed due to throttling.
- LimitExceededException:
A limit was exceeded.
- InternalFailureException:
An internal failure occurred.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the given tags (metadata) from the resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
A list of the keys of the tags to be removed from the resource.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request was invalid.
- ResourceNotFoundException:
The resource was not found.
- ResourceInUseException:
The resource is in use.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
UpdateAlarmModel
$result = $client->updateAlarmModel([/* ... */]); $promise = $client->updateAlarmModelAsync([/* ... */]);
Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
Parameter Syntax
$result = $client->updateAlarmModel([
'alarmCapabilities' => [
'acknowledgeFlow' => [
'enabled' => true || false, // REQUIRED
],
'initializationConfiguration' => [
'disabledOnInitialization' => true || false, // REQUIRED
],
],
'alarmEventActions' => [
'alarmActions' => [
[
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
],
'alarmModelDescription' => '<string>',
'alarmModelName' => '<string>', // REQUIRED
'alarmNotification' => [
'notificationActions' => [
[
'action' => [ // REQUIRED
'lambdaAction' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
],
'emailConfigurations' => [
[
'content' => [
'additionalMessage' => '<string>',
'subject' => '<string>',
],
'from' => '<string>', // REQUIRED
'recipients' => [ // REQUIRED
'to' => [
[
'ssoIdentity' => [
'identityStoreId' => '<string>', // REQUIRED
'userId' => '<string>',
],
],
// ...
],
],
],
// ...
],
'smsConfigurations' => [
[
'additionalMessage' => '<string>',
'recipients' => [ // REQUIRED
[
'ssoIdentity' => [
'identityStoreId' => '<string>', // REQUIRED
'userId' => '<string>',
],
],
// ...
],
'senderId' => '<string>',
],
// ...
],
],
// ...
],
],
'alarmRule' => [ // REQUIRED
'simpleRule' => [
'comparisonOperator' => 'GREATER|GREATER_OR_EQUAL|LESS|LESS_OR_EQUAL|EQUAL|NOT_EQUAL', // REQUIRED
'inputProperty' => '<string>', // REQUIRED
'threshold' => '<string>', // REQUIRED
],
],
'roleArn' => '<string>', // REQUIRED
'severity' => <integer>,
]);
Parameter Details
Members
- alarmCapabilities
-
- Type: AlarmCapabilities structure
Contains the configuration information of alarm state changes.
- alarmEventActions
-
- Type: AlarmEventActions structure
Contains information about one or more alarm actions.
- alarmModelDescription
-
- Type: string
The description of the alarm model.
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- alarmNotification
-
- Type: AlarmNotification structure
Contains information about one or more notification actions.
- alarmRule
-
- Required: Yes
- Type: AlarmRule structure
Defines when your alarm is invoked.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- severity
-
- Type: int
A non-negative integer that reflects the severity level of the alarm.
Result Syntax
[
'alarmModelArn' => '<string>',
'alarmModelVersion' => '<string>',
'creationTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'status' => 'ACTIVE|ACTIVATING|INACTIVE|FAILED',
]
Result Details
Members
- alarmModelArn
-
- Type: string
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- alarmModelVersion
-
- Type: string
The version of the alarm model.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was created, in the Unix epoch format.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was last updated, in the Unix epoch format.
- status
-
- Type: string
The status of the alarm model. The status can be one of the following values:
-
ACTIVE- The alarm model is active and it's ready to evaluate data. -
ACTIVATING- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. -
INACTIVE- The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. -
FAILED- You couldn't create or update the alarm model. Check your alarm model information and try again.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceInUseException:
The resource is in use.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
UpdateDetectorModel
$result = $client->updateDetectorModel([/* ... */]); $promise = $client->updateDetectorModelAsync([/* ... */]);
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
Parameter Syntax
$result = $client->updateDetectorModel([
'detectorModelDefinition' => [ // REQUIRED
'initialStateName' => '<string>', // REQUIRED
'states' => [ // REQUIRED
[
'onEnter' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onExit' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onInput' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
'transitionEvents' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'dynamoDB' => [
'hashKeyField' => '<string>', // REQUIRED
'hashKeyType' => '<string>',
'hashKeyValue' => '<string>', // REQUIRED
'operation' => '<string>',
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'payloadField' => '<string>',
'rangeKeyField' => '<string>',
'rangeKeyType' => '<string>',
'rangeKeyValue' => '<string>',
'tableName' => '<string>', // REQUIRED
],
'dynamoDBv2' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'tableName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'iotSiteWise' => [
'assetId' => '<string>',
'entryId' => '<string>',
'propertyAlias' => '<string>',
'propertyId' => '<string>',
'propertyValue' => [
'quality' => '<string>',
'timestamp' => [
'offsetInNanos' => '<string>',
'timeInSeconds' => '<string>', // REQUIRED
],
'value' => [
'booleanValue' => '<string>',
'doubleValue' => '<string>',
'integerValue' => '<string>',
'stringValue' => '<string>',
],
],
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'durationExpression' => '<string>',
'seconds' => <integer>,
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'payload' => [
'contentExpression' => '<string>', // REQUIRED
'type' => 'STRING|JSON', // REQUIRED
],
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>', // REQUIRED
'eventName' => '<string>', // REQUIRED
'nextState' => '<string>', // REQUIRED
],
// ...
],
],
'stateName' => '<string>', // REQUIRED
],
// ...
],
],
'detectorModelDescription' => '<string>',
'detectorModelName' => '<string>', // REQUIRED
'evaluationMethod' => 'BATCH|SERIAL',
'roleArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- detectorModelDefinition
-
- Required: Yes
- Type: DetectorModelDefinition structure
Information that defines how a detector operates.
- detectorModelDescription
-
- Type: string
A brief description of the detector model.
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model that is updated.
- evaluationMethod
-
- Type: string
Information about the order in which events are evaluated and how actions are executed.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
Result Syntax
[
'detectorModelConfiguration' => [
'creationTime' => <DateTime>,
'detectorModelArn' => '<string>',
'detectorModelDescription' => '<string>',
'detectorModelName' => '<string>',
'detectorModelVersion' => '<string>',
'evaluationMethod' => 'BATCH|SERIAL',
'key' => '<string>',
'lastUpdateTime' => <DateTime>,
'roleArn' => '<string>',
'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
],
]
Result Details
Members
- detectorModelConfiguration
-
- Type: DetectorModelConfiguration structure
Information about how the detector model is configured.
Errors
- InvalidRequestException:
The request was invalid.
- ResourceInUseException:
The resource is in use.
- ResourceNotFoundException:
The resource was not found.
- ThrottlingException:
The request could not be completed due to throttling.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
UpdateInput
$result = $client->updateInput([/* ... */]); $promise = $client->updateInputAsync([/* ... */]);
Updates an input.
Parameter Syntax
$result = $client->updateInput([
'inputDefinition' => [ // REQUIRED
'attributes' => [ // REQUIRED
[
'jsonPath' => '<string>', // REQUIRED
],
// ...
],
],
'inputDescription' => '<string>',
'inputName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- inputDefinition
-
- Required: Yes
- Type: InputDefinition structure
The definition of the input.
- inputDescription
-
- Type: string
A brief description of the input.
- inputName
-
- Required: Yes
- Type: string
The name of the input you want to update.
Result Syntax
[
'inputConfiguration' => [
'creationTime' => <DateTime>,
'inputArn' => '<string>',
'inputDescription' => '<string>',
'inputName' => '<string>',
'lastUpdateTime' => <DateTime>,
'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
],
]
Result Details
Members
- inputConfiguration
-
- Type: InputConfiguration structure
Information about the configuration of the input.
Errors
- InvalidRequestException:
The request was invalid.
- ThrottlingException:
The request could not be completed due to throttling.
- ResourceNotFoundException:
The resource was not found.
- InternalFailureException:
An internal failure occurred.
- ServiceUnavailableException:
The service is currently unavailable.
- ResourceInUseException:
The resource is in use.
Shapes
AcknowledgeFlow
Description
Specifies whether to get notified for alarm state changes.
Members
- enabled
-
- Required: Yes
- Type: boolean
The value must be
TRUEorFALSE. IfTRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return toNORMAL. IfFALSE, you won't receive notifications. The alarm automatically changes to theNORMALstate when the input property value returns to the specified range.
Action
Description
An action to be performed when the condition is TRUE.
Members
- clearTimer
-
- Type: ClearTimerAction structure
Information needed to clear the timer.
- dynamoDB
-
- Type: DynamoDBAction structure
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
- dynamoDBv2
-
- Type: DynamoDBv2Action structure
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
- firehose
-
- Type: FirehoseAction structure
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
- iotEvents
-
- Type: IotEventsAction structure
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
- iotSiteWise
-
- Type: IotSiteWiseAction structure
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
- iotTopicPublish
-
- Type: IotTopicPublishAction structure
Publishes an MQTT message with the given topic to the AWS IoT message broker.
- lambda
-
- Type: LambdaAction structure
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
- resetTimer
-
- Type: ResetTimerAction structure
Information needed to reset the timer.
- setTimer
-
- Type: SetTimerAction structure
Information needed to set the timer.
- setVariable
-
- Type: SetVariableAction structure
Sets a variable to a specified value.
- sns
-
- Type: SNSTopicPublishAction structure
Sends an Amazon SNS message.
- sqs
-
- Type: SqsAction structure
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
AlarmAction
Description
Specifies one of the following actions to receive notifications when the alarm state changes.
Members
- dynamoDB
-
- Type: DynamoDBAction structure
Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
You must use expressions for all parameters in
DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
hashKeyTypeparameter can be'STRING'. -
For references, you must specify either variables or input values. For example, the value for the
hashKeyFieldparameter can be$input.GreenhouseInput.name. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
hashKeyValueparameter uses a substitution template.'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit' -
For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
If the defined payload type is a string,
DynamoDBActionwrites non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for thepayloadFieldparameter is<payload-field>_raw. - dynamoDBv2
-
- Type: DynamoDBv2Action structure
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You must use expressions for all parameters in
DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
tableNameparameter can be'GreenhouseTemperatureTable'. -
For references, you must specify either variables or input values. For example, the value for the
tableNameparameter can be$variable.ddbtableName. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
contentExpressionparameter inPayloaduses a substitution template.'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}' -
For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
The value for the
typeparameter inPayloadmust beJSON. - firehose
-
- Type: FirehoseAction structure
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
- iotEvents
-
- Type: IotEventsAction structure
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
- iotSiteWise
-
- Type: IotSiteWiseAction structure
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.
You must use expressions for all parameters in
IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
propertyAliasparameter can be'/company/windfarm/3/turbine/7/temperature'. -
For references, you must specify either variables or input values. For example, the value for the
assetIdparameter can be$input.TurbineInput.assetId1. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
propertyAliasparameter uses a substitution template.'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'
You must specify either
propertyAliasor bothassetIdandpropertyIdto identify the target asset property in AWS IoT SiteWise.For more information, see Expressions in the AWS IoT Events Developer Guide.
- iotTopicPublish
-
- Type: IotTopicPublishAction structure
Information required to publish the MQTT message through the AWS IoT message broker.
- lambda
-
- Type: LambdaAction structure
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
- sns
-
- Type: SNSTopicPublishAction structure
Information required to publish the Amazon SNS message.
- sqs
-
- Type: SqsAction structure
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
AlarmCapabilities
Description
Contains the configuration information of alarm state changes.
Members
- acknowledgeFlow
-
- Type: AcknowledgeFlow structure
Specifies whether to get notified for alarm state changes.
- initializationConfiguration
-
- Type: InitializationConfiguration structure
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
AlarmEventActions
Description
Contains information about one or more alarm actions.
Members
- alarmActions
-
- Type: Array of AlarmAction structures
Specifies one or more supported actions to receive notifications when the alarm state changes.
AlarmModelSummary
Description
Contains a summary of an alarm model.
Members
- alarmModelDescription
-
- Type: string
The description of the alarm model.
- alarmModelName
-
- Type: string
The name of the alarm model.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was created, in the Unix epoch format.
AlarmModelVersionSummary
Description
Contains a summary of an alarm model version.
Members
- alarmModelArn
-
- Type: string
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- alarmModelName
-
- Type: string
The name of the alarm model.
- alarmModelVersion
-
- Type: string
The version of the alarm model.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was created, in the Unix epoch format.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm model was last updated, in the Unix epoch format.
- roleArn
-
- Type: string
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- status
-
- Type: string
The status of the alarm model. The status can be one of the following values:
-
ACTIVE- The alarm model is active and it's ready to evaluate data. -
ACTIVATING- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. -
INACTIVE- The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. -
FAILED- You couldn't create or update the alarm model. Check your alarm model information and try again.
- statusMessage
-
- Type: string
Contains information about the status of the alarm model version.
AlarmNotification
Description
Contains information about one or more notification actions.
Members
- notificationActions
-
- Type: Array of NotificationAction structures
Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
AlarmRule
Description
Defines when your alarm is invoked.
Members
- simpleRule
-
- Type: SimpleRule structure
A rule that compares an input property value to a threshold value with a comparison operator.
AnalysisResult
Description
Contains the result of the analysis.
Members
- level
-
- Type: string
The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
-
INFO- An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action. -
WARNING- A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected. -
ERROR- An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
- locations
-
- Type: Array of AnalysisResultLocation structures
Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
- message
-
- Type: string
Contains additional information about the analysis result.
- type
-
- Type: string
The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
-
supported-actions- You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region. -
service-limits- Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase. -
structure- The detector model must follow a structure that AWS IoT Events supports. -
expression-syntax- Your expression must follow the required syntax. -
data-type- Data types referenced in the detector model must be compatible. -
referenced-data- You must define the data referenced in your detector model before you can use the data. -
referenced-resource- Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
AnalysisResultLocation
Description
Contains information that you can use to locate the field in your detector model that the analysis result references.
Members
- path
-
- Type: string
A JsonPath expression that identifies the error field in your detector model.
AssetPropertyTimestamp
Description
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.
You must use expressions for all parameters in AssetPropertyTimestamp. The expressions accept literals, operators, functions, references, and substitution templates.
Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
timeInSecondsparameter can be'1586400675'. -
For references, you must specify either variables or input values. For example, the value for the
offsetInNanosparameter can be$variable.time. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
timeInSecondsparameter uses a substitution template.'${$input.TemperatureInput.sensorData.timestamp / 1000}'
For more information, see Expressions in the AWS IoT Events Developer Guide.
Members
- offsetInNanos
-
- Type: string
The nanosecond offset converted from
timeInSeconds. The valid range is between 0-999999999. - timeInSeconds
-
- Required: Yes
- Type: string
The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
AssetPropertyValue
Description
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.
You must use expressions for all parameters in AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates.
Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
qualityparameter can be'GOOD'. -
For references, you must specify either variables or input values. For example, the value for the
qualityparameter can be$input.TemperatureInput.sensorData.quality.
For more information, see Expressions in the AWS IoT Events Developer Guide.
Members
- quality
-
- Type: string
The quality of the asset property value. The value must be
'GOOD','BAD', or'UNCERTAIN'. - timestamp
-
- Type: AssetPropertyTimestamp structure
The timestamp associated with the asset property value. The default is the current event time.
- value
-
- Type: AssetPropertyVariant structure
The value to send to an asset property.
AssetPropertyVariant
Description
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.
You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.
Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
integerValueparameter can be'100'. -
For references, you must specify either variables or parameters. For example, the value for the
booleanValueparameter can be$variable.offline. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
doubleValueparameter uses a substitution template.'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'
For more information, see Expressions in the AWS IoT Events Developer Guide.
You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.
Members
- booleanValue
-
- Type: string
The asset property value is a Boolean value that must be
'TRUE'or'FALSE'. You must use an expression, and the evaluated result should be a Boolean value. - doubleValue
-
- Type: string
The asset property value is a double. You must use an expression, and the evaluated result should be a double.
- integerValue
-
- Type: string
The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
- stringValue
-
- Type: string
The asset property value is a string. You must use an expression, and the evaluated result should be a string.
Attribute
Description
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.
Members
- jsonPath
-
- Required: Yes
- Type: 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 theconditionexpressions used by detectors.Syntax:
<field-name>.<field-name>...
ClearTimerAction
Description
Information needed to clear the timer.
Members
- timerName
-
- Required: Yes
- Type: string
The name of the timer to clear.
DetectorDebugOption
Description
The detector model and the specific detectors (instances) for which the logging level is given.
Members
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model.
- keyValue
-
- Type: string
The value of the input attribute key used to create the detector (the instance of the detector model).
DetectorModel
Description
Information about the detector model.
Members
- detectorModelConfiguration
-
- Type: DetectorModelConfiguration structure
Information about how the detector is configured.
- detectorModelDefinition
-
- Type: DetectorModelDefinition structure
Information that defines how a detector operates.
DetectorModelConfiguration
Description
Information about how the detector model is configured.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector model was created.
- detectorModelArn
-
- Type: string
The ARN of the detector model.
- detectorModelDescription
-
- Type: string
A brief description of the detector model.
- detectorModelName
-
- Type: string
The name of the detector model.
- detectorModelVersion
-
- Type: string
The version of the detector model.
- evaluationMethod
-
- Type: string
Information about the order in which events are evaluated and how actions are executed.
- key
-
- Type: string
The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector model was last updated.
- roleArn
-
- Type: string
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
- status
-
- Type: string
The status of the detector model.
DetectorModelDefinition
Description
Information that defines how a detector operates.
Members
- initialStateName
-
- Required: Yes
- Type: string
The state that is entered at the creation of each detector (instance).
- states
-
- Required: Yes
- Type: Array of State structures
Information about the states of the detector.
DetectorModelSummary
Description
Information about the detector model.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector model was created.
- detectorModelDescription
-
- Type: string
A brief description of the detector model.
- detectorModelName
-
- Type: string
The name of the detector model.
DetectorModelVersionSummary
Description
Information about the detector model version.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector model version was created.
- detectorModelArn
-
- Type: string
The ARN of the detector model version.
- detectorModelName
-
- Type: string
The name of the detector model.
- detectorModelVersion
-
- Type: string
The ID of the detector model version.
- evaluationMethod
-
- Type: string
Information about the order in which events are evaluated and how actions are executed.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the detector model version was updated.
- roleArn
-
- Type: string
The ARN of the role that grants the detector model permission to perform its tasks.
- status
-
- Type: string
The status of the detector model version.
DynamoDBAction
Description
Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.
Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
hashKeyTypeparameter can be'STRING'. -
For references, you must specify either variables or input values. For example, the value for the
hashKeyFieldparameter can be$input.GreenhouseInput.name. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
hashKeyValueparameter uses a substitution template.'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit' -
For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.
Members
- hashKeyField
-
- Required: Yes
- Type: string
The name of the hash key (also called the partition key). The
hashKeyFieldvalue must match the partition key of the target DynamoDB table. - hashKeyType
-
- Type: string
The data type for the hash key (also called the partition key). You can specify the following values:
-
'STRING'- The hash key is a string. -
'NUMBER'- The hash key is a number.
If you don't specify
hashKeyType, the default value is'STRING'. - hashKeyValue
-
- Required: Yes
- Type: string
The value of the hash key (also called the partition key).
- operation
-
- Type: string
The type of operation to perform. You can specify the following values:
-
'INSERT'- Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. -
'UPDATE'- Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. -
'DELETE'- Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the
'INSERT'operation. - payload
-
- Type: Payload structure
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use
contentExpression. - payloadField
-
- Type: string
The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is
payload. - rangeKeyField
-
- Type: string
The name of the range key (also called the sort key). The
rangeKeyFieldvalue must match the sort key of the target DynamoDB table. - rangeKeyType
-
- Type: string
The data type for the range key (also called the sort key), You can specify the following values:
-
'STRING'- The range key is a string. -
'NUMBER'- The range key is number.
If you don't specify
rangeKeyField, the default value is'STRING'. - rangeKeyValue
-
- Type: string
The value of the range key (also called the sort key).
- tableName
-
- Required: Yes
- Type: string
The name of the DynamoDB table. The
tableNamevalue must match the table name of the target DynamoDB table.
DynamoDBv2Action
Description
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.
Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
tableNameparameter can be'GreenhouseTemperatureTable'. -
For references, you must specify either variables or input values. For example, the value for the
tableNameparameter can be$variable.ddbtableName. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
contentExpressionparameter inPayloaduses a substitution template.'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}' -
For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
The value for the type parameter in Payload must be JSON.
Members
- payload
-
- Type: Payload structure
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use
contentExpression. - tableName
-
- Required: Yes
- Type: string
The name of the DynamoDB table.
EmailConfiguration
Description
Contains the configuration information of email notifications.
Members
- content
-
- Type: EmailContent structure
Contains the subject and message of an email.
- from
-
- Required: Yes
- Type: string
The email address that sends emails.
If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES.
- recipients
-
- Required: Yes
- Type: EmailRecipients structure
Contains the information of one or more recipients who receive the emails.
You must add the users that receive emails to your AWS SSO store.
EmailContent
Description
Contains the subject and message of an email.
Members
- additionalMessage
-
- Type: string
The message that you want to send. The message can be up to 200 characters.
- subject
-
- Type: string
The subject of the email.
EmailRecipients
Description
Contains the information of one or more recipients who receive the emails.
You must add the users that receive emails to your AWS SSO store.
Members
- to
-
- Type: Array of RecipientDetail structures
Specifies one or more recipients who receive the email.
Event
Description
Specifies the actions to be performed when the condition evaluates to TRUE.
Members
- actions
-
- Type: Array of Action structures
The actions to be performed.
- condition
-
- Type: string
Optional. The Boolean expression that, when TRUE, causes the
actionsto be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE). - eventName
-
- Required: Yes
- Type: string
The name of the event.
FirehoseAction
Description
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
Members
- deliveryStreamName
-
- Required: Yes
- Type: string
The name of the Kinesis Data Firehose delivery stream where the data is written.
- payload
-
- Type: Payload structure
You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
- separator
-
- Type: string
A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
InitializationConfiguration
Description
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
Members
- disabledOnInitialization
-
- Required: Yes
- Type: boolean
The value must be
TRUEorFALSE. IfFALSE, all alarm instances created based on the alarm model are activated. The default value isTRUE.
Input
Description
Information about the input.
Members
- inputConfiguration
-
- Type: InputConfiguration structure
Information about the configuration of an input.
- inputDefinition
-
- Type: InputDefinition structure
The definition of the input.
InputConfiguration
Description
Information about the configuration of an input.
Members
- creationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the input was created.
- inputArn
-
- Required: Yes
- Type: string
The ARN of the input.
- inputDescription
-
- Type: string
A brief description of the input.
- inputName
-
- Required: Yes
- Type: string
The name of the input.
- lastUpdateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the input was updated.
- status
-
- Required: Yes
- Type: string
The status of the input.
InputDefinition
Description
The definition of the input.
Members
- attributes
-
- Required: Yes
- Type: Array of Attribute structures
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 theconditionexpressions used by detectors that monitor this input.
InputIdentifier
Description
The identifer of the input.
Members
- iotEventsInputIdentifier
-
- Type: IotEventsInputIdentifier structure
The identifier of the input routed to AWS IoT Events.
- iotSiteWiseInputIdentifier
-
- Type: IotSiteWiseInputIdentifier structure
The identifer of the input routed from AWS IoT SiteWise.
InputSummary
Description
Information about the input.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the input was created.
- inputArn
-
- Type: string
The ARN of the input.
- inputDescription
-
- Type: string
A brief description of the input.
- inputName
-
- Type: string
The name of the input.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the input was updated.
- status
-
- Type: string
The status of the input.
InternalFailureException
Description
An internal failure occurred.
Members
- message
-
- Type: string
The message for the exception.
InvalidRequestException
Description
The request was invalid.
Members
- message
-
- Type: string
The message for the exception.
IotEventsAction
Description
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
Members
- inputName
-
- Required: Yes
- Type: string
The name of the AWS IoT Events input where the data is sent.
- payload
-
- Type: Payload structure
You can configure the action payload when you send a message to an AWS IoT Events input.
IotEventsInputIdentifier
Description
The identifier of the input routed to AWS IoT Events.
Members
- inputName
-
- Required: Yes
- Type: string
The name of the input routed to AWS IoT Events.
IotSiteWiseAction
Description
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.
You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.
Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
propertyAliasparameter can be'/company/windfarm/3/turbine/7/temperature'. -
For references, you must specify either variables or input values. For example, the value for the
assetIdparameter can be$input.TurbineInput.assetId1. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
propertyAliasparameter uses a substitution template.'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'
You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.
For more information, see Expressions in the AWS IoT Events Developer Guide.
Members
- assetId
-
- Type: string
The ID of the asset that has the specified property.
- entryId
-
- Type: string
A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
- propertyAlias
-
- Type: string
The alias of the asset property.
- propertyId
-
- Type: string
The ID of the asset property.
- propertyValue
-
- Type: AssetPropertyValue structure
The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
IotSiteWiseAssetModelPropertyIdentifier
Description
The asset model property identifer of the input routed from AWS IoT SiteWise.
Members
- assetModelId
-
- Required: Yes
- Type: string
The ID of the AWS IoT SiteWise asset model.
- propertyId
-
- Required: Yes
- Type: string
The ID of the AWS IoT SiteWise asset property.
IotSiteWiseInputIdentifier
Description
The identifer of the input routed from AWS IoT SiteWise.
Members
- iotSiteWiseAssetModelPropertyIdentifier
-
- Type: IotSiteWiseAssetModelPropertyIdentifier structure
The identifier of the AWS IoT SiteWise asset model property.
IotTopicPublishAction
Description
Information required to publish the MQTT message through the AWS IoT message broker.
Members
- mqttTopic
-
- Required: Yes
- Type: string
The MQTT topic of the message. You can use a string expression that includes variables (
$variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string. - payload
-
- Type: Payload structure
You can configure the action payload when you publish a message to an AWS IoT Core topic.
LambdaAction
Description
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
Members
- functionArn
-
- Required: Yes
- Type: string
The ARN of the Lambda function that is executed.
- payload
-
- Type: Payload structure
You can configure the action payload when you send a message to a Lambda function.
LimitExceededException
Description
A limit was exceeded.
Members
- message
-
- Type: string
The message for the exception.
LoggingOptions
Description
The values of the AWS IoT Events logging options.
Members
- detectorDebugOptions
-
- Type: Array of DetectorDebugOption structures
Information that identifies those detector models and their detectors (instances) for which the logging level is given.
- enabled
-
- Required: Yes
- Type: boolean
If TRUE, logging is enabled for AWS IoT Events.
- level
-
- Required: Yes
- Type: string
The logging level.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the role that grants permission to AWS IoT Events to perform logging.
NotificationAction
Description
Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
Members
- action
-
- Required: Yes
- Type: NotificationTargetActions structure
Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
- emailConfigurations
-
- Type: Array of EmailConfiguration structures
Contains the configuration information of email notifications.
- smsConfigurations
-
- Type: Array of SMSConfiguration structures
Contains the configuration information of SMS notifications.
NotificationTargetActions
Description
Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
Members
- lambdaAction
-
- Type: LambdaAction structure
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
OnEnterLifecycle
Description
When entering this state, perform these actions if the condition is TRUE.
Members
- events
-
- Type: Array of Event structures
Specifies the actions that are performed when the state is entered and the
conditionisTRUE.
OnExitLifecycle
Description
When exiting this state, perform these actions if the specified condition is TRUE.
Members
- events
-
- Type: Array of Event structures
Specifies the
actionsthat are performed when the state is exited and theconditionisTRUE.
OnInputLifecycle
Description
Specifies the actions performed when the condition evaluates to TRUE.
Members
- events
-
- Type: Array of Event structures
Specifies the actions performed when the
conditionevaluates to TRUE. - transitionEvents
-
- Type: Array of TransitionEvent structures
Specifies the actions performed, and the next state entered, when a
conditionevaluates to TRUE.
Payload
Description
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
Members
- contentExpression
-
- Required: Yes
- Type: string
The content of the payload. You can use a string expression that includes quoted strings (
'<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain${}as the content. The recommended maximum size of a content expression is 1 KB. - type
-
- Required: Yes
- Type: string
The value of the payload type can be either
STRINGorJSON.
RecipientDetail
Description
The information that identifies the recipient.
Members
- ssoIdentity
-
- Type: SSOIdentity structure
The AWS Single Sign-On (AWS SSO) authentication information.
ResetTimerAction
Description
Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.
Members
- timerName
-
- Required: Yes
- Type: string
The name of the timer to reset.
ResourceAlreadyExistsException
Description
The resource already exists.
Members
- message
-
- Type: string
The message for the exception.
- resourceArn
-
- Type: string
The ARN of the resource.
- resourceId
-
- Type: string
The ID of the resource.
ResourceInUseException
Description
The resource is in use.
Members
- message
-
- Type: string
The message for the exception.
ResourceNotFoundException
Description
The resource was not found.
Members
- message
-
- Type: string
The message for the exception.
RoutedResource
Description
Contains information about the routed resource.
Members
- arn
-
- Type: string
The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- name
-
- Type: string
The name of the routed resource.
SMSConfiguration
Description
Contains the configuration information of SMS notifications.
Members
- additionalMessage
-
- Type: string
The message that you want to send. The message can be up to 200 characters.
- recipients
-
- Required: Yes
- Type: Array of RecipientDetail structures
Specifies one or more recipients who receive the message.
You must add the users that receive SMS messages to your AWS SSO store.
- senderId
-
- Type: string
The sender ID.
SNSTopicPublishAction
Description
Information required to publish the Amazon SNS message.
Members
- payload
-
- Type: Payload structure
You can configure the action payload when you send a message as an Amazon SNS push notification.
- targetArn
-
- Required: Yes
- Type: string
The ARN of the Amazon SNS target where the message is sent.
SSOIdentity
Description
Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide.
Members
- identityStoreId
-
- Required: Yes
- Type: string
The ID of the AWS SSO identity store.
- userId
-
- Type: string
The user ID.
ServiceUnavailableException
Description
The service is currently unavailable.
Members
- message
-
- Type: string
The message for the exception.
SetTimerAction
Description
Information needed to set the timer.
Members
- durationExpression
-
- Type: string
The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (
$variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number. - seconds
-
- Type: int
The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
- timerName
-
- Required: Yes
- Type: string
The name of the timer.
SetVariableAction
Description
Information about the variable and its new value.
Members
- value
-
- Required: Yes
- Type: string
The new value of the variable.
- variableName
-
- Required: Yes
- Type: string
The name of the variable.
SimpleRule
Description
A rule that compares an input property value to a threshold value with a comparison operator.
Members
- comparisonOperator
-
- Required: Yes
- Type: string
The comparison operator.
- inputProperty
-
- Required: Yes
- Type: string
The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
- threshold
-
- Required: Yes
- Type: string
The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
SqsAction
Description
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
Members
- payload
-
- Type: Payload structure
You can configure the action payload when you send a message to an Amazon SQS queue.
- queueUrl
-
- Required: Yes
- Type: string
The URL of the SQS queue where the data is written.
- useBase64
-
- Type: boolean
Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
State
Description
Information that defines a state of a detector.
Members
- onEnter
-
- Type: OnEnterLifecycle structure
When entering this state, perform these
actionsif theconditionis TRUE. - onExit
-
- Type: OnExitLifecycle structure
When exiting this state, perform these
actionsif the specifiedconditionisTRUE. - onInput
-
- Type: OnInputLifecycle structure
When an input is received and the
conditionis TRUE, perform the specifiedactions. - stateName
-
- Required: Yes
- Type: string
The name of the state.
Tag
Description
Metadata that can be used to manage the resource.
Members
- key
-
- Required: Yes
- Type: string
The tag's key.
- value
-
- Required: Yes
- Type: string
The tag's value.
ThrottlingException
Description
The request could not be completed due to throttling.
Members
- message
-
- Type: string
The message for the exception.
TransitionEvent
Description
Specifies the actions performed and the next state entered when a condition evaluates to TRUE.
Members
- actions
-
- Type: Array of Action structures
The actions to be performed.
- condition
-
- Required: Yes
- Type: string
Required. A Boolean expression that when TRUE causes the actions to be performed and the
nextStateto be entered. - eventName
-
- Required: Yes
- Type: string
The name of the transition event.
- nextState
-
- Required: Yes
- Type: string
The next state to enter.
UnsupportedOperationException
Description
The requested operation is not supported.
Members
- message
-
- Type: string
The message for the exception.