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#
Check if an operation can be paginated.
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:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iotevents").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
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)
...
- See AlarmRuleTypeDef
- See TagTypeDef
- See AlarmNotificationTypeDef
- See AlarmEventActionsTypeDef
- See AlarmCapabilitiesTypeDef
- See CreateAlarmModelResponseTypeDef
# create_alarm_model method usage example with argument unpacking
kwargs: CreateAlarmModelRequestRequestTypeDef = { # (1)
"alarmModelName": ...,
"roleArn": ...,
"alarmRule": ...,
}
parent.create_alarm_model(**kwargs)
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)
...
- See DetectorModelDefinitionTypeDef
- See TagTypeDef
- See EvaluationMethodType
- See CreateDetectorModelResponseTypeDef
# create_detector_model method usage example with argument unpacking
kwargs: CreateDetectorModelRequestRequestTypeDef = { # (1)
"detectorModelName": ...,
"detectorModelDefinition": ...,
"roleArn": ...,
}
parent.create_detector_model(**kwargs)
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)
...
# create_input method usage example with argument unpacking
kwargs: CreateInputRequestRequestTypeDef = { # (1)
"inputName": ...,
"inputDefinition": ...,
}
parent.create_input(**kwargs)
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)
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)
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)
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)
...
# describe_alarm_model method usage example with argument unpacking
kwargs: DescribeAlarmModelRequestRequestTypeDef = { # (1)
"alarmModelName": ...,
}
parent.describe_alarm_model(**kwargs)
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)
...
# describe_detector_model method usage example with argument unpacking
kwargs: DescribeDetectorModelRequestRequestTypeDef = { # (1)
"detectorModelName": ...,
}
parent.describe_detector_model(**kwargs)
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)
...
# describe_detector_model_analysis method usage example with argument unpacking
kwargs: DescribeDetectorModelAnalysisRequestRequestTypeDef = { # (1)
"analysisId": ...,
}
parent.describe_detector_model_analysis(**kwargs)
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)
...
# describe_input method usage example with argument unpacking
kwargs: DescribeInputRequestRequestTypeDef = { # (1)
"inputName": ...,
}
parent.describe_input(**kwargs)
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)
...
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
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:
...
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)
...
# get_detector_model_analysis_results method usage example with argument unpacking
kwargs: GetDetectorModelAnalysisResultsRequestRequestTypeDef = { # (1)
"analysisId": ...,
}
parent.get_detector_model_analysis_results(**kwargs)
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)
...
# list_alarm_model_versions method usage example with argument unpacking
kwargs: ListAlarmModelVersionsRequestRequestTypeDef = { # (1)
"alarmModelName": ...,
}
parent.list_alarm_model_versions(**kwargs)
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)
...
# list_alarm_models method usage example with argument unpacking
kwargs: ListAlarmModelsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_alarm_models(**kwargs)
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.