prowler-sdk-poc
Version:
1,086 lines • 83.6 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class IoTAnalytics extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: IoTAnalytics.Types.ClientConfiguration)
config: Config & IoTAnalytics.Types.ClientConfiguration;
/**
* Sends messages to a channel.
*/
batchPutMessage(params: IoTAnalytics.Types.BatchPutMessageRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.BatchPutMessageResponse) => void): Request<IoTAnalytics.Types.BatchPutMessageResponse, AWSError>;
/**
* Sends messages to a channel.
*/
batchPutMessage(callback?: (err: AWSError, data: IoTAnalytics.Types.BatchPutMessageResponse) => void): Request<IoTAnalytics.Types.BatchPutMessageResponse, AWSError>;
/**
* Cancels the reprocessing of data through the pipeline.
*/
cancelPipelineReprocessing(params: IoTAnalytics.Types.CancelPipelineReprocessingRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CancelPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.CancelPipelineReprocessingResponse, AWSError>;
/**
* Cancels the reprocessing of data through the pipeline.
*/
cancelPipelineReprocessing(callback?: (err: AWSError, data: IoTAnalytics.Types.CancelPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.CancelPipelineReprocessingResponse, AWSError>;
/**
* Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
*/
createChannel(params: IoTAnalytics.Types.CreateChannelRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateChannelResponse) => void): Request<IoTAnalytics.Types.CreateChannelResponse, AWSError>;
/**
* Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
*/
createChannel(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateChannelResponse) => void): Request<IoTAnalytics.Types.CreateChannelResponse, AWSError>;
/**
* Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.
*/
createDataset(params: IoTAnalytics.Types.CreateDatasetRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetResponse) => void): Request<IoTAnalytics.Types.CreateDatasetResponse, AWSError>;
/**
* Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.
*/
createDataset(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetResponse) => void): Request<IoTAnalytics.Types.CreateDatasetResponse, AWSError>;
/**
* Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
*/
createDatasetContent(params: IoTAnalytics.Types.CreateDatasetContentRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetContentResponse) => void): Request<IoTAnalytics.Types.CreateDatasetContentResponse, AWSError>;
/**
* Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
*/
createDatasetContent(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetContentResponse) => void): Request<IoTAnalytics.Types.CreateDatasetContentResponse, AWSError>;
/**
* Creates a data store, which is a repository for messages.
*/
createDatastore(params: IoTAnalytics.Types.CreateDatastoreRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request<IoTAnalytics.Types.CreateDatastoreResponse, AWSError>;
/**
* Creates a data store, which is a repository for messages.
*/
createDatastore(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request<IoTAnalytics.Types.CreateDatastoreResponse, AWSError>;
/**
* Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
*/
createPipeline(params: IoTAnalytics.Types.CreatePipelineRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreatePipelineResponse) => void): Request<IoTAnalytics.Types.CreatePipelineResponse, AWSError>;
/**
* Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
*/
createPipeline(callback?: (err: AWSError, data: IoTAnalytics.Types.CreatePipelineResponse) => void): Request<IoTAnalytics.Types.CreatePipelineResponse, AWSError>;
/**
* Deletes the specified channel.
*/
deleteChannel(params: IoTAnalytics.Types.DeleteChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified channel.
*/
deleteChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified dataset. You do not have to delete the content of the dataset before you perform this operation.
*/
deleteDataset(params: IoTAnalytics.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified dataset. You do not have to delete the content of the dataset before you perform this operation.
*/
deleteDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the content of the specified dataset.
*/
deleteDatasetContent(params: IoTAnalytics.Types.DeleteDatasetContentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the content of the specified dataset.
*/
deleteDatasetContent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified data store.
*/
deleteDatastore(params: IoTAnalytics.Types.DeleteDatastoreRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified data store.
*/
deleteDatastore(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified pipeline.
*/
deletePipeline(params: IoTAnalytics.Types.DeletePipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified pipeline.
*/
deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves information about a channel.
*/
describeChannel(params: IoTAnalytics.Types.DescribeChannelRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeChannelResponse) => void): Request<IoTAnalytics.Types.DescribeChannelResponse, AWSError>;
/**
* Retrieves information about a channel.
*/
describeChannel(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeChannelResponse) => void): Request<IoTAnalytics.Types.DescribeChannelResponse, AWSError>;
/**
* Retrieves information about a dataset.
*/
describeDataset(params: IoTAnalytics.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatasetResponse) => void): Request<IoTAnalytics.Types.DescribeDatasetResponse, AWSError>;
/**
* Retrieves information about a dataset.
*/
describeDataset(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatasetResponse) => void): Request<IoTAnalytics.Types.DescribeDatasetResponse, AWSError>;
/**
* Retrieves information about a data store.
*/
describeDatastore(params: IoTAnalytics.Types.DescribeDatastoreRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatastoreResponse) => void): Request<IoTAnalytics.Types.DescribeDatastoreResponse, AWSError>;
/**
* Retrieves information about a data store.
*/
describeDatastore(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatastoreResponse) => void): Request<IoTAnalytics.Types.DescribeDatastoreResponse, AWSError>;
/**
* Retrieves the current settings of the IoT Analytics logging options.
*/
describeLoggingOptions(params: IoTAnalytics.Types.DescribeLoggingOptionsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeLoggingOptionsResponse) => void): Request<IoTAnalytics.Types.DescribeLoggingOptionsResponse, AWSError>;
/**
* Retrieves the current settings of the IoT Analytics logging options.
*/
describeLoggingOptions(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeLoggingOptionsResponse) => void): Request<IoTAnalytics.Types.DescribeLoggingOptionsResponse, AWSError>;
/**
* Retrieves information about a pipeline.
*/
describePipeline(params: IoTAnalytics.Types.DescribePipelineRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribePipelineResponse) => void): Request<IoTAnalytics.Types.DescribePipelineResponse, AWSError>;
/**
* Retrieves information about a pipeline.
*/
describePipeline(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribePipelineResponse) => void): Request<IoTAnalytics.Types.DescribePipelineResponse, AWSError>;
/**
* Retrieves the contents of a dataset as presigned URIs.
*/
getDatasetContent(params: IoTAnalytics.Types.GetDatasetContentRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.GetDatasetContentResponse) => void): Request<IoTAnalytics.Types.GetDatasetContentResponse, AWSError>;
/**
* Retrieves the contents of a dataset as presigned URIs.
*/
getDatasetContent(callback?: (err: AWSError, data: IoTAnalytics.Types.GetDatasetContentResponse) => void): Request<IoTAnalytics.Types.GetDatasetContentResponse, AWSError>;
/**
* Retrieves a list of channels.
*/
listChannels(params: IoTAnalytics.Types.ListChannelsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListChannelsResponse) => void): Request<IoTAnalytics.Types.ListChannelsResponse, AWSError>;
/**
* Retrieves a list of channels.
*/
listChannels(callback?: (err: AWSError, data: IoTAnalytics.Types.ListChannelsResponse) => void): Request<IoTAnalytics.Types.ListChannelsResponse, AWSError>;
/**
* Lists information about dataset contents that have been created.
*/
listDatasetContents(params: IoTAnalytics.Types.ListDatasetContentsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetContentsResponse) => void): Request<IoTAnalytics.Types.ListDatasetContentsResponse, AWSError>;
/**
* Lists information about dataset contents that have been created.
*/
listDatasetContents(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetContentsResponse) => void): Request<IoTAnalytics.Types.ListDatasetContentsResponse, AWSError>;
/**
* Retrieves information about datasets.
*/
listDatasets(params: IoTAnalytics.Types.ListDatasetsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetsResponse) => void): Request<IoTAnalytics.Types.ListDatasetsResponse, AWSError>;
/**
* Retrieves information about datasets.
*/
listDatasets(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetsResponse) => void): Request<IoTAnalytics.Types.ListDatasetsResponse, AWSError>;
/**
* Retrieves a list of data stores.
*/
listDatastores(params: IoTAnalytics.Types.ListDatastoresRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatastoresResponse) => void): Request<IoTAnalytics.Types.ListDatastoresResponse, AWSError>;
/**
* Retrieves a list of data stores.
*/
listDatastores(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatastoresResponse) => void): Request<IoTAnalytics.Types.ListDatastoresResponse, AWSError>;
/**
* Retrieves a list of pipelines.
*/
listPipelines(params: IoTAnalytics.Types.ListPipelinesRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListPipelinesResponse) => void): Request<IoTAnalytics.Types.ListPipelinesResponse, AWSError>;
/**
* Retrieves a list of pipelines.
*/
listPipelines(callback?: (err: AWSError, data: IoTAnalytics.Types.ListPipelinesResponse) => void): Request<IoTAnalytics.Types.ListPipelinesResponse, AWSError>;
/**
* Lists the tags (metadata) that you have assigned to the resource.
*/
listTagsForResource(params: IoTAnalytics.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListTagsForResourceResponse) => void): Request<IoTAnalytics.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags (metadata) that you have assigned to the resource.
*/
listTagsForResource(callback?: (err: AWSError, data: IoTAnalytics.Types.ListTagsForResourceResponse) => void): Request<IoTAnalytics.Types.ListTagsForResourceResponse, AWSError>;
/**
* Sets or updates the IoT Analytics logging options. If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
*/
putLoggingOptions(params: IoTAnalytics.Types.PutLoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets or updates the IoT Analytics logging options. If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
*/
putLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Simulates the results of running a pipeline activity on a message payload.
*/
runPipelineActivity(params: IoTAnalytics.Types.RunPipelineActivityRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.RunPipelineActivityResponse) => void): Request<IoTAnalytics.Types.RunPipelineActivityResponse, AWSError>;
/**
* Simulates the results of running a pipeline activity on a message payload.
*/
runPipelineActivity(callback?: (err: AWSError, data: IoTAnalytics.Types.RunPipelineActivityResponse) => void): Request<IoTAnalytics.Types.RunPipelineActivityResponse, AWSError>;
/**
* Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
*/
sampleChannelData(params: IoTAnalytics.Types.SampleChannelDataRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.SampleChannelDataResponse) => void): Request<IoTAnalytics.Types.SampleChannelDataResponse, AWSError>;
/**
* Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
*/
sampleChannelData(callback?: (err: AWSError, data: IoTAnalytics.Types.SampleChannelDataResponse) => void): Request<IoTAnalytics.Types.SampleChannelDataResponse, AWSError>;
/**
* Starts the reprocessing of raw message data through the pipeline.
*/
startPipelineReprocessing(params: IoTAnalytics.Types.StartPipelineReprocessingRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.StartPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.StartPipelineReprocessingResponse, AWSError>;
/**
* Starts the reprocessing of raw message data through the pipeline.
*/
startPipelineReprocessing(callback?: (err: AWSError, data: IoTAnalytics.Types.StartPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.StartPipelineReprocessingResponse, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*/
tagResource(params: IoTAnalytics.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.TagResourceResponse) => void): Request<IoTAnalytics.Types.TagResourceResponse, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*/
tagResource(callback?: (err: AWSError, data: IoTAnalytics.Types.TagResourceResponse) => void): Request<IoTAnalytics.Types.TagResourceResponse, AWSError>;
/**
* Removes the given tags (metadata) from the resource.
*/
untagResource(params: IoTAnalytics.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.UntagResourceResponse) => void): Request<IoTAnalytics.Types.UntagResourceResponse, AWSError>;
/**
* Removes the given tags (metadata) from the resource.
*/
untagResource(callback?: (err: AWSError, data: IoTAnalytics.Types.UntagResourceResponse) => void): Request<IoTAnalytics.Types.UntagResourceResponse, AWSError>;
/**
* Used to update the settings of a channel.
*/
updateChannel(params: IoTAnalytics.Types.UpdateChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Used to update the settings of a channel.
*/
updateChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the settings of a dataset.
*/
updateDataset(params: IoTAnalytics.Types.UpdateDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the settings of a dataset.
*/
updateDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Used to update the settings of a data store.
*/
updateDatastore(params: IoTAnalytics.Types.UpdateDatastoreRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Used to update the settings of a data store.
*/
updateDatastore(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
*/
updatePipeline(params: IoTAnalytics.Types.UpdatePipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
*/
updatePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace IoTAnalytics {
export type ActivityBatchSize = number;
export type ActivityName = string;
export interface AddAttributesActivity {
/**
* The name of the addAttributes activity.
*/
name: ActivityName;
/**
* A list of 1-50 AttributeNameMapping objects that map an existing attribute to a new attribute. The existing attributes remain in the message, so if you want to remove the originals, use RemoveAttributeActivity.
*/
attributes: AttributeNameMapping;
/**
* The next activity in the pipeline.
*/
next?: ActivityName;
}
export type AttributeName = string;
export type AttributeNameMapping = {[key: string]: AttributeName};
export type AttributeNames = AttributeName[];
export type BatchPutMessageErrorEntries = BatchPutMessageErrorEntry[];
export interface BatchPutMessageErrorEntry {
/**
* The ID of the message that caused the error. See the value corresponding to the messageId key in the message object.
*/
messageId?: MessageId;
/**
* The code associated with the error.
*/
errorCode?: ErrorCode;
/**
* The message associated with the error.
*/
errorMessage?: ErrorMessage;
}
export interface BatchPutMessageRequest {
/**
* The name of the channel where the messages are sent.
*/
channelName: ChannelName;
/**
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}. The field names of message payloads (data) that you send to IoT Analytics: Must contain only alphanumeric characters and undescores (_). No other special characters are allowed. Must begin with an alphabetic character or single underscore (_). Cannot contain hyphens (-). In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$". Cannot be more than 255 characters. Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.) For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.
*/
messages: Messages;
}
export interface BatchPutMessageResponse {
/**
* A list of any errors encountered when sending the messages to the channel.
*/
batchPutMessageErrorEntries?: BatchPutMessageErrorEntries;
}
export type BucketKeyExpression = string;
export type BucketName = string;
export interface CancelPipelineReprocessingRequest {
/**
* The name of pipeline for which data reprocessing is canceled.
*/
pipelineName: PipelineName;
/**
* The ID of the reprocessing task (returned by StartPipelineReprocessing).
*/
reprocessingId: ReprocessingId;
}
export interface CancelPipelineReprocessingResponse {
}
export interface Channel {
/**
* The name of the channel.
*/
name?: ChannelName;
/**
* Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.
*/
storage?: ChannelStorage;
/**
* The ARN of the channel.
*/
arn?: ChannelArn;
/**
* The status of the channel.
*/
status?: ChannelStatus;
/**
* How long, in days, message data is kept for the channel.
*/
retentionPeriod?: RetentionPeriod;
/**
* When the channel was created.
*/
creationTime?: Timestamp;
/**
* When the channel was last updated.
*/
lastUpdateTime?: Timestamp;
/**
* The last time when a new message arrived in the channel. IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation. This feature only applies to messages that arrived in the data store after October 23, 2020.
*/
lastMessageArrivalTime?: Timestamp;
}
export interface ChannelActivity {
/**
* The name of the channel activity.
*/
name: ActivityName;
/**
* The name of the channel from which the messages are processed.
*/
channelName: ChannelName;
/**
* The next activity in the pipeline.
*/
next?: ActivityName;
}
export type ChannelArn = string;
export interface ChannelMessages {
/**
* Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your channel messages. You must use the full path for the key. Example path: channel/mychannel/__dt=2020-02-29 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz
*/
s3Paths?: S3PathChannelMessages;
}
export type ChannelName = string;
export interface ChannelStatistics {
/**
* The estimated size of the channel.
*/
size?: EstimatedResourceSize;
}
export type ChannelStatus = "CREATING"|"ACTIVE"|"DELETING"|string;
export interface ChannelStorage {
/**
* Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.
*/
serviceManagedS3?: ServiceManagedChannelS3Storage;
/**
* Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
*/
customerManagedS3?: CustomerManagedChannelS3Storage;
}
export interface ChannelStorageSummary {
/**
* Used to store channel data in an S3 bucket managed by IoT Analytics.
*/
serviceManagedS3?: ServiceManagedChannelS3StorageSummary;
/**
* Used to store channel data in an S3 bucket that you manage.
*/
customerManagedS3?: CustomerManagedChannelS3StorageSummary;
}
export type ChannelSummaries = ChannelSummary[];
export interface ChannelSummary {
/**
* The name of the channel.
*/
channelName?: ChannelName;
/**
* Where channel data is stored.
*/
channelStorage?: ChannelStorageSummary;
/**
* The status of the channel.
*/
status?: ChannelStatus;
/**
* When the channel was created.
*/
creationTime?: Timestamp;
/**
* The last time the channel was updated.
*/
lastUpdateTime?: Timestamp;
/**
* The last time when a new message arrived in the channel. IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation. This feature only applies to messages that arrived in the data store after October 23, 2020.
*/
lastMessageArrivalTime?: Timestamp;
}
export interface Column {
/**
* The name of the column.
*/
name: ColumnName;
/**
* The type of data. For more information about the supported data types, see Common data types in the Glue Developer Guide.
*/
type: ColumnDataType;
}
export type ColumnDataType = string;
export type ColumnName = string;
export type Columns = Column[];
export type ComputeType = "ACU_1"|"ACU_2"|string;
export interface ContainerDatasetAction {
/**
* The ARN of the Docker container stored in your account. The Docker container contains an application and required support libraries and is used to generate dataset contents.
*/
image: Image;
/**
* The ARN of the role that gives permission to the system to access required resources to run the containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application.
*/
executionRoleArn: RoleArn;
/**
* Configuration of the resource that executes the containerAction.
*/
resourceConfiguration: ResourceConfiguration;
/**
* The values of variables used in the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue.
*/
variables?: Variables;
}
export interface CreateChannelRequest {
/**
* The name of the channel.
*/
channelName: ChannelName;
/**
* Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.
*/
channelStorage?: ChannelStorage;
/**
* How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.
*/
retentionPeriod?: RetentionPeriod;
/**
* Metadata which can be used to manage the channel.
*/
tags?: TagList;
}
export interface CreateChannelResponse {
/**
* The name of the channel.
*/
channelName?: ChannelName;
/**
* The ARN of the channel.
*/
channelArn?: ChannelArn;
/**
* How long, in days, message data is kept for the channel.
*/
retentionPeriod?: RetentionPeriod;
}
export interface CreateDatasetContentRequest {
/**
* The name of the dataset.
*/
datasetName: DatasetName;
/**
* The version ID of the dataset content. To specify versionId for a dataset content, the dataset must use a DeltaTimer filter.
*/
versionId?: DatasetContentVersion;
}
export interface CreateDatasetContentResponse {
/**
* The version ID of the dataset contents that are being created.
*/
versionId?: DatasetContentVersion;
}
export interface CreateDatasetRequest {
/**
* The name of the dataset.
*/
datasetName: DatasetName;
/**
* A list of actions that create the dataset contents.
*/
actions: DatasetActions;
/**
* A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.
*/
triggers?: DatasetTriggers;
/**
* When dataset contents are created, they are delivered to destinations specified here.
*/
contentDeliveryRules?: DatasetContentDeliveryRules;
/**
* Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*/
retentionPeriod?: RetentionPeriod;
/**
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*/
versioningConfiguration?: VersioningConfiguration;
/**
* Metadata which can be used to manage the dataset.
*/
tags?: TagList;
/**
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
*/
lateDataRules?: LateDataRules;
}
export interface CreateDatasetResponse {
/**
* The name of the dataset.
*/
datasetName?: DatasetName;
/**
* The ARN of the dataset.
*/
datasetArn?: DatasetArn;
/**
* How long, in days, dataset contents are kept for the dataset.
*/
retentionPeriod?: RetentionPeriod;
}
export interface CreateDatastoreRequest {
/**
* The name of the data store.
*/
datastoreName: DatastoreName;
/**
* Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
*/
datastoreStorage?: DatastoreStorage;
/**
* How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
*/
retentionPeriod?: RetentionPeriod;
/**
* Metadata which can be used to manage the data store.
*/
tags?: TagList;
/**
* Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet. The default file format is JSON. You can specify only one format. You can't change the file format after you create the data store.
*/
fileFormatConfiguration?: FileFormatConfiguration;
/**
* Contains information about the partition dimensions in a data store.
*/
datastorePartitions?: DatastorePartitions;
}
export interface CreateDatastoreResponse {
/**
* The name of the data store.
*/
datastoreName?: DatastoreName;
/**
* The ARN of the data store.
*/
datastoreArn?: DatastoreArn;
/**
* How long, in days, message data is kept for the data store.
*/
retentionPeriod?: RetentionPeriod;
}
export interface CreatePipelineRequest {
/**
* The name of the pipeline.
*/
pipelineName: PipelineName;
/**
* A list of 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 unctions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity. For example: pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
*/
pipelineActivities: PipelineActivities;
/**
* Metadata which can be used to manage the pipeline.
*/
tags?: TagList;
}
export interface CreatePipelineResponse {
/**
* The name of the pipeline.
*/
pipelineName?: PipelineName;
/**
* The ARN of the pipeline.
*/
pipelineArn?: PipelineArn;
}
export interface CustomerManagedChannelS3Storage {
/**
* The name of the S3 bucket in which channel data is stored.
*/
bucket: BucketName;
/**
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
*/
keyPrefix?: S3KeyPrefix;
/**
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*/
roleArn: RoleArn;
}
export interface CustomerManagedChannelS3StorageSummary {
/**
* The name of the S3 bucket in which channel data is stored.
*/
bucket?: BucketName;
/**
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).
*/
keyPrefix?: S3KeyPrefix;
/**
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*/
roleArn?: RoleArn;
}
export interface CustomerManagedDatastoreS3Storage {
/**
* The name of the Amazon S3 bucket where your data is stored.
*/
bucket: BucketName;
/**
* (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
*/
keyPrefix?: S3KeyPrefix;
/**
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*/
roleArn: RoleArn;
}
export interface CustomerManagedDatastoreS3StorageSummary {
/**
* The name of the Amazon S3 bucket where your data is stored.
*/
bucket?: BucketName;
/**
* (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
*/
keyPrefix?: S3KeyPrefix;
/**
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*/
roleArn?: RoleArn;
}
export interface Dataset {
/**
* The name of the dataset.
*/
name?: DatasetName;
/**
* The ARN of the dataset.
*/
arn?: DatasetArn;
/**
* The DatasetAction objects that automatically create the dataset contents.
*/
actions?: DatasetActions;
/**
* The DatasetTrigger objects that specify when the dataset is automatically updated.
*/
triggers?: DatasetTriggers;
/**
* When dataset contents are created they are delivered to destinations specified here.
*/
contentDeliveryRules?: DatasetContentDeliveryRules;
/**
* The status of the dataset.
*/
status?: DatasetStatus;
/**
* When the dataset was created.
*/
creationTime?: Timestamp;
/**
* The last time the dataset was updated.
*/
lastUpdateTime?: Timestamp;
/**
* Optional. How long, in days, message data is kept for the dataset.
*/
retentionPeriod?: RetentionPeriod;
/**
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*/
versioningConfiguration?: VersioningConfiguration;
/**
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
*/
lateDataRules?: LateDataRules;
}
export interface DatasetAction {
/**
* The name of the dataset action by which dataset contents are automatically created.
*/
actionName?: DatasetActionName;
/**
* An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.
*/
queryAction?: SqlQueryDatasetAction;
/**
* Information that allows the system to run a containerized application to create the dataset contents. The application must be in a Docker container along with any required support libraries.
*/
containerAction?: ContainerDatasetAction;
}
export type DatasetActionName = string;
export type DatasetActionSummaries = DatasetActionSummary[];
export interface DatasetActionSummary {
/**
* The name of the action that automatically creates the dataset's contents.
*/
actionName?: DatasetActionName;
/**
* The type of action by which the dataset's contents are automatically created.
*/
actionType?: DatasetActionType;
}
export type DatasetActionType = "QUERY"|"CONTAINER"|string;
export type DatasetActions = DatasetAction[];
export type DatasetArn = string;
export interface DatasetContentDeliveryDestination {
/**
* Configuration information for delivery of dataset contents to IoT Events.
*/
iotEventsDestinationConfiguration?: IotEventsDestinationConfiguration;
/**
* Configuration information for delivery of dataset contents to Amazon S3.
*/
s3DestinationConfiguration?: S3DestinationConfiguration;
}
export interface DatasetContentDeliveryRule {
/**
* The name of the dataset content delivery rules entry.
*/
entryName?: EntryName;
/**
* The destination to which dataset contents are delivered.
*/
destination: DatasetContentDeliveryDestination;
}
export type DatasetContentDeliveryRules = DatasetContentDeliveryRule[];
export type DatasetContentState = "CREATING"|"SUCCEEDED"|"FAILED"|string;
export interface DatasetContentStatus {
/**
* The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.
*/
state?: DatasetContentState;
/**
* The reason the dataset contents are in this state.
*/
reason?: Reason;
}
export type DatasetContentSummaries = DatasetContentSummary[];
export interface DatasetContentSummary {
/**
* The version of the dataset contents.
*/
version?: DatasetContentVersion;
/**
* The status of the dataset contents.
*/
status?: DatasetContentStatus;
/**
* The actual time the creation of the dataset contents was started.
*/
creationTime?: Timestamp;
/**
* The time the creation of the dataset contents was scheduled to start.
*/
scheduleTime?: Timestamp;
/**
* The time the dataset content status was updated to SUCCEEDED or FAILED.
*/
completionTime?: Timestamp;
}
export type DatasetContentVersion = string;
export interface DatasetContentVersionValue {
/**
* The name of the dataset whose latest contents are used as input to the notebook or application.
*/
datasetName: DatasetName;
}
export type DatasetEntries = DatasetEntry[];
export interface DatasetEntry {
/**
* The name of the dataset item.
*/
entryName?: EntryName;
/**
* The presigned URI of the dataset item.
*/
dataURI?: PresignedURI;
}
export type DatasetName = string;
export type DatasetStatus = "CREATING"|"ACTIVE"|"DELETING"|string;
export type DatasetSummaries = DatasetSummary[];
export interface DatasetSummary {
/**
* The name of the dataset.
*/
datasetName?: DatasetName;
/**
* The status of the dataset.
*/
status?: DatasetStatus;
/**
* The time the dataset was created.
*/
creationTime?: Timestamp;
/**
* The last time the dataset was updated.
*/
lastUpdateTime?: Timestamp;
/**
* A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
*/
triggers?: DatasetTriggers;
/**
* A list of DataActionSummary objects.
*/
actions?: DatasetActionSummaries;
}
export interface DatasetTrigger {
/**
* The Schedule when the trigger is initiated.
*/
schedule?: Schedule;
/**
* The dataset whose content creation triggers the creation of this dataset's contents.
*/
dataset?: TriggeringDataset;
}
export type DatasetTriggers = DatasetTrigger[];
export interface Datastore {
/**
* The name of the data store.
*/
name?: DatastoreName;
/**
* Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
*/
storage?: DatastoreStorage;
/**
* The ARN of the data store.
*/
arn?: DatastoreArn;
/**
* 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.
*/
status?: DatastoreStatus;
/**
* How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
*/
retentionPeriod?: RetentionPeriod;
/**
* When the data store was created.
*/
creationTime?: Timestamp;
/**
* The last time the data store was updated.
*/
lastUpdateTime?: Timestamp;
/**
* The last time when a new message arrived in the data store. IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation. This feature only applies to messages that arrived in the data store after October 23, 2020.
*/
lastMessageArrivalTime?: Timestamp;
/**
* Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet. The default file format is JSON. You can specify only one format. You can't change the file format after you create the data store.
*/
fileFormatConfiguration?: FileFormatConfiguration;
/**
* Contains information about the partition dimensions in a data store.
*/
datastorePartitions?: DatastorePartitions;
}
export interface DatastoreActivity {
/**
* The name of the datastore activity.
*/
name: ActivityName;
/**
* The name of the data store where processed messages are stored.
*/
datastoreName: DatastoreName;
}
export type DatastoreArn = string;
export interface DatastoreIotSiteWiseMultiLayerStorage {
/**
* Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
*/
customerManagedS3Storage: IotSiteWiseCustomerManagedDatastoreS3Storage;
}
export interface DatastoreIotSiteWiseMultiLayerStorageSummary {
/**
* Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
*/
customerManagedS3Storage?: IotSiteWiseCustomerManagedDatastoreS3StorageSummary;
}
export type DatastoreName = string;
export interface DatastorePartition {
/**
* A partition dimension defined by an attributeName.
*/
attributePartition?: Partition;
/**
* A partition dimension defined by a timestamp attribute.
*/
timestampPartition?: TimestampPartition;
}
export interface DatastorePartitions {
/**
* A list of partition dimensions in a data store.
*/
partitions?: Partitions;
}
export interface DatastoreStatistics {
/**
* The estimated size of the data store.
*/
size?: EstimatedResourceSize;
}
export type DatastoreStatus = "CREATING"|"ACTIVE"|"DELETING"|string;
export interface DatastoreStorage {
/**
* Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.
*/
serviceManagedS3?: ServiceManagedDatastoreS3Storage;
/**
* S3-customer-managed; When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
*/
customerManagedS3?: CustomerManagedDatastoreS3Storage;
/**
* Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
*/
iotSiteWiseMultiLayerStorage?: DatastoreIotSiteWiseMultiLayerStorage;
}
export interface DatastoreStorageSummary {
/**
* Used to store data in an Amazon S3 bucket managed by IoT Analytics.
*/
serviceManagedS3?: ServiceManagedDatastoreS3StorageSummary;
/**
* Used to store data in an Amazon S3 bucket managed by IoT Analytics.
*/
customerManagedS3?: CustomerManagedDatastoreS3StorageSummary;
/**
* Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
*/
iotSiteWiseMultiLayerStorage?: DatastoreIotSiteWiseMultiLayerStorageSummary;
}
export type DatastoreSummaries = DatastoreSummary[];
export interface DatastoreSummary {
/**
* The name of the data store.
*/
datastoreName?: DatastoreName;
/**
* Where data in a data store is stored.
*/
datastoreStorage?: DatastoreStorageSummary;
/**
* The status of the data store.
*/
status?: DatastoreStatus;
/**
* When the data store was created.
*/
creationTime?: Timestamp;
/**
* The last time the data store was updated.
*/
lastUpdateTime?: Timestamp;
/**
* The last time when a new message arrived in the data store. IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation. This feature only applies to messages that arrived in the data store after October 23, 2020.
*/
lastMessageArrivalTime?: Timestamp;
/**
* The file format of the data in the data store.
*/
fileFormatType?: FileFormatType;
/**
* Contains information about the partition dimensions in a data store.
*/
datastorePartitions?: DatastorePartitions;
}
export interface DeleteChannelRequest {
/**
* The name of the channel to delete.
*/
channelName: ChannelName;
}
export interface DeleteDatasetContentRequest {
/**
* The name of the dataset whose content is deleted.
*/
datasetName: DatasetName;
/**
* The version of the dataset whose content is deleted. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default.
*/
versionId?: DatasetContentVersion;
}
export interface DeleteDatasetRequest {
/**
* The name of the dataset to delete.
*/
datasetName: DatasetName;
}
export interface DeleteDatastoreRequest {
/**
* The name of the data store to delete.
*/
datastoreName: DatastoreName;
}
export interface DeletePipelineRequest {
/**
* The name of the pipeline to delete.
*/
pipelineName: PipelineName;
}
export interface DeltaTime {
/**
* The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing beg