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 */).
- CreateDetectorModel ( array $params = [] )
Creates a detector model.
- CreateInput ( array $params = [] )
Creates an input.
- DeleteDetectorModel ( array $params = [] )
Deletes a detector model.
- DeleteInput ( array $params = [] )
Deletes an input.
- DescribeDetectorModel ( array $params = [] )
Describes a detector model.
- DescribeInput ( array $params = [] )
Describes an input.
- DescribeLoggingOptions ( array $params = [] )
Retrieves the current settings of the AWS IoT Events logging options.
- ListDetectorModelVersions ( array $params = [] )
Lists all the versions of a detector model.
- ListDetectorModels ( array $params = [] )
Lists the detector models you have created.
- 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.
- TagResource ( array $params = [] )
Adds to or modifies the tags of the given resource.
- UntagResource ( array $params = [] )
Removes the given tags (metadata) from the resource.
- UpdateDetectorModel ( array $params = [] )
Updates a detector model.
- UpdateInput ( array $params = [] )
Updates an input.
Operations
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
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onExit' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onInput' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
'transitionEvents' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'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
-
The request was invalid.
-
The resource is in use.
-
ResourceAlreadyExistsException:
The resource already exists.
-
A limit was exceeded.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
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
-
The request was invalid.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
-
ResourceAlreadyExistsException:
The resource already exists.
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
Result Syntax
[]
Result Details
Errors
-
The request was invalid.
-
The resource is in use.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
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
Result Syntax
[]
Result Details
Errors
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The resource is in use.
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
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>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
],
'lambda' => [
'functionArn' => '<string>',
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'targetArn' => '<string>',
],
'sqs' => [
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>',
],
// ...
],
],
'onExit' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
],
'lambda' => [
'functionArn' => '<string>',
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'targetArn' => '<string>',
],
'sqs' => [
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>',
],
// ...
],
],
'onInput' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
],
'lambda' => [
'functionArn' => '<string>',
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'targetArn' => '<string>',
],
'sqs' => [
'queueUrl' => '<string>',
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>',
],
// ...
],
'transitionEvents' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>',
],
'iotTopicPublish' => [
'mqttTopic' => '<string>',
],
'lambda' => [
'functionArn' => '<string>',
],
'resetTimer' => [
'timerName' => '<string>',
],
'setTimer' => [
'seconds' => <integer>,
'timerName' => '<string>',
],
'setVariable' => [
'value' => '<string>',
'variableName' => '<string>',
],
'sns' => [
'targetArn' => '<string>',
],
'sqs' => [
'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
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
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
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
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
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
-
The request was invalid.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The resource was not found.
-
The service is currently unavailable.
-
UnsupportedOperationException:
The requested operation is not supported.
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
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
A token to retrieve the next set of results, or
nullif there are no additional results.
Errors
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
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
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
A token to retrieve the next set of results, or
nullif there are no additional results.
Errors
-
The request was invalid.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
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
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
A token to retrieve the next set of results, or
nullif there are no additional results.
Errors
-
The request was invalid.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
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
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
-
The request was invalid.
-
The resource was not found.
-
The resource is in use.
-
The request could not be completed due to throttling.
-
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
-
The request was invalid.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
-
UnsupportedOperationException:
The requested operation is not supported.
-
The resource is in use.
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
-
The request was invalid.
-
The resource was not found.
-
The resource is in use.
-
The request could not be completed due to throttling.
-
A limit was exceeded.
-
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
Result Syntax
[]
Result Details
Errors
-
The request was invalid.
-
The resource was not found.
-
The resource is in use.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
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
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onExit' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
],
'onInput' => [
'events' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'queueUrl' => '<string>', // REQUIRED
'useBase64' => true || false,
],
],
// ...
],
'condition' => '<string>',
'eventName' => '<string>', // REQUIRED
],
// ...
],
'transitionEvents' => [
[
'actions' => [
[
'clearTimer' => [
'timerName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
'separator' => '<string>',
],
'iotEvents' => [
'inputName' => '<string>', // REQUIRED
],
'iotTopicPublish' => [
'mqttTopic' => '<string>', // REQUIRED
],
'lambda' => [
'functionArn' => '<string>', // REQUIRED
],
'resetTimer' => [
'timerName' => '<string>', // REQUIRED
],
'setTimer' => [
'seconds' => <integer>, // REQUIRED
'timerName' => '<string>', // REQUIRED
],
'setVariable' => [
'value' => '<string>', // REQUIRED
'variableName' => '<string>', // REQUIRED
],
'sns' => [
'targetArn' => '<string>', // REQUIRED
],
'sqs' => [
'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
-
The request was invalid.
-
The resource is in use.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
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
-
The request was invalid.
-
The request could not be completed due to throttling.
-
The resource was not found.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The resource is in use.
Shapes
Action
Description
An action to be performed when the condition is TRUE.
Members
- clearTimer
-
- Type: ClearTimerAction structure
Information needed to clear the timer.
- 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.
- 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.
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
DetectorDebugOption
Description
The detector model and the specific detectors (instances) for which the logging level is given.
Members
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 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.
- 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
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.
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.
- 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).
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.
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
InvalidRequestException
IotEventsAction
Description
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
Members
IotTopicPublishAction
Description
Information required to publish the MQTT message through the AWS IoT message broker.
Members
LambdaAction
Description
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
Members
LimitExceededException
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.
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
conditionis TRUE.
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 theconditionis TRUE.
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.
ResetTimerAction
Description
Information needed to reset the timer.
Members
ResourceAlreadyExistsException
Description
The resource already exists.
Members
ResourceInUseException
ResourceNotFoundException
SNSTopicPublishAction
Description
Information required to publish the Amazon SNS message.
Members
ServiceUnavailableException
Description
The service is currently unavailable.
Members
SetTimerAction
Description
Information needed to set the timer.
Members
SetVariableAction
Description
Information about the variable and its new value.
Members
SqsAction
Description
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
Members
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 specifiedconditionis TRUE. - 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
ThrottlingException
Description
The request could not be completed due to throttling.
Members
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.
