Struct aws_sdk_iotevents::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS IoT Events
Client for invoking operations on AWS IoT Events. Each operation on AWS IoT Events is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_iotevents::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_iotevents::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateAlarmModel
operation has
a Client::create_alarm_model
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_alarm_model()
.alarm_model_name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn create_alarm_model(&self) -> CreateAlarmModelFluentBuilder
pub fn create_alarm_model(&self) -> CreateAlarmModelFluentBuilder
Constructs a fluent builder for the CreateAlarmModel
operation.
- The fluent builder is configurable:
alarm_model_name(impl Into<String>)
/set_alarm_model_name(Option<String>)
:
required: trueA unique name that helps you identify the alarm model. You can’t change this name after you create the alarm model.
alarm_model_description(impl Into<String>)
/set_alarm_model_description(Option<String>)
:
required: falseA description that tells you what the alarm model detects.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.
You can create up to 50 tags for one alarm model.
key(impl Into<String>)
/set_key(Option<String>)
:
required: falseAn input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
severity(i32)
/set_severity(Option<i32>)
:
required: falseA non-negative integer that reflects the severity level of the alarm.
alarm_rule(AlarmRule)
/set_alarm_rule(Option<AlarmRule>)
:
required: trueDefines when your alarm is invoked.
alarm_notification(AlarmNotification)
/set_alarm_notification(Option<AlarmNotification>)
:
required: falseContains information about one or more notification actions.
alarm_event_actions(AlarmEventActions)
/set_alarm_event_actions(Option<AlarmEventActions>)
:
required: falseContains information about one or more alarm actions.
alarm_capabilities(AlarmCapabilities)
/set_alarm_capabilities(Option<AlarmCapabilities>)
:
required: falseContains the configuration information of alarm state changes.
- On success, responds with
CreateAlarmModelOutput
with field(s):creation_time(Option<DateTime>)
:The time the alarm model was created, in the Unix epoch format.
alarm_model_arn(Option<String>)
:The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
alarm_model_version(Option<String>)
:The version of the alarm model.
last_update_time(Option<DateTime>)
:The time the alarm model was last updated, in the Unix epoch format.
status(Option<AlarmModelVersionStatus>)
:The status of the alarm model. The status can be one of the following values:
-
ACTIVE
- The alarm model is active and it’s ready to evaluate data. -
ACTIVATING
- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. -
INACTIVE
- The alarm model is inactive, so it isn’t ready to evaluate data. Check your alarm model information and update the alarm model. -
FAILED
- You couldn’t create or update the alarm model. Check your alarm model information and try again.
-
- On failure, responds with
SdkError<CreateAlarmModelError>
source§impl Client
impl Client
sourcepub fn create_detector_model(&self) -> CreateDetectorModelFluentBuilder
pub fn create_detector_model(&self) -> CreateDetectorModelFluentBuilder
Constructs a fluent builder for the CreateDetectorModel
operation.
- The fluent builder is configurable:
detector_model_name(impl Into<String>)
/set_detector_model_name(Option<String>)
:
required: trueThe name of the detector model.
detector_model_definition(DetectorModelDefinition)
/set_detector_model_definition(Option<DetectorModelDefinition>)
:
required: trueInformation that defines how the detectors operate.
detector_model_description(impl Into<String>)
/set_detector_model_description(Option<String>)
:
required: falseA brief description of the detector model.
key(impl Into<String>)
/set_key(Option<String>)
:
required: falseThe input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseMetadata that can be used to manage the detector model.
evaluation_method(EvaluationMethod)
/set_evaluation_method(Option<EvaluationMethod>)
:
required: falseInformation about the order in which events are evaluated and how actions are executed.
- On success, responds with
CreateDetectorModelOutput
with field(s):detector_model_configuration(Option<DetectorModelConfiguration>)
:Information about how the detector model is configured.
- On failure, responds with
SdkError<CreateDetectorModelError>
source§impl Client
impl Client
sourcepub fn create_input(&self) -> CreateInputFluentBuilder
pub fn create_input(&self) -> CreateInputFluentBuilder
Constructs a fluent builder for the CreateInput
operation.
- The fluent builder is configurable:
input_name(impl Into<String>)
/set_input_name(Option<String>)
:
required: trueThe name you want to give to the input.
input_description(impl Into<String>)
/set_input_description(Option<String>)
:
required: falseA brief description of the input.
input_definition(InputDefinition)
/set_input_definition(Option<InputDefinition>)
:
required: trueThe definition of the input.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseMetadata that can be used to manage the input.
- On success, responds with
CreateInputOutput
with field(s):input_configuration(Option<InputConfiguration>)
:Information about the configuration of the input.
- On failure, responds with
SdkError<CreateInputError>
source§impl Client
impl Client
sourcepub fn delete_alarm_model(&self) -> DeleteAlarmModelFluentBuilder
pub fn delete_alarm_model(&self) -> DeleteAlarmModelFluentBuilder
Constructs a fluent builder for the DeleteAlarmModel
operation.
- The fluent builder is configurable:
alarm_model_name(impl Into<String>)
/set_alarm_model_name(Option<String>)
:
required: trueThe name of the alarm model.
- On success, responds with
DeleteAlarmModelOutput
- On failure, responds with
SdkError<DeleteAlarmModelError>
source§impl Client
impl Client
sourcepub fn delete_detector_model(&self) -> DeleteDetectorModelFluentBuilder
pub fn delete_detector_model(&self) -> DeleteDetectorModelFluentBuilder
Constructs a fluent builder for the DeleteDetectorModel
operation.
- The fluent builder is configurable:
detector_model_name(impl Into<String>)
/set_detector_model_name(Option<String>)
:
required: trueThe name of the detector model to be deleted.
- On success, responds with
DeleteDetectorModelOutput
- On failure, responds with
SdkError<DeleteDetectorModelError>
source§impl Client
impl Client
sourcepub fn delete_input(&self) -> DeleteInputFluentBuilder
pub fn delete_input(&self) -> DeleteInputFluentBuilder
Constructs a fluent builder for the DeleteInput
operation.
- The fluent builder is configurable:
input_name(impl Into<String>)
/set_input_name(Option<String>)
:
required: trueThe name of the input to delete.
- On success, responds with
DeleteInputOutput
- On failure, responds with
SdkError<DeleteInputError>
source§impl Client
impl Client
sourcepub fn describe_alarm_model(&self) -> DescribeAlarmModelFluentBuilder
pub fn describe_alarm_model(&self) -> DescribeAlarmModelFluentBuilder
Constructs a fluent builder for the DescribeAlarmModel
operation.
- The fluent builder is configurable:
alarm_model_name(impl Into<String>)
/set_alarm_model_name(Option<String>)
:
required: trueThe name of the alarm model.
alarm_model_version(impl Into<String>)
/set_alarm_model_version(Option<String>)
:
required: falseThe version of the alarm model.
- On success, responds with
DescribeAlarmModelOutput
with field(s):creation_time(Option<DateTime>)
:The time the alarm model was created, in the Unix epoch format.
alarm_model_arn(Option<String>)
:The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
alarm_model_version(Option<String>)
:The version of the alarm model.
last_update_time(Option<DateTime>)
:The time the alarm model was last updated, in the Unix epoch format.
status(Option<AlarmModelVersionStatus>)
:The status of the alarm model. The status can be one of the following values:
-
ACTIVE
- The alarm model is active and it’s ready to evaluate data. -
ACTIVATING
- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. -
INACTIVE
- The alarm model is inactive, so it isn’t ready to evaluate data. Check your alarm model information and update the alarm model. -
FAILED
- You couldn’t create or update the alarm model. Check your alarm model information and try again.
-
status_message(Option<String>)
:Contains information about the status of the alarm model.
alarm_model_name(Option<String>)
:The name of the alarm model.
alarm_model_description(Option<String>)
:The description of the alarm model.
role_arn(Option<String>)
:The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
key(Option<String>)
:An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
severity(Option<i32>)
:A non-negative integer that reflects the severity level of the alarm.
alarm_rule(Option<AlarmRule>)
:Defines when your alarm is invoked.
alarm_notification(Option<AlarmNotification>)
:Contains information about one or more notification actions.
alarm_event_actions(Option<AlarmEventActions>)
:Contains information about one or more alarm actions.
alarm_capabilities(Option<AlarmCapabilities>)
:Contains the configuration information of alarm state changes.
- On failure, responds with
SdkError<DescribeAlarmModelError>
source§impl Client
impl Client
sourcepub fn describe_detector_model(&self) -> DescribeDetectorModelFluentBuilder
pub fn describe_detector_model(&self) -> DescribeDetectorModelFluentBuilder
Constructs a fluent builder for the DescribeDetectorModel
operation.
- The fluent builder is configurable:
detector_model_name(impl Into<String>)
/set_detector_model_name(Option<String>)
:
required: trueThe name of the detector model.
detector_model_version(impl Into<String>)
/set_detector_model_version(Option<String>)
:
required: falseThe version of the detector model.
- On success, responds with
DescribeDetectorModelOutput
with field(s):detector_model(Option<DetectorModel>)
:Information about the detector model.
- On failure, responds with
SdkError<DescribeDetectorModelError>
source§impl Client
impl Client
sourcepub fn describe_detector_model_analysis(
&self
) -> DescribeDetectorModelAnalysisFluentBuilder
pub fn describe_detector_model_analysis( &self ) -> DescribeDetectorModelAnalysisFluentBuilder
Constructs a fluent builder for the DescribeDetectorModelAnalysis
operation.
- The fluent builder is configurable:
analysis_id(impl Into<String>)
/set_analysis_id(Option<String>)
:
required: trueThe ID of the analysis result that you want to retrieve.
- On success, responds with
DescribeDetectorModelAnalysisOutput
with field(s):status(Option<AnalysisStatus>)
:The status of the analysis activity. The status can be one of the following values:
-
RUNNING
- AWS IoT Events is analyzing your detector model. This process can take several minutes to complete. -
COMPLETE
- AWS IoT Events finished analyzing your detector model. -
FAILED
- AWS IoT Events couldn’t analyze your detector model. Try again later.
-
- On failure, responds with
SdkError<DescribeDetectorModelAnalysisError>
source§impl Client
impl Client
sourcepub fn describe_input(&self) -> DescribeInputFluentBuilder
pub fn describe_input(&self) -> DescribeInputFluentBuilder
Constructs a fluent builder for the DescribeInput
operation.
- The fluent builder is configurable:
input_name(impl Into<String>)
/set_input_name(Option<String>)
:
required: trueThe name of the input.
- On success, responds with
DescribeInputOutput
with field(s):input(Option<Input>)
:Information about the input.
- On failure, responds with
SdkError<DescribeInputError>
source§impl Client
impl Client
sourcepub fn describe_logging_options(&self) -> DescribeLoggingOptionsFluentBuilder
pub fn describe_logging_options(&self) -> DescribeLoggingOptionsFluentBuilder
Constructs a fluent builder for the DescribeLoggingOptions
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeLoggingOptionsOutput
with field(s):logging_options(Option<LoggingOptions>)
:The current settings of the AWS IoT Events logging options.
- On failure, responds with
SdkError<DescribeLoggingOptionsError>
source§impl Client
impl Client
sourcepub fn get_detector_model_analysis_results(
&self
) -> GetDetectorModelAnalysisResultsFluentBuilder
pub fn get_detector_model_analysis_results( &self ) -> GetDetectorModelAnalysisResultsFluentBuilder
Constructs a fluent builder for the GetDetectorModelAnalysisResults
operation.
- The fluent builder is configurable:
analysis_id(impl Into<String>)
/set_analysis_id(Option<String>)
:
required: trueThe ID of the analysis result that you want to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that you can use to return the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request.
- On success, responds with
GetDetectorModelAnalysisResultsOutput
with field(s):analysis_results(Option<Vec::<AnalysisResult>>)
:Contains information about one or more analysis results.
next_token(Option<String>)
:The token that you can use to return the next set of results, or
null
if there are no more results.
- On failure, responds with
SdkError<GetDetectorModelAnalysisResultsError>
source§impl Client
impl Client
sourcepub fn list_alarm_model_versions(&self) -> ListAlarmModelVersionsFluentBuilder
pub fn list_alarm_model_versions(&self) -> ListAlarmModelVersionsFluentBuilder
Constructs a fluent builder for the ListAlarmModelVersions
operation.
- The fluent builder is configurable:
alarm_model_name(impl Into<String>)
/set_alarm_model_name(Option<String>)
:
required: trueThe name of the alarm model.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that you can use to return the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request.
- On success, responds with
ListAlarmModelVersionsOutput
with field(s):alarm_model_version_summaries(Option<Vec::<AlarmModelVersionSummary>>)
:A list that summarizes each alarm model version.
next_token(Option<String>)
:The token that you can use to return the next set of results, or
null
if there are no more results.
- On failure, responds with
SdkError<ListAlarmModelVersionsError>
source§impl Client
impl Client
sourcepub fn list_alarm_models(&self) -> ListAlarmModelsFluentBuilder
pub fn list_alarm_models(&self) -> ListAlarmModelsFluentBuilder
Constructs a fluent builder for the ListAlarmModels
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that you can use to return the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request.
- On success, responds with
ListAlarmModelsOutput
with field(s):alarm_model_summaries(Option<Vec::<AlarmModelSummary>>)
:A list that summarizes each alarm model.
next_token(Option<String>)
:The token that you can use to return the next set of results, or
null
if there are no more results.
- On failure, responds with
SdkError<ListAlarmModelsError>
source§impl Client
impl Client
sourcepub fn list_detector_model_versions(
&self
) -> ListDetectorModelVersionsFluentBuilder
pub fn list_detector_model_versions( &self ) -> ListDetectorModelVersionsFluentBuilder
Constructs a fluent builder for the ListDetectorModelVersions
operation.
- The fluent builder is configurable:
detector_model_name(impl Into<String>)
/set_detector_model_name(Option<String>)
:
required: trueThe name of the detector model whose versions are returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that you can use to return the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request.
- On success, responds with
ListDetectorModelVersionsOutput
with field(s):detector_model_version_summaries(Option<Vec::<DetectorModelVersionSummary>>)
:Summary information about the detector model versions.
next_token(Option<String>)
:The token that you can use to return the next set of results, or
null
if there are no more results.
- On failure, responds with
SdkError<ListDetectorModelVersionsError>
source§impl Client
impl Client
sourcepub fn list_detector_models(&self) -> ListDetectorModelsFluentBuilder
pub fn list_detector_models(&self) -> ListDetectorModelsFluentBuilder
Constructs a fluent builder for the ListDetectorModels
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that you can use to return the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request.
- On success, responds with
ListDetectorModelsOutput
with field(s):detector_model_summaries(Option<Vec::<DetectorModelSummary>>)
:Summary information about the detector models.
next_token(Option<String>)
:The token that you can use to return the next set of results, or
null
if there are no more results.
- On failure, responds with
SdkError<ListDetectorModelsError>
source§impl Client
impl Client
sourcepub fn list_input_routings(&self) -> ListInputRoutingsFluentBuilder
pub fn list_input_routings(&self) -> ListInputRoutingsFluentBuilder
Constructs a fluent builder for the ListInputRoutings
operation.
- The fluent builder is configurable:
input_identifier(InputIdentifier)
/set_input_identifier(Option<InputIdentifier>)
:
required: trueThe identifer of the routed input.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that you can use to return the next set of results.
- On success, responds with
ListInputRoutingsOutput
with field(s):routed_resources(Option<Vec::<RoutedResource>>)
:Summary information about the routed resources.
next_token(Option<String>)
:The token that you can use to return the next set of results, or
null
if there are no more results.
- On failure, responds with
SdkError<ListInputRoutingsError>
source§impl Client
impl Client
sourcepub fn list_inputs(&self) -> ListInputsFluentBuilder
pub fn list_inputs(&self) -> ListInputsFluentBuilder
Constructs a fluent builder for the ListInputs
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that you can use to return the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request.
- On success, responds with
ListInputsOutput
with field(s):input_summaries(Option<Vec::<InputSummary>>)
:Summary information about the inputs.
next_token(Option<String>)
:The token that you can use to return the next set of results, or
null
if there are no more results.
- On failure, responds with
SdkError<ListInputsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:The list of tags assigned to the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn put_logging_options(&self) -> PutLoggingOptionsFluentBuilder
pub fn put_logging_options(&self) -> PutLoggingOptionsFluentBuilder
Constructs a fluent builder for the PutLoggingOptions
operation.
- The fluent builder is configurable:
logging_options(LoggingOptions)
/set_logging_options(Option<LoggingOptions>)
:
required: trueThe new values of the AWS IoT Events logging options.
- On success, responds with
PutLoggingOptionsOutput
- On failure, responds with
SdkError<PutLoggingOptionsError>
source§impl Client
impl Client
sourcepub fn start_detector_model_analysis(
&self
) -> StartDetectorModelAnalysisFluentBuilder
pub fn start_detector_model_analysis( &self ) -> StartDetectorModelAnalysisFluentBuilder
Constructs a fluent builder for the StartDetectorModelAnalysis
operation.
- The fluent builder is configurable:
detector_model_definition(DetectorModelDefinition)
/set_detector_model_definition(Option<DetectorModelDefinition>)
:
required: trueInformation that defines how a detector operates.
- On success, responds with
StartDetectorModelAnalysisOutput
with field(s):analysis_id(Option<String>)
:The ID that you can use to retrieve the analysis result.
- On failure, responds with
SdkError<StartDetectorModelAnalysisError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueThe new or modified tags for the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of the keys of the tags to be removed from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_alarm_model(&self) -> UpdateAlarmModelFluentBuilder
pub fn update_alarm_model(&self) -> UpdateAlarmModelFluentBuilder
Constructs a fluent builder for the UpdateAlarmModel
operation.
- The fluent builder is configurable:
alarm_model_name(impl Into<String>)
/set_alarm_model_name(Option<String>)
:
required: trueThe name of the alarm model.
alarm_model_description(impl Into<String>)
/set_alarm_model_description(Option<String>)
:
required: falseThe description of the alarm model.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
severity(i32)
/set_severity(Option<i32>)
:
required: falseA non-negative integer that reflects the severity level of the alarm.
alarm_rule(AlarmRule)
/set_alarm_rule(Option<AlarmRule>)
:
required: trueDefines when your alarm is invoked.
alarm_notification(AlarmNotification)
/set_alarm_notification(Option<AlarmNotification>)
:
required: falseContains information about one or more notification actions.
alarm_event_actions(AlarmEventActions)
/set_alarm_event_actions(Option<AlarmEventActions>)
:
required: falseContains information about one or more alarm actions.
alarm_capabilities(AlarmCapabilities)
/set_alarm_capabilities(Option<AlarmCapabilities>)
:
required: falseContains the configuration information of alarm state changes.
- On success, responds with
UpdateAlarmModelOutput
with field(s):creation_time(Option<DateTime>)
:The time the alarm model was created, in the Unix epoch format.
alarm_model_arn(Option<String>)
:The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
alarm_model_version(Option<String>)
:The version of the alarm model.
last_update_time(Option<DateTime>)
:The time the alarm model was last updated, in the Unix epoch format.
status(Option<AlarmModelVersionStatus>)
:The status of the alarm model. The status can be one of the following values:
-
ACTIVE
- The alarm model is active and it’s ready to evaluate data. -
ACTIVATING
- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. -
INACTIVE
- The alarm model is inactive, so it isn’t ready to evaluate data. Check your alarm model information and update the alarm model. -
FAILED
- You couldn’t create or update the alarm model. Check your alarm model information and try again.
-
- On failure, responds with
SdkError<UpdateAlarmModelError>
source§impl Client
impl Client
sourcepub fn update_detector_model(&self) -> UpdateDetectorModelFluentBuilder
pub fn update_detector_model(&self) -> UpdateDetectorModelFluentBuilder
Constructs a fluent builder for the UpdateDetectorModel
operation.
- The fluent builder is configurable:
detector_model_name(impl Into<String>)
/set_detector_model_name(Option<String>)
:
required: trueThe name of the detector model that is updated.
detector_model_definition(DetectorModelDefinition)
/set_detector_model_definition(Option<DetectorModelDefinition>)
:
required: trueInformation that defines how a detector operates.
detector_model_description(impl Into<String>)
/set_detector_model_description(Option<String>)
:
required: falseA brief description of the detector model.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
evaluation_method(EvaluationMethod)
/set_evaluation_method(Option<EvaluationMethod>)
:
required: falseInformation about the order in which events are evaluated and how actions are executed.
- On success, responds with
UpdateDetectorModelOutput
with field(s):detector_model_configuration(Option<DetectorModelConfiguration>)
:Information about how the detector model is configured.
- On failure, responds with
SdkError<UpdateDetectorModelError>
source§impl Client
impl Client
sourcepub fn update_input(&self) -> UpdateInputFluentBuilder
pub fn update_input(&self) -> UpdateInputFluentBuilder
Constructs a fluent builder for the UpdateInput
operation.
- The fluent builder is configurable:
input_name(impl Into<String>)
/set_input_name(Option<String>)
:
required: trueThe name of the input you want to update.
input_description(impl Into<String>)
/set_input_description(Option<String>)
:
required: falseA brief description of the input.
input_definition(InputDefinition)
/set_input_definition(Option<InputDefinition>)
:
required: trueThe definition of the input.
- On success, responds with
UpdateInputOutput
with field(s):input_configuration(Option<InputConfiguration>)
:Information about the configuration of the input.
- On failure, responds with
SdkError<UpdateInputError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more