IoTEventsDataClient

Index > IoTEventsData > IoTEventsDataClient

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

IoTEventsDataClient

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

Usage example

from boto3.session import Session
from mypy_boto3_iotevents_data.client import IoTEventsDataClient

def get_iotevents-data_client() -> IoTEventsDataClient:
    return Session().client("iotevents-data")

Exceptions

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

Usage example

client = boto3.client("iotevents-data")

try:
    do_something(client)
except (
    client.ClientError,
    client.InternalFailureException,
    client.InvalidRequestException,
    client.ResourceNotFoundException,
    client.ServiceUnavailableException,
    client.ThrottlingException,
) as e:
    print(e)

Type checking example

from mypy_boto3_iotevents_data.client import Exceptions

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

Methods

batch_acknowledge_alarm

Acknowledges one or more alarms.

Type annotations and code completion for boto3.client("iotevents-data").batch_acknowledge_alarm method. boto3 documentation

Method definition

def batch_acknowledge_alarm(
    self,
    *,
    acknowledgeActionRequests: Sequence[AcknowledgeAlarmActionRequestTypeDef],  # (1)
) -> BatchAcknowledgeAlarmResponseTypeDef:  # (2)
    ...

1. See AcknowledgeAlarmActionRequestTypeDef
2. See BatchAcknowledgeAlarmResponseTypeDef

Usage example with kwargs

kwargs: BatchAcknowledgeAlarmRequestRequestTypeDef = {  # (1)
    "acknowledgeActionRequests": ...,
}

parent.batch_acknowledge_alarm(**kwargs)

1. See BatchAcknowledgeAlarmRequestRequestTypeDef

batch_delete_detector

Deletes one or more detectors that were created.

Type annotations and code completion for boto3.client("iotevents-data").batch_delete_detector method. boto3 documentation

Method definition

def batch_delete_detector(
    self,
    *,
    detectors: Sequence[DeleteDetectorRequestTypeDef],  # (1)
) -> BatchDeleteDetectorResponseTypeDef:  # (2)
    ...

1. See DeleteDetectorRequestTypeDef
2. See BatchDeleteDetectorResponseTypeDef

Usage example with kwargs

kwargs: BatchDeleteDetectorRequestRequestTypeDef = {  # (1)
    "detectors": ...,
}

parent.batch_delete_detector(**kwargs)

1. See BatchDeleteDetectorRequestRequestTypeDef

batch_disable_alarm

Disables one or more alarms.

Type annotations and code completion for boto3.client("iotevents-data").batch_disable_alarm method. boto3 documentation

Method definition

def batch_disable_alarm(
    self,
    *,
    disableActionRequests: Sequence[DisableAlarmActionRequestTypeDef],  # (1)
) -> BatchDisableAlarmResponseTypeDef:  # (2)
    ...

1. See DisableAlarmActionRequestTypeDef
2. See BatchDisableAlarmResponseTypeDef

Usage example with kwargs

kwargs: BatchDisableAlarmRequestRequestTypeDef = {  # (1)
    "disableActionRequests": ...,
}

parent.batch_disable_alarm(**kwargs)

1. See BatchDisableAlarmRequestRequestTypeDef

batch_enable_alarm

Enables one or more alarms.

Type annotations and code completion for boto3.client("iotevents-data").batch_enable_alarm method. boto3 documentation

Method definition

def batch_enable_alarm(
    self,
    *,
    enableActionRequests: Sequence[EnableAlarmActionRequestTypeDef],  # (1)
) -> BatchEnableAlarmResponseTypeDef:  # (2)
    ...

1. See EnableAlarmActionRequestTypeDef
2. See BatchEnableAlarmResponseTypeDef

Usage example with kwargs

kwargs: BatchEnableAlarmRequestRequestTypeDef = {  # (1)
    "enableActionRequests": ...,
}

parent.batch_enable_alarm(**kwargs)

1. See BatchEnableAlarmRequestRequestTypeDef

batch_put_message

Sends a set of messages to the IoT Events system.

Type annotations and code completion for boto3.client("iotevents-data").batch_put_message method. boto3 documentation

Method definition

def batch_put_message(
    self,
    *,
    messages: Sequence[MessageTypeDef],  # (1)
) -> BatchPutMessageResponseTypeDef:  # (2)
    ...

1. See MessageTypeDef
2. See BatchPutMessageResponseTypeDef

Usage example with kwargs

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

parent.batch_put_message(**kwargs)

1. See BatchPutMessageRequestRequestTypeDef

batch_reset_alarm

Resets one or more alarms.

Type annotations and code completion for boto3.client("iotevents-data").batch_reset_alarm method. boto3 documentation

Method definition

def batch_reset_alarm(
    self,
    *,
    resetActionRequests: Sequence[ResetAlarmActionRequestTypeDef],  # (1)
) -> BatchResetAlarmResponseTypeDef:  # (2)
    ...

1. See ResetAlarmActionRequestTypeDef
2. See BatchResetAlarmResponseTypeDef

Usage example with kwargs

kwargs: BatchResetAlarmRequestRequestTypeDef = {  # (1)
    "resetActionRequests": ...,
}

parent.batch_reset_alarm(**kwargs)

1. See BatchResetAlarmRequestRequestTypeDef

batch_snooze_alarm

Changes one or more alarms to the snooze mode.

Type annotations and code completion for boto3.client("iotevents-data").batch_snooze_alarm method. boto3 documentation

Method definition

def batch_snooze_alarm(
    self,
    *,
    snoozeActionRequests: Sequence[SnoozeAlarmActionRequestTypeDef],  # (1)
) -> BatchSnoozeAlarmResponseTypeDef:  # (2)
    ...

1. See SnoozeAlarmActionRequestTypeDef
2. See BatchSnoozeAlarmResponseTypeDef

Usage example with kwargs

kwargs: BatchSnoozeAlarmRequestRequestTypeDef = {  # (1)
    "snoozeActionRequests": ...,
}

parent.batch_snooze_alarm(**kwargs)

1. See BatchSnoozeAlarmRequestRequestTypeDef

batch_update_detector

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

Type annotations and code completion for boto3.client("iotevents-data").batch_update_detector method. boto3 documentation

Method definition

def batch_update_detector(
    self,
    *,
    detectors: Sequence[UpdateDetectorRequestTypeDef],  # (1)
) -> BatchUpdateDetectorResponseTypeDef:  # (2)
    ...

1. See UpdateDetectorRequestTypeDef
2. See BatchUpdateDetectorResponseTypeDef

Usage example with kwargs

kwargs: BatchUpdateDetectorRequestRequestTypeDef = {  # (1)
    "detectors": ...,
}

parent.batch_update_detector(**kwargs)

1. See BatchUpdateDetectorRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("iotevents-data").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

describe_alarm

Retrieves information about an alarm.

Type annotations and code completion for boto3.client("iotevents-data").describe_alarm method. boto3 documentation

Method definition

def describe_alarm(
    self,
    *,
    alarmModelName: str,
    keyValue: str = ...,
) -> DescribeAlarmResponseTypeDef:  # (1)
    ...

1. See DescribeAlarmResponseTypeDef

Usage example with kwargs

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

parent.describe_alarm(**kwargs)

1. See DescribeAlarmRequestRequestTypeDef

describe_detector

Returns information about the specified detector (instance).

Type annotations and code completion for boto3.client("iotevents-data").describe_detector method. boto3 documentation

Method definition

def describe_detector(
    self,
    *,
    detectorModelName: str,
    keyValue: str = ...,
) -> DescribeDetectorResponseTypeDef:  # (1)
    ...

1. See DescribeDetectorResponseTypeDef

Usage example with kwargs

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

parent.describe_detector(**kwargs)

1. See DescribeDetectorRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("iotevents-data").generate_presigned_url method. boto3 documentation

Method definition

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

list_alarms

Lists one or more alarms.

Type annotations and code completion for boto3.client("iotevents-data").list_alarms method. boto3 documentation

Method definition

def list_alarms(
    self,
    *,
    alarmModelName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAlarmsResponseTypeDef:  # (1)
    ...

1. See ListAlarmsResponseTypeDef

Usage example with kwargs

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

parent.list_alarms(**kwargs)

1. See ListAlarmsRequestRequestTypeDef

list_detectors

Lists detectors (the instances of a detector model).

Type annotations and code completion for boto3.client("iotevents-data").list_detectors method. boto3 documentation

Method definition

def list_detectors(
    self,
    *,
    detectorModelName: str,
    stateName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDetectorsResponseTypeDef:  # (1)
    ...

1. See ListDetectorsResponseTypeDef

Usage example with kwargs

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

parent.list_detectors(**kwargs)

1. See ListDetectorsRequestRequestTypeDef