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

1. See MessageTypeDef
2. See BatchPutMessageResponseTypeDef

# batch_put_message method usage example with argument unpacking

kwargs: BatchPutMessageRequestRequestTypeDef = {  # (1)
    "channelName": ...,
    "messages": ...,
}

parent.batch_put_message(**kwargs)

1. See BatchPutMessageRequestRequestTypeDef

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)

1. See CancelPipelineReprocessingRequestRequestTypeDef

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

1. See ChannelStorageTypeDef
2. See RetentionPeriodTypeDef
3. See TagTypeDef
4. See CreateChannelResponseTypeDef

# create_channel method usage example with argument unpacking

kwargs: CreateChannelRequestRequestTypeDef = {  # (1)
    "channelName": ...,
}

parent.create_channel(**kwargs)

1. See CreateChannelRequestRequestTypeDef

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[DatasetActionUnionTypeDef],  # (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)
    ...

1. See DatasetActionTypeDef DatasetActionOutputTypeDef
2. See DatasetTriggerTypeDef
3. See DatasetContentDeliveryRuleTypeDef
4. See RetentionPeriodTypeDef
5. See VersioningConfigurationTypeDef
6. See TagTypeDef
7. See LateDataRuleTypeDef
8. See CreateDatasetResponseTypeDef

# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
    "actions": ...,
}

parent.create_dataset(**kwargs)

1. See CreateDatasetRequestRequestTypeDef

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

1. See CreateDatasetContentResponseTypeDef

# create_dataset_content method usage example with argument unpacking

kwargs: CreateDatasetContentRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
}

parent.create_dataset_content(**kwargs)

1. See CreateDatasetContentRequestRequestTypeDef

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

1. See DatastoreStorageTypeDef
2. See RetentionPeriodTypeDef
3. See TagTypeDef
4. See FileFormatConfigurationTypeDef
5. See DatastorePartitionsTypeDef
6. See CreateDatastoreResponseTypeDef

# create_datastore method usage example with argument unpacking

kwargs: CreateDatastoreRequestRequestTypeDef = {  # (1)
    "datastoreName": ...,
}

parent.create_datastore(**kwargs)

1. See CreateDatastoreRequestRequestTypeDef

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[PipelineActivityUnionTypeDef],  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreatePipelineResponseTypeDef:  # (3)
    ...

1. See PipelineActivityTypeDef PipelineActivityOutputTypeDef
2. See TagTypeDef
3. See CreatePipelineResponseTypeDef

# create_pipeline method usage example with argument unpacking

kwargs: CreatePipelineRequestRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "pipelineActivities": ...,
}

parent.create_pipeline(**kwargs)

1. See CreatePipelineRequestRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_channel method usage example with argument unpacking

kwargs: DeleteChannelRequestRequestTypeDef = {  # (1)
    "channelName": ...,
}

parent.delete_channel(**kwargs)

1. See DeleteChannelRequestRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_dataset method usage example with argument unpacking

kwargs: DeleteDatasetRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
}

parent.delete_dataset(**kwargs)

1. See DeleteDatasetRequestRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_dataset_content method usage example with argument unpacking

kwargs: DeleteDatasetContentRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
}

parent.delete_dataset_content(**kwargs)

1. See DeleteDatasetContentRequestRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_datastore method usage example with argument unpacking

kwargs: DeleteDatastoreRequestRequestTypeDef = {  # (1)
    "datastoreName": ...,
}

parent.delete_datastore(**kwargs)

1. See DeleteDatastoreRequestRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_pipeline method usage example with argument unpacking

kwargs: DeletePipelineRequestRequestTypeDef = {  # (1)
    "pipelineName": ...,
}

parent.delete_pipeline(**kwargs)

1. See DeletePipelineRequestRequestTypeDef

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

1. See DescribeChannelResponseTypeDef

# describe_channel method usage example with argument unpacking

kwargs: DescribeChannelRequestRequestTypeDef = {  # (1)
    "channelName": ...,
}

parent.describe_channel(**kwargs)

1. See DescribeChannelRequestRequestTypeDef

describe_dataset

Retrieves information about a dataset.

Type annotations and code completion for boto3.client("iotanalytics").describe_dataset method. boto3 documentation

# describe_dataset method definition

def describe_dataset(
    self,
    *,
    datasetName: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetResponseTypeDef

# describe_dataset method usage example with argument unpacking

kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
}

parent.describe_dataset(**kwargs)

1. See DescribeDatasetRequestRequestTypeDef

describe_datastore

Retrieves information about a data store.

Type annotations and code completion for boto3.client("iotanalytics").describe_datastore method. boto3 documentation

# describe_datastore method definition

def describe_datastore(
    self,
    *,
    datastoreName: str,
    includeStatistics: bool = ...,
) -> DescribeDatastoreResponseTypeDef:  # (1)
    ...

1. See DescribeDatastoreResponseTypeDef

# describe_datastore method usage example with argument unpacking

kwargs: DescribeDatastoreRequestRequestTypeDef = {  # (1)
    "datastoreName": ...,
}

parent.describe_datastore(**kwargs)

1. See DescribeDatastoreRequestRequestTypeDef

describe_logging_options

Retrieves the current settings of the IoT Analytics logging options.

Type annotations and code completion for boto3.client("iotanalytics").describe_logging_options method. boto3 documentation

# describe_logging_options method definition

def describe_logging_options(
    self,
) -> DescribeLoggingOptionsResponseTypeDef:  # (1)
    ...

1. See DescribeLoggingOptionsResponseTypeDef

describe_pipeline

Retrieves information about a pipeline.

Type annotations and code completion for boto3.client("iotanalytics").describe_pipeline method. boto3 documentation

# describe_pipeline method definition

def describe_pipeline(
    self,
    *,
    pipelineName: str,
) -> DescribePipelineResponseTypeDef:  # (1)
    ...

1. See DescribePipelineResponseTypeDef

# describe_pipeline method usage example with argument unpacking

kwargs: DescribePipelineRequestRequestTypeDef = {  # (1)
    "pipelineName": ...,
}

parent.describe_pipeline(**kwargs)

1. See DescribePipelineRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("iotanalytics").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_dataset_content

Retrieves the contents of a dataset as presigned URIs.

Type annotations and code completion for boto3.client("iotanalytics").get_dataset_content method. boto3 documentation

# get_dataset_content method definition

def get_dataset_content(
    self,
    *,
    datasetName: str,
    versionId: str = ...,
) -> GetDatasetContentResponseTypeDef:  # (1)
    ...

1. See GetDatasetContentResponseTypeDef

# get_dataset_content method usage example with argument unpacking

kwargs: GetDatasetContentRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
}

parent.get_dataset_content(**kwargs)

1. See GetDatasetContentRequestRequestTypeDef

list_channels

Retrieves a list of channels.

Type annotations and code completion for boto3.client("iotanalytics").list_channels method. boto3 documentation

# list_channels method definition

def list_channels(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListChannelsResponseTypeDef:  # (1)
    ...

1. See ListChannelsResponseTypeDef

# list_channels method usage example with argument unpacking

kwargs: ListChannelsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_channels(**kwargs)

1. See ListChannelsRequestRequestTypeDef

list_dataset_contents

Lists information about dataset contents that have been created.

Type annotations and code completion for boto3.client("iotanalytics").list_dataset_contents method. boto3 documentation

# list_dataset_contents method definition

def list_dataset_contents(
    self,
    *,
    datasetName: str,
    nextToken: str = ...,
    maxResults: int = ...,
    scheduledOnOrAfter: TimestampTypeDef = ...,
    scheduledBefore: TimestampTypeDef = ...,
) -> ListDatasetContentsResponseTypeDef:  # (1)
    ...

1. See ListDatasetContentsResponseTypeDef

# list_dataset_contents method usage example with argument unpacking

kwargs: ListDatasetContentsRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
}

parent.list_dataset_contents(**kwargs)

1. See ListDatasetContentsRequestRequestTypeDef

list_datasets

Retrieves information about datasets.

Type annotations and code completion for boto3.client("iotanalytics").list_datasets method. boto3 documentation

# list_datasets method definition

def list_datasets(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetsResponseTypeDef:  # (1)
    ...

1. See ListDatasetsResponseTypeDef

# list_datasets method usage example with argument unpacking

kwargs: ListDatasetsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_datasets(**kwargs)

1. See ListDatasetsRequestRequestTypeDef

list_datastores

Retrieves a list of data stores.

Type annotations and code completion for boto3.client("iotanalytics").list_datastores method. boto3 documentation

# list_datastores method definition

def list_datastores(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatastoresResponseTypeDef:  # (1)
    ...

1. See ListDatastoresResponseTypeDef

# list_datastores method usage example with argument unpacking

kwargs: ListDatastoresRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_datastores(**kwargs)

1. See ListDatastoresRequestRequestTypeDef

list_pipelines

Retrieves a list of pipelines.

Type annotations and code completion for boto3.client("iotanalytics").list_pipelines method. boto3 documentation

# list_pipelines method definition

def list_pipelines(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPipelinesResponseTypeDef:  # (1)
    ...

1. See ListPipelinesResponseTypeDef

# list_pipelines method usage example with argument unpacking

kwargs: ListPipelinesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_pipelines(**kwargs)

1. See ListPipelinesRequestRequestTypeDef

list_tags_for_resource

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

Type annotations and code completion for boto3.client("iotanalytics").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_logging_options

Sets or updates the IoT Analytics logging options.

Type annotations and code completion for boto3.client("iotanalytics").put_logging_options method. boto3 documentation

# put_logging_options method definition

def put_logging_options(
    self,
    *,
    loggingOptions: LoggingOptionsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See LoggingOptionsTypeDef
2. See EmptyResponseMetadataTypeDef

# put_logging_options method usage example with argument unpacking

kwargs: PutLoggingOptionsRequestRequestTypeDef = {  # (1)
    "loggingOptions": ...,
}

parent.put_logging_options(**kwargs)

1. See PutLoggingOptionsRequestRequestTypeDef

run_pipeline_activity

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

Type annotations and code completion for boto3.client("iotanalytics").run_pipeline_activity method. boto3 documentation

# run_pipeline_activity method definition

def run_pipeline_activity(
    self,
    *,
    pipelineActivity: PipelineActivityTypeDef,  # (1)
    payloads: Sequence[BlobTypeDef],
) -> RunPipelineActivityResponseTypeDef:  # (2)
    ...

1. See PipelineActivityTypeDef
2. See RunPipelineActivityResponseTypeDef

# run_pipeline_activity method usage example with argument unpacking

kwargs: RunPipelineActivityRequestRequestTypeDef = {  # (1)
    "pipelineActivity": ...,
    "payloads": ...,
}

parent.run_pipeline_activity(**kwargs)

1. See RunPipelineActivityRequestRequestTypeDef

sample_channel_data

Retrieves a sample of messages from the specified channel ingested during the specified timeframe.

Type annotations and code completion for boto3.client("iotanalytics").sample_channel_data method. boto3 documentation

# sample_channel_data method definition

def sample_channel_data(
    self,
    *,
    channelName: str,
    maxMessages: int = ...,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
) -> SampleChannelDataResponseTypeDef:  # (1)
    ...

1. See SampleChannelDataResponseTypeDef

# sample_channel_data method usage example with argument unpacking

kwargs: SampleChannelDataRequestRequestTypeDef = {  # (1)
    "channelName": ...,
}

parent.sample_channel_data(**kwargs)

1. See SampleChannelDataRequestRequestTypeDef

start_pipeline_reprocessing

Starts the reprocessing of raw message data through the pipeline.

Type annotations and code completion for boto3.client("iotanalytics").start_pipeline_reprocessing method. boto3 documentation

# start_pipeline_reprocessing method definition

def start_pipeline_reprocessing(
    self,
    *,
    pipelineName: str,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    channelMessages: ChannelMessagesTypeDef = ...,  # (1)
) -> StartPipelineReprocessingResponseTypeDef:  # (2)
    ...

1. See ChannelMessagesTypeDef
2. See StartPipelineReprocessingResponseTypeDef

# start_pipeline_reprocessing method usage example with argument unpacking

kwargs: StartPipelineReprocessingRequestRequestTypeDef = {  # (1)
    "pipelineName": ...,
}

parent.start_pipeline_reprocessing(**kwargs)

1. See StartPipelineReprocessingRequestRequestTypeDef

tag_resource

Adds to or modifies the tags of the given resource.

Type annotations and code completion for boto3.client("iotanalytics").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the given tags (metadata) from the resource.

Type annotations and code completion for boto3.client("iotanalytics").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_channel

Used to update the settings of a channel.

Type annotations and code completion for boto3.client("iotanalytics").update_channel method. boto3 documentation

# update_channel method definition

def update_channel(
    self,
    *,
    channelName: str,
    channelStorage: ChannelStorageTypeDef = ...,  # (1)
    retentionPeriod: RetentionPeriodTypeDef = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See ChannelStorageTypeDef
2. See RetentionPeriodTypeDef
3. See EmptyResponseMetadataTypeDef

# update_channel method usage example with argument unpacking

kwargs: UpdateChannelRequestRequestTypeDef = {  # (1)
    "channelName": ...,
}

parent.update_channel(**kwargs)

1. See UpdateChannelRequestRequestTypeDef

update_dataset

Updates the settings of a dataset.

Type annotations and code completion for boto3.client("iotanalytics").update_dataset method. boto3 documentation

# update_dataset method definition

def update_dataset(
    self,
    *,
    datasetName: str,
    actions: Sequence[DatasetActionTypeDef],  # (1)
    triggers: Sequence[DatasetTriggerTypeDef] = ...,  # (2)
    contentDeliveryRules: Sequence[DatasetContentDeliveryRuleTypeDef] = ...,  # (3)
    retentionPeriod: RetentionPeriodTypeDef = ...,  # (4)
    versioningConfiguration: VersioningConfigurationTypeDef = ...,  # (5)
    lateDataRules: Sequence[LateDataRuleTypeDef] = ...,  # (6)
) -> EmptyResponseMetadataTypeDef:  # (7)
    ...

1. See DatasetActionTypeDef
2. See DatasetTriggerTypeDef
3. See DatasetContentDeliveryRuleTypeDef
4. See RetentionPeriodTypeDef
5. See VersioningConfigurationTypeDef
6. See LateDataRuleTypeDef
7. See EmptyResponseMetadataTypeDef

# update_dataset method usage example with argument unpacking

kwargs: UpdateDatasetRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
    "actions": ...,
}

parent.update_dataset(**kwargs)

1. See UpdateDatasetRequestRequestTypeDef

update_datastore

Used to update the settings of a data store.

Type annotations and code completion for boto3.client("iotanalytics").update_datastore method. boto3 documentation

# update_datastore method definition

def update_datastore(
    self,
    *,
    datastoreName: str,
    retentionPeriod: RetentionPeriodTypeDef = ...,  # (1)
    datastoreStorage: DatastoreStorageTypeDef = ...,  # (2)
    fileFormatConfiguration: FileFormatConfigurationTypeDef = ...,  # (3)
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...

1. See RetentionPeriodTypeDef
2. See DatastoreStorageTypeDef
3. See FileFormatConfigurationTypeDef
4. See EmptyResponseMetadataTypeDef

# update_datastore method usage example with argument unpacking

kwargs: UpdateDatastoreRequestRequestTypeDef = {  # (1)
    "datastoreName": ...,
}

parent.update_datastore(**kwargs)

1. See UpdateDatastoreRequestRequestTypeDef

update_pipeline

Updates the settings of a pipeline.

Type annotations and code completion for boto3.client("iotanalytics").update_pipeline method. boto3 documentation

# update_pipeline method definition

def update_pipeline(
    self,
    *,
    pipelineName: str,
    pipelineActivities: Sequence[PipelineActivityTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See PipelineActivityTypeDef
2. See EmptyResponseMetadataTypeDef

# update_pipeline method usage example with argument unpacking

kwargs: UpdatePipelineRequestRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "pipelineActivities": ...,
}

parent.update_pipeline(**kwargs)

1. See UpdatePipelineRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("iotanalytics").get_paginator method with overloads.

• client.get_paginator("list_channels") -> ListChannelsPaginator
• client.get_paginator("list_dataset_contents") -> ListDatasetContentsPaginator
• client.get_paginator("list_datasets") -> ListDatasetsPaginator
• client.get_paginator("list_datastores") -> ListDatastoresPaginator
• client.get_paginator("list_pipelines") -> ListPipelinesPaginator