@datafire/amazonaws_iotanalytics v5.0.0

@datafire/amazonaws_iotanalytics

Client library for AWS IoT Analytics

Installation and Usage

npm install --save @datafire/amazonaws_iotanalytics

let amazonaws_iotanalytics = require('@datafire/amazonaws_iotanalytics').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_iotanalytics.ListChannels({}).then(data => {
  console.log(data);
});

Description

Actions

ListChannels

amazonaws_iotanalytics.ListChannels({}, context)

Input

• input object
  • maxResults string
  • nextToken string

Output

• output ListChannelsResponse

CreateChannel

amazonaws_iotanalytics.CreateChannel({
  "channelName": ""
}, context)

Input

• input object
  • channelName required ChannelName
  • retentionPeriod RetentionPeriod

Output

Output schema unknown

DeleteChannel

amazonaws_iotanalytics.DeleteChannel({
  "channelName": ""
}, context)

Input

• input object
  • channelName required string

Output

Output schema unknown

DescribeChannel

amazonaws_iotanalytics.DescribeChannel({
  "channelName": ""
}, context)

Input

• input object
  • channelName required string

Output

• output DescribeChannelResponse

UpdateChannel

amazonaws_iotanalytics.UpdateChannel({
  "channelName": ""
}, context)

Input

• input object
  • channelName required string
  • retentionPeriod RetentionPeriod

Output

Output schema unknown

SampleChannelData

amazonaws_iotanalytics.SampleChannelData({
  "channelName": ""
}, context)

Input

• input object
  • channelName required string

Output

• output SampleChannelDataResponse

ListDatasets

amazonaws_iotanalytics.ListDatasets({}, context)

Input

• input object
  • maxResults string
  • nextToken string

Output

• output ListDatasetsResponse

CreateDataset

amazonaws_iotanalytics.CreateDataset({
  "datasetName": "",
  "actions": []
}, context)

Input

• input object
  • actions required DatasetActions
  • datasetName required DatasetName
  • triggers DatasetTriggers

Output

Output schema unknown

DeleteDataset

amazonaws_iotanalytics.DeleteDataset({
  "datasetName": ""
}, context)

Input

• input object
  • datasetName required string

Output

Output schema unknown

DescribeDataset

amazonaws_iotanalytics.DescribeDataset({
  "datasetName": ""
}, context)

Input

• input object
  • datasetName required string

Output

• output DescribeDatasetResponse

UpdateDataset

amazonaws_iotanalytics.UpdateDataset({
  "datasetName": "",
  "actions": []
}, context)

Input

• input object
  • datasetName required string
  • actions required DatasetActions
  • triggers DatasetTriggers

Output

Output schema unknown

DeleteDatasetContent

amazonaws_iotanalytics.DeleteDatasetContent({
  "datasetName": ""
}, context)

Input

• input object
  • datasetName required string

Output

Output schema unknown

GetDatasetContent

amazonaws_iotanalytics.GetDatasetContent({
  "datasetName": ""
}, context)

Input

• input object
  • datasetName required string

Output

• output GetDatasetContentResponse

CreateDatasetContent

amazonaws_iotanalytics.CreateDatasetContent({
  "datasetName": ""
}, context)

Input

• input object
  • datasetName required string

Output

Output schema unknown

ListDatastores

amazonaws_iotanalytics.ListDatastores({}, context)

Input

• input object
  • maxResults string
  • nextToken string

Output

• output ListDatastoresResponse

CreateDatastore

amazonaws_iotanalytics.CreateDatastore({
  "datastoreName": ""
}, context)

Input

• input object
  • datastoreName required DatastoreName
  • retentionPeriod RetentionPeriod

Output

Output schema unknown

DeleteDatastore

amazonaws_iotanalytics.DeleteDatastore({
  "datastoreName": ""
}, context)

Input

• input object
  • datastoreName required string

Output

Output schema unknown

DescribeDatastore

amazonaws_iotanalytics.DescribeDatastore({
  "datastoreName": ""
}, context)

Input

• input object
  • datastoreName required string

Output

• output DescribeDatastoreResponse

UpdateDatastore

amazonaws_iotanalytics.UpdateDatastore({
  "datastoreName": ""
}, context)

Input

• input object
  • datastoreName required string
  • retentionPeriod RetentionPeriod

Output

Output schema unknown

DescribeLoggingOptions

amazonaws_iotanalytics.DescribeLoggingOptions({}, context)

Input

• input object

Output

• output DescribeLoggingOptionsResponse

PutLoggingOptions

amazonaws_iotanalytics.PutLoggingOptions({
  "loggingOptions": {
    "roleArn": "",
    "level": "",
    "enabled": true
  }
}, context)

Input

• input object
  • loggingOptions required LoggingOptions

Output

Output schema unknown

BatchPutMessage

amazonaws_iotanalytics.BatchPutMessage({
  "channelName": "",
  "messages": []
}, context)

Input

• input object
  • channelName required ChannelName
  • messages required Messages

Output

• output BatchPutMessageResponse

RunPipelineActivity

amazonaws_iotanalytics.RunPipelineActivity({
  "pipelineActivity": {},
  "payloads": []
}, context)

Input

• input object
  • payloads required MessagePayloads
  • pipelineActivity required PipelineActivity

Output

• output RunPipelineActivityResponse

ListPipelines

amazonaws_iotanalytics.ListPipelines({}, context)

Input

• input object
  • maxResults string
  • nextToken string

Output

• output ListPipelinesResponse

CreatePipeline

amazonaws_iotanalytics.CreatePipeline({
  "pipelineName": "",
  "pipelineActivities": []
}, context)

Input

• input object
  • pipelineActivities required PipelineActivities
  • pipelineName required PipelineName

Output

Output schema unknown

DeletePipeline

amazonaws_iotanalytics.DeletePipeline({
  "pipelineName": ""
}, context)

Input

• input object
  • pipelineName required string

Output

Output schema unknown

DescribePipeline

amazonaws_iotanalytics.DescribePipeline({
  "pipelineName": ""
}, context)

Input

• input object
  • pipelineName required string

Output

• output DescribePipelineResponse

UpdatePipeline

amazonaws_iotanalytics.UpdatePipeline({
  "pipelineName": "",
  "pipelineActivities": []
}, context)

Input

• input object
  • pipelineName required string
  • pipelineActivities required PipelineActivities

Output

Output schema unknown

StartPipelineReprocessing

amazonaws_iotanalytics.StartPipelineReprocessing({
  "pipelineName": ""
}, context)

Input

• input object
  • pipelineName required string
  • endTime EndTime
  • startTime StartTime

Output

• output StartPipelineReprocessingResponse

CancelPipelineReprocessing

amazonaws_iotanalytics.CancelPipelineReprocessing({
  "pipelineName": "",
  "reprocessingId": ""
}, context)

Input

• input object
  • pipelineName required string
  • reprocessingId required string

Output

• output CancelPipelineReprocessingResponse

Definitions

ActivityBatchSize

• ActivityBatchSize integer

ActivityName

• ActivityName string

AddAttributesActivity

• AddAttributesActivity object: An activity that adds other attributes based on existing attributes in the message.
  • attributes required AttributeNameMapping
  • name required ActivityName
  • next ActivityName

AttributeName

• AttributeName string

AttributeNameMapping

• AttributeNameMapping array
  • items object
    • key AttributeName
    • value AttributeName

AttributeNames

• AttributeNames array
  • items AttributeName

BatchPutMessageErrorEntries

• BatchPutMessageErrorEntries array
  • items BatchPutMessageErrorEntry

BatchPutMessageErrorEntry

• BatchPutMessageErrorEntry object: Contains informations about errors.
  • errorCode ErrorCode
  • errorMessage ErrorMessage
  • messageId MessageId

BatchPutMessageRequest

• BatchPutMessageRequest object
  • channelName required ChannelName
  • messages required Messages

BatchPutMessageResponse

• BatchPutMessageResponse object
  • batchPutMessageErrorEntries BatchPutMessageErrorEntries

CancelPipelineReprocessingRequest

• CancelPipelineReprocessingRequest object

CancelPipelineReprocessingResponse

• CancelPipelineReprocessingResponse object

Channel

• Channel object: A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
  • arn ChannelArn
  • creationTime Timestamp
  • lastUpdateTime Timestamp
  • name ChannelName
  • retentionPeriod RetentionPeriod
  • status ChannelStatus

ChannelActivity

• ChannelActivity object: The activity that determines the source of the messages to be processed.
  • channelName required ChannelName
  • name required ActivityName
  • next ActivityName

ChannelArn

• ChannelArn string

ChannelName

• ChannelName string

ChannelStatus

• ChannelStatus string (values: CREATING, ACTIVE, DELETING)

ChannelSummaries

• ChannelSummaries array
  • items ChannelSummary

ChannelSummary

• ChannelSummary object: A summary of information about a channel.
  • channelName ChannelName
  • creationTime Timestamp
  • lastUpdateTime Timestamp
  • status ChannelStatus

CreateChannelRequest

• CreateChannelRequest object
  • channelName required ChannelName
  • retentionPeriod RetentionPeriod

CreateChannelResponse

• CreateChannelResponse object
  • channelArn ChannelArn
  • channelName ChannelName
  • retentionPeriod RetentionPeriod

CreateDatasetContentRequest

• CreateDatasetContentRequest object

CreateDatasetRequest

• CreateDatasetRequest object
  • actions required DatasetActions
  • datasetName required DatasetName
  • triggers DatasetTriggers

CreateDatasetResponse

• CreateDatasetResponse object
  • datasetArn DatasetArn
  • datasetName DatasetName

CreateDatastoreRequest

• CreateDatastoreRequest object
  • datastoreName required DatastoreName
  • retentionPeriod RetentionPeriod

CreateDatastoreResponse

• CreateDatastoreResponse object
  • datastoreArn DatastoreArn
  • datastoreName DatastoreName
  • retentionPeriod RetentionPeriod

CreatePipelineRequest

• CreatePipelineRequest object
  • pipelineActivities required PipelineActivities
  • pipelineName required PipelineName

CreatePipelineResponse

• CreatePipelineResponse object
  • pipelineArn PipelineArn
  • pipelineName PipelineName

Dataset

• Dataset object: Information about a data set.
  • actions DatasetActions
  • arn DatasetArn
  • creationTime Timestamp
  • lastUpdateTime Timestamp
  • name DatasetName
  • status DatasetStatus
  • triggers DatasetTriggers

DatasetAction

• DatasetAction object: A "DatasetAction" object specifying the query that creates the data set content.
  • actionName DatasetActionName
  • queryAction SqlQueryDatasetAction

DatasetActionName

• DatasetActionName string

DatasetActions

• DatasetActions array
  • items DatasetAction

DatasetArn

• DatasetArn string

DatasetContentState

• DatasetContentState string (values: CREATING, SUCCEEDED, FAILED)

DatasetContentStatus

• DatasetContentStatus object: The state of the data set and the reason it is in this state.
  • reason Reason
  • state DatasetContentState

DatasetContentVersion

• DatasetContentVersion string

DatasetEntries

• DatasetEntries array
  • items DatasetEntry

DatasetEntry

• DatasetEntry object: The reference to a data set entry.
  • dataURI PresignedURI
  • entryName EntryName

DatasetName

• DatasetName string

DatasetStatus

• DatasetStatus string (values: CREATING, ACTIVE, DELETING)

DatasetSummaries

• DatasetSummaries array
  • items DatasetSummary

DatasetSummary

• DatasetSummary object: A summary of information about a data set.
  • creationTime Timestamp
  • datasetName DatasetName
  • lastUpdateTime Timestamp
  • status DatasetStatus

DatasetTrigger

• DatasetTrigger object: The "DatasetTrigger" that specifies when the data set is automatically updated.
  • schedule Schedule

DatasetTriggers

• DatasetTriggers array
  • items DatasetTrigger

Datastore

• Datastore object: Information about a data store.
  • arn DatastoreArn
  • creationTime Timestamp
  • lastUpdateTime Timestamp
  • name DatastoreName
  • retentionPeriod RetentionPeriod
  • status DatastoreStatus

DatastoreActivity

• DatastoreActivity object: The 'datastore' activity that specifies where to store the processed data.
  • datastoreName required DatastoreName
  • name required ActivityName

DatastoreArn

• DatastoreArn string

DatastoreName

• DatastoreName string

DatastoreStatus

• DatastoreStatus string (values: CREATING, ACTIVE, DELETING)

DatastoreSummaries

• DatastoreSummaries array
  • items DatastoreSummary

DatastoreSummary

• DatastoreSummary object: A summary of information about a data store.
  • creationTime Timestamp
  • datastoreName DatastoreName
  • lastUpdateTime Timestamp
  • status DatastoreStatus

DeleteChannelRequest

• DeleteChannelRequest object

DeleteDatasetContentRequest

• DeleteDatasetContentRequest object

DeleteDatasetRequest

• DeleteDatasetRequest object

DeleteDatastoreRequest

• DeleteDatastoreRequest object

DeletePipelineRequest

• DeletePipelineRequest object

DescribeChannelRequest

• DescribeChannelRequest object

DescribeChannelResponse

• DescribeChannelResponse object
  • channel Channel

DescribeDatasetRequest

• DescribeDatasetRequest object

DescribeDatasetResponse

• DescribeDatasetResponse object
  • dataset Dataset

DescribeDatastoreRequest

• DescribeDatastoreRequest object

DescribeDatastoreResponse

• DescribeDatastoreResponse object
  • datastore Datastore

DescribeLoggingOptionsRequest

• DescribeLoggingOptionsRequest object

DescribeLoggingOptionsResponse

• DescribeLoggingOptionsResponse object
  • loggingOptions LoggingOptions

DescribePipelineRequest

• DescribePipelineRequest object

DescribePipelineResponse

• DescribePipelineResponse object
  • pipeline Pipeline

DeviceRegistryEnrichActivity

• DeviceRegistryEnrichActivity object: An activity that adds data from the AWS IoT device registry to your message.
  • attribute required AttributeName
  • name required ActivityName
  • next ActivityName
  • roleArn required RoleArn
  • thingName required AttributeName

DeviceShadowEnrichActivity

• DeviceShadowEnrichActivity object: An activity that adds information from the AWS IoT Device Shadows service to a message.
  • attribute required AttributeName
  • name required ActivityName
  • next ActivityName
  • roleArn required RoleArn
  • thingName required AttributeName

EndTime

• EndTime string

EntryName

• EntryName string

ErrorCode

• ErrorCode string

ErrorMessage

• ErrorMessage string

FilterActivity

• FilterActivity object: An activity that filters a message based on its attributes.
  • filter required FilterExpression
  • name required ActivityName
  • next ActivityName

FilterExpression

• FilterExpression string

GetDatasetContentRequest

• GetDatasetContentRequest object

GetDatasetContentResponse

• GetDatasetContentResponse object
  • entries DatasetEntries
  • status DatasetContentStatus
  • timestamp Timestamp

InternalFailureException

• InternalFailureException object: There was an internal failure.
  • message errorMessage

InvalidRequestException

• InvalidRequestException object: The request was not valid.
  • message errorMessage

LambdaActivity

• LambdaActivity object: An activity that runs a Lambda function to modify the message.
  • batchSize required ActivityBatchSize
  • lambdaName required LambdaName
  • name required ActivityName
  • next ActivityName

LambdaName

• LambdaName string

LimitExceededException

• LimitExceededException object: The command caused an internal limit to be exceeded.
  • message errorMessage

ListChannelsRequest

• ListChannelsRequest object

ListChannelsResponse

• ListChannelsResponse object
  • channelSummaries ChannelSummaries
  • nextToken NextToken

ListDatasetsRequest

• ListDatasetsRequest object

ListDatasetsResponse

• ListDatasetsResponse object
  • datasetSummaries DatasetSummaries
  • nextToken NextToken

ListDatastoresRequest

• ListDatastoresRequest object

ListDatastoresResponse

• ListDatastoresResponse object
  • datastoreSummaries DatastoreSummaries
  • nextToken NextToken

ListPipelinesRequest

• ListPipelinesRequest object

ListPipelinesResponse

• ListPipelinesResponse object
  • nextToken NextToken
  • pipelineSummaries PipelineSummaries

LogResult

• LogResult string

LoggingEnabled

• LoggingEnabled boolean

LoggingLevel

• LoggingLevel string (values: ERROR)

LoggingOptions

• LoggingOptions object: Information about logging options.
  • enabled required LoggingEnabled
  • level required LoggingLevel
  • roleArn required RoleArn

MathActivity

• MathActivity object: An activity that computes an arithmetic expression using the message's attributes.
  • attribute required AttributeName
  • math required MathExpression
  • name required ActivityName
  • next ActivityName

MathExpression

• MathExpression string

MaxMessages

• MaxMessages integer

MaxResults

• MaxResults integer

Message

• Message object: Information about a message.
  • messageId required MessageId
  • payload required MessagePayload

MessageId

• MessageId string

MessagePayload

• MessagePayload string

MessagePayloads

• MessagePayloads array
  • items MessagePayload

Messages

• Messages array
  • items Message

NextToken

• NextToken string

Pipeline

• Pipeline object: Contains information about a pipeline.
  • activities PipelineActivities
  • arn PipelineArn
  • creationTime Timestamp
  • lastUpdateTime Timestamp
  • name PipelineName
  • reprocessingSummaries ReprocessingSummaries

PipelineActivities

• PipelineActivities array
  • items PipelineActivity

PipelineActivity

• PipelineActivity object: An activity that performs a transformation on a message.
  • addAttributes AddAttributesActivity
  • channel ChannelActivity
  • datastore DatastoreActivity
  • deviceRegistryEnrich DeviceRegistryEnrichActivity
  • deviceShadowEnrich DeviceShadowEnrichActivity
  • filter FilterActivity
  • lambda LambdaActivity
  • math MathActivity
  • removeAttributes RemoveAttributesActivity
  • selectAttributes SelectAttributesActivity

PipelineArn

• PipelineArn string

PipelineName

• PipelineName string

PipelineSummaries

• PipelineSummaries array
  • items PipelineSummary

PipelineSummary

• PipelineSummary object: A summary of information about a pipeline.
  • creationTime Timestamp
  • lastUpdateTime Timestamp
  • pipelineName PipelineName
  • reprocessingSummaries ReprocessingSummaries

PresignedURI

• PresignedURI string

PutLoggingOptionsRequest

• PutLoggingOptionsRequest object
  • loggingOptions required LoggingOptions

Reason

• Reason string

RemoveAttributesActivity

• RemoveAttributesActivity object: An activity that removes attributes from a message.
  • attributes required AttributeNames
  • name required ActivityName
  • next ActivityName

ReprocessingId

• ReprocessingId string

ReprocessingStatus

• ReprocessingStatus string (values: RUNNING, SUCCEEDED, CANCELLED, FAILED)

ReprocessingSummaries

• ReprocessingSummaries array
  • items ReprocessingSummary

ReprocessingSummary

• ReprocessingSummary object: Information about pipeline reprocessing.
  • creationTime Timestamp
  • id ReprocessingId
  • status ReprocessingStatus

ResourceAlreadyExistsException

• ResourceAlreadyExistsException object: A resource with the same name already exists.
  • message errorMessage
  • resourceArn resourceArn
  • resourceId resourceId

ResourceNotFoundException

• ResourceNotFoundException object: A resource with the specified name could not be found.
  • message errorMessage

RetentionPeriod

• RetentionPeriod object: How long, in days, message data is kept.
  • numberOfDays RetentionPeriodInDays
  • unlimited UnlimitedRetentionPeriod

RetentionPeriodInDays

• RetentionPeriodInDays integer

RoleArn

• RoleArn string

RunPipelineActivityRequest

• RunPipelineActivityRequest object
  • payloads required MessagePayloads
  • pipelineActivity required PipelineActivity

RunPipelineActivityResponse

• RunPipelineActivityResponse object
  • logResult LogResult
  • payloads MessagePayloads

SampleChannelDataRequest

• SampleChannelDataRequest object

SampleChannelDataResponse

• SampleChannelDataResponse object
  • payloads MessagePayloads

Schedule

• Schedule object: The schedule for when to trigger an update.
  • expression ScheduleExpression

ScheduleExpression

• ScheduleExpression string

SelectAttributesActivity

• SelectAttributesActivity object: Creates a new message using only the specified attributes from the original message.
  • attributes required AttributeNames
  • name required ActivityName
  • next ActivityName

ServiceUnavailableException

• ServiceUnavailableException object: The service is temporarily unavailable.
  • message errorMessage

SqlQuery

• SqlQuery string

SqlQueryDatasetAction

• SqlQueryDatasetAction object: The SQL query to modify the message.
  • sqlQuery required SqlQuery

StartPipelineReprocessingRequest

• StartPipelineReprocessingRequest object
  • endTime EndTime
  • startTime StartTime

StartPipelineReprocessingResponse

• StartPipelineReprocessingResponse object
  • reprocessingId ReprocessingId

StartTime

• StartTime string

ThrottlingException

• ThrottlingException object: The request was denied due to request throttling.
  • message errorMessage

Timestamp

• Timestamp string

UnlimitedRetentionPeriod

• UnlimitedRetentionPeriod boolean

UpdateChannelRequest

• UpdateChannelRequest object
  • retentionPeriod RetentionPeriod

UpdateDatasetRequest

• UpdateDatasetRequest object
  • actions required DatasetActions
  • triggers DatasetTriggers

UpdateDatastoreRequest

• UpdateDatastoreRequest object
  • retentionPeriod RetentionPeriod

UpdatePipelineRequest

• UpdatePipelineRequest object
  • pipelineActivities required PipelineActivities

errorMessage

• errorMessage string

resourceArn

• resourceArn string

resourceId

• resourceId string