AWS IoT Analytics 2017-11-27
- Client: Aws\IoTAnalytics\IoTAnalyticsClient
- Service ID: iotanalytics
- Version: 2017-11-27
This page describes the parameters and results for the operations of the AWS IoT Analytics (2017-11-27), and shows how to use the Aws\IoTAnalytics\IoTAnalyticsClient object to call the described operations. This documentation is specific to the 2017-11-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 */).
- BatchPutMessage ( array $params = [] )
Sends messages to a channel.
- CancelPipelineReprocessing ( array $params = [] )
Cancels the reprocessing of data through the pipeline.
- CreateChannel ( array $params = [] )
Used to create a channel.
- CreateDataset ( array $params = [] )
Used to create a dataset.
- CreateDatasetContent ( array $params = [] )
Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
- CreateDatastore ( array $params = [] )
Creates a data store, which is a repository for messages.
- CreatePipeline ( array $params = [] )
Creates a pipeline.
- DeleteChannel ( array $params = [] )
Deletes the specified channel.
- DeleteDataset ( array $params = [] )
Deletes the specified dataset.
- DeleteDatasetContent ( array $params = [] )
Deletes the content of the specified dataset.
- DeleteDatastore ( array $params = [] )
Deletes the specified data store.
- DeletePipeline ( array $params = [] )
Deletes the specified pipeline.
- DescribeChannel ( array $params = [] )
Retrieves information about a channel.
- DescribeDataset ( array $params = [] )
Retrieves information about a dataset.
- DescribeDatastore ( array $params = [] )
Retrieves information about a data store.
- DescribeLoggingOptions ( array $params = [] )
Retrieves the current settings of the IoT Analytics logging options.
- DescribePipeline ( array $params = [] )
Retrieves information about a pipeline.
- GetDatasetContent ( array $params = [] )
Retrieves the contents of a dataset as presigned URIs.
- ListChannels ( array $params = [] )
Retrieves a list of channels.
- ListDatasetContents ( array $params = [] )
Lists information about dataset contents that have been created.
- ListDatasets ( array $params = [] )
Retrieves information about datasets.
- ListDatastores ( array $params = [] )
Retrieves a list of data stores.
- ListPipelines ( array $params = [] )
Retrieves a list of pipelines.
- ListTagsForResource ( array $params = [] )
Lists the tags (metadata) that you have assigned to the resource.
- PutLoggingOptions ( array $params = [] )
Sets or updates the IoT Analytics logging options.
- RunPipelineActivity ( array $params = [] )
Simulates the results of running a pipeline activity on a message payload.
- SampleChannelData ( array $params = [] )
Retrieves a sample of messages from the specified channel ingested during the specified timeframe.
- StartPipelineReprocessing ( array $params = [] )
Starts the reprocessing of raw message data through the pipeline.
- TagResource ( array $params = [] )
Adds to or modifies the tags of the given resource.
- UntagResource ( array $params = [] )
Removes the given tags (metadata) from the resource.
- UpdateChannel ( array $params = [] )
Used to update the settings of a channel.
- UpdateDataset ( array $params = [] )
Updates the settings of a dataset.
- UpdateDatastore ( array $params = [] )
Used to update the settings of a data store.
- UpdatePipeline ( array $params = [] )
Updates the settings of a pipeline.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchPutMessage
$result = $client->batchPutMessage([/* ... */]); $promise = $client->batchPutMessageAsync([/* ... */]);
Sends messages to a channel.
Parameter Syntax
$result = $client->batchPutMessage([
'channelName' => '<string>', // REQUIRED
'messages' => [ // REQUIRED
[
'messageId' => '<string>', // REQUIRED
'payload' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- channelName
-
- Required: Yes
- Type: string
The name of the channel where the messages are sent.
- messages
-
- Required: Yes
- Type: Array of Message structures
The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
The field names of message payloads (data) that you send to IoT Analytics:
-
Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
-
Must begin with an alphabetic character or single underscore (_).
-
Cannot contain hyphens (-).
-
In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
-
Cannot be more than 255 characters.
-
Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.
Result Syntax
[
'batchPutMessageErrorEntries' => [
[
'errorCode' => '<string>',
'errorMessage' => '<string>',
'messageId' => '<string>',
],
// ...
],
]
Result Details
Members
- batchPutMessageErrorEntries
-
- Type: Array of BatchPutMessageErrorEntry structures
A list of any errors encountered when sending the messages to the channel.
Errors
-
A resource with the specified name could not be found.
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
CancelPipelineReprocessing
$result = $client->cancelPipelineReprocessing([/* ... */]); $promise = $client->cancelPipelineReprocessingAsync([/* ... */]);
Cancels the reprocessing of data through the pipeline.
Parameter Syntax
$result = $client->cancelPipelineReprocessing([
'pipelineName' => '<string>', // REQUIRED
'reprocessingId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
A resource with the specified name could not be found.
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
CreateChannel
$result = $client->createChannel([/* ... */]); $promise = $client->createChannelAsync([/* ... */]);
Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
Parameter Syntax
$result = $client->createChannel([
'channelName' => '<string>', // REQUIRED
'channelStorage' => [
'customerManagedS3' => [
'bucket' => '<string>', // REQUIRED
'keyPrefix' => '<string>',
'roleArn' => '<string>', // REQUIRED
],
'serviceManagedS3' => [
],
],
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- channelName
-
- Required: Yes
- Type: string
The name of the channel.
- channelStorage
-
- Type: ChannelStorage structure
Where channel data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You can't change this storage option after the channel is created. - retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the channel. When
customerManagedS3storage is selected, this parameter is ignored. - tags
-
- Type: Array of Tag structures
Metadata which can be used to manage the channel.
Result Syntax
[
'channelArn' => '<string>',
'channelName' => '<string>',
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
]
Result Details
Members
- channelArn
-
- Type: string
The ARN of the channel.
- channelName
-
- Type: string
The name of the channel.
- retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the channel.
Errors
-
The request was not valid.
-
ResourceAlreadyExistsException:
A resource with the same name already exists.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
CreateDataset
$result = $client->createDataset([/* ... */]); $promise = $client->createDatasetAsync([/* ... */]);
Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.
Parameter Syntax
$result = $client->createDataset([
'actions' => [ // REQUIRED
[
'actionName' => '<string>',
'containerAction' => [
'executionRoleArn' => '<string>', // REQUIRED
'image' => '<string>', // REQUIRED
'resourceConfiguration' => [ // REQUIRED
'computeType' => 'ACU_1|ACU_2', // REQUIRED
'volumeSizeInGB' => <integer>, // REQUIRED
],
'variables' => [
[
'datasetContentVersionValue' => [
'datasetName' => '<string>', // REQUIRED
],
'doubleValue' => <float>,
'name' => '<string>', // REQUIRED
'outputFileUriValue' => [
'fileName' => '<string>', // REQUIRED
],
'stringValue' => '<string>',
],
// ...
],
],
'queryAction' => [
'filters' => [
[
'deltaTime' => [
'offsetSeconds' => <integer>, // REQUIRED
'timeExpression' => '<string>', // REQUIRED
],
],
// ...
],
'sqlQuery' => '<string>', // REQUIRED
],
],
// ...
],
'contentDeliveryRules' => [
[
'destination' => [ // REQUIRED
'iotEventsDestinationConfiguration' => [
'inputName' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
's3DestinationConfiguration' => [
'bucket' => '<string>', // REQUIRED
'glueConfiguration' => [
'databaseName' => '<string>', // REQUIRED
'tableName' => '<string>', // REQUIRED
],
'key' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
],
'entryName' => '<string>',
],
// ...
],
'datasetName' => '<string>', // REQUIRED
'lateDataRules' => [
[
'ruleConfiguration' => [ // REQUIRED
'deltaTimeSessionWindowConfiguration' => [
'timeoutInMinutes' => <integer>, // REQUIRED
],
],
'ruleName' => '<string>',
],
// ...
],
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'triggers' => [
[
'dataset' => [
'name' => '<string>', // REQUIRED
],
'schedule' => [
'expression' => '<string>',
],
],
// ...
],
'versioningConfiguration' => [
'maxVersions' => <integer>,
'unlimited' => true || false,
],
]);
Parameter Details
Members
- actions
-
- Required: Yes
- Type: Array of DatasetAction structures
A list of actions that create the dataset contents.
- contentDeliveryRules
-
- Type: Array of DatasetContentDeliveryRule structures
When dataset contents are created, they are delivered to destinations specified here.
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset.
- lateDataRules
-
- Type: Array of LateDataRule structures
A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
lateDataRules, the dataset must use a DeltaTimer filter. - retentionPeriod
-
- Type: RetentionPeriod structure
Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to
null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by theversioningConfigurationparameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide. - tags
-
- Type: Array of Tag structures
Metadata which can be used to manage the dataset.
- triggers
-
- Type: Array of DatasetTrigger structures
A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five
DataSetTriggerobjects. - versioningConfiguration
-
- Type: VersioningConfiguration structure
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the
retentionPeriodparameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
Result Syntax
[
'datasetArn' => '<string>',
'datasetName' => '<string>',
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
]
Result Details
Members
- datasetArn
-
- Type: string
The ARN of the dataset.
- datasetName
-
- Type: string
The name of the dataset.
- retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, dataset contents are kept for the dataset.
Errors
-
The request was not valid.
-
ResourceAlreadyExistsException:
A resource with the same name already exists.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
CreateDatasetContent
$result = $client->createDatasetContent([/* ... */]); $promise = $client->createDatasetContentAsync([/* ... */]);
Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
Parameter Syntax
$result = $client->createDatasetContent([
'datasetName' => '<string>', // REQUIRED
'versionId' => '<string>',
]);
Parameter Details
Members
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset.
- versionId
-
- Type: string
The version ID of the dataset content. To specify
versionIdfor a dataset content, the dataset must use a DeltaTimer filter.
Result Syntax
[
'versionId' => '<string>',
]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
CreateDatastore
$result = $client->createDatastore([/* ... */]); $promise = $client->createDatastoreAsync([/* ... */]);
Creates a data store, which is a repository for messages.
Parameter Syntax
$result = $client->createDatastore([
'datastoreName' => '<string>', // REQUIRED
'datastorePartitions' => [
'partitions' => [
[
'attributePartition' => [
'attributeName' => '<string>', // REQUIRED
],
'timestampPartition' => [
'attributeName' => '<string>', // REQUIRED
'timestampFormat' => '<string>',
],
],
// ...
],
],
'datastoreStorage' => [
'customerManagedS3' => [
'bucket' => '<string>', // REQUIRED
'keyPrefix' => '<string>',
'roleArn' => '<string>', // REQUIRED
],
'iotSiteWiseMultiLayerStorage' => [
'customerManagedS3Storage' => [ // REQUIRED
'bucket' => '<string>', // REQUIRED
'keyPrefix' => '<string>',
],
],
'serviceManagedS3' => [
],
],
'fileFormatConfiguration' => [
'jsonConfiguration' => [
],
'parquetConfiguration' => [
'schemaDefinition' => [
'columns' => [
[
'name' => '<string>', // REQUIRED
'type' => '<string>', // REQUIRED
],
// ...
],
],
],
],
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- datastoreName
-
- Required: Yes
- Type: string
The name of the data store.
- datastorePartitions
-
- Type: DatastorePartitions structure
Contains information about the partition dimensions in a data store.
- datastoreStorage
-
- Type: DatastoreStorage structure
Where data in a data store is stored.. You can choose
serviceManagedS3storage,customerManagedS3storage, oriotSiteWiseMultiLayerStoragestorage. The default isserviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created. - fileFormatConfiguration
-
- Type: FileFormatConfiguration structure
Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
- retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the data store. When
customerManagedS3storage is selected, this parameter is ignored. - tags
-
- Type: Array of Tag structures
Metadata which can be used to manage the data store.
Result Syntax
[
'datastoreArn' => '<string>',
'datastoreName' => '<string>',
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
]
Result Details
Members
- datastoreArn
-
- Type: string
The ARN of the data store.
- datastoreName
-
- Type: string
The name of the data store.
- retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the data store.
Errors
-
The request was not valid.
-
ResourceAlreadyExistsException:
A resource with the same name already exists.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
CreatePipeline
$result = $client->createPipeline([/* ... */]); $promise = $client->createPipelineAsync([/* ... */]);
Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
Parameter Syntax
$result = $client->createPipeline([
'pipelineActivities' => [ // REQUIRED
[
'addAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'channel' => [
'channelName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'datastore' => [
'datastoreName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
],
'deviceRegistryEnrich' => [
'attribute' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
'roleArn' => '<string>', // REQUIRED
'thingName' => '<string>', // REQUIRED
],
'deviceShadowEnrich' => [
'attribute' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
'roleArn' => '<string>', // REQUIRED
'thingName' => '<string>', // REQUIRED
],
'filter' => [
'filter' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'lambda' => [
'batchSize' => <integer>, // REQUIRED
'lambdaName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'math' => [
'attribute' => '<string>', // REQUIRED
'math' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'removeAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'selectAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
],
// ...
],
'pipelineName' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- pipelineActivities
-
- Required: Yes
- Type: Array of PipelineActivity structures
A list of
PipelineActivityobjects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda unctions on messages for advanced processing; or performing mathematical transformations to normalize device data.The list can be 2-25
PipelineActivityobjects and must contain both achanneland adatastoreactivity. Each entry in the list must contain only one activity. For example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ] - pipelineName
-
- Required: Yes
- Type: string
The name of the pipeline.
- tags
-
- Type: Array of Tag structures
Metadata which can be used to manage the pipeline.
Result Syntax
[
'pipelineArn' => '<string>',
'pipelineName' => '<string>',
]
Result Details
Members
Errors
-
The request was not valid.
-
ResourceAlreadyExistsException:
A resource with the same name already exists.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
DeleteChannel
$result = $client->deleteChannel([/* ... */]); $promise = $client->deleteChannelAsync([/* ... */]);
Deletes the specified channel.
Parameter Syntax
$result = $client->deleteChannel([
'channelName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DeleteDataset
$result = $client->deleteDataset([/* ... */]); $promise = $client->deleteDatasetAsync([/* ... */]);
Deletes the specified dataset.
You do not have to delete the content of the dataset before you perform this operation.
Parameter Syntax
$result = $client->deleteDataset([
'datasetName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DeleteDatasetContent
$result = $client->deleteDatasetContent([/* ... */]); $promise = $client->deleteDatasetContentAsync([/* ... */]);
Deletes the content of the specified dataset.
Parameter Syntax
$result = $client->deleteDatasetContent([
'datasetName' => '<string>', // REQUIRED
'versionId' => '<string>',
]);
Parameter Details
Members
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset whose content is deleted.
- versionId
-
- Type: string
The version of the dataset whose content is deleted. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default.
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DeleteDatastore
$result = $client->deleteDatastore([/* ... */]); $promise = $client->deleteDatastoreAsync([/* ... */]);
Deletes the specified data store.
Parameter Syntax
$result = $client->deleteDatastore([
'datastoreName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DeletePipeline
$result = $client->deletePipeline([/* ... */]); $promise = $client->deletePipelineAsync([/* ... */]);
Deletes the specified pipeline.
Parameter Syntax
$result = $client->deletePipeline([
'pipelineName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DescribeChannel
$result = $client->describeChannel([/* ... */]); $promise = $client->describeChannelAsync([/* ... */]);
Retrieves information about a channel.
Parameter Syntax
$result = $client->describeChannel([
'channelName' => '<string>', // REQUIRED
'includeStatistics' => true || false,
]);
Parameter Details
Members
Result Syntax
[
'channel' => [
'arn' => '<string>',
'creationTime' => <DateTime>,
'lastMessageArrivalTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
'status' => 'CREATING|ACTIVE|DELETING',
'storage' => [
'customerManagedS3' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
'roleArn' => '<string>',
],
'serviceManagedS3' => [
],
],
],
'statistics' => [
'size' => [
'estimatedOn' => <DateTime>,
'estimatedSizeInBytes' => <float>,
],
],
]
Result Details
Members
- channel
-
- Type: Channel structure
An object that contains information about the channel.
- statistics
-
- Type: ChannelStatistics structure
Statistics about the channel. Included if the
includeStatisticsparameter is set totruein the request.
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DescribeDataset
$result = $client->describeDataset([/* ... */]); $promise = $client->describeDatasetAsync([/* ... */]);
Retrieves information about a dataset.
Parameter Syntax
$result = $client->describeDataset([
'datasetName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'dataset' => [
'actions' => [
[
'actionName' => '<string>',
'containerAction' => [
'executionRoleArn' => '<string>',
'image' => '<string>',
'resourceConfiguration' => [
'computeType' => 'ACU_1|ACU_2',
'volumeSizeInGB' => <integer>,
],
'variables' => [
[
'datasetContentVersionValue' => [
'datasetName' => '<string>',
],
'doubleValue' => <float>,
'name' => '<string>',
'outputFileUriValue' => [
'fileName' => '<string>',
],
'stringValue' => '<string>',
],
// ...
],
],
'queryAction' => [
'filters' => [
[
'deltaTime' => [
'offsetSeconds' => <integer>,
'timeExpression' => '<string>',
],
],
// ...
],
'sqlQuery' => '<string>',
],
],
// ...
],
'arn' => '<string>',
'contentDeliveryRules' => [
[
'destination' => [
'iotEventsDestinationConfiguration' => [
'inputName' => '<string>',
'roleArn' => '<string>',
],
's3DestinationConfiguration' => [
'bucket' => '<string>',
'glueConfiguration' => [
'databaseName' => '<string>',
'tableName' => '<string>',
],
'key' => '<string>',
'roleArn' => '<string>',
],
],
'entryName' => '<string>',
],
// ...
],
'creationTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'lateDataRules' => [
[
'ruleConfiguration' => [
'deltaTimeSessionWindowConfiguration' => [
'timeoutInMinutes' => <integer>,
],
],
'ruleName' => '<string>',
],
// ...
],
'name' => '<string>',
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
'status' => 'CREATING|ACTIVE|DELETING',
'triggers' => [
[
'dataset' => [
'name' => '<string>',
],
'schedule' => [
'expression' => '<string>',
],
],
// ...
],
'versioningConfiguration' => [
'maxVersions' => <integer>,
'unlimited' => true || false,
],
],
]
Result Details
Members
- dataset
-
- Type: Dataset structure
An object that contains information about the dataset.
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DescribeDatastore
$result = $client->describeDatastore([/* ... */]); $promise = $client->describeDatastoreAsync([/* ... */]);
Retrieves information about a data store.
Parameter Syntax
$result = $client->describeDatastore([
'datastoreName' => '<string>', // REQUIRED
'includeStatistics' => true || false,
]);
Parameter Details
Members
Result Syntax
[
'datastore' => [
'arn' => '<string>',
'creationTime' => <DateTime>,
'datastorePartitions' => [
'partitions' => [
[
'attributePartition' => [
'attributeName' => '<string>',
],
'timestampPartition' => [
'attributeName' => '<string>',
'timestampFormat' => '<string>',
],
],
// ...
],
],
'fileFormatConfiguration' => [
'jsonConfiguration' => [
],
'parquetConfiguration' => [
'schemaDefinition' => [
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
],
// ...
],
],
],
],
'lastMessageArrivalTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
'status' => 'CREATING|ACTIVE|DELETING',
'storage' => [
'customerManagedS3' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
'roleArn' => '<string>',
],
'iotSiteWiseMultiLayerStorage' => [
'customerManagedS3Storage' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
],
],
'serviceManagedS3' => [
],
],
],
'statistics' => [
'size' => [
'estimatedOn' => <DateTime>,
'estimatedSizeInBytes' => <float>,
],
],
]
Result Details
Members
- datastore
-
- Type: Datastore structure
Information about the data store.
- statistics
-
- Type: DatastoreStatistics structure
Additional statistical information about the data store. Included if the
includeStatisticsparameter is set totruein the request.
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DescribeLoggingOptions
$result = $client->describeLoggingOptions([/* ... */]); $promise = $client->describeLoggingOptionsAsync([/* ... */]);
Retrieves the current settings of the IoT Analytics logging options.
Parameter Syntax
$result = $client->describeLoggingOptions([ ]);
Parameter Details
Members
Result Syntax
[
'loggingOptions' => [
'enabled' => true || false,
'level' => 'ERROR',
'roleArn' => '<string>',
],
]
Result Details
Members
- loggingOptions
-
- Type: LoggingOptions structure
The current settings of the IoT Analytics logging options.
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
DescribePipeline
$result = $client->describePipeline([/* ... */]); $promise = $client->describePipelineAsync([/* ... */]);
Retrieves information about a pipeline.
Parameter Syntax
$result = $client->describePipeline([
'pipelineName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'pipeline' => [
'activities' => [
[
'addAttributes' => [
'attributes' => ['<string>', ...],
'name' => '<string>',
'next' => '<string>',
],
'channel' => [
'channelName' => '<string>',
'name' => '<string>',
'next' => '<string>',
],
'datastore' => [
'datastoreName' => '<string>',
'name' => '<string>',
],
'deviceRegistryEnrich' => [
'attribute' => '<string>',
'name' => '<string>',
'next' => '<string>',
'roleArn' => '<string>',
'thingName' => '<string>',
],
'deviceShadowEnrich' => [
'attribute' => '<string>',
'name' => '<string>',
'next' => '<string>',
'roleArn' => '<string>',
'thingName' => '<string>',
],
'filter' => [
'filter' => '<string>',
'name' => '<string>',
'next' => '<string>',
],
'lambda' => [
'batchSize' => <integer>,
'lambdaName' => '<string>',
'name' => '<string>',
'next' => '<string>',
],
'math' => [
'attribute' => '<string>',
'math' => '<string>',
'name' => '<string>',
'next' => '<string>',
],
'removeAttributes' => [
'attributes' => ['<string>', ...],
'name' => '<string>',
'next' => '<string>',
],
'selectAttributes' => [
'attributes' => ['<string>', ...],
'name' => '<string>',
'next' => '<string>',
],
],
// ...
],
'arn' => '<string>',
'creationTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'reprocessingSummaries' => [
[
'creationTime' => <DateTime>,
'id' => '<string>',
'status' => 'RUNNING|SUCCEEDED|CANCELLED|FAILED',
],
// ...
],
],
]
Result Details
Members
- pipeline
-
- Type: Pipeline structure
A
Pipelineobject that contains information about the pipeline.
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
GetDatasetContent
$result = $client->getDatasetContent([/* ... */]); $promise = $client->getDatasetContentAsync([/* ... */]);
Retrieves the contents of a dataset as presigned URIs.
Parameter Syntax
$result = $client->getDatasetContent([
'datasetName' => '<string>', // REQUIRED
'versionId' => '<string>',
]);
Parameter Details
Members
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset whose contents are retrieved.
- versionId
-
- Type: string
The version of the dataset whose contents are retrieved. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the latest or latest successfully completed dataset. If not specified, "$LATEST_SUCCEEDED" is the default.
Result Syntax
[
'entries' => [
[
'dataURI' => '<string>',
'entryName' => '<string>',
],
// ...
],
'status' => [
'reason' => '<string>',
'state' => 'CREATING|SUCCEEDED|FAILED',
],
'timestamp' => <DateTime>,
]
Result Details
Members
- entries
-
- Type: Array of DatasetEntry structures
A list of
DatasetEntryobjects. - status
-
- Type: DatasetContentStatus structure
The status of the dataset content.
- timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the request was made.
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
ListChannels
$result = $client->listChannels([/* ... */]); $promise = $client->listChannelsAsync([/* ... */]);
Retrieves a list of channels.
Parameter Syntax
$result = $client->listChannels([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'channelSummaries' => [
[
'channelName' => '<string>',
'channelStorage' => [
'customerManagedS3' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
'roleArn' => '<string>',
],
'serviceManagedS3' => [
],
],
'creationTime' => <DateTime>,
'lastMessageArrivalTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'status' => 'CREATING|ACTIVE|DELETING',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- channelSummaries
-
- Type: Array of ChannelSummary structures
A list of
ChannelSummaryobjects. - nextToken
-
- Type: string
The token to retrieve the next set of results, or
nullif there are no more results.
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
ListDatasetContents
$result = $client->listDatasetContents([/* ... */]); $promise = $client->listDatasetContentsAsync([/* ... */]);
Lists information about dataset contents that have been created.
Parameter Syntax
$result = $client->listDatasetContents([
'datasetName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'scheduledBefore' => <integer || string || DateTime>,
'scheduledOnOrAfter' => <integer || string || DateTime>,
]);
Parameter Details
Members
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset whose contents information you want to list.
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
The token for the next set of results.
- scheduledBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter to limit results to those dataset contents whose creation is scheduled before the given time. See the field
triggers.schedulein theCreateDatasetrequest. (timestamp) - scheduledOnOrAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter to limit results to those dataset contents whose creation is scheduled on or after the given time. See the field
triggers.schedulein theCreateDatasetrequest. (timestamp)
Result Syntax
[
'datasetContentSummaries' => [
[
'completionTime' => <DateTime>,
'creationTime' => <DateTime>,
'scheduleTime' => <DateTime>,
'status' => [
'reason' => '<string>',
'state' => 'CREATING|SUCCEEDED|FAILED',
],
'version' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- datasetContentSummaries
-
- Type: Array of DatasetContentSummary structures
Summary information about dataset contents that have been created.
- nextToken
-
- Type: string
The token to retrieve the next set of results, or
nullif there are no more results.
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
A resource with the specified name could not be found.
ListDatasets
$result = $client->listDatasets([/* ... */]); $promise = $client->listDatasetsAsync([/* ... */]);
Retrieves information about datasets.
Parameter Syntax
$result = $client->listDatasets([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'datasetSummaries' => [
[
'actions' => [
[
'actionName' => '<string>',
'actionType' => 'QUERY|CONTAINER',
],
// ...
],
'creationTime' => <DateTime>,
'datasetName' => '<string>',
'lastUpdateTime' => <DateTime>,
'status' => 'CREATING|ACTIVE|DELETING',
'triggers' => [
[
'dataset' => [
'name' => '<string>',
],
'schedule' => [
'expression' => '<string>',
],
],
// ...
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- datasetSummaries
-
- Type: Array of DatasetSummary structures
A list of
DatasetSummaryobjects. - nextToken
-
- Type: string
The token to retrieve the next set of results, or
nullif there are no more results.
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
ListDatastores
$result = $client->listDatastores([/* ... */]); $promise = $client->listDatastoresAsync([/* ... */]);
Retrieves a list of data stores.
Parameter Syntax
$result = $client->listDatastores([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'datastoreSummaries' => [
[
'creationTime' => <DateTime>,
'datastoreName' => '<string>',
'datastorePartitions' => [
'partitions' => [
[
'attributePartition' => [
'attributeName' => '<string>',
],
'timestampPartition' => [
'attributeName' => '<string>',
'timestampFormat' => '<string>',
],
],
// ...
],
],
'datastoreStorage' => [
'customerManagedS3' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
'roleArn' => '<string>',
],
'iotSiteWiseMultiLayerStorage' => [
'customerManagedS3Storage' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
],
],
'serviceManagedS3' => [
],
],
'fileFormatType' => 'JSON|PARQUET',
'lastMessageArrivalTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'status' => 'CREATING|ACTIVE|DELETING',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- datastoreSummaries
-
- Type: Array of DatastoreSummary structures
A list of
DatastoreSummaryobjects. - nextToken
-
- Type: string
The token to retrieve the next set of results, or
nullif there are no more results.
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
ListPipelines
$result = $client->listPipelines([/* ... */]); $promise = $client->listPipelinesAsync([/* ... */]);
Retrieves a list of pipelines.
Parameter Syntax
$result = $client->listPipelines([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'pipelineSummaries' => [
[
'creationTime' => <DateTime>,
'lastUpdateTime' => <DateTime>,
'pipelineName' => '<string>',
'reprocessingSummaries' => [
[
'creationTime' => <DateTime>,
'id' => '<string>',
'status' => 'RUNNING|SUCCEEDED|CANCELLED|FAILED',
],
// ...
],
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token to retrieve the next set of results, or
nullif there are no more results. - pipelineSummaries
-
- Type: Array of PipelineSummary structures
A list of
PipelineSummaryobjects.
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags (metadata) that 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 tags (metadata) that you have assigned to the resource.
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
-
A resource with the specified name could not be found.
PutLoggingOptions
$result = $client->putLoggingOptions([/* ... */]); $promise = $client->putLoggingOptionsAsync([/* ... */]);
Sets or updates the IoT Analytics logging options.
If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, 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
'enabled' => true || false, // REQUIRED
'level' => 'ERROR', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- loggingOptions
-
- Required: Yes
- Type: LoggingOptions structure
The new values of the IoT Analytics logging options.
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
RunPipelineActivity
$result = $client->runPipelineActivity([/* ... */]); $promise = $client->runPipelineActivityAsync([/* ... */]);
Simulates the results of running a pipeline activity on a message payload.
Parameter Syntax
$result = $client->runPipelineActivity([
'payloads' => [<string || resource || Psr\Http\Message\StreamInterface>, ...], // REQUIRED
'pipelineActivity' => [ // REQUIRED
'addAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'channel' => [
'channelName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'datastore' => [
'datastoreName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
],
'deviceRegistryEnrich' => [
'attribute' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
'roleArn' => '<string>', // REQUIRED
'thingName' => '<string>', // REQUIRED
],
'deviceShadowEnrich' => [
'attribute' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
'roleArn' => '<string>', // REQUIRED
'thingName' => '<string>', // REQUIRED
],
'filter' => [
'filter' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'lambda' => [
'batchSize' => <integer>, // REQUIRED
'lambdaName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'math' => [
'attribute' => '<string>', // REQUIRED
'math' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'removeAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'selectAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
],
]);
Parameter Details
Members
- payloads
-
- Required: Yes
- Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s
The sample message payloads on which the pipeline activity is run.
- pipelineActivity
-
- Required: Yes
- Type: PipelineActivity structure
The pipeline activity that is run. This must not be a channel activity or a data store activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a Lambda activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.
Result Syntax
[
'logResult' => '<string>',
'payloads' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
]
Result Details
Members
- logResult
-
- Type: string
In case the pipeline activity fails, the log message that is generated.
- payloads
-
- Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s
The enriched or transformed sample message payloads as base64-encoded strings. (The results of running the pipeline activity on each input sample message payload, encoded in base64.)
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
SampleChannelData
$result = $client->sampleChannelData([/* ... */]); $promise = $client->sampleChannelDataAsync([/* ... */]);
Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
Parameter Syntax
$result = $client->sampleChannelData([
'channelName' => '<string>', // REQUIRED
'endTime' => <integer || string || DateTime>,
'maxMessages' => <integer>,
'startTime' => <integer || string || DateTime>,
]);
Parameter Details
Members
- channelName
-
- Required: Yes
- Type: string
The name of the channel whose message samples are retrieved.
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time window from which sample messages are retrieved.
- maxMessages
-
- Type: int
The number of sample messages to be retrieved. The limit is 10. The default is also 10.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time window from which sample messages are retrieved.
Result Syntax
[
'payloads' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
]
Result Details
Members
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
StartPipelineReprocessing
$result = $client->startPipelineReprocessing([/* ... */]); $promise = $client->startPipelineReprocessingAsync([/* ... */]);
Starts the reprocessing of raw message data through the pipeline.
Parameter Syntax
$result = $client->startPipelineReprocessing([
'channelMessages' => [
's3Paths' => ['<string>', ...],
],
'endTime' => <integer || string || DateTime>,
'pipelineName' => '<string>', // REQUIRED
'startTime' => <integer || string || DateTime>,
]);
Parameter Details
Members
- channelMessages
-
- Type: ChannelMessages structure
Specifies one or more sets of channel messages that you want to reprocess.
If you use the
channelMessagesobject, you must not specify a value forstartTimeandendTime. - endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time (exclusive) of raw message data that is reprocessed.
If you specify a value for the
endTimeparameter, you must not use thechannelMessagesobject. - pipelineName
-
- Required: Yes
- Type: string
The name of the pipeline on which to start reprocessing.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time (inclusive) of raw message data that is reprocessed.
If you specify a value for the
startTimeparameter, you must not use thechannelMessagesobject.
Result Syntax
[
'reprocessingId' => '<string>',
]
Result Details
Errors
-
A resource with the specified name could not be found.
-
ResourceAlreadyExistsException:
A resource with the same name already exists.
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
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 whose tags you want to modify.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The new or modified tags for the resource.
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
-
A resource with the specified name could not be found.
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 not valid.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
-
A resource with the specified name could not be found.
UpdateChannel
$result = $client->updateChannel([/* ... */]); $promise = $client->updateChannelAsync([/* ... */]);
Used to update the settings of a channel.
Parameter Syntax
$result = $client->updateChannel([
'channelName' => '<string>', // REQUIRED
'channelStorage' => [
'customerManagedS3' => [
'bucket' => '<string>', // REQUIRED
'keyPrefix' => '<string>',
'roleArn' => '<string>', // REQUIRED
],
'serviceManagedS3' => [
],
],
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
]);
Parameter Details
Members
- channelName
-
- Required: Yes
- Type: string
The name of the channel to be updated.
- channelStorage
-
- Type: ChannelStorage structure
Where channel data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You can't change this storage option after the channel is created. - retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the channel. The retention period can't be updated if the channel's Amazon S3 storage is customer-managed.
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
UpdateDataset
$result = $client->updateDataset([/* ... */]); $promise = $client->updateDatasetAsync([/* ... */]);
Updates the settings of a dataset.
Parameter Syntax
$result = $client->updateDataset([
'actions' => [ // REQUIRED
[
'actionName' => '<string>',
'containerAction' => [
'executionRoleArn' => '<string>', // REQUIRED
'image' => '<string>', // REQUIRED
'resourceConfiguration' => [ // REQUIRED
'computeType' => 'ACU_1|ACU_2', // REQUIRED
'volumeSizeInGB' => <integer>, // REQUIRED
],
'variables' => [
[
'datasetContentVersionValue' => [
'datasetName' => '<string>', // REQUIRED
],
'doubleValue' => <float>,
'name' => '<string>', // REQUIRED
'outputFileUriValue' => [
'fileName' => '<string>', // REQUIRED
],
'stringValue' => '<string>',
],
// ...
],
],
'queryAction' => [
'filters' => [
[
'deltaTime' => [
'offsetSeconds' => <integer>, // REQUIRED
'timeExpression' => '<string>', // REQUIRED
],
],
// ...
],
'sqlQuery' => '<string>', // REQUIRED
],
],
// ...
],
'contentDeliveryRules' => [
[
'destination' => [ // REQUIRED
'iotEventsDestinationConfiguration' => [
'inputName' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
's3DestinationConfiguration' => [
'bucket' => '<string>', // REQUIRED
'glueConfiguration' => [
'databaseName' => '<string>', // REQUIRED
'tableName' => '<string>', // REQUIRED
],
'key' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
],
'entryName' => '<string>',
],
// ...
],
'datasetName' => '<string>', // REQUIRED
'lateDataRules' => [
[
'ruleConfiguration' => [ // REQUIRED
'deltaTimeSessionWindowConfiguration' => [
'timeoutInMinutes' => <integer>, // REQUIRED
],
],
'ruleName' => '<string>',
],
// ...
],
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
'triggers' => [
[
'dataset' => [
'name' => '<string>', // REQUIRED
],
'schedule' => [
'expression' => '<string>',
],
],
// ...
],
'versioningConfiguration' => [
'maxVersions' => <integer>,
'unlimited' => true || false,
],
]);
Parameter Details
Members
- actions
-
- Required: Yes
- Type: Array of DatasetAction structures
A list of
DatasetActionobjects. - contentDeliveryRules
-
- Type: Array of DatasetContentDeliveryRule structures
When dataset contents are created, they are delivered to destinations specified here.
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset to update.
- lateDataRules
-
- Type: Array of LateDataRule structures
A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
lateDataRules, the dataset must use a DeltaTimer filter. - retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, dataset contents are kept for the dataset.
- triggers
-
- Type: Array of DatasetTrigger structures
A list of
DatasetTriggerobjects. The list can be empty or can contain up to fiveDatasetTriggerobjects. - versioningConfiguration
-
- Type: VersioningConfiguration structure
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the
retentionPeriodparameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
UpdateDatastore
$result = $client->updateDatastore([/* ... */]); $promise = $client->updateDatastoreAsync([/* ... */]);
Used to update the settings of a data store.
Parameter Syntax
$result = $client->updateDatastore([
'datastoreName' => '<string>', // REQUIRED
'datastoreStorage' => [
'customerManagedS3' => [
'bucket' => '<string>', // REQUIRED
'keyPrefix' => '<string>',
'roleArn' => '<string>', // REQUIRED
],
'iotSiteWiseMultiLayerStorage' => [
'customerManagedS3Storage' => [ // REQUIRED
'bucket' => '<string>', // REQUIRED
'keyPrefix' => '<string>',
],
],
'serviceManagedS3' => [
],
],
'fileFormatConfiguration' => [
'jsonConfiguration' => [
],
'parquetConfiguration' => [
'schemaDefinition' => [
'columns' => [
[
'name' => '<string>', // REQUIRED
'type' => '<string>', // REQUIRED
],
// ...
],
],
],
],
'retentionPeriod' => [
'numberOfDays' => <integer>,
'unlimited' => true || false,
],
]);
Parameter Details
Members
- datastoreName
-
- Required: Yes
- Type: string
The name of the data store to be updated.
- datastoreStorage
-
- Type: DatastoreStorage structure
Where data in a data store is stored.. You can choose
serviceManagedS3storage,customerManagedS3storage, oriotSiteWiseMultiLayerStoragestorage. The default isserviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created. - fileFormatConfiguration
-
- Type: FileFormatConfiguration structure
Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
- retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the data store. The retention period can't be updated if the data store's Amazon S3 storage is customer-managed.
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
UpdatePipeline
$result = $client->updatePipeline([/* ... */]); $promise = $client->updatePipelineAsync([/* ... */]);
Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
Parameter Syntax
$result = $client->updatePipeline([
'pipelineActivities' => [ // REQUIRED
[
'addAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'channel' => [
'channelName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'datastore' => [
'datastoreName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
],
'deviceRegistryEnrich' => [
'attribute' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
'roleArn' => '<string>', // REQUIRED
'thingName' => '<string>', // REQUIRED
],
'deviceShadowEnrich' => [
'attribute' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
'roleArn' => '<string>', // REQUIRED
'thingName' => '<string>', // REQUIRED
],
'filter' => [
'filter' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'lambda' => [
'batchSize' => <integer>, // REQUIRED
'lambdaName' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'math' => [
'attribute' => '<string>', // REQUIRED
'math' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'removeAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
'selectAttributes' => [
'attributes' => ['<string>', ...], // REQUIRED
'name' => '<string>', // REQUIRED
'next' => '<string>',
],
],
// ...
],
'pipelineName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- pipelineActivities
-
- Required: Yes
- Type: Array of PipelineActivity structures
A list of
PipelineActivityobjects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data.The list can be 2-25
PipelineActivityobjects and must contain both achanneland adatastoreactivity. Each entry in the list must contain only one activity. For example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ] - pipelineName
-
- Required: Yes
- Type: string
The name of the pipeline to update.
Result Syntax
[]
Result Details
Errors
-
The request was not valid.
-
A resource with the specified name could not be found.
-
There was an internal failure.
-
The service is temporarily unavailable.
-
The request was denied due to request throttling.
-
The command caused an internal limit to be exceeded.
Shapes
AddAttributesActivity
Description
An activity that adds other attributes based on existing attributes in the message.
Members
- attributes
-
- Required: Yes
- Type: Associative array of custom strings keys (AttributeName) to strings
A list of 1-50
AttributeNameMappingobjects that map an existing attribute to a new attribute.The existing attributes remain in the message, so if you want to remove the originals, use
RemoveAttributeActivity. - name
-
- Required: Yes
- Type: string
The name of the addAttributes activity.
- next
-
- Type: string
The next activity in the pipeline.
BatchPutMessageErrorEntry
Description
Contains informations about errors.
Members
Channel
Description
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
Members
- arn
-
- Type: string
The ARN of the channel.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the channel was created.
- lastMessageArrivalTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the
lastMessageArrivalTimevalue is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the channel was last updated.
- name
-
- Type: string
The name of the channel.
- retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the channel.
- status
-
- Type: string
The status of the channel.
- storage
-
- Type: ChannelStorage structure
Where channel data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You can't change this storage option after the channel is created.
ChannelActivity
Description
The activity that determines the source of the messages to be processed.
Members
ChannelMessages
Description
Specifies one or more sets of channel messages.
Members
- s3Paths
-
- Type: Array of strings
Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your channel messages.
You must use the full path for the key.
Example path:
channel/mychannel/__dt=2020-02-29 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz
ChannelStatistics
Description
Statistics information about the channel.
Members
- size
-
- Type: EstimatedResourceSize structure
The estimated size of the channel.
ChannelStorage
Description
Where channel data is stored. You may choose one of serviceManagedS3, customerManagedS3 storage. If not specified, the default is serviceManagedS3. This can't be changed after creation of the channel.
Members
- customerManagedS3
-
- Type: CustomerManagedChannelS3Storage structure
Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the
retentionPeriodparameter is ignored. You can't change the choice of S3 storage after the data store is created. - serviceManagedS3
-
- Type: ServiceManagedChannelS3Storage structure
Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.
ChannelStorageSummary
Description
Where channel data is stored.
Members
- customerManagedS3
-
- Type: CustomerManagedChannelS3StorageSummary structure
Used to store channel data in an S3 bucket that you manage.
- serviceManagedS3
-
- Type: ServiceManagedChannelS3StorageSummary structure
Used to store channel data in an S3 bucket managed by IoT Analytics.
ChannelSummary
Description
A summary of information about a channel.
Members
- channelName
-
- Type: string
The name of the channel.
- channelStorage
-
- Type: ChannelStorageSummary structure
Where channel data is stored.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the channel was created.
- lastMessageArrivalTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the
lastMessageArrivalTimevalue is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the channel was updated.
- status
-
- Type: string
The status of the channel.
Column
Description
Contains information about a column that stores your data.
Members
- name
-
- Required: Yes
- Type: string
The name of the column.
- type
-
- Required: Yes
- Type: string
The type of data. For more information about the supported data types, see Common data types in the Glue Developer Guide.
ContainerDatasetAction
Description
Information required to run the containerAction to produce dataset contents.
Members
- executionRoleArn
-
- Required: Yes
- Type: string
The ARN of the role that gives permission to the system to access required resources to run the
containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application. - image
-
- Required: Yes
- Type: string
The ARN of the Docker container stored in your account. The Docker container contains an application and required support libraries and is used to generate dataset contents.
- resourceConfiguration
-
- Required: Yes
- Type: ResourceConfiguration structure
Configuration of the resource that executes the
containerAction. - variables
-
- Type: Array of Variable structures
The values of variables used in the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of
stringValue,datasetContentVersionValue, oroutputFileUriValue.
CustomerManagedChannelS3Storage
Description
Used to store channel data in an S3 bucket that you manage. If customer-managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
Members
- bucket
-
- Required: Yes
- Type: string
The name of the S3 bucket in which channel data is stored.
- keyPrefix
-
- Type: string
(Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
- roleArn
-
- Required: Yes
- Type: string
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
CustomerManagedChannelS3StorageSummary
Description
Used to store channel data in an S3 bucket that you manage.
Members
- bucket
-
- Type: string
The name of the S3 bucket in which channel data is stored.
- keyPrefix
-
- Type: string
(Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).
- roleArn
-
- Type: string
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
CustomerManagedDatastoreS3Storage
Description
S3-customer-managed; When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
Members
- bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket where your data is stored.
- keyPrefix
-
- Type: string
(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
- roleArn
-
- Required: Yes
- Type: string
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
CustomerManagedDatastoreS3StorageSummary
Description
Contains information about the data store that you manage.
Members
- bucket
-
- Type: string
The name of the Amazon S3 bucket where your data is stored.
- keyPrefix
-
- Type: string
(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
- roleArn
-
- Type: string
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
Dataset
Description
Information about a dataset.
Members
- actions
-
- Type: Array of DatasetAction structures
The
DatasetActionobjects that automatically create the dataset contents. - arn
-
- Type: string
The ARN of the dataset.
- contentDeliveryRules
-
- Type: Array of DatasetContentDeliveryRule structures
When dataset contents are created they are delivered to destinations specified here.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the dataset was created.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the dataset was updated.
- lateDataRules
-
- Type: Array of LateDataRule structures
A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
lateDataRules, the dataset must use a DeltaTimer filter. - name
-
- Type: string
The name of the dataset.
- retentionPeriod
-
- Type: RetentionPeriod structure
Optional. How long, in days, message data is kept for the dataset.
- status
-
- Type: string
The status of the dataset.
- triggers
-
- Type: Array of DatasetTrigger structures
The
DatasetTriggerobjects that specify when the dataset is automatically updated. - versioningConfiguration
-
- Type: VersioningConfiguration structure
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the
retentionPeriodparameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
DatasetAction
Description
A DatasetAction object that specifies how dataset contents are automatically created.
Members
- actionName
-
- Type: string
The name of the dataset action by which dataset contents are automatically created.
- containerAction
-
- Type: ContainerDatasetAction structure
Information that allows the system to run a containerized application to create the dataset contents. The application must be in a Docker container along with any required support libraries.
- queryAction
-
- Type: SqlQueryDatasetAction structure
An
SqlQueryDatasetActionobject that uses an SQL query to automatically create dataset contents.
DatasetActionSummary
Description
Information about the action that automatically creates the dataset's contents.
Members
DatasetContentDeliveryDestination
Description
The destination to which dataset contents are delivered.
Members
- iotEventsDestinationConfiguration
-
- Type: IotEventsDestinationConfiguration structure
Configuration information for delivery of dataset contents to IoT Events.
- s3DestinationConfiguration
-
- Type: S3DestinationConfiguration structure
Configuration information for delivery of dataset contents to Amazon S3.
DatasetContentDeliveryRule
Description
When dataset contents are created, they are delivered to destination specified here.
Members
- destination
-
- Required: Yes
- Type: DatasetContentDeliveryDestination structure
The destination to which dataset contents are delivered.
- entryName
-
- Type: string
The name of the dataset content delivery rules entry.
DatasetContentStatus
Description
The state of the dataset contents and the reason they are in this state.
Members
DatasetContentSummary
Description
Summary information about dataset contents.
Members
- completionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the dataset content status was updated to SUCCEEDED or FAILED.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The actual time the creation of the dataset contents was started.
- scheduleTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the creation of the dataset contents was scheduled to start.
- status
-
- Type: DatasetContentStatus structure
The status of the dataset contents.
- version
-
- Type: string
The version of the dataset contents.
DatasetContentVersionValue
Description
The dataset whose latest contents are used as input to the notebook or application.
Members
DatasetEntry
Description
The reference to a dataset entry.
Members
DatasetSummary
Description
A summary of information about a dataset.
Members
- actions
-
- Type: Array of DatasetActionSummary structures
A list of
DataActionSummaryobjects. - creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the dataset was created.
- datasetName
-
- Type: string
The name of the dataset.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the dataset was updated.
- status
-
- Type: string
The status of the dataset.
- triggers
-
- Type: Array of DatasetTrigger structures
A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five
DataSetTriggerobjects
DatasetTrigger
Description
The DatasetTrigger that specifies when the dataset is automatically updated.
Members
- dataset
-
- Type: TriggeringDataset structure
The dataset whose content creation triggers the creation of this dataset's contents.
- schedule
-
- Type: Schedule structure
The Schedule when the trigger is initiated.
Datastore
Description
Information about a data store.
Members
- arn
-
- Type: string
The ARN of the data store.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the data store was created.
- datastorePartitions
-
- Type: DatastorePartitions structure
Contains information about the partition dimensions in a data store.
- fileFormatConfiguration
-
- Type: FileFormatConfiguration structure
Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
- lastMessageArrivalTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time when a new message arrived in the data store.
IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the
lastMessageArrivalTimevalue is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the data store was updated.
- name
-
- Type: string
The name of the data store.
- retentionPeriod
-
- Type: RetentionPeriod structure
How long, in days, message data is kept for the data store. When
customerManagedS3storage is selected, this parameter is ignored. - status
-
- Type: string
The status of a data store:
- CREATING
-
The data store is being created.
- ACTIVE
-
The data store has been created and can be used.
- DELETING
-
The data store is being deleted.
- storage
-
- Type: DatastoreStorage structure
Where data in a data store is stored.. You can choose
serviceManagedS3storage,customerManagedS3storage, oriotSiteWiseMultiLayerStoragestorage. The default isserviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
DatastoreActivity
Description
The datastore activity that specifies where to store the processed data.
Members
DatastoreIotSiteWiseMultiLayerStorage
Description
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
Members
- customerManagedS3Storage
-
- Required: Yes
- Type: IotSiteWiseCustomerManagedDatastoreS3Storage structure
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
DatastoreIotSiteWiseMultiLayerStorageSummary
Description
Contains information about the data store that you manage, which stores data used by IoT SiteWise.
Members
- customerManagedS3Storage
-
- Type: IotSiteWiseCustomerManagedDatastoreS3StorageSummary structure
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
DatastorePartition
Description
A single dimension to partition a data store. The dimension must be an AttributePartition or a TimestampPartition.
Members
- attributePartition
-
- Type: Partition structure
A partition dimension defined by an
attributeName. - timestampPartition
-
- Type: TimestampPartition structure
A partition dimension defined by a timestamp attribute.
DatastorePartitions
Description
Contains information about the partition dimensions in a data store.
Members
- partitions
-
- Type: Array of DatastorePartition structures
A list of partition dimensions in a data store.
DatastoreStatistics
Description
Statistical information about the data store.
Members
- size
-
- Type: EstimatedResourceSize structure
The estimated size of the data store.
DatastoreStorage
Description
Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
Members
- customerManagedS3
-
- Type: CustomerManagedDatastoreS3Storage structure
S3-customer-managed; When you choose customer-managed storage, the
retentionPeriodparameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created. - iotSiteWiseMultiLayerStorage
-
- Type: DatastoreIotSiteWiseMultiLayerStorage structure
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
- serviceManagedS3
-
- Type: ServiceManagedDatastoreS3Storage structure
Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.
DatastoreStorageSummary
Description
Contains information about your data store.
Members
- customerManagedS3
-
- Type: CustomerManagedDatastoreS3StorageSummary structure
Used to store data in an Amazon S3 bucket managed by IoT Analytics.
- iotSiteWiseMultiLayerStorage
-
- Type: DatastoreIotSiteWiseMultiLayerStorageSummary structure
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
- serviceManagedS3
-
- Type: ServiceManagedDatastoreS3StorageSummary structure
Used to store data in an Amazon S3 bucket managed by IoT Analytics.
DatastoreSummary
Description
A summary of information about a data store.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the data store was created.
- datastoreName
-
- Type: string
The name of the data store.
- datastorePartitions
-
- Type: DatastorePartitions structure
Contains information about the partition dimensions in a data store.
- datastoreStorage
-
- Type: DatastoreStorageSummary structure
Where data in a data store is stored.
- fileFormatType
-
- Type: string
The file format of the data in the data store.
- lastMessageArrivalTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time when a new message arrived in the data store.
IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the
lastMessageArrivalTimevalue is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the data store was updated.
- status
-
- Type: string
The status of the data store.
DeltaTime
Description
Used to limit data to that which has arrived since the last execution of the action.
Members
- offsetSeconds
-
- Required: Yes
- Type: int
The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe.
- timeExpression
-
- Required: Yes
- Type: string
An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated.
DeltaTimeSessionWindowConfiguration
Description
A structure that contains the configuration information of a delta time session window.
DeltaTime specifies a time interval. You can use DeltaTime to create dataset contents with data that has arrived in the data store since the last execution. For an example of DeltaTime, see Creating a SQL dataset with a delta window (CLI) in the IoT Analytics User Guide.
Members
- timeoutInMinutes
-
- Required: Yes
- Type: int
A time interval. You can use
timeoutInMinutesso that IoT Analytics can batch up late data notifications that have been generated since the last execution. IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.For more information about how to write a timestamp expression, see Date and Time Functions and Operators, in the Presto 0.172 Documentation.
DeviceRegistryEnrichActivity
Description
An activity that adds data from the IoT device registry to your message.
Members
- attribute
-
- Required: Yes
- Type: string
The name of the attribute that is added to the message.
- name
-
- Required: Yes
- Type: string
The name of the
deviceRegistryEnrichactivity. - next
-
- Type: string
The next activity in the pipeline.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the role that allows access to the device's registry information.
- thingName
-
- Required: Yes
- Type: string
The name of the IoT device whose registry information is added to the message.
DeviceShadowEnrichActivity
Description
An activity that adds information from the IoT Device Shadow service to a message.
Members
- attribute
-
- Required: Yes
- Type: string
The name of the attribute that is added to the message.
- name
-
- Required: Yes
- Type: string
The name of the
deviceShadowEnrichactivity. - next
-
- Type: string
The next activity in the pipeline.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the role that allows access to the device's shadow.
- thingName
-
- Required: Yes
- Type: string
The name of the IoT device whose shadow information is added to the message.
EstimatedResourceSize
Description
The estimated size of the resource.
Members
FileFormatConfiguration
Description
Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
Members
- jsonConfiguration
-
- Type: JsonConfiguration structure
Contains the configuration information of the JSON format.
- parquetConfiguration
-
- Type: ParquetConfiguration structure
Contains the configuration information of the Parquet format.
FilterActivity
Description
An activity that filters a message based on its attributes.
Members
- filter
-
- Required: Yes
- Type: string
An expression that looks like a SQL WHERE clause that must return a Boolean value. Messages that satisfy the condition are passed to the next activity.
- name
-
- Required: Yes
- Type: string
The name of the filter activity.
- next
-
- Type: string
The next activity in the pipeline.
GlueConfiguration
Description
Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
Members
- databaseName
-
- Required: Yes
- Type: string
The name of the database in your Glue Data Catalog in which the table is located. An Glue Data Catalog database contains metadata tables.
- tableName
-
- Required: Yes
- Type: string
The name of the table in your Glue Data Catalog that is used to perform the ETL operations. An Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.
InternalFailureException
InvalidRequestException
IotEventsDestinationConfiguration
Description
Configuration information for delivery of dataset contents to IoT Events.
Members
IotSiteWiseCustomerManagedDatastoreS3Storage
Description
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
Members
- bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket where your data is stored.
- keyPrefix
-
- Type: string
(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
IotSiteWiseCustomerManagedDatastoreS3StorageSummary
Description
Contains information about the data store that you manage, which stores data used by IoT SiteWise.
Members
- bucket
-
- Type: string
The name of the Amazon S3 bucket where your data is stored.
- keyPrefix
-
- Type: string
(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
JsonConfiguration
Description
Contains the configuration information of the JSON format.
Members
LambdaActivity
Description
An activity that runs a Lambda function to modify the message.
Members
- batchSize
-
- Required: Yes
- Type: int
The number of messages passed to the Lambda function for processing.
The Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
- lambdaName
-
- Required: Yes
- Type: string
The name of the Lambda function that is run on the message.
- name
-
- Required: Yes
- Type: string
The name of the lambda activity.
- next
-
- Type: string
The next activity in the pipeline.
LateDataRule
Description
A structure that contains the name and configuration information of a late data rule.
Members
- ruleConfiguration
-
- Required: Yes
- Type: LateDataRuleConfiguration structure
The information needed to configure the late data rule.
- ruleName
-
- Type: string
The name of the late data rule.
LateDataRuleConfiguration
Description
The information needed to configure a delta time session window.
Members
- deltaTimeSessionWindowConfiguration
-
- Type: DeltaTimeSessionWindowConfiguration structure
The information needed to configure a delta time session window.
LimitExceededException
LoggingOptions
Description
Information about logging options.
Members
MathActivity
Description
An activity that computes an arithmetic expression using the message's attributes.
Members
- attribute
-
- Required: Yes
- Type: string
The name of the attribute that contains the result of the math operation.
- math
-
- Required: Yes
- Type: string
An expression that uses one or more existing attributes and must return an integer value.
- name
-
- Required: Yes
- Type: string
The name of the math activity.
- next
-
- Type: string
The next activity in the pipeline.
Message
Description
Information about a message.
Members
- messageId
-
- Required: Yes
- Type: string
The ID you want to assign to the message. Each
messageIdmust be unique within each batch sent. - payload
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The payload of the message. This can be a JSON string or a base64-encoded string representing binary data, in which case you must decode it by means of a pipeline activity.
OutputFileUriValue
Description
The value of the variable as a structure that specifies an output file URI.
Members
ParquetConfiguration
Description
Contains the configuration information of the Parquet format.
Members
- schemaDefinition
-
- Type: SchemaDefinition structure
Information needed to define a schema.
Partition
Description
A partition dimension defined by an attribute.
Members
Pipeline
Description
Contains information about a pipeline.
Members
- activities
-
- Type: Array of PipelineActivity structures
The activities that perform transformations on the messages.
- arn
-
- Type: string
The ARN of the pipeline.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the pipeline was created.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time the pipeline was updated.
- name
-
- Type: string
The name of the pipeline.
- reprocessingSummaries
-
- Type: Array of ReprocessingSummary structures
A summary of information about the pipeline reprocessing.
PipelineActivity
Description
An activity that performs a transformation on a message.
Members
- addAttributes
-
- Type: AddAttributesActivity structure
Adds other attributes based on existing attributes in the message.
- channel
-
- Type: ChannelActivity structure
Determines the source of the messages to be processed.
- datastore
-
- Type: DatastoreActivity structure
Specifies where to store the processed message data.
- deviceRegistryEnrich
-
- Type: DeviceRegistryEnrichActivity structure
Adds data from the IoT device registry to your message.
- deviceShadowEnrich
-
- Type: DeviceShadowEnrichActivity structure
Adds information from the IoT Device Shadow service to a message.
- filter
-
- Type: FilterActivity structure
Filters a message based on its attributes.
- lambda
-
- Type: LambdaActivity structure
Runs a Lambda function to modify the message.
- math
-
- Type: MathActivity structure
Computes an arithmetic expression using the message's attributes and adds it to the message.
- removeAttributes
-
- Type: RemoveAttributesActivity structure
Removes attributes from a message.
- selectAttributes
-
- Type: SelectAttributesActivity structure
Used to create a new message using only the specified attributes from the original message.
PipelineSummary
Description
A summary of information about a pipeline.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the pipeline was created.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the pipeline was last updated.
- pipelineName
-
- Type: string
The name of the pipeline.
- reprocessingSummaries
-
- Type: Array of ReprocessingSummary structures
A summary of information about the pipeline reprocessing.
QueryFilter
Description
Information that is used to filter message data, to segregate it according to the timeframe in which it arrives.
Members
- deltaTime
-
- Type: DeltaTime structure
Used to limit data to that which has arrived since the last execution of the action.
RemoveAttributesActivity
Description
An activity that removes attributes from a message.
Members
ReprocessingSummary
Description
Information about pipeline reprocessing.
Members
ResourceAlreadyExistsException
Description
A resource with the same name already exists.
Members
ResourceConfiguration
Description
The configuration of the resource used to execute the containerAction.
Members
- computeType
-
- Required: Yes
- Type: string
The type of the compute resource used to execute the
containerAction. Possible values are:ACU_1(vCPU=4, memory=16 GiB) orACU_2(vCPU=8, memory=32 GiB). - volumeSizeInGB
-
- Required: Yes
- Type: int
The size, in GB, of the persistent storage available to the resource instance used to execute the
containerAction(min: 1, max: 50).
ResourceNotFoundException
RetentionPeriod
Description
How long, in days, message data is kept.
Members
S3DestinationConfiguration
Description
Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
Members
- bucket
-
- Required: Yes
- Type: string
The name of the S3 bucket to which dataset contents are delivered.
- glueConfiguration
-
- Type: GlueConfiguration structure
Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
- key
-
- Required: Yes
- Type: string
The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.
You can create a unique key with the following options:
-
Use
!{iotanalytics:scheduleTime}to insert the time of a scheduled SQL query run. -
Use
!{iotanalytics:versionId}to insert a unique hash that identifies a dataset content. -
Use
!{iotanalytics:creationTime}to insert the creation time of a dataset content.
The following example creates a unique key for a CSV file:
dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csvIf you don't use
!{iotanalytics:versionId}to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the samescheduleTimebut differentversionIds. This means that one dataset content overwrites the other. - roleArn
-
- Required: Yes
- Type: string
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.
Schedule
Description
The schedule for when to trigger an update.
Members
- expression
-
- Type: string
The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.
SchemaDefinition
Description
Information needed to define a schema.
Members
- columns
-
- Type: Array of Column structures
Specifies one or more columns that store your data.
Each schema can have up to 100 columns. Each column can have up to 100 nested types.
SelectAttributesActivity
Description
Used to create a new message using only the specified attributes from the original message.
Members
ServiceManagedChannelS3Storage
Description
Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.
Members
ServiceManagedChannelS3StorageSummary
Description
Used to store channel data in an S3 bucket managed by IoT Analytics.
Members
ServiceManagedDatastoreS3Storage
Description
Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.
Members
ServiceManagedDatastoreS3StorageSummary
Description
Contains information about the data store that is managed by IoT Analytics.
Members
ServiceUnavailableException
SqlQueryDatasetAction
Description
The SQL query to modify the message.
Members
- filters
-
- Type: Array of QueryFilter structures
Prefilters applied to message data.
- sqlQuery
-
- Required: Yes
- Type: string
A SQL query string.
Tag
Description
A set of key-value pairs that are used to manage the resource.
Members
ThrottlingException
TimestampPartition
Description
A partition dimension defined by a timestamp attribute.
Members
TriggeringDataset
Description
Information about the dataset whose content generation triggers the new dataset content generation.
Members
Variable
Description
An instance of a variable to be passed to the containerAction execution. Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue.
Members
- datasetContentVersionValue
-
- Type: DatasetContentVersionValue structure
The value of the variable as a structure that specifies a dataset content version.
- doubleValue
-
- Type: double
The value of the variable as a double (numeric).
- name
-
- Required: Yes
- Type: string
The name of the variable.
- outputFileUriValue
-
- Type: OutputFileUriValue structure
The value of the variable as a structure that specifies an output file URI.
- stringValue
-
- Type: string
The value of the variable as a string.