IoTAnalyticsClient#
Index > IoTAnalytics > IoTAnalyticsClient
Auto-generated documentation for IoTAnalytics type annotations stubs module mypy-boto3-iotanalytics.
IoTAnalyticsClient#
Type annotations and code completion for boto3.client("iotanalytics")
.
boto3 documentation
# IoTAnalyticsClient usage example
from boto3.session import Session
from mypy_boto3_iotanalytics.client import IoTAnalyticsClient
def get_iotanalytics_client() -> IoTAnalyticsClient:
return Session().client("iotanalytics")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("iotanalytics").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("iotanalytics")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.InternalFailureException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceUnavailableException,
client.exceptions.ThrottlingException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_iotanalytics.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
batch_put_message#
Sends messages to a channel.
Type annotations and code completion for boto3.client("iotanalytics").batch_put_message
method.
boto3 documentation
# batch_put_message method definition
def batch_put_message(
self,
*,
channelName: str,
messages: Sequence[MessageTypeDef], # (1)
) -> BatchPutMessageResponseTypeDef: # (2)
...
# batch_put_message method usage example with argument unpacking
kwargs: BatchPutMessageRequestRequestTypeDef = { # (1)
"channelName": ...,
"messages": ...,
}
parent.batch_put_message(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("iotanalytics").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_pipeline_reprocessing#
Cancels the reprocessing of data through the pipeline.
Type annotations and code completion for boto3.client("iotanalytics").cancel_pipeline_reprocessing
method.
boto3 documentation
# cancel_pipeline_reprocessing method definition
def cancel_pipeline_reprocessing(
self,
*,
pipelineName: str,
reprocessingId: str,
) -> Dict[str, Any]:
...
# cancel_pipeline_reprocessing method usage example with argument unpacking
kwargs: CancelPipelineReprocessingRequestRequestTypeDef = { # (1)
"pipelineName": ...,
"reprocessingId": ...,
}
parent.cancel_pipeline_reprocessing(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iotanalytics").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_channel#
Used to create a channel.
Type annotations and code completion for boto3.client("iotanalytics").create_channel
method.
boto3 documentation
# create_channel method definition
def create_channel(
self,
*,
channelName: str,
channelStorage: ChannelStorageTypeDef = ..., # (1)
retentionPeriod: RetentionPeriodTypeDef = ..., # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateChannelResponseTypeDef: # (4)
...
- See ChannelStorageTypeDef
- See RetentionPeriodTypeDef
- See TagTypeDef
- See CreateChannelResponseTypeDef
# create_channel method usage example with argument unpacking
kwargs: CreateChannelRequestRequestTypeDef = { # (1)
"channelName": ...,
}
parent.create_channel(**kwargs)
create_dataset#
Used to create a dataset.
Type annotations and code completion for boto3.client("iotanalytics").create_dataset
method.
boto3 documentation
# create_dataset method definition
def create_dataset(
self,
*,
datasetName: str,
actions: Sequence[DatasetActionTypeDef], # (1)
triggers: Sequence[DatasetTriggerTypeDef] = ..., # (2)
contentDeliveryRules: Sequence[DatasetContentDeliveryRuleTypeDef] = ..., # (3)
retentionPeriod: RetentionPeriodTypeDef = ..., # (4)
versioningConfiguration: VersioningConfigurationTypeDef = ..., # (5)
tags: Sequence[TagTypeDef] = ..., # (6)
lateDataRules: Sequence[LateDataRuleTypeDef] = ..., # (7)
) -> CreateDatasetResponseTypeDef: # (8)
...
- See DatasetActionTypeDef
- See DatasetTriggerTypeDef
- See DatasetContentDeliveryRuleTypeDef
- See RetentionPeriodTypeDef
- See VersioningConfigurationTypeDef
- See TagTypeDef
- See LateDataRuleTypeDef
- See CreateDatasetResponseTypeDef
# create_dataset method usage example with argument unpacking
kwargs: CreateDatasetRequestRequestTypeDef = { # (1)
"datasetName": ...,
"actions": ...,
}
parent.create_dataset(**kwargs)
create_dataset_content#
Creates the content of a dataset by applying a queryAction
(a SQL query) or a
containerAction
(executing a containerized
application).
Type annotations and code completion for boto3.client("iotanalytics").create_dataset_content
method.
boto3 documentation
# create_dataset_content method definition
def create_dataset_content(
self,
*,
datasetName: str,
versionId: str = ...,
) -> CreateDatasetContentResponseTypeDef: # (1)
...
# create_dataset_content method usage example with argument unpacking
kwargs: CreateDatasetContentRequestRequestTypeDef = { # (1)
"datasetName": ...,
}
parent.create_dataset_content(**kwargs)
create_datastore#
Creates a data store, which is a repository for messages.
Type annotations and code completion for boto3.client("iotanalytics").create_datastore
method.
boto3 documentation
# create_datastore method definition
def create_datastore(
self,
*,
datastoreName: str,
datastoreStorage: DatastoreStorageTypeDef = ..., # (1)
retentionPeriod: RetentionPeriodTypeDef = ..., # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
fileFormatConfiguration: FileFormatConfigurationTypeDef = ..., # (4)
datastorePartitions: DatastorePartitionsTypeDef = ..., # (5)
) -> CreateDatastoreResponseTypeDef: # (6)
...
- See DatastoreStorageTypeDef
- See RetentionPeriodTypeDef
- See TagTypeDef
- See FileFormatConfigurationTypeDef
- See DatastorePartitionsTypeDef
- See CreateDatastoreResponseTypeDef
# create_datastore method usage example with argument unpacking
kwargs: CreateDatastoreRequestRequestTypeDef = { # (1)
"datastoreName": ...,
}
parent.create_datastore(**kwargs)
create_pipeline#
Creates a pipeline.
Type annotations and code completion for boto3.client("iotanalytics").create_pipeline
method.
boto3 documentation
# create_pipeline method definition
def create_pipeline(
self,
*,
pipelineName: str,
pipelineActivities: Sequence[PipelineActivityTypeDef], # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreatePipelineResponseTypeDef: # (3)
...
# create_pipeline method usage example with argument unpacking
kwargs: CreatePipelineRequestRequestTypeDef = { # (1)
"pipelineName": ...,
"pipelineActivities": ...,
}
parent.create_pipeline(**kwargs)
delete_channel#
Deletes the specified channel.
Type annotations and code completion for boto3.client("iotanalytics").delete_channel
method.
boto3 documentation
# delete_channel method definition
def delete_channel(
self,
*,
channelName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_channel method usage example with argument unpacking
kwargs: DeleteChannelRequestRequestTypeDef = { # (1)
"channelName": ...,
}
parent.delete_channel(**kwargs)
delete_dataset#
Deletes the specified dataset.
Type annotations and code completion for boto3.client("iotanalytics").delete_dataset
method.
boto3 documentation
# delete_dataset method definition
def delete_dataset(
self,
*,
datasetName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_dataset method usage example with argument unpacking
kwargs: DeleteDatasetRequestRequestTypeDef = { # (1)
"datasetName": ...,
}
parent.delete_dataset(**kwargs)
delete_dataset_content#
Deletes the content of the specified dataset.
Type annotations and code completion for boto3.client("iotanalytics").delete_dataset_content
method.
boto3 documentation
# delete_dataset_content method definition
def delete_dataset_content(
self,
*,
datasetName: str,
versionId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_dataset_content method usage example with argument unpacking
kwargs: DeleteDatasetContentRequestRequestTypeDef = { # (1)
"datasetName": ...,
}
parent.delete_dataset_content(**kwargs)
delete_datastore#
Deletes the specified data store.
Type annotations and code completion for boto3.client("iotanalytics").delete_datastore
method.
boto3 documentation
# delete_datastore method definition
def delete_datastore(
self,
*,
datastoreName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_datastore method usage example with argument unpacking
kwargs: DeleteDatastoreRequestRequestTypeDef = { # (1)
"datastoreName": ...,
}
parent.delete_datastore(**kwargs)
delete_pipeline#
Deletes the specified pipeline.
Type annotations and code completion for boto3.client("iotanalytics").delete_pipeline
method.
boto3 documentation
# delete_pipeline method definition
def delete_pipeline(
self,
*,
pipelineName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_pipeline method usage example with argument unpacking
kwargs: DeletePipelineRequestRequestTypeDef = { # (1)
"pipelineName": ...,
}
parent.delete_pipeline(**kwargs)
describe_channel#
Retrieves information about a channel.
Type annotations and code completion for boto3.client("iotanalytics").describe_channel
method.
boto3 documentation
# describe_channel method definition
def describe_channel(
self,
*,
channelName: str,
includeStatistics: bool = ...,
) -> DescribeChannelResponseTypeDef: # (1)
...
# describe_channel method usage example with argument unpacking
kwargs: DescribeChannelRequestRequestTypeDef = { # (1)
"channelName": ...,
}
parent.describe_channel(**kwargs)
describe_dataset#
Retrieves information about a dataset.
Type annotations and code completion for boto3.client("iotanalytics").describe_dataset
method.