2018/04/23 - AWS IoT Analytics - 30 new api methods
Changes Introducing AWS IoT Analytics SDK. AWS IoT Analytics provides advanced data analysis for AWS IoT. It allows you to collect large amounts of device data, process messages, store them, and then query the data and run sophisticated analytics to make accurate decisions in your IoT applications and machine learning use cases. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.
Retrieves a list of pipelines.
See also: AWS API Documentation
Request Syntax
client.list_pipelines(
nextToken='string',
maxResults=123
)
string
The token for the next set of results.
integer
The maximum number of results to return in this request.
The default value is 100.
dict
Response Syntax
{
'pipelineSummaries': [
{
'pipelineName': 'string',
'reprocessingSummaries': [
{
'id': 'string',
'status': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
'creationTime': datetime(2015, 1, 1)
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
pipelineSummaries (list) --
A list of "PipelineSummary" objects.
(dict) --
A summary of information about a pipeline.
pipelineName (string) --
The name of the pipeline.
reprocessingSummaries (list) --
A summary of information about the pipeline reprocessing.
(dict) --
Information about pipeline reprocessing.
id (string) --
The 'reprocessingId' returned by "StartPipelineReprocessing".
status (string) --
The status of the pipeline reprocessing.
creationTime (datetime) --
The time the pipeline reprocessing was created.
creationTime (datetime) --
When the pipeline was created.
lastUpdateTime (datetime) --
When the pipeline was last updated.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Retrieves information about a data set.
See also: AWS API Documentation
Request Syntax
client.describe_dataset(
datasetName='string'
)
string
[REQUIRED]
The name of the data set whose information is retrieved.
dict
Response Syntax
{
'dataset': {
'name': 'string',
'arn': 'string',
'actions': [
{
'actionName': 'string',
'queryAction': {
'sqlQuery': 'string'
}
},
],
'triggers': [
{
'schedule': {
'expression': 'string'
}
},
],
'status': 'CREATING'|'ACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
dataset (dict) --
An object that contains information about the data set.
name (string) --
The name of the data set.
arn (string) --
The ARN of the data set.
actions (list) --
The "DatasetAction" objects that create the data set.
(dict) --
A "DatasetAction" object specifying the query that creates the data set content.
actionName (string) --
The name of the data set action.
queryAction (dict) --
An "SqlQueryDatasetAction" object that contains the SQL query to modify the message.
sqlQuery (string) --
An SQL query string.
triggers (list) --
The "DatasetTrigger" objects that specify when the data set is automatically updated.
(dict) --
The "DatasetTrigger" that specifies when the data set is automatically updated.
schedule (dict) --
The "Schedule" when the trigger is initiated.
expression (string) --
The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
status (string) --
The status of the data set.
creationTime (datetime) --
When the data set was created.
lastUpdateTime (datetime) --
The last time the data set was updated.
Creates a pipeline. A pipeline consumes messages from one or more channels and allows you to process the messages before storing them in a data store.
See also: AWS API Documentation
Request Syntax
client.create_pipeline(
pipelineName='string',
pipelineActivities=[
{
'channel': {
'name': 'string',
'channelName': 'string',
'next': 'string'
},
'lambda': {
'name': 'string',
'lambdaName': 'string',
'batchSize': 123,
'next': 'string'
},
'datastore': {
'name': 'string',
'datastoreName': 'string'
},
'addAttributes': {
'name': 'string',
'attributes': {
'string': 'string'
},
'next': 'string'
},
'removeAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'selectAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'filter': {
'name': 'string',
'filter': 'string',
'next': 'string'
},
'math': {
'name': 'string',
'attribute': 'string',
'math': 'string',
'next': 'string'
},
'deviceRegistryEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
},
'deviceShadowEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
}
},
]
)
string
[REQUIRED]
The name of the pipeline.
list
[REQUIRED]
A list of pipeline activities.
The list can be 1-25 PipelineActivity objects. 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.
(dict) --
An activity that performs a transformation on a message.
channel (dict) --
Determines the source of the messages to be processed.
name (string) -- [REQUIRED]
The name of the 'channel' activity.
channelName (string) -- [REQUIRED]
The name of the channel from which the messages are processed.
next (string) --
The next activity in the pipeline.
lambda (dict) --
Runs a Lambda function to modify the message.
name (string) -- [REQUIRED]
The name of the 'lambda' activity.
lambdaName (string) -- [REQUIRED]
The name of the Lambda function that is run on the message.
batchSize (integer) -- [REQUIRED]
The number of messages passed to the Lambda function for processing.
The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
next (string) --
The next activity in the pipeline.
datastore (dict) --
Specifies where to store the processed message data.
name (string) -- [REQUIRED]
The name of the 'datastore' activity.
datastoreName (string) -- [REQUIRED]
The name of the data store where processed messages are stored.
addAttributes (dict) --
Adds other attributes based on existing attributes in the message.
name (string) -- [REQUIRED]
The name of the 'addAttributes' activity.
attributes (dict) -- [REQUIRED]
A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute.
Note
The existing attributes remain in the message, so if you want to remove the originals, use "RemoveAttributeActivity".
(string) --
(string) --
next (string) --
The next activity in the pipeline.
removeAttributes (dict) --
Removes attributes from a message.
name (string) -- [REQUIRED]
The name of the 'removeAttributes' activity.
attributes (list) -- [REQUIRED]
A list of 1-50 attributes to remove from the message.
(string) --
next (string) --
The next activity in the pipeline.
selectAttributes (dict) --
Creates a new message using only the specified attributes from the original message.
name (string) -- [REQUIRED]
The name of the 'selectAttributes' activity.
attributes (list) -- [REQUIRED]
A list of the attributes to select from the message.
(string) --
next (string) --
The next activity in the pipeline.
filter (dict) --
Filters a message based on its attributes.
name (string) -- [REQUIRED]
The name of the 'filter' activity.
filter (string) -- [REQUIRED]
An expression that looks like an SQL WHERE clause that must return a Boolean value.
next (string) --
The next activity in the pipeline.
math (dict) --
Computes an arithmetic expression using the message's attributes and adds it to the message.
name (string) -- [REQUIRED]
The name of the 'math' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that will contain the result of the math operation.
math (string) -- [REQUIRED]
An expression that uses one or more existing attributes and must return an integer value.
next (string) --
The next activity in the pipeline.
deviceRegistryEnrich (dict) --
Adds data from the AWS IoT device registry to your message.
name (string) -- [REQUIRED]
The name of the 'deviceRegistryEnrich' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that is added to the message.
thingName (string) -- [REQUIRED]
The name of the IoT device whose registry information is added to the message.
roleArn (string) -- [REQUIRED]
The ARN of the role that allows access to the device's registry information.
next (string) --
The next activity in the pipeline.
deviceShadowEnrich (dict) --
Adds information from the AWS IoT Device Shadows service to a message.
name (string) -- [REQUIRED]
The name of the 'deviceShadowEnrich' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that is added to the message.
thingName (string) -- [REQUIRED]
The name of the IoT device whose shadow information is added to the message.
roleArn (string) -- [REQUIRED]
The ARN of the role that allows access to the device's shadow.
next (string) --
The next activity in the pipeline.
dict
Response Syntax
{
'pipelineName': 'string',
'pipelineArn': 'string'
}
Response Structure
(dict) --
pipelineName (string) --
The name of the pipeline.
pipelineArn (string) --
The ARN of the pipeline.
Deletes the specified data store.
See also: AWS API Documentation
Request Syntax
client.delete_datastore(
datastoreName='string'
)
string
[REQUIRED]
The name of the data store to delete.
None
Retrieves information about a channel.
See also: AWS API Documentation
Request Syntax
client.describe_channel(
channelName='string'
)
string
[REQUIRED]
The name of the channel whose information is retrieved.
dict
Response Syntax
{
'channel': {
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING',
'retentionPeriod': {
'unlimited': True|False,
'numberOfDays': 123
},
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
channel (dict) --
An object that contains information about the channel.
name (string) --
The name of the channel.
arn (string) --
The ARN of the channel.
status (string) --
The status of the channel.
retentionPeriod (dict) --
How long, in days, message data is kept for the channel.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
creationTime (datetime) --
When the channel was created.
lastUpdateTime (datetime) --
When the channel was last updated.
Starts the reprocessing of raw message data through the pipeline.
See also: AWS API Documentation
Request Syntax
client.start_pipeline_reprocessing(
pipelineName='string',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The name of the pipeline on which to start reprocessing.
datetime
The start time (inclusive) of raw message data that is reprocessed.
datetime
The end time (exclusive) of raw message data that is reprocessed.
dict
Response Syntax
{
'reprocessingId': 'string'
}
Response Structure
(dict) --
reprocessingId (string) --
The ID of the pipeline reprocessing activity that was started.
Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
See also: AWS API Documentation
Request Syntax
client.create_channel(
channelName='string',
retentionPeriod={
'unlimited': True|False,
'numberOfDays': 123
}
)
string
[REQUIRED]
The name of the channel.
dict
How long, in days, message data is kept for the channel.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
dict
Response Syntax
{
'channelName': 'string',
'channelArn': 'string',
'retentionPeriod': {
'unlimited': True|False,
'numberOfDays': 123
}
}
Response Structure
(dict) --
channelName (string) --
The name of the channel.
channelArn (string) --
The ARN of the channel.
retentionPeriod (dict) --
How long, in days, message data is kept for the channel.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
Updates the settings of a channel.
See also: AWS API Documentation
Request Syntax
client.update_channel(
channelName='string',
retentionPeriod={
'unlimited': True|False,
'numberOfDays': 123
}
)
string
[REQUIRED]
The name of the channel to be updated.
dict
How long, in days, message data is kept for the channel.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
None
Deletes the specified pipeline.
See also: AWS API Documentation
Request Syntax
client.delete_pipeline(
pipelineName='string'
)
string
[REQUIRED]
The name of the pipeline to delete.
None
Updates the settings of a data set.
See also: AWS API Documentation
Request Syntax
client.update_dataset(
datasetName='string',
actions=[
{
'actionName': 'string',
'queryAction': {
'sqlQuery': 'string'
}
},
],
triggers=[
{
'schedule': {
'expression': 'string'
}
},
]
)
string
[REQUIRED]
The name of the data set to update.
list
[REQUIRED]
A list of "DatasetAction" objects. Only one action is supported at this time.
(dict) --
A "DatasetAction" object specifying the query that creates the data set content.
actionName (string) --
The name of the data set action.
queryAction (dict) --
An "SqlQueryDatasetAction" object that contains the SQL query to modify the message.
sqlQuery (string) -- [REQUIRED]
An SQL query string.
list
A list of "DatasetTrigger" objects. The list can be empty or can contain up to five DataSetTrigger objects.
(dict) --
The "DatasetTrigger" that specifies when the data set is automatically updated.
schedule (dict) --
The "Schedule" when the trigger is initiated.
expression (string) --
The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
None
Simulates the results of running a pipeline activity on a message payload.
See also: AWS API Documentation
Request Syntax
client.run_pipeline_activity(
pipelineActivity={
'channel': {
'name': 'string',
'channelName': 'string',
'next': 'string'
},
'lambda': {
'name': 'string',
'lambdaName': 'string',
'batchSize': 123,
'next': 'string'
},
'datastore': {
'name': 'string',
'datastoreName': 'string'
},
'addAttributes': {
'name': 'string',
'attributes': {
'string': 'string'
},
'next': 'string'
},
'removeAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'selectAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'filter': {
'name': 'string',
'filter': 'string',
'next': 'string'
},
'math': {
'name': 'string',
'attribute': 'string',
'math': 'string',
'next': 'string'
},
'deviceRegistryEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
},
'deviceShadowEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
}
},
payloads=[
b'bytes',
]
)
dict
[REQUIRED]
The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' 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.
channel (dict) --
Determines the source of the messages to be processed.
name (string) -- [REQUIRED]
The name of the 'channel' activity.
channelName (string) -- [REQUIRED]
The name of the channel from which the messages are processed.
next (string) --
The next activity in the pipeline.
lambda (dict) --
Runs a Lambda function to modify the message.
name (string) -- [REQUIRED]
The name of the 'lambda' activity.
lambdaName (string) -- [REQUIRED]
The name of the Lambda function that is run on the message.
batchSize (integer) -- [REQUIRED]
The number of messages passed to the Lambda function for processing.
The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
next (string) --
The next activity in the pipeline.
datastore (dict) --
Specifies where to store the processed message data.
name (string) -- [REQUIRED]
The name of the 'datastore' activity.
datastoreName (string) -- [REQUIRED]
The name of the data store where processed messages are stored.
addAttributes (dict) --
Adds other attributes based on existing attributes in the message.
name (string) -- [REQUIRED]
The name of the 'addAttributes' activity.
attributes (dict) -- [REQUIRED]
A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute.
Note
The existing attributes remain in the message, so if you want to remove the originals, use "RemoveAttributeActivity".
(string) --
(string) --
next (string) --
The next activity in the pipeline.
removeAttributes (dict) --
Removes attributes from a message.
name (string) -- [REQUIRED]
The name of the 'removeAttributes' activity.
attributes (list) -- [REQUIRED]
A list of 1-50 attributes to remove from the message.
(string) --
next (string) --
The next activity in the pipeline.
selectAttributes (dict) --
Creates a new message using only the specified attributes from the original message.
name (string) -- [REQUIRED]
The name of the 'selectAttributes' activity.
attributes (list) -- [REQUIRED]
A list of the attributes to select from the message.
(string) --
next (string) --
The next activity in the pipeline.
filter (dict) --
Filters a message based on its attributes.
name (string) -- [REQUIRED]
The name of the 'filter' activity.
filter (string) -- [REQUIRED]
An expression that looks like an SQL WHERE clause that must return a Boolean value.
next (string) --
The next activity in the pipeline.
math (dict) --
Computes an arithmetic expression using the message's attributes and adds it to the message.
name (string) -- [REQUIRED]
The name of the 'math' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that will contain the result of the math operation.
math (string) -- [REQUIRED]
An expression that uses one or more existing attributes and must return an integer value.
next (string) --
The next activity in the pipeline.
deviceRegistryEnrich (dict) --
Adds data from the AWS IoT device registry to your message.
name (string) -- [REQUIRED]
The name of the 'deviceRegistryEnrich' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that is added to the message.
thingName (string) -- [REQUIRED]
The name of the IoT device whose registry information is added to the message.
roleArn (string) -- [REQUIRED]
The ARN of the role that allows access to the device's registry information.
next (string) --
The next activity in the pipeline.
deviceShadowEnrich (dict) --
Adds information from the AWS IoT Device Shadows service to a message.
name (string) -- [REQUIRED]
The name of the 'deviceShadowEnrich' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that is added to the message.
thingName (string) -- [REQUIRED]
The name of the IoT device whose shadow information is added to the message.
roleArn (string) -- [REQUIRED]
The ARN of the role that allows access to the device's shadow.
next (string) --
The next activity in the pipeline.
list
[REQUIRED]
The sample message payloads on which the pipeline activity is run.
(bytes) --
dict
Response Syntax
{
'payloads': [
b'bytes',
],
'logResult': 'string'
}
Response Structure
(dict) --
payloads (list) --
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.)
(bytes) --
logResult (string) --
In case the pipeline activity fails, the log message that is generated.
Deletes the specified channel.
See also: AWS API Documentation
Request Syntax
client.delete_channel(
channelName='string'
)
string
[REQUIRED]
The name of the channel to delete.
None
Updates the settings of a data store.
See also: AWS API Documentation
Request Syntax
client.update_datastore(
datastoreName='string',
retentionPeriod={
'unlimited': True|False,
'numberOfDays': 123
}
)
string
[REQUIRED]
The name of the data store to be updated.
dict
How long, in days, message data is kept for the data store.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
None
Deletes the specified data set.
You do not have to delete the content of the data set before you perform this operation.
See also: AWS API Documentation
Request Syntax
client.delete_dataset(
datasetName='string'
)
string
[REQUIRED]
The name of the data set to delete.
None
Retrieves a list of channels.
See also: AWS API Documentation
Request Syntax
client.list_channels(
nextToken='string',
maxResults=123
)
string
The token for the next set of results.
integer
The maximum number of results to return in this request.
The default value is 100.
dict
Response Syntax
{
'channelSummaries': [
{
'channelName': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
channelSummaries (list) --
A list of "ChannelSummary" objects.
(dict) --
A summary of information about a channel.
channelName (string) --
The name of the channel.
status (string) --
The status of the channel.
creationTime (datetime) --
When the channel was created.
lastUpdateTime (datetime) --
The last time the channel was updated.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Retrieves information about data sets.
See also: AWS API Documentation
Request Syntax
client.list_datasets(
nextToken='string',
maxResults=123
)
string
The token for the next set of results.
integer
The maximum number of results to return in this request.
The default value is 100.
dict
Response Syntax
{
'datasetSummaries': [
{
'datasetName': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datasetSummaries (list) --
A list of "DatasetSummary" objects.
(dict) --
A summary of information about a data set.
datasetName (string) --
The name of the data set.
status (string) --
The status of the data set.
creationTime (datetime) --
The time the data set was created.
lastUpdateTime (datetime) --
The last time the data set was updated.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Sends messages to a channel.
See also: AWS API Documentation
Request Syntax
client.batch_put_message(
channelName='string',
messages=[
{
'messageId': 'string',
'payload': b'bytes'
},
]
)
string
[REQUIRED]
The name of the channel where the messages are sent.
list
[REQUIRED]
The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.
(dict) --
Information about a message.
messageId (string) -- [REQUIRED]
The ID you wish to assign to the message.
payload (bytes) -- [REQUIRED]
The payload of the message.
dict
Response Syntax
{
'batchPutMessageErrorEntries': [
{
'messageId': 'string',
'errorCode': 'string',
'errorMessage': 'string'
},
]
}
Response Structure
(dict) --
batchPutMessageErrorEntries (list) --
A list of any errors encountered when sending the messages to the channel.
(dict) --
Contains informations about errors.
messageId (string) --
The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the message object.)
errorCode (string) --
The code associated with the error.
errorMessage (string) --
The message associated with the error.
Retrieves the current settings of the AWS IoT Analytics logging options.
See also: AWS API Documentation
Request Syntax
client.describe_logging_options()
dict
Response Syntax
{
'loggingOptions': {
'roleArn': 'string',
'level': 'ERROR',
'enabled': True|False
}
}
Response Structure
(dict) --
loggingOptions (dict) --
The current settings of the AWS IoT Analytics logging options.
roleArn (string) --
The ARN of the role that grants permission to AWS IoT Analytics to perform logging.
level (string) --
The logging level. Currently, only "ERROR" is supported.
enabled (boolean) --
If true, logging is enabled for AWS IoT Analytics.
Creates a data set. A data set stores data retrieved from a data store by applying an SQL action.
Note
This operation creates the skeleton of a data set. To populate the data set, call "CreateDatasetContent".
See also: AWS API Documentation
Request Syntax
client.create_dataset(
datasetName='string',
actions=[
{
'actionName': 'string',
'queryAction': {
'sqlQuery': 'string'
}
},
],
triggers=[
{
'schedule': {
'expression': 'string'
}
},
]
)
string
[REQUIRED]
The name of the data set.
list
[REQUIRED]
A list of actions that create the data set. Only one action is supported at this time.
(dict) --
A "DatasetAction" object specifying the query that creates the data set content.
actionName (string) --
The name of the data set action.
queryAction (dict) --
An "SqlQueryDatasetAction" object that contains the SQL query to modify the message.
sqlQuery (string) -- [REQUIRED]
An SQL query string.
list
A list of triggers. A trigger causes data set content to be populated at a specified time or time interval. The list of triggers can be empty or contain up to five DataSetTrigger objects.
(dict) --
The "DatasetTrigger" that specifies when the data set is automatically updated.
schedule (dict) --
The "Schedule" when the trigger is initiated.
expression (string) --
The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
dict
Response Syntax
{
'datasetName': 'string',
'datasetArn': 'string'
}
Response Structure
(dict) --
datasetName (string) --
The name of the data set.
datasetArn (string) --
The ARN of the data set.
Retrieves a list of data stores.
See also: AWS API Documentation
Request Syntax
client.list_datastores(
nextToken='string',
maxResults=123
)
string
The token for the next set of results.
integer
The maximum number of results to return in this request.
The default value is 100.
dict
Response Syntax
{
'datastoreSummaries': [
{
'datastoreName': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datastoreSummaries (list) --
A list of "DatastoreSummary" objects.
(dict) --
A summary of information about a data store.
datastoreName (string) --
The name of the data store.
status (string) --
The status of the data store.
creationTime (datetime) --
When the data store was created.
lastUpdateTime (datetime) --
The last time the data store was updated.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Retrieves the contents of a data set as pre-signed URIs.
See also: AWS API Documentation
Request Syntax
client.get_dataset_content(
datasetName='string',
versionId='string'
)
string
[REQUIRED]
The name of the data set whose contents are retrieved.
string
The version of the data set 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 data set. If not specified, "$LATEST_SUCCEEDED" is the default.
dict
Response Syntax
{
'entries': [
{
'entryName': 'string',
'dataURI': 'string'
},
],
'timestamp': datetime(2015, 1, 1),
'status': {
'state': 'CREATING'|'SUCCEEDED'|'FAILED',
'reason': 'string'
}
}
Response Structure
(dict) --
entries (list) --
A list of "DatasetEntry" objects.
(dict) --
The reference to a data set entry.
entryName (string) --
The name of the data set item.
dataURI (string) --
The pre-signed URI of the data set item.
timestamp (datetime) --
The time when the request was made.
status (dict) --
The status of the data set content.
state (string) --
The state of the data set. Can be one of "CREATING", "SUCCEEDED" or "FAILED".
reason (string) --
The reason the data set is in this state.
Retrieves information about a pipeline.
See also: AWS API Documentation
Request Syntax
client.describe_pipeline(
pipelineName='string'
)
string
[REQUIRED]
The name of the pipeline whose information is retrieved.
dict
Response Syntax
{
'pipeline': {
'name': 'string',
'arn': 'string',
'activities': [
{
'channel': {
'name': 'string',
'channelName': 'string',
'next': 'string'
},
'lambda': {
'name': 'string',
'lambdaName': 'string',
'batchSize': 123,
'next': 'string'
},
'datastore': {
'name': 'string',
'datastoreName': 'string'
},
'addAttributes': {
'name': 'string',
'attributes': {
'string': 'string'
},
'next': 'string'
},
'removeAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'selectAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'filter': {
'name': 'string',
'filter': 'string',
'next': 'string'
},
'math': {
'name': 'string',
'attribute': 'string',
'math': 'string',
'next': 'string'
},
'deviceRegistryEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
},
'deviceShadowEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
}
},
],
'reprocessingSummaries': [
{
'id': 'string',
'status': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
'creationTime': datetime(2015, 1, 1)
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
pipeline (dict) --
A "Pipeline" object that contains information about the pipeline.
name (string) --
The name of the pipeline.
arn (string) --
The ARN of the pipeline.
activities (list) --
The activities that perform transformations on the messages.
(dict) --
An activity that performs a transformation on a message.
channel (dict) --
Determines the source of the messages to be processed.
name (string) --
The name of the 'channel' activity.
channelName (string) --
The name of the channel from which the messages are processed.
next (string) --
The next activity in the pipeline.
lambda (dict) --
Runs a Lambda function to modify the message.
name (string) --
The name of the 'lambda' activity.
lambdaName (string) --
The name of the Lambda function that is run on the message.
batchSize (integer) --
The number of messages passed to the Lambda function for processing.
The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
next (string) --
The next activity in the pipeline.
datastore (dict) --
Specifies where to store the processed message data.
name (string) --
The name of the 'datastore' activity.
datastoreName (string) --
The name of the data store where processed messages are stored.
addAttributes (dict) --
Adds other attributes based on existing attributes in the message.
name (string) --
The name of the 'addAttributes' activity.
attributes (dict) --
A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute.
Note
The existing attributes remain in the message, so if you want to remove the originals, use "RemoveAttributeActivity".
(string) --
(string) --
next (string) --
The next activity in the pipeline.
removeAttributes (dict) --
Removes attributes from a message.
name (string) --
The name of the 'removeAttributes' activity.
attributes (list) --
A list of 1-50 attributes to remove from the message.
(string) --
next (string) --
The next activity in the pipeline.
selectAttributes (dict) --
Creates a new message using only the specified attributes from the original message.
name (string) --
The name of the 'selectAttributes' activity.
attributes (list) --
A list of the attributes to select from the message.
(string) --
next (string) --
The next activity in the pipeline.
filter (dict) --
Filters a message based on its attributes.
name (string) --
The name of the 'filter' activity.
filter (string) --
An expression that looks like an SQL WHERE clause that must return a Boolean value.
next (string) --
The next activity in the pipeline.
math (dict) --
Computes an arithmetic expression using the message's attributes and adds it to the message.
name (string) --
The name of the 'math' activity.
attribute (string) --
The name of the attribute that will contain the result of the math operation.
math (string) --
An expression that uses one or more existing attributes and must return an integer value.
next (string) --
The next activity in the pipeline.
deviceRegistryEnrich (dict) --
Adds data from the AWS IoT device registry to your message.
name (string) --
The name of the 'deviceRegistryEnrich' activity.
attribute (string) --
The name of the attribute that is added to the message.
thingName (string) --
The name of the IoT device whose registry information is added to the message.
roleArn (string) --
The ARN of the role that allows access to the device's registry information.
next (string) --
The next activity in the pipeline.
deviceShadowEnrich (dict) --
Adds information from the AWS IoT Device Shadows service to a message.
name (string) --
The name of the 'deviceShadowEnrich' activity.
attribute (string) --
The name of the attribute that is added to the message.
thingName (string) --
The name of the IoT device whose shadow information is added to the message.
roleArn (string) --
The ARN of the role that allows access to the device's shadow.
next (string) --
The next activity in the pipeline.
reprocessingSummaries (list) --
A summary of information about the pipeline reprocessing.
(dict) --
Information about pipeline reprocessing.
id (string) --
The 'reprocessingId' returned by "StartPipelineReprocessing".
status (string) --
The status of the pipeline reprocessing.
creationTime (datetime) --
The time the pipeline reprocessing was created.
creationTime (datetime) --
When the pipeline was created.
lastUpdateTime (datetime) --
The last time the pipeline was updated.
Deletes the content of the specified data set.
See also: AWS API Documentation
Request Syntax
client.delete_dataset_content(
datasetName='string',
versionId='string'
)
string
[REQUIRED]
The name of the data set whose content is deleted.
string
The version of the data set 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.
None
Creates a data store, which is a repository for messages.
See also: AWS API Documentation
Request Syntax
client.create_datastore(
datastoreName='string',
retentionPeriod={
'unlimited': True|False,
'numberOfDays': 123
}
)
string
[REQUIRED]
The name of the data store.
dict
How long, in days, message data is kept for the data store.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
dict
Response Syntax
{
'datastoreName': 'string',
'datastoreArn': 'string',
'retentionPeriod': {
'unlimited': True|False,
'numberOfDays': 123
}
}
Response Structure
(dict) --
datastoreName (string) --
The name of the data store.
datastoreArn (string) --
The ARN of the data store.
retentionPeriod (dict) --
How long, in days, message data is kept for the data store.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
Creates the content of a data set by applying an SQL action.
See also: AWS API Documentation
Request Syntax
client.create_dataset_content(
datasetName='string'
)
string
[REQUIRED]
The name of the data set.
None
Retrieves information about a data store.
See also: AWS API Documentation
Request Syntax
client.describe_datastore(
datastoreName='string'
)
string
[REQUIRED]
The name of the data store
dict
Response Syntax
{
'datastore': {
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING',
'retentionPeriod': {
'unlimited': True|False,
'numberOfDays': 123
},
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
datastore (dict) --
Information about the data store.
name (string) --
The name of the data store.
arn (string) --
The ARN of the data store.
status (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.
retentionPeriod (dict) --
How long, in days, message data is kept for the data store.
unlimited (boolean) --
If true, message data is kept indefinitely.
numberOfDays (integer) --
The number of days that message data is kept. The "unlimited" parameter must be false.
creationTime (datetime) --
When the data store was created.
lastUpdateTime (datetime) --
The last time the data store was updated.
Sets or updates the AWS IoT Analytics logging options.
See also: AWS API Documentation
Request Syntax
client.put_logging_options(
loggingOptions={
'roleArn': 'string',
'level': 'ERROR',
'enabled': True|False
}
)
dict
[REQUIRED]
The new values of the AWS IoT Analytics logging options.
roleArn (string) -- [REQUIRED]
The ARN of the role that grants permission to AWS IoT Analytics to perform logging.
level (string) -- [REQUIRED]
The logging level. Currently, only "ERROR" is supported.
enabled (boolean) -- [REQUIRED]
If true, logging is enabled for AWS IoT Analytics.
None
Cancels the reprocessing of data through the pipeline.
See also: AWS API Documentation
Request Syntax
client.cancel_pipeline_reprocessing(
pipelineName='string',
reprocessingId='string'
)
string
[REQUIRED]
The name of pipeline for which data reprocessing is canceled.
string
[REQUIRED]
The ID of the reprocessing task (returned by "StartPipelineReprocessing").
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
See also: AWS API Documentation
Request Syntax
client.sample_channel_data(
channelName='string',
maxMessages=123,
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The name of the channel whose message samples are retrieved.
integer
The number of sample messages to be retrieved. The limit is 10, the default is also 10.
datetime
The start of the time window from which sample messages are retrieved.
datetime
The end of the time window from which sample messages are retrieved.
dict
Response Syntax
{
'payloads': [
b'bytes',
]
}
Response Structure
(dict) --
payloads (list) --
The list of message samples. Each sample message is returned as a base64-encoded string.
(bytes) --
Updates the settings of a pipeline.
See also: AWS API Documentation
Request Syntax
client.update_pipeline(
pipelineName='string',
pipelineActivities=[
{
'channel': {
'name': 'string',
'channelName': 'string',
'next': 'string'
},
'lambda': {
'name': 'string',
'lambdaName': 'string',
'batchSize': 123,
'next': 'string'
},
'datastore': {
'name': 'string',
'datastoreName': 'string'
},
'addAttributes': {
'name': 'string',
'attributes': {
'string': 'string'
},
'next': 'string'
},
'removeAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'selectAttributes': {
'name': 'string',
'attributes': [
'string',
],
'next': 'string'
},
'filter': {
'name': 'string',
'filter': 'string',
'next': 'string'
},
'math': {
'name': 'string',
'attribute': 'string',
'math': 'string',
'next': 'string'
},
'deviceRegistryEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
},
'deviceShadowEnrich': {
'name': 'string',
'attribute': 'string',
'thingName': 'string',
'roleArn': 'string',
'next': 'string'
}
},
]
)
string
[REQUIRED]
The name of the pipeline to update.
list
[REQUIRED]
A list of "PipelineActivity" objects.
The list can be 1-25 PipelineActivity objects. 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.
(dict) --
An activity that performs a transformation on a message.
channel (dict) --
Determines the source of the messages to be processed.
name (string) -- [REQUIRED]
The name of the 'channel' activity.
channelName (string) -- [REQUIRED]
The name of the channel from which the messages are processed.
next (string) --
The next activity in the pipeline.
lambda (dict) --
Runs a Lambda function to modify the message.
name (string) -- [REQUIRED]
The name of the 'lambda' activity.
lambdaName (string) -- [REQUIRED]
The name of the Lambda function that is run on the message.
batchSize (integer) -- [REQUIRED]
The number of messages passed to the Lambda function for processing.
The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
next (string) --
The next activity in the pipeline.
datastore (dict) --
Specifies where to store the processed message data.
name (string) -- [REQUIRED]
The name of the 'datastore' activity.
datastoreName (string) -- [REQUIRED]
The name of the data store where processed messages are stored.
addAttributes (dict) --
Adds other attributes based on existing attributes in the message.
name (string) -- [REQUIRED]
The name of the 'addAttributes' activity.
attributes (dict) -- [REQUIRED]
A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute.
Note
The existing attributes remain in the message, so if you want to remove the originals, use "RemoveAttributeActivity".
(string) --
(string) --
next (string) --
The next activity in the pipeline.
removeAttributes (dict) --
Removes attributes from a message.
name (string) -- [REQUIRED]
The name of the 'removeAttributes' activity.
attributes (list) -- [REQUIRED]
A list of 1-50 attributes to remove from the message.
(string) --
next (string) --
The next activity in the pipeline.
selectAttributes (dict) --
Creates a new message using only the specified attributes from the original message.
name (string) -- [REQUIRED]
The name of the 'selectAttributes' activity.
attributes (list) -- [REQUIRED]
A list of the attributes to select from the message.
(string) --
next (string) --
The next activity in the pipeline.
filter (dict) --
Filters a message based on its attributes.
name (string) -- [REQUIRED]
The name of the 'filter' activity.
filter (string) -- [REQUIRED]
An expression that looks like an SQL WHERE clause that must return a Boolean value.
next (string) --
The next activity in the pipeline.
math (dict) --
Computes an arithmetic expression using the message's attributes and adds it to the message.
name (string) -- [REQUIRED]
The name of the 'math' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that will contain the result of the math operation.
math (string) -- [REQUIRED]
An expression that uses one or more existing attributes and must return an integer value.
next (string) --
The next activity in the pipeline.
deviceRegistryEnrich (dict) --
Adds data from the AWS IoT device registry to your message.
name (string) -- [REQUIRED]
The name of the 'deviceRegistryEnrich' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that is added to the message.
thingName (string) -- [REQUIRED]
The name of the IoT device whose registry information is added to the message.
roleArn (string) -- [REQUIRED]
The ARN of the role that allows access to the device's registry information.
next (string) --
The next activity in the pipeline.
deviceShadowEnrich (dict) --
Adds information from the AWS IoT Device Shadows service to a message.
name (string) -- [REQUIRED]
The name of the 'deviceShadowEnrich' activity.
attribute (string) -- [REQUIRED]
The name of the attribute that is added to the message.
thingName (string) -- [REQUIRED]
The name of the IoT device whose shadow information is added to the message.
roleArn (string) -- [REQUIRED]
The ARN of the role that allows access to the device's shadow.
next (string) --
The next activity in the pipeline.
None