Skip to content

Type definitions#

Index > IoTAnalytics > Type definitions

Auto-generated documentation for IoTAnalytics type annotations stubs module mypy-boto3-iotanalytics.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AddAttributesActivityTypeDef#

# AddAttributesActivityTypeDef definition

class AddAttributesActivityTypeDef(TypedDict):
    name: str,
    attributes: Mapping[str, str],
    next: NotRequired[str],

BatchPutMessageErrorEntryTypeDef#

# BatchPutMessageErrorEntryTypeDef definition

class BatchPutMessageErrorEntryTypeDef(TypedDict):
    messageId: NotRequired[str],
    errorCode: NotRequired[str],
    errorMessage: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CancelPipelineReprocessingRequestRequestTypeDef#

# CancelPipelineReprocessingRequestRequestTypeDef definition

class CancelPipelineReprocessingRequestRequestTypeDef(TypedDict):
    pipelineName: str,
    reprocessingId: str,

ChannelActivityTypeDef#

# ChannelActivityTypeDef definition

class ChannelActivityTypeDef(TypedDict):
    name: str,
    channelName: str,
    next: NotRequired[str],

ChannelMessagesTypeDef#

# ChannelMessagesTypeDef definition

class ChannelMessagesTypeDef(TypedDict):
    s3Paths: NotRequired[Sequence[str]],

EstimatedResourceSizeTypeDef#

# EstimatedResourceSizeTypeDef definition

class EstimatedResourceSizeTypeDef(TypedDict):
    estimatedSizeInBytes: NotRequired[float],
    estimatedOn: NotRequired[datetime],

CustomerManagedChannelS3StorageSummaryTypeDef#

# CustomerManagedChannelS3StorageSummaryTypeDef definition

class CustomerManagedChannelS3StorageSummaryTypeDef(TypedDict):
    bucket: NotRequired[str],
    keyPrefix: NotRequired[str],
    roleArn: NotRequired[str],

CustomerManagedChannelS3StorageTypeDef#

# CustomerManagedChannelS3StorageTypeDef definition

class CustomerManagedChannelS3StorageTypeDef(TypedDict):
    bucket: str,
    roleArn: str,
    keyPrefix: NotRequired[str],

RetentionPeriodTypeDef#

# RetentionPeriodTypeDef definition

class RetentionPeriodTypeDef(TypedDict):
    unlimited: NotRequired[bool],
    numberOfDays: NotRequired[int],

ColumnTypeDef#

# ColumnTypeDef definition

class ColumnTypeDef(TypedDict):
    name: str,
    type: str,

ResourceConfigurationTypeDef#

# ResourceConfigurationTypeDef definition

class ResourceConfigurationTypeDef(TypedDict):
    computeType: ComputeTypeType,  # (1)
    volumeSizeInGB: int,
  1. See ComputeTypeType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

CreateDatasetContentRequestRequestTypeDef#

# CreateDatasetContentRequestRequestTypeDef definition

class CreateDatasetContentRequestRequestTypeDef(TypedDict):
    datasetName: str,
    versionId: NotRequired[str],

VersioningConfigurationTypeDef#

# VersioningConfigurationTypeDef definition

class VersioningConfigurationTypeDef(TypedDict):
    unlimited: NotRequired[bool],
    maxVersions: NotRequired[int],

CustomerManagedDatastoreS3StorageSummaryTypeDef#

# CustomerManagedDatastoreS3StorageSummaryTypeDef definition

class CustomerManagedDatastoreS3StorageSummaryTypeDef(TypedDict):
    bucket: NotRequired[str],
    keyPrefix: NotRequired[str],
    roleArn: NotRequired[str],

CustomerManagedDatastoreS3StorageTypeDef#

# CustomerManagedDatastoreS3StorageTypeDef definition

class CustomerManagedDatastoreS3StorageTypeDef(TypedDict):
    bucket: str,
    roleArn: str,
    keyPrefix: NotRequired[str],

DatasetActionSummaryTypeDef#

# DatasetActionSummaryTypeDef definition

class DatasetActionSummaryTypeDef(TypedDict):
    actionName: NotRequired[str],
    actionType: NotRequired[DatasetActionTypeType],  # (1)
  1. See DatasetActionTypeType

IotEventsDestinationConfigurationTypeDef#

# IotEventsDestinationConfigurationTypeDef definition

class IotEventsDestinationConfigurationTypeDef(TypedDict):
    inputName: str,
    roleArn: str,

DatasetContentStatusTypeDef#

# DatasetContentStatusTypeDef definition

class DatasetContentStatusTypeDef(TypedDict):
    state: NotRequired[DatasetContentStateType],  # (1)
    reason: NotRequired[str],
  1. See DatasetContentStateType

DatasetContentVersionValueTypeDef#

# DatasetContentVersionValueTypeDef definition

class DatasetContentVersionValueTypeDef(TypedDict):
    datasetName: str,

DatasetEntryTypeDef#

# DatasetEntryTypeDef definition

class DatasetEntryTypeDef(TypedDict):
    entryName: NotRequired[str],
    dataURI: NotRequired[str],

ScheduleTypeDef#

# ScheduleTypeDef definition

class ScheduleTypeDef(TypedDict):
    expression: NotRequired[str],

TriggeringDatasetTypeDef#

# TriggeringDatasetTypeDef definition

class TriggeringDatasetTypeDef(TypedDict):
    name: str,

DatastoreActivityTypeDef#

# DatastoreActivityTypeDef definition

class DatastoreActivityTypeDef(TypedDict):
    name: str,
    datastoreName: str,

IotSiteWiseCustomerManagedDatastoreS3StorageSummaryTypeDef#

# IotSiteWiseCustomerManagedDatastoreS3StorageSummaryTypeDef definition

class IotSiteWiseCustomerManagedDatastoreS3StorageSummaryTypeDef(TypedDict):
    bucket: NotRequired[str],
    keyPrefix: NotRequired[str],

IotSiteWiseCustomerManagedDatastoreS3StorageTypeDef#

# IotSiteWiseCustomerManagedDatastoreS3StorageTypeDef definition

class IotSiteWiseCustomerManagedDatastoreS3StorageTypeDef(TypedDict):
    bucket: str,
    keyPrefix: NotRequired[str],

PartitionTypeDef#

# PartitionTypeDef definition

class PartitionTypeDef(TypedDict):
    attributeName: str,

TimestampPartitionTypeDef#

# TimestampPartitionTypeDef definition

class TimestampPartitionTypeDef(TypedDict):
    attributeName: str,
    timestampFormat: NotRequired[str],

DeleteChannelRequestRequestTypeDef#

# DeleteChannelRequestRequestTypeDef definition

class DeleteChannelRequestRequestTypeDef(TypedDict):
    channelName: str,

DeleteDatasetContentRequestRequestTypeDef#

# DeleteDatasetContentRequestRequestTypeDef definition

class DeleteDatasetContentRequestRequestTypeDef(TypedDict):
    datasetName: str,
    versionId: NotRequired[str],

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    datasetName: str,

DeleteDatastoreRequestRequestTypeDef#

# DeleteDatastoreRequestRequestTypeDef definition

class DeleteDatastoreRequestRequestTypeDef(TypedDict):
    datastoreName: str,

DeletePipelineRequestRequestTypeDef#

# DeletePipelineRequestRequestTypeDef definition

class DeletePipelineRequestRequestTypeDef(TypedDict):
    pipelineName: str,

DeltaTimeSessionWindowConfigurationTypeDef#

# DeltaTimeSessionWindowConfigurationTypeDef definition

class DeltaTimeSessionWindowConfigurationTypeDef(TypedDict):
    timeoutInMinutes: int,

DeltaTimeTypeDef#

# DeltaTimeTypeDef definition

class DeltaTimeTypeDef(TypedDict):
    offsetSeconds: int,
    timeExpression: str,

DescribeChannelRequestRequestTypeDef#

# DescribeChannelRequestRequestTypeDef definition

class DescribeChannelRequestRequestTypeDef(TypedDict):
    channelName: str,
    includeStatistics: NotRequired[bool],

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    datasetName: str,

DescribeDatastoreRequestRequestTypeDef#

# DescribeDatastoreRequestRequestTypeDef definition

class DescribeDatastoreRequestRequestTypeDef(TypedDict):
    datastoreName: str,
    includeStatistics: NotRequired[bool],

LoggingOptionsTypeDef#

# LoggingOptionsTypeDef definition

class LoggingOptionsTypeDef(TypedDict):
    roleArn: str,
    level: LoggingLevelType,  # (1)
    enabled: bool,
  1. See LoggingLevelType

DescribePipelineRequestRequestTypeDef#

# DescribePipelineRequestRequestTypeDef definition

class DescribePipelineRequestRequestTypeDef(TypedDict):
    pipelineName: str,

DeviceRegistryEnrichActivityTypeDef#

# DeviceRegistryEnrichActivityTypeDef definition

class DeviceRegistryEnrichActivityTypeDef(TypedDict):
    name: str,
    attribute: str,
    thingName: str,
    roleArn: str,
    next: NotRequired[str],

DeviceShadowEnrichActivityTypeDef#

# DeviceShadowEnrichActivityTypeDef definition

class DeviceShadowEnrichActivityTypeDef(TypedDict):
    name: str,
    attribute: str,
    thingName: str,
    roleArn: str,
    next: NotRequired[str],

FilterActivityTypeDef#

# FilterActivityTypeDef definition

class FilterActivityTypeDef(TypedDict):
    name: str,
    filter: str,
    next: NotRequired[str],

GetDatasetContentRequestRequestTypeDef#

# GetDatasetContentRequestRequestTypeDef definition

class GetDatasetContentRequestRequestTypeDef(TypedDict):
    datasetName: str,
    versionId: NotRequired[str],

GlueConfigurationTypeDef#

# GlueConfigurationTypeDef definition

class GlueConfigurationTypeDef(TypedDict):
    tableName: str,
    databaseName: str,

LambdaActivityTypeDef#

# LambdaActivityTypeDef definition

class LambdaActivityTypeDef(TypedDict):
    name: str,
    lambdaName: str,
    batchSize: int,
    next: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListChannelsRequestRequestTypeDef#

# ListChannelsRequestRequestTypeDef definition

class ListChannelsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef definition

class ListDatasetsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDatastoresRequestRequestTypeDef#

# ListDatastoresRequestRequestTypeDef definition

class ListDatastoresRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPipelinesRequestRequestTypeDef#

# ListPipelinesRequestRequestTypeDef definition

class ListPipelinesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

MathActivityTypeDef#

# MathActivityTypeDef definition

class MathActivityTypeDef(TypedDict):
    name: str,
    attribute: str,
    math: str,
    next: NotRequired[str],

OutputFileUriValueTypeDef#

# OutputFileUriValueTypeDef definition

class OutputFileUriValueTypeDef(TypedDict):
    fileName: str,

RemoveAttributesActivityTypeDef#

# RemoveAttributesActivityTypeDef definition

class RemoveAttributesActivityTypeDef(TypedDict):
    name: str,
    attributes: Sequence[str],
    next: NotRequired[str],

SelectAttributesActivityTypeDef#

# SelectAttributesActivityTypeDef definition

class SelectAttributesActivityTypeDef(TypedDict):
    name: str,
    attributes: Sequence[str],
    next: NotRequired[str],

ReprocessingSummaryTypeDef#

# ReprocessingSummaryTypeDef definition

class ReprocessingSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    status: NotRequired[ReprocessingStatusType],  # (1)
    creationTime: NotRequired[datetime],
  1. See ReprocessingStatusType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

BatchPutMessageResponseTypeDef#

# BatchPutMessageResponseTypeDef definition

class BatchPutMessageResponseTypeDef(TypedDict):
    batchPutMessageErrorEntries: List[BatchPutMessageErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchPutMessageErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

CreateDatasetContentResponseTypeDef#

# CreateDatasetContentResponseTypeDef definition

class CreateDatasetContentResponseTypeDef(TypedDict):
    versionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePipelineResponseTypeDef#

# CreatePipelineResponseTypeDef definition

class CreatePipelineResponseTypeDef(TypedDict):
    pipelineName: str,
    pipelineArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RunPipelineActivityResponseTypeDef#

# RunPipelineActivityResponseTypeDef definition

class RunPipelineActivityResponseTypeDef(TypedDict):
    payloads: List[bytes],
    logResult: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SampleChannelDataResponseTypeDef#

# SampleChannelDataResponseTypeDef definition

class SampleChannelDataResponseTypeDef(TypedDict):
    payloads: List[bytes],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartPipelineReprocessingResponseTypeDef#

# StartPipelineReprocessingResponseTypeDef definition

class StartPipelineReprocessingResponseTypeDef(TypedDict):
    reprocessingId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

MessageTypeDef#

# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    messageId: str,
    payload: Union[str, bytes, IO[Any], StreamingBody],

ChannelStatisticsTypeDef#

# ChannelStatisticsTypeDef definition

class ChannelStatisticsTypeDef(TypedDict):
    size: NotRequired[EstimatedResourceSizeTypeDef],  # (1)
  1. See EstimatedResourceSizeTypeDef

DatastoreStatisticsTypeDef#

# DatastoreStatisticsTypeDef definition

class DatastoreStatisticsTypeDef(TypedDict):
    size: NotRequired[EstimatedResourceSizeTypeDef],  # (1)
  1. See EstimatedResourceSizeTypeDef

ChannelStorageSummaryTypeDef#

# ChannelStorageSummaryTypeDef definition

class ChannelStorageSummaryTypeDef(TypedDict):
    serviceManagedS3: NotRequired[Dict[str, Any]],
    customerManagedS3: NotRequired[CustomerManagedChannelS3StorageSummaryTypeDef],  # (1)
  1. See CustomerManagedChannelS3StorageSummaryTypeDef

ChannelStorageTypeDef#

# ChannelStorageTypeDef definition

class ChannelStorageTypeDef(TypedDict):
    serviceManagedS3: NotRequired[Mapping[str, Any]],
    customerManagedS3: NotRequired[CustomerManagedChannelS3StorageTypeDef],  # (1)
  1. See CustomerManagedChannelS3StorageTypeDef

CreateChannelResponseTypeDef#

# CreateChannelResponseTypeDef definition

class CreateChannelResponseTypeDef(TypedDict):
    channelName: str,
    channelArn: str,
    retentionPeriod: RetentionPeriodTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See