IoTAnalytics

Table of Contents

Client

class IoTAnalytics.Client

A low-level client representing AWS IoT Analytics:

client = session.create_client('iotanalytics')

These are the available methods:

batch_put_message(**kwargs)

Sends messages to a channel.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_message(
    channelName='string',
    messages=[
        {
            'messageId': 'string',
            'payload': b'bytes'
        },
    ]
)
Parameters
  • channelName (string) --

    [REQUIRED]

    The name of the channel where the messages are sent.

  • messages (list) --

    [REQUIRED]

    The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.

    Note that the field names of message payloads (data) that you send to AWS 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 greater 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.

    • (dict) --

      Information about a message.

      • messageId (string) -- [REQUIRED]

        The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

      • payload (bytes) -- [REQUIRED]

        The payload of the message. This may 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).

Return type

dict

Returns

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.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_pipeline_reprocessing(**kwargs)

Cancels the reprocessing of data through the pipeline.

See also: AWS API Documentation

Request Syntax

response = client.cancel_pipeline_reprocessing(
    pipelineName='string',
    reprocessingId='string'
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of pipeline for which data reprocessing is canceled.

  • reprocessingId (string) --

    [REQUIRED]

    The ID of the reprocessing task (returned by "StartPipelineReprocessing").

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_channel(**kwargs)

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

response = client.create_channel(
    channelName='string',
    retentionPeriod={
        'unlimited': True|False,
        'numberOfDays': 123
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • channelName (string) --

    [REQUIRED]

    The name 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.

  • tags (list) --

    Metadata which can be used to manage the channel.

    • (dict) --

      A set of key/value pairs which are used to manage the resource.

      • key (string) -- [REQUIRED]

        The tag's key.

      • value (string) -- [REQUIRED]

        The tag's value.

Return type

dict

Returns

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.

create_dataset(**kwargs)

Creates a data set. A data set 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 data set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify.

See also: AWS API Documentation

Request Syntax

response = client.create_dataset(
    datasetName='string',
    actions=[
        {
            'actionName': 'string',
            'queryAction': {
                'sqlQuery': 'string',
                'filters': [
                    {
                        'deltaTime': {
                            'offsetSeconds': 123,
                            'timeExpression': 'string'
                        }
                    },
                ]
            },
            'containerAction': {
                'image': 'string',
                'executionRoleArn': 'string',
                'resourceConfiguration': {
                    'computeType': 'ACU_1'|'ACU_2',
                    'volumeSizeInGB': 123
                },
                'variables': [
                    {
                        'name': 'string',
                        'stringValue': 'string',
                        'doubleValue': 123.0,
                        'datasetContentVersionValue': {
                            'datasetName': 'string'
                        },
                        'outputFileUriValue': {
                            'fileName': 'string'
                        }
                    },
                ]
            }
        },
    ],
    triggers=[
        {
            'schedule': {
                'expression': 'string'
            },
            'dataset': {
                'name': 'string'
            }
        },
    ],
    contentDeliveryRules=[
        {
            'entryName': 'string',
            'destination': {
                'iotEventsDestinationConfiguration': {
                    'inputName': 'string',
                    'roleArn': 'string'
                }
            }
        },
    ],
    retentionPeriod={
        'unlimited': True|False,
        'numberOfDays': 123
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • datasetName (string) --

    [REQUIRED]

    The name of the data set.

  • actions (list) --

    [REQUIRED]

    A list of actions that create the data set contents.

    • (dict) --

      A "DatasetAction" object that specifies how data set contents are automatically created.

      • actionName (string) --

        The name of the data set action by which data set contents are automatically created.

      • queryAction (dict) --

        An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.

        • sqlQuery (string) -- [REQUIRED]

          A SQL query string.

        • filters (list) --

          Pre-filters applied to message data.

          • (dict) --

            Information which is used to filter message data, to segregate it according to the time frame in which it arrives.

            • deltaTime (dict) --

              Used to limit data to that which has arrived since the last execution of the action.

              • offsetSeconds (integer) -- [REQUIRED]

                The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will 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 time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.

              • timeExpression (string) -- [REQUIRED]

                An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.

      • containerAction (dict) --

        Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.

        • image (string) -- [REQUIRED]

          The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.

        • executionRoleArn (string) -- [REQUIRED]

          The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.

        • resourceConfiguration (dict) -- [REQUIRED]

          Configuration of the resource which executes the "containerAction".

          • computeType (string) -- [REQUIRED]

            The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).

          • volumeSizeInGB (integer) -- [REQUIRED]

            The size (in GB) of the persistent storage available to the resource instance used to execute the "containerAction" (min: 1, max: 50).

        • variables (list) --

          The values of variables used within 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", or "outputFileUriValue".

          • (dict) --

            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".

            • name (string) -- [REQUIRED]

              The name of the variable.

            • stringValue (string) --

              The value of the variable as a string.

            • doubleValue (float) --

              The value of the variable as a double (numeric).

            • datasetContentVersionValue (dict) --

              The value of the variable as a structure that specifies a data set content version.

              • datasetName (string) -- [REQUIRED]

                The name of the data set whose latest contents are used as input to the notebook or application.

            • outputFileUriValue (dict) --

              The value of the variable as a structure that specifies an output file URI.

              • fileName (string) -- [REQUIRED]

                The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.

  • triggers (list) --

    A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. 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.

      • dataset (dict) --

        The data set whose content creation triggers the creation of this data set's contents.

        • name (string) -- [REQUIRED]

          The name of the data set whose content generation triggers the new data set content generation.

  • contentDeliveryRules (list) --

    When data set contents are created they are delivered to destinations specified here.

    • (dict) --

      When data set contents are created they are delivered to destination specified here.

      • entryName (string) --

        The name of the data set content delivery rules entry.

      • destination (dict) -- [REQUIRED]

        The destination to which data set contents are delivered.

        • iotEventsDestinationConfiguration (dict) --

          Configuration information for delivery of data set contents to AWS IoT Events.

          • inputName (string) -- [REQUIRED]

            The name of the AWS IoT Events input to which data set contents are delivered.

          • roleArn (string) -- [REQUIRED]

            The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input.

  • retentionPeriod (dict) --

    [Optional] How long, in days, message data is kept for the data set. If not given or set to null, the latest version of the dataset content plus the latest succeeded version (if they are different) are retained for at most 90 days.

    • 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.

  • tags (list) --

    Metadata which can be used to manage the data set.

    • (dict) --

      A set of key/value pairs which are used to manage the resource.

      • key (string) -- [REQUIRED]

        The tag's key.

      • value (string) -- [REQUIRED]

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'datasetName': 'string',
    'datasetArn': 'string',
    'retentionPeriod': {
        'unlimited': True|False,
        'numberOfDays': 123
    }
}

Response Structure

  • (dict) --

    • datasetName (string) --

      The name of the data set.

    • datasetArn (string) --

      The ARN of the data set.

    • retentionPeriod (dict) --

      How long, in days, message data is kept for the data set.

      • 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.

create_dataset_content(**kwargs)

Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application).

See also: AWS API Documentation

Request Syntax

response = client.create_dataset_content(
    datasetName='string'
)
Parameters
datasetName (string) --

[REQUIRED]

The name of the data set.

Return type
dict
Returns
Response Syntax
{
    'versionId': 'string'
}

Response Structure

  • (dict) --
    • versionId (string) --

      The version ID of the data set contents which are being created.

create_datastore(**kwargs)

Creates a data store, which is a repository for messages.

See also: AWS API Documentation

Request Syntax

response = client.create_datastore(
    datastoreName='string',
    retentionPeriod={
        'unlimited': True|False,
        'numberOfDays': 123
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • datastoreName (string) --

    [REQUIRED]

    The name 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.

  • tags (list) --

    Metadata which can be used to manage the data store.

    • (dict) --

      A set of key/value pairs which are used to manage the resource.

      • key (string) -- [REQUIRED]

        The tag's key.

      • value (string) -- [REQUIRED]

        The tag's value.

Return type

dict

Returns

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.

create_pipeline(**kwargs)

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

response = 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'
            }
        },
    ],
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline.

  • pipelineActivities (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 a 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 contains 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.

  • tags (list) --

    Metadata which can be used to manage the pipeline.

    • (dict) --

      A set of key/value pairs which are used to manage the resource.

      • key (string) -- [REQUIRED]

        The tag's key.

      • value (string) -- [REQUIRED]

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'pipelineName': 'string',
    'pipelineArn': 'string'
}

Response Structure

  • (dict) --

    • pipelineName (string) --

      The name of the pipeline.

    • pipelineArn (string) --

      The ARN of the pipeline.

delete_channel(**kwargs)

Deletes the specified channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_channel(
    channelName='string'
)
Parameters
channelName (string) --

[REQUIRED]

The name of the channel to delete.

Returns
None
delete_dataset(**kwargs)

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

response = client.delete_dataset(
    datasetName='string'
)
Parameters
datasetName (string) --

[REQUIRED]

The name of the data set to delete.

Returns
None
delete_dataset_content(**kwargs)

Deletes the content of the specified data set.

See also: AWS API Documentation

Request Syntax

response = client.delete_dataset_content(
    datasetName='string',
    versionId='string'
)
Parameters
  • datasetName (string) --

    [REQUIRED]

    The name of the data set whose content is deleted.

  • versionId (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.
Returns

None

delete_datastore(**kwargs)

Deletes the specified data store.

See also: AWS API Documentation

Request Syntax

response = client.delete_datastore(
    datastoreName='string'
)
Parameters
datastoreName (string) --

[REQUIRED]

The name of the data store to delete.

Returns
None
delete_pipeline(**kwargs)

Deletes the specified pipeline.

See also: AWS API Documentation

Request Syntax

response = client.delete_pipeline(
    pipelineName='string'
)
Parameters
pipelineName (string) --

[REQUIRED]

The name of the pipeline to delete.

Returns
None
describe_channel(**kwargs)

Retrieves information about a channel.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel(
    channelName='string',
    includeStatistics=True|False
)
Parameters
  • channelName (string) --

    [REQUIRED]

    The name of the channel whose information is retrieved.

  • includeStatistics (boolean) -- If true, additional statistical information about the channel is included in the response.
Return type

dict

Returns

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)
    },
    'statistics': {
        'size': {
            'estimatedSizeInBytes': 123.0,
            'estimatedOn': 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.

    • statistics (dict) --

      Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.

      • size (dict) --

        The estimated size of the channel.

        • estimatedSizeInBytes (float) --

          The estimated size of the resource in bytes.

        • estimatedOn (datetime) --

          The time when the estimate of the size of the resource was made.

describe_dataset(**kwargs)

Retrieves information about a data set.

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset(
    datasetName='string'
)
Parameters
datasetName (string) --

[REQUIRED]

The name of the data set whose information is retrieved.

Return type
dict
Returns
Response Syntax
{
    'dataset': {
        'name': 'string',
        'arn': 'string',
        'actions': [
            {
                'actionName': 'string',
                'queryAction': {
                    'sqlQuery': 'string',
                    'filters': [
                        {
                            'deltaTime': {
                                'offsetSeconds': 123,
                                'timeExpression': 'string'
                            }
                        },
                    ]
                },
                'containerAction': {
                    'image': 'string',
                    'executionRoleArn': 'string',
                    'resourceConfiguration': {
                        'computeType': 'ACU_1'|'ACU_2',
                        'volumeSizeInGB': 123
                    },
                    'variables': [
                        {
                            'name': 'string',
                            'stringValue': 'string',
                            'doubleValue': 123.0,
                            'datasetContentVersionValue': {
                                'datasetName': 'string'
                            },
                            'outputFileUriValue': {
                                'fileName': 'string'
                            }
                        },
                    ]
                }
            },
        ],
        'triggers': [
            {
                'schedule': {
                    'expression': 'string'
                },
                'dataset': {
                    'name': 'string'
                }
            },
        ],
        'contentDeliveryRules': [
            {
                'entryName': 'string',
                'destination': {
                    'iotEventsDestinationConfiguration': {
                        'inputName': 'string',
                        'roleArn': 'string'
                    }
                }
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1),
        'retentionPeriod': {
            'unlimited': True|False,
            'numberOfDays': 123
        }
    }
}

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 automatically create the data set contents.

        • (dict) --

          A "DatasetAction" object that specifies how data set contents are automatically created.

          • actionName (string) --

            The name of the data set action by which data set contents are automatically created.

          • queryAction (dict) --

            An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.

            • sqlQuery (string) --

              A SQL query string.

            • filters (list) --

              Pre-filters applied to message data.

              • (dict) --

                Information which is used to filter message data, to segregate it according to the time frame in which it arrives.

                • deltaTime (dict) --

                  Used to limit data to that which has arrived since the last execution of the action.

                  • offsetSeconds (integer) --

                    The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will 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 time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.

                  • timeExpression (string) --

                    An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.

          • containerAction (dict) --

            Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.

            • image (string) --

              The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.

            • executionRoleArn (string) --

              The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.

            • resourceConfiguration (dict) --

              Configuration of the resource which executes the "containerAction".

              • computeType (string) --

                The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).

              • volumeSizeInGB (integer) --

                The size (in GB) of the persistent storage available to the resource instance used to execute the "containerAction" (min: 1, max: 50).

            • variables (list) --

              The values of variables used within 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", or "outputFileUriValue".

              • (dict) --

                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".

                • name (string) --

                  The name of the variable.

                • stringValue (string) --

                  The value of the variable as a string.

                • doubleValue (float) --

                  The value of the variable as a double (numeric).

                • datasetContentVersionValue (dict) --

                  The value of the variable as a structure that specifies a data set content version.

                  • datasetName (string) --

                    The name of the data set whose latest contents are used as input to the notebook or application.

                • outputFileUriValue (dict) --

                  The value of the variable as a structure that specifies an output file URI.

                  • fileName (string) --

                    The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.

      • 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.

          • dataset (dict) --

            The data set whose content creation triggers the creation of this data set's contents.

            • name (string) --

              The name of the data set whose content generation triggers the new data set content generation.

      • contentDeliveryRules (list) --

        When data set contents are created they are delivered to destinations specified here.

        • (dict) --

          When data set contents are created they are delivered to destination specified here.

          • entryName (string) --

            The name of the data set content delivery rules entry.

          • destination (dict) --

            The destination to which data set contents are delivered.

            • iotEventsDestinationConfiguration (dict) --

              Configuration information for delivery of data set contents to AWS IoT Events.

              • inputName (string) --

                The name of the AWS IoT Events input to which data set contents are delivered.

              • roleArn (string) --

                The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input.

      • 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.

      • retentionPeriod (dict) --

        [Optional] How long, in days, message data is kept for the data set.

        • 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.

describe_datastore(**kwargs)

Retrieves information about a data store.

See also: AWS API Documentation

Request Syntax

response = client.describe_datastore(
    datastoreName='string',
    includeStatistics=True|False
)
Parameters
  • datastoreName (string) --

    [REQUIRED]

    The name of the data store

  • includeStatistics (boolean) -- If true, additional statistical information about the datastore is included in the response.
Return type

dict

Returns

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)
    },
    'statistics': {
        'size': {
            'estimatedSizeInBytes': 123.0,
            'estimatedOn': 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.

    • statistics (dict) --

      Additional statistical information about the data store. Included if the 'includeStatistics' parameter is set to true in the request.

      • size (dict) --

        The estimated size of the data store.

        • estimatedSizeInBytes (float) --

          The estimated size of the resource in bytes.

        • estimatedOn (datetime) --

          The time when the estimate of the size of the resource was made.

describe_logging_options()

Retrieves the current settings of the AWS IoT Analytics logging options.

See also: AWS API Documentation

Request Syntax

response = client.describe_logging_options()
Return type
dict
Returns
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.

describe_pipeline(**kwargs)

Retrieves information about a pipeline.

See also: AWS API Documentation

Request Syntax

response = client.describe_pipeline(
    pipelineName='string'
)
Parameters
pipelineName (string) --

[REQUIRED]

The name of the pipeline whose information is retrieved.

Return type
dict
Returns
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 a 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 contains 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.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_dataset_content(**kwargs)

Retrieves the contents of a data set as pre-signed URIs.

See also: AWS API Documentation

Request Syntax

response = client.get_dataset_content(
    datasetName='string',
    versionId='string'
)
Parameters
  • datasetName (string) --

    [REQUIRED]

    The name of the data set whose contents are retrieved.

  • versionId (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.
Return type

dict

Returns

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 contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED".

      • reason (string) --

        The reason the data set contents are in this state.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_channels(**kwargs)

Retrieves a list of channels.

See also: AWS API Documentation

Request Syntax

response = client.list_channels(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) --

    The maximum number of results to return in this request.

    The default value is 100.

Return type

dict

Returns

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.

list_dataset_contents(**kwargs)

Lists information about data set contents that have been created.

See also: AWS API Documentation

Request Syntax

response = client.list_dataset_contents(
    datasetName='string',
    nextToken='string',
    maxResults=123,
    scheduledOnOrAfter=datetime(2015, 1, 1),
    scheduledBefore=datetime(2015, 1, 1)
)
Parameters
  • datasetName (string) --

    [REQUIRED]

    The name of the data set whose contents information you want to list.

  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return in this request.
  • scheduledOnOrAfter (datetime) -- A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
  • scheduledBefore (datetime) -- A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
Return type

dict

Returns

Response Syntax

{
    'datasetContentSummaries': [
        {
            'version': 'string',
            'status': {
                'state': 'CREATING'|'SUCCEEDED'|'FAILED',
                'reason': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'scheduleTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • datasetContentSummaries (list) --

      Summary information about data set contents that have been created.

      • (dict) --

        Summary information about data set contents.

        • version (string) --

          The version of the data set contents.

        • status (dict) --

          The status of the data set contents.

          • state (string) --

            The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED".

          • reason (string) --

            The reason the data set contents are in this state.

        • creationTime (datetime) --

          The actual time the creation of the data set contents was started.

        • scheduleTime (datetime) --

          The time the creation of the data set contents was scheduled to start.

    • nextToken (string) --

      The token to retrieve the next set of results, or null if there are no more results.

list_datasets(**kwargs)

Retrieves information about data sets.

See also: AWS API Documentation

Request Syntax

response = client.list_datasets(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) --

    The maximum number of results to return in this request.

    The default value is 100.

Return type

dict

Returns

Response Syntax

{
    'datasetSummaries': [
        {
            'datasetName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'triggers': [
                {
                    'schedule': {
                        'expression': 'string'
                    },
                    'dataset': {
                        'name': 'string'
                    }
                },
            ],
            'actions': [
                {
                    'actionName': 'string',
                    'actionType': 'QUERY'|'CONTAINER'
                },
            ]
        },
    ],
    '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.

        • triggers (list) --

          A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. 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.

            • dataset (dict) --

              The data set whose content creation triggers the creation of this data set's contents.

              • name (string) --

                The name of the data set whose content generation triggers the new data set content generation.

        • actions (list) --

          A list of "DataActionSummary" objects.

          • (dict) --

            • actionName (string) --

              The name of the action which automatically creates the data set's contents.

            • actionType (string) --

              The type of action by which the data set's contents are automatically created.

    • nextToken (string) --

      The token to retrieve the next set of results, or null if there are no more results.

list_datastores(**kwargs)

Retrieves a list of data stores.

See also: AWS API Documentation

Request Syntax

response = client.list_datastores(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) --

    The maximum number of results to return in this request.

    The default value is 100.

Return type

dict

Returns

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.

list_pipelines(**kwargs)

Retrieves a list of pipelines.

See also: AWS API Documentation

Request Syntax

response = client.list_pipelines(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) --

    The maximum number of results to return in this request.

    The default value is 100.

Return type

dict

Returns

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.

list_tags_for_resource(**kwargs)

Lists the tags (metadata) which you have assigned to the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The ARN of the resource whose tags you want to list.

Return type
dict
Returns
Response Syntax
{
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • tags (list) --

      The tags (metadata) which you have assigned to the resource.

      • (dict) --

        A set of key/value pairs which are used to manage the resource.

        • key (string) --

          The tag's key.

        • value (string) --

          The tag's value.

put_logging_options(**kwargs)

Sets or updates the AWS IoT Analytics logging options.

Note that 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 5 minutes for that change to take effect.

See also: AWS API Documentation

Request Syntax

response = client.put_logging_options(
    loggingOptions={
        'roleArn': 'string',
        'level': 'ERROR',
        'enabled': True|False
    }
)
Parameters
loggingOptions (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.

Returns
None
run_pipeline_activity(**kwargs)

Simulates the results of running a pipeline activity on a message payload.

See also: AWS API Documentation

Request Syntax

response = 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',
    ]
)
Parameters
  • pipelineActivity (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 a 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 contains 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.

  • payloads (list) --

    [REQUIRED]

    The sample message payloads on which the pipeline activity is run.

    • (bytes) --
Return type

dict

Returns

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.

sample_channel_data(**kwargs)

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

response = client.sample_channel_data(
    channelName='string',
    maxMessages=123,
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
Parameters
  • channelName (string) --

    [REQUIRED]

    The name of the channel whose message samples are retrieved.

  • maxMessages (integer) -- The number of sample messages to be retrieved. The limit is 10, the default is also 10.
  • startTime (datetime) -- The start of the time window from which sample messages are retrieved.
  • endTime (datetime) -- The end of the time window from which sample messages are retrieved.
Return type

dict

Returns

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) --

start_pipeline_reprocessing(**kwargs)

Starts the reprocessing of raw message data through the pipeline.

See also: AWS API Documentation

Request Syntax

response = client.start_pipeline_reprocessing(
    pipelineName='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline on which to start reprocessing.

  • startTime (datetime) -- The start time (inclusive) of raw message data that is reprocessed.
  • endTime (datetime) -- The end time (exclusive) of raw message data that is reprocessed.
Return type

dict

Returns

Response Syntax

{
    'reprocessingId': 'string'
}

Response Structure

  • (dict) --

    • reprocessingId (string) --

      The ID of the pipeline reprocessing activity that was started.

tag_resource(**kwargs)

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource whose tags you want to modify.

  • tags (list) --

    [REQUIRED]

    The new or modified tags for the resource.

    • (dict) --

      A set of key/value pairs which are used to manage the resource.

      • key (string) -- [REQUIRED]

        The tag's key.

      • value (string) -- [REQUIRED]

        The tag's value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

Removes the given tags (metadata) from the resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource whose tags you want to remove.

  • tagKeys (list) --

    [REQUIRED]

    The keys of those tags which you want to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_channel(**kwargs)

Updates the settings of a channel.

See also: AWS API Documentation

Request Syntax

response = client.update_channel(
    channelName='string',
    retentionPeriod={
        'unlimited': True|False,
        'numberOfDays': 123
    }
)
Parameters
  • channelName (string) --

    [REQUIRED]

    The name of the channel to be updated.

  • 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.

Returns

None

update_dataset(**kwargs)

Updates the settings of a data set.

See also: AWS API Documentation

Request Syntax

response = client.update_dataset(
    datasetName='string',
    actions=[
        {
            'actionName': 'string',
            'queryAction': {
                'sqlQuery': 'string',
                'filters': [
                    {
                        'deltaTime': {
                            'offsetSeconds': 123,
                            'timeExpression': 'string'
                        }
                    },
                ]
            },
            'containerAction': {
                'image': 'string',
                'executionRoleArn': 'string',
                'resourceConfiguration': {
                    'computeType': 'ACU_1'|'ACU_2',
                    'volumeSizeInGB': 123
                },
                'variables': [
                    {
                        'name': 'string',
                        'stringValue': 'string',
                        'doubleValue': 123.0,
                        'datasetContentVersionValue': {
                            'datasetName': 'string'
                        },
                        'outputFileUriValue': {
                            'fileName': 'string'
                        }
                    },
                ]
            }
        },
    ],
    triggers=[
        {
            'schedule': {
                'expression': 'string'
            },
            'dataset': {
                'name': 'string'
            }
        },
    ],
    contentDeliveryRules=[
        {
            'entryName': 'string',
            'destination': {
                'iotEventsDestinationConfiguration': {
                    'inputName': 'string',
                    'roleArn': 'string'
                }
            }
        },
    ],
    retentionPeriod={
        'unlimited': True|False,
        'numberOfDays': 123
    }
)
Parameters
  • datasetName (string) --

    [REQUIRED]

    The name of the data set to update.

  • actions (list) --

    [REQUIRED]

    A list of "DatasetAction" objects.

    • (dict) --

      A "DatasetAction" object that specifies how data set contents are automatically created.

      • actionName (string) --

        The name of the data set action by which data set contents are automatically created.

      • queryAction (dict) --

        An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.

        • sqlQuery (string) -- [REQUIRED]

          A SQL query string.

        • filters (list) --

          Pre-filters applied to message data.

          • (dict) --

            Information which is used to filter message data, to segregate it according to the time frame in which it arrives.

            • deltaTime (dict) --

              Used to limit data to that which has arrived since the last execution of the action.

              • offsetSeconds (integer) -- [REQUIRED]

                The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will 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 time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.

              • timeExpression (string) -- [REQUIRED]

                An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.

      • containerAction (dict) --

        Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.

        • image (string) -- [REQUIRED]

          The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.

        • executionRoleArn (string) -- [REQUIRED]

          The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.

        • resourceConfiguration (dict) -- [REQUIRED]

          Configuration of the resource which executes the "containerAction".

          • computeType (string) -- [REQUIRED]

            The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).

          • volumeSizeInGB (integer) -- [REQUIRED]

            The size (in GB) of the persistent storage available to the resource instance used to execute the "containerAction" (min: 1, max: 50).

        • variables (list) --

          The values of variables used within 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", or "outputFileUriValue".

          • (dict) --

            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".

            • name (string) -- [REQUIRED]

              The name of the variable.

            • stringValue (string) --

              The value of the variable as a string.

            • doubleValue (float) --

              The value of the variable as a double (numeric).

            • datasetContentVersionValue (dict) --

              The value of the variable as a structure that specifies a data set content version.

              • datasetName (string) -- [REQUIRED]

                The name of the data set whose latest contents are used as input to the notebook or application.

            • outputFileUriValue (dict) --

              The value of the variable as a structure that specifies an output file URI.

              • fileName (string) -- [REQUIRED]

                The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.

  • triggers (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.

      • dataset (dict) --

        The data set whose content creation triggers the creation of this data set's contents.

        • name (string) -- [REQUIRED]

          The name of the data set whose content generation triggers the new data set content generation.

  • contentDeliveryRules (list) --

    When data set contents are created they are delivered to destinations specified here.

    • (dict) --

      When data set contents are created they are delivered to destination specified here.

      • entryName (string) --

        The name of the data set content delivery rules entry.

      • destination (dict) -- [REQUIRED]

        The destination to which data set contents are delivered.

        • iotEventsDestinationConfiguration (dict) --

          Configuration information for delivery of data set contents to AWS IoT Events.

          • inputName (string) -- [REQUIRED]

            The name of the AWS IoT Events input to which data set contents are delivered.

          • roleArn (string) -- [REQUIRED]

            The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input.

  • retentionPeriod (dict) --

    How long, in days, message data is kept for the data set.

    • 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.

Returns

None

update_datastore(**kwargs)

Updates the settings of a data store.

See also: AWS API Documentation

Request Syntax

response = client.update_datastore(
    datastoreName='string',
    retentionPeriod={
        'unlimited': True|False,
        'numberOfDays': 123
    }
)
Parameters
  • datastoreName (string) --

    [REQUIRED]

    The name of the data store to be updated.

  • 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.

Returns

None

update_pipeline(**kwargs)

Updates the settings of a pipeline.

See also: AWS API Documentation

Request Syntax

response = 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'
            }
        },
    ]
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline to update.

  • pipelineActivities (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 a 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 contains 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.

Returns

None

Paginators

The available paginators are:

class IoTAnalytics.Paginator.ListChannels
paginator = client.get_paginator('list_channels')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTAnalytics.Client.list_channels().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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) --

      A token to resume pagination.

class IoTAnalytics.Paginator.ListDatasetContents
paginator = client.get_paginator('list_dataset_contents')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTAnalytics.Client.list_dataset_contents().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetName='string',
    scheduledOnOrAfter=datetime(2015, 1, 1),
    scheduledBefore=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • datasetName (string) --

    [REQUIRED]

    The name of the data set whose contents information you want to list.

  • scheduledOnOrAfter (datetime) -- A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
  • scheduledBefore (datetime) -- A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'datasetContentSummaries': [
        {
            'version': 'string',
            'status': {
                'state': 'CREATING'|'SUCCEEDED'|'FAILED',
                'reason': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'scheduleTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • datasetContentSummaries (list) --

      Summary information about data set contents that have been created.

      • (dict) --

        Summary information about data set contents.

        • version (string) --

          The version of the data set contents.

        • status (dict) --

          The status of the data set contents.

          • state (string) --

            The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED".

          • reason (string) --

            The reason the data set contents are in this state.

        • creationTime (datetime) --

          The actual time the creation of the data set contents was started.

        • scheduleTime (datetime) --

          The time the creation of the data set contents was scheduled to start.

    • NextToken (string) --

      A token to resume pagination.

class IoTAnalytics.Paginator.ListDatasets
paginator = client.get_paginator('list_datasets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTAnalytics.Client.list_datasets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'datasetSummaries': [
        {
            'datasetName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'triggers': [
                {
                    'schedule': {
                        'expression': 'string'
                    },
                    'dataset': {
                        'name': 'string'
                    }
                },
            ],
            'actions': [
                {
                    'actionName': 'string',
                    'actionType': 'QUERY'|'CONTAINER'
                },
            ]
        },
    ],
    '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.

        • triggers (list) --

          A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. 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.

            • dataset (dict) --

              The data set whose content creation triggers the creation of this data set's contents.

              • name (string) --

                The name of the data set whose content generation triggers the new data set content generation.

        • actions (list) --

          A list of "DataActionSummary" objects.

          • (dict) --
            • actionName (string) --

              The name of the action which automatically creates the data set's contents.

            • actionType (string) --

              The type of action by which the data set's contents are automatically created.

    • NextToken (string) --

      A token to resume pagination.

class IoTAnalytics.Paginator.ListDatastores
paginator = client.get_paginator('list_datastores')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTAnalytics.Client.list_datastores().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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) --

      A token to resume pagination.

class IoTAnalytics.Paginator.ListPipelines
paginator = client.get_paginator('list_pipelines')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTAnalytics.Client.list_pipelines().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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) --

      A token to resume pagination.