Skip to content

IoTEventsClient#

Index > IoTEvents > IoTEventsClient

Auto-generated documentation for IoTEvents type annotations stubs module mypy-boto3-iotevents.

IoTEventsClient#

Type annotations and code completion for boto3.client("iotevents"). boto3 documentation

# IoTEventsClient usage example

from boto3.session import Session
from mypy_boto3_iotevents.client import IoTEventsClient

def get_iotevents_client() -> IoTEventsClient:
    return Session().client("iotevents")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("iotevents").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("iotevents")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalFailureException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnsupportedOperationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_iotevents.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("iotevents").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("iotevents").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:
    ...

create_alarm_model#

Creates an alarm model to monitor an AWS IoT Events input attribute.

Type annotations and code completion for boto3.client("iotevents").create_alarm_model method. boto3 documentation

# create_alarm_model method definition

def create_alarm_model(
    self,
    *,
    alarmModelName: str,
    roleArn: str,
    alarmRule: AlarmRuleTypeDef,  # (1)
    alarmModelDescription: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    key: str = ...,
    severity: int = ...,
    alarmNotification: AlarmNotificationTypeDef = ...,  # (3)
    alarmEventActions: AlarmEventActionsTypeDef = ...,  # (4)
    alarmCapabilities: AlarmCapabilitiesTypeDef = ...,  # (5)
) -> CreateAlarmModelResponseTypeDef:  # (6)
    ...
  1. See AlarmRuleTypeDef
  2. See TagTypeDef
  3. See AlarmNotificationTypeDef
  4. See AlarmEventActionsTypeDef
  5. See AlarmCapabilitiesTypeDef
  6. See CreateAlarmModelResponseTypeDef 
# create_alarm_model method usage example with argument unpacking

kwargs: CreateAlarmModelRequestRequestTypeDef = {  # (1)
    "alarmModelName": ...,
    "roleArn": ...,
    "alarmRule": ...,
}

parent.create_alarm_model(**kwargs)
  1. See CreateAlarmModelRequestRequestTypeDef

create_detector_model#

Creates a detector model.

Type annotations and code completion for boto3.client("iotevents").create_detector_model method. boto3 documentation

# create_detector_model method definition

def create_detector_model(
    self,
    *,
    detectorModelName: str,
    detectorModelDefinition: DetectorModelDefinitionTypeDef,  # (1)
    roleArn: str,
    detectorModelDescription: str = ...,
    key: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    evaluationMethod: EvaluationMethodType = ...,  # (3)
) -> CreateDetectorModelResponseTypeDef:  # (4)
    ...
  1. See DetectorModelDefinitionTypeDef
  2. See TagTypeDef
  3. See EvaluationMethodType
  4. See CreateDetectorModelResponseTypeDef 
# create_detector_model method usage example with argument unpacking

kwargs: CreateDetectorModelRequestRequestTypeDef = {  # (1)
    "detectorModelName": ...,
    "detectorModelDefinition": ...,
    "roleArn": ...,
}

parent.create_detector_model(**kwargs)
  1. See CreateDetectorModelRequestRequestTypeDef

create_input#

Creates an input.

Type annotations and code completion for boto3.client("iotevents").create_input method. boto3 documentation

# create_input method definition

def create_input(
    self,
    *,
    inputName: str,
    inputDefinition: InputDefinitionTypeDef,  # (1)
    inputDescription: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateInputResponseTypeDef:  # (3)
    ...
  1. See InputDefinitionTypeDef
  2. See TagTypeDef
  3. See CreateInputResponseTypeDef 
# create_input method usage example with argument unpacking

kwargs: CreateInputRequestRequestTypeDef = {  # (1)
    "inputName": ...,
    "inputDefinition": ...,
}

parent.create_input(**kwargs)
  1. See CreateInputRequestRequestTypeDef

delete_alarm_model#

Deletes an alarm model.

Type annotations and code completion for boto3.client("iotevents").delete_alarm_model method. boto3 documentation

# delete_alarm_model method definition

def delete_alarm_model(
    self,
    *,
    alarmModelName: str,
) -> dict[str, Any]:
    ...
# delete_alarm_model method usage example with argument unpacking

kwargs: DeleteAlarmModelRequestRequestTypeDef = {  # (1)
    "alarmModelName": ...,
}

parent.delete_alarm_model(**kwargs)
  1. See DeleteAlarmModelRequestRequestTypeDef

delete_detector_model#

Deletes a detector model.

Type annotations and code completion for boto3.client("iotevents").delete_detector_model method. boto3 documentation

# delete_detector_model method definition

def delete_detector_model(
    self,
    *,
    detectorModelName: str,
) -> dict[str, Any]:
    ...
# delete_detector_model method usage example with argument unpacking

kwargs: DeleteDetectorModelRequestRequestTypeDef = {  # (1)
    "detectorModelName": ...,
}

parent.delete_detector_model(**kwargs)
  1. See DeleteDetectorModelRequestRequestTypeDef

delete_input#

Deletes an input.

Type annotations and code completion for boto3.client("iotevents").delete_input method. boto3 documentation

# delete_input method definition

def delete_input(
    self,
    *,
    inputName: str,
) -> dict[str, Any]:
    ...
# delete_input method usage example with argument unpacking

kwargs: DeleteInputRequestRequestTypeDef = {  # (1)
    "inputName": ...,
}

parent.delete_input(**kwargs)
  1. See DeleteInputRequestRequestTypeDef

describe_alarm_model#

Retrieves information about an alarm model.

Type annotations and code completion for boto3.client("iotevents").describe_alarm_model method. boto3 documentation

# describe_alarm_model method definition

def describe_alarm_model(
    self,
    *,
    alarmModelName: str,
    alarmModelVersion: str = ...,
) -> DescribeAlarmModelResponseTypeDef:  # (1)
    ...
  1. See DescribeAlarmModelResponseTypeDef 
# describe_alarm_model method usage example with argument unpacking

kwargs: DescribeAlarmModelRequestRequestTypeDef = {  # (1)
    "alarmModelName": ...,
}

parent.describe_alarm_model(**kwargs)
  1. See DescribeAlarmModelRequestRequestTypeDef

describe_detector_model#

Describes a detector model.

Type annotations and code completion for boto3.client("iotevents").describe_detector_model method. boto3 documentation

# describe_detector_model method definition

def describe_detector_model(
    self,
    *,
    detectorModelName: str,
    detectorModelVersion: str = ...,
) -> DescribeDetectorModelResponseTypeDef:  # (1)
    ...
  1. See DescribeDetectorModelResponseTypeDef 
# describe_detector_model method usage example with argument unpacking

kwargs: DescribeDetectorModelRequestRequestTypeDef = {  # (1)
    "detectorModelName": ...,
}

parent.describe_detector_model(**kwargs)
  1. See DescribeDetectorModelRequestRequestTypeDef

describe_detector_model_analysis#

Retrieves runtime information about a detector model analysis.

Type annotations and code completion for boto3.client("iotevents").describe_detector_model_analysis method. boto3 documentation

# describe_detector_model_analysis method definition

def describe_detector_model_analysis(
    self,
    *,
    analysisId: str,
) -> DescribeDetectorModelAnalysisResponseTypeDef:  # (1)
    ...
  1. See DescribeDetectorModelAnalysisResponseTypeDef 
# describe_detector_model_analysis method usage example with argument unpacking

kwargs: DescribeDetectorModelAnalysisRequestRequestTypeDef = {  # (1)
    "analysisId": ...,
}

parent.describe_detector_model_analysis(**kwargs)
  1. See DescribeDetectorModelAnalysisRequestRequestTypeDef

describe_input#

Describes an input.

Type annotations and code completion for boto3.client("iotevents").describe_input method. boto3 documentation

# describe_input method definition

def describe_input(
    self,
    *,
    inputName: str,
) -> DescribeInputResponseTypeDef:  # (1)
    ...
  1. See DescribeInputResponseTypeDef 
# describe_input method usage example with argument unpacking

kwargs: DescribeInputRequestRequestTypeDef = {  # (1)
    "inputName": ...,
}

parent.describe_input(**kwargs)
  1. See DescribeInputRequestRequestTypeDef

describe_logging_options#

Retrieves the current settings of the AWS IoT Events logging options.

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

# describe_logging_options method definition

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

get_detector_model_analysis_results#

Retrieves one or more analysis results of the detector model.

Type annotations and code completion for boto3.client("iotevents").get_detector_model_analysis_results method. boto3 documentation

# get_detector_model_analysis_results method definition

def get_detector_model_analysis_results(
    self,
    *,
    analysisId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetDetectorModelAnalysisResultsResponseTypeDef:  # (1)
    ...
  1. See GetDetectorModelAnalysisResultsResponseTypeDef 
# get_detector_model_analysis_results method usage example with argument unpacking

kwargs: GetDetectorModelAnalysisResultsRequestRequestTypeDef = {  # (1)
    "analysisId": ...,
}

parent.get_detector_model_analysis_results(**kwargs)
  1. See GetDetectorModelAnalysisResultsRequestRequestTypeDef

list_alarm_model_versions#

Lists all the versions of an alarm model.

Type annotations and code completion for boto3.client("iotevents").list_alarm_model_versions method. boto3 documentation

# list_alarm_model_versions method definition

def list_alarm_model_versions(
    self,
    *,
    alarmModelName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAlarmModelVersionsResponseTypeDef:  # (1)
    ...
  1. See ListAlarmModelVersionsResponseTypeDef 
# list_alarm_model_versions method usage example with argument unpacking

kwargs: ListAlarmModelVersionsRequestRequestTypeDef = {  # (1)
    "alarmModelName": ...,
}

parent.list_alarm_model_versions(**kwargs)
  1. See ListAlarmModelVersionsRequestRequestTypeDef

list_alarm_models#

Lists the alarm models that you created.

Type annotations and code completion for boto3.client("iotevents").list_alarm_models method. boto3 documentation

# list_alarm_models method definition

def list_alarm_models(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAlarmModelsResponseTypeDef:  # (1)
    ...
  1. See ListAlarmModelsResponseTypeDef 
# list_alarm_models method usage example with argument unpacking

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

parent.list_alarm_models(**kwargs)
  1. See ListAlarmModelsRequestRequestTypeDef

list_detector_model_versions#

Lists all the versions of a detector model.

Type annotations and code completion for boto3.client("iotevents").list_detector_model_versions method. boto3 documentation

# list_detector_model_versions method definition

def list_detector_model_versions(
    self,
    *,
    detectorModelName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDetectorModelVersionsResponseTypeDef:  # (1)
    ...
  1. See ListDetectorModelVersionsResponseTypeDef 
# list_detector_model_versions method usage example with argument unpacking

kwargs: ListDetectorModelVersionsRequestRequestTypeDef = {  # (1)
    "detectorModelName": ...,
}

parent.list_detector_model_versions(**kwargs)
  1. See ListDetectorModelVersionsRequestRequestTypeDef

list_detector_models#

Lists the detector models you have created.

Type annotations and code completion for boto3.client("iotevents").list_detector_models method. boto3 documentation

# list_detector_models method definition

def list_detector_models(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDetectorModelsResponseTypeDef:  # (1)
    ...
  1. See ListDetectorModelsResponseTypeDef 
# list_detector_models method usage example with argument unpacking

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

parent.list_detector_models(**kwargs)
  1. See ListDetectorModelsRequestRequestTypeDef

list_input_routings#

Lists one or more input routings.

Type annotations and code completion for boto3.client("iotevents").list_input_routings method. boto3 documentation

# list_input_routings method definition

def list_input_routings(
    self,
    *,
    inputIdentifier: InputIdentifierTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListInputRoutingsResponseTypeDef:  # (2)
    ...
  1. See InputIdentifierTypeDef
  2. See ListInputRoutingsResponseTypeDef 
# list_input_routings method usage example with argument unpacking

kwargs: ListInputRoutingsRequestRequestTypeDef = {  # (1)
    "inputIdentifier": ...,
}

parent.list_input_routings(**kwargs)
  1. See ListInputRoutingsRequestRequestTypeDef

list_inputs#

Lists the inputs you have created.

Type annotations and code completion for boto3.client("iotevents").list_inputs method. boto3 documentation

# list_inputs method definition

def list_inputs(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListInputsResponseTypeDef:  # (1)
    ...
  1. See ListInputsResponseTypeDef 
# list_inputs method usage example with argument unpacking

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

parent.list_inputs(**kwargs)
  1. See ListInputsRequestRequestTypeDef

list_tags_for_resource#

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

Type annotations and code completion for boto3.client("iotevents").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 AWS IoT Events logging options.

Type annotations and code completion for boto3.client("iotevents").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

start_detector_model_analysis#

Performs an analysis of your detector model.

Type annotations and code completion for boto3.client("iotevents").start_detector_model_analysis method. boto3 documentation

# start_detector_model_analysis method definition

def start_detector_model_analysis(
    self,
    *,
    detectorModelDefinition: DetectorModelDefinitionTypeDef,  # (1)
) -> StartDetectorModelAnalysisResponseTypeDef:  # (2)
    ...
  1. See DetectorModelDefinitionTypeDef
  2. See StartDetectorModelAnalysisResponseTypeDef 
# start_detector_model_analysis method usage example with argument unpacking

kwargs: StartDetectorModelAnalysisRequestRequestTypeDef = {  # (1)
    "detectorModelDefinition": ...,
}

parent.start_detector_model_analysis(**kwargs)
  1. See StartDetectorModelAnalysisRequestRequestTypeDef

tag_resource#

Adds to or modifies the tags of the given resource.

Type annotations and code completion for boto3.client("iotevents").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("iotevents").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_alarm_model#

Updates an alarm model.

Type annotations and code completion for boto3.client("iotevents").update_alarm_model method. boto3 documentation

# update_alarm_model method definition

def update_alarm_model(
    self,
    *,
    alarmModelName: str,
    roleArn: str,
    alarmRule: AlarmRuleTypeDef,  # (1)
    alarmModelDescription: str = ...,
    severity: int = ...,
    alarmNotification: AlarmNotificationTypeDef = ...,  # (2)
    alarmEventActions: AlarmEventActionsTypeDef = ...,  # (3)
    alarmCapabilities: AlarmCapabilitiesTypeDef = ...,  # (4)
) -> UpdateAlarmModelResponseTypeDef:  # (5)
    ...
  1. See AlarmRuleTypeDef
  2. See AlarmNotificationTypeDef
  3. See AlarmEventActionsTypeDef
  4. See AlarmCapabilitiesTypeDef
  5. See UpdateAlarmModelResponseTypeDef 
# update_alarm_model method usage example with argument unpacking

kwargs: UpdateAlarmModelRequestRequestTypeDef = {  # (1)
    "alarmModelName": ...,
    "roleArn": ...,
    "alarmRule": ...,
}

parent.update_alarm_model(**kwargs)
  1. See UpdateAlarmModelRequestRequestTypeDef

update_detector_model#

Updates a detector model.

Type annotations and code completion for boto3.client("iotevents").update_detector_model method. boto3 documentation

# update_detector_model method definition

def update_detector_model(
    self,
    *,
    detectorModelName: str,
    detectorModelDefinition: DetectorModelDefinitionTypeDef,  # (1)
    roleArn: str,
    detectorModelDescription: str = ...,
    evaluationMethod: EvaluationMethodType = ...,  # (2)
) -> UpdateDetectorModelResponseTypeDef:  # (3)
    ...
  1. See DetectorModelDefinitionTypeDef
  2. See EvaluationMethodType
  3. See UpdateDetectorModelResponseTypeDef 
# update_detector_model method usage example with argument unpacking

kwargs: UpdateDetectorModelRequestRequestTypeDef = {  # (1)
    "detectorModelName": ...,
    "detectorModelDefinition": ...,
    "roleArn": ...,
}

parent.update_detector_model(**kwargs)
  1. See UpdateDetectorModelRequestRequestTypeDef

update_input#

Updates an input.

Type annotations and code completion for boto3.client("iotevents").update_input method. boto3 documentation

# update_input method definition

def update_input(
    self,
    *,
    inputName: str,
    inputDefinition: InputDefinitionTypeDef,  # (1)
    inputDescription: str = ...,
) -> UpdateInputResponseTypeDef:  # (2)
    ...
  1. See InputDefinitionTypeDef
  2. See UpdateInputResponseTypeDef 
# update_input method usage example with argument unpacking

kwargs: UpdateInputRequestRequestTypeDef = {  # (1)
    "inputName": ...,
    "inputDefinition": ...,
}

parent.update_input(**kwargs)
  1. See UpdateInputRequestRequestTypeDef