IoT Analytics

Implementation details for API iotanalytics

Coverage Overview

IoT Analytics is supported by LocalStack only in the pro image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
BatchPutMessage
CancelPipelineReprocessing
CreateChannel✔️pro✔️Show Tests
CreateDataset✔️pro✔️Show Tests
CreateDatasetContent
CreateDatastore✔️pro✔️Show Tests
CreatePipeline✔️pro✔️Show Tests
DeleteChannel✔️pro✔️Show Tests
DeleteDataset✔️pro✔️Show Tests
DeleteDatasetContent
DeleteDatastore✔️pro✔️Show Tests
DeletePipeline✔️pro✔️Show Tests
DescribeChannel✔️pro✔️Show Tests
DescribeDataset✔️pro✔️Show Tests
DescribeDatastore✔️pro✔️Show Tests
DescribeLoggingOptions
DescribePipeline✔️pro✔️Show Tests
GetDatasetContent
ListChannels✔️pro✔️Show Tests
ListDatasetContents
ListDatasets✔️pro✔️Show Tests
ListDatastores✔️pro✔️Show Tests
ListPipelines✔️pro✔️Show Tests
ListTagsForResource
PutLoggingOptions
RunPipelineActivity
SampleChannelData
StartPipelineReprocessing
TagResource
UntagResource
UpdateChannel
UpdateDataset
UpdateDatastore
UpdatePipeline

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateChannel

Parameters: channelName
  • LocalStack Pro
    • test_channels LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_channels HTTP Status Code: 201
Parameters: channelName, tags
  • LocalStack Pro
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 201

CreateDataset

Parameters: actions, datasetName
  • LocalStack Pro
    • test_datasets LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datasets HTTP Status Code: 201
Parameters: actions, datasetName, retentionPeriod, tags, triggers
  • LocalStack Pro
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 201

CreateDatastore

Parameters: datastoreName
  • LocalStack Pro
    • test_datastores LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datastores HTTP Status Code: 201
Parameters: datastoreName, tags
  • LocalStack Pro
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 201

CreatePipeline

Parameters: pipelineActivities, pipelineName
  • LocalStack Pro
    • test_pipelines LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_pipelines HTTP Status Code: 201
Parameters: pipelineActivities, pipelineName, tags
  • LocalStack Pro
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 201

DeleteChannel

Parameters: channelName
  • LocalStack Pro
    • test_channels LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_channels HTTP Status Code: 204
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 204

DeleteDataset

Parameters: datasetName
  • LocalStack Pro
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 204
    • test_datasets LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datasets HTTP Status Code: 204

DeleteDatastore

Parameters: datastoreName
  • LocalStack Pro
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 204
    • test_datastores LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datastores HTTP Status Code: 204

DeletePipeline

Parameters: pipelineName
  • LocalStack Pro
    • test_create_iotanalytics_resources LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_create_iotanalytics_resources HTTP Status Code: 204
    • test_pipelines LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_pipelines HTTP Status Code: 204

DescribeChannel

Parameters: channelName
  • LocalStack Pro
    • test_channels LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_channels HTTP Status Code: 200
    • test_channels LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_channels HTTP Status Code: 404 (ResourceNotFoundException)

DescribeDataset

Parameters: datasetName
  • LocalStack Pro
    • test_datasets LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datasets HTTP Status Code: 200
    • test_datasets LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datasets HTTP Status Code: 404 (ResourceNotFoundException)

DescribeDatastore

Parameters: datastoreName
  • LocalStack Pro
    • test_datastores LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datastores HTTP Status Code: 200
    • test_datastores LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datastores HTTP Status Code: 404 (ResourceNotFoundException)

DescribePipeline

Parameters: pipelineName
  • LocalStack Pro
    • test_pipelines LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_pipelines HTTP Status Code: 200
    • test_pipelines LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_pipelines HTTP Status Code: 404 (ResourceNotFoundException)

ListChannels

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_channels LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_channels HTTP Status Code: 200

ListDatasets

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_datasets LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datasets HTTP Status Code: 200

ListDatastores

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_datastores LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_datastores HTTP Status Code: 200

ListPipelines

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_pipelines LocalStack Pro: tests/aws/services/iotanalytics/test_iotanalytics.py::TestIotAnalytics::test_pipelines HTTP Status Code: 200

Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)