@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IotEventsAsyncClient extends SdkClient
builder()
method.
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IotEventsAsyncClient create()
IotEventsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IotEventsAsyncClientBuilder builder()
IotEventsAsyncClient.default CompletableFuture<CreateAlarmModelResponse> createAlarmModel(CreateAlarmModelRequest createAlarmModelRequest)
Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.
createAlarmModelRequest - default CompletableFuture<CreateAlarmModelResponse> createAlarmModel(Consumer<CreateAlarmModelRequest.Builder> createAlarmModelRequest)
Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.
This is a convenience which creates an instance of the CreateAlarmModelRequest.Builder avoiding the need
to create one manually via CreateAlarmModelRequest.builder()
createAlarmModelRequest - A Consumer that will call methods on CreateAlarmModelRequest.Builder to create a request.default CompletableFuture<CreateDetectorModelResponse> createDetectorModel(CreateDetectorModelRequest createDetectorModelRequest)
Creates a detector model.
createDetectorModelRequest - default CompletableFuture<CreateDetectorModelResponse> createDetectorModel(Consumer<CreateDetectorModelRequest.Builder> createDetectorModelRequest)
Creates a detector model.
This is a convenience which creates an instance of the CreateDetectorModelRequest.Builder avoiding the
need to create one manually via CreateDetectorModelRequest.builder()
createDetectorModelRequest - A Consumer that will call methods on CreateDetectorModelRequest.Builder to create a
request.default CompletableFuture<CreateInputResponse> createInput(CreateInputRequest createInputRequest)
Creates an input.
createInputRequest - default CompletableFuture<CreateInputResponse> createInput(Consumer<CreateInputRequest.Builder> createInputRequest)
Creates an input.
This is a convenience which creates an instance of the CreateInputRequest.Builder avoiding the need to
create one manually via CreateInputRequest.builder()
createInputRequest - A Consumer that will call methods on CreateInputRequest.Builder to create a request.default CompletableFuture<DeleteAlarmModelResponse> deleteAlarmModel(DeleteAlarmModelRequest deleteAlarmModelRequest)
Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
deleteAlarmModelRequest - default CompletableFuture<DeleteAlarmModelResponse> deleteAlarmModel(Consumer<DeleteAlarmModelRequest.Builder> deleteAlarmModelRequest)
Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
This is a convenience which creates an instance of the DeleteAlarmModelRequest.Builder avoiding the need
to create one manually via DeleteAlarmModelRequest.builder()
deleteAlarmModelRequest - A Consumer that will call methods on DeleteAlarmModelRequest.Builder to create a request.default CompletableFuture<DeleteDetectorModelResponse> deleteDetectorModel(DeleteDetectorModelRequest deleteDetectorModelRequest)
Deletes a detector model. Any active instances of the detector model are also deleted.
deleteDetectorModelRequest - default CompletableFuture<DeleteDetectorModelResponse> deleteDetectorModel(Consumer<DeleteDetectorModelRequest.Builder> deleteDetectorModelRequest)
Deletes a detector model. Any active instances of the detector model are also deleted.
This is a convenience which creates an instance of the DeleteDetectorModelRequest.Builder avoiding the
need to create one manually via DeleteDetectorModelRequest.builder()
deleteDetectorModelRequest - A Consumer that will call methods on DeleteDetectorModelRequest.Builder to create a
request.default CompletableFuture<DeleteInputResponse> deleteInput(DeleteInputRequest deleteInputRequest)
Deletes an input.
deleteInputRequest - default CompletableFuture<DeleteInputResponse> deleteInput(Consumer<DeleteInputRequest.Builder> deleteInputRequest)
Deletes an input.
This is a convenience which creates an instance of the DeleteInputRequest.Builder avoiding the need to
create one manually via DeleteInputRequest.builder()
deleteInputRequest - A Consumer that will call methods on DeleteInputRequest.Builder to create a request.default CompletableFuture<DescribeAlarmModelResponse> describeAlarmModel(DescribeAlarmModelRequest describeAlarmModelRequest)
Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion
parameter, the latest version is returned.
describeAlarmModelRequest - default CompletableFuture<DescribeAlarmModelResponse> describeAlarmModel(Consumer<DescribeAlarmModelRequest.Builder> describeAlarmModelRequest)
Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion
parameter, the latest version is returned.
This is a convenience which creates an instance of the DescribeAlarmModelRequest.Builder avoiding the
need to create one manually via DescribeAlarmModelRequest.builder()
describeAlarmModelRequest - A Consumer that will call methods on DescribeAlarmModelRequest.Builder to create a
request.default CompletableFuture<DescribeDetectorModelResponse> describeDetectorModel(DescribeDetectorModelRequest describeDetectorModelRequest)
Describes a detector model. If the version parameter is not specified, information about the latest
version is returned.
describeDetectorModelRequest - default CompletableFuture<DescribeDetectorModelResponse> describeDetectorModel(Consumer<DescribeDetectorModelRequest.Builder> describeDetectorModelRequest)
Describes a detector model. If the version parameter is not specified, information about the latest
version is returned.
This is a convenience which creates an instance of the DescribeDetectorModelRequest.Builder avoiding the
need to create one manually via DescribeDetectorModelRequest.builder()
describeDetectorModelRequest - A Consumer that will call methods on DescribeDetectorModelRequest.Builder to create a
request.default CompletableFuture<DescribeDetectorModelAnalysisResponse> describeDetectorModelAnalysis(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest)
Retrieves runtime information about a detector model analysis.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
describeDetectorModelAnalysisRequest - default CompletableFuture<DescribeDetectorModelAnalysisResponse> describeDetectorModelAnalysis(Consumer<DescribeDetectorModelAnalysisRequest.Builder> describeDetectorModelAnalysisRequest)
Retrieves runtime information about a detector model analysis.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
This is a convenience which creates an instance of the DescribeDetectorModelAnalysisRequest.Builder
avoiding the need to create one manually via DescribeDetectorModelAnalysisRequest.builder()
describeDetectorModelAnalysisRequest - A Consumer that will call methods on DescribeDetectorModelAnalysisRequest.Builder to
create a request.default CompletableFuture<DescribeInputResponse> describeInput(DescribeInputRequest describeInputRequest)
Describes an input.
describeInputRequest - default CompletableFuture<DescribeInputResponse> describeInput(Consumer<DescribeInputRequest.Builder> describeInputRequest)
Describes an input.
This is a convenience which creates an instance of the DescribeInputRequest.Builder avoiding the need to
create one manually via DescribeInputRequest.builder()
describeInputRequest - A Consumer that will call methods on DescribeInputRequest.Builder to create a request.default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current settings of the AWS IoT Events logging options.
describeLoggingOptionsRequest - default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)
Retrieves the current settings of the AWS IoT Events logging options.
This is a convenience which creates an instance of the DescribeLoggingOptionsRequest.Builder avoiding the
need to create one manually via DescribeLoggingOptionsRequest.builder()
describeLoggingOptionsRequest - A Consumer that will call methods on DescribeLoggingOptionsRequest.Builder to create a
request.default CompletableFuture<GetDetectorModelAnalysisResultsResponse> getDetectorModelAnalysisResults(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest)
Retrieves one or more analysis results of the detector model.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
getDetectorModelAnalysisResultsRequest - default CompletableFuture<GetDetectorModelAnalysisResultsResponse> getDetectorModelAnalysisResults(Consumer<GetDetectorModelAnalysisResultsRequest.Builder> getDetectorModelAnalysisResultsRequest)
Retrieves one or more analysis results of the detector model.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
This is a convenience which creates an instance of the GetDetectorModelAnalysisResultsRequest.Builder
avoiding the need to create one manually via GetDetectorModelAnalysisResultsRequest.builder()
getDetectorModelAnalysisResultsRequest - A Consumer that will call methods on GetDetectorModelAnalysisResultsRequest.Builder to
create a request.default CompletableFuture<ListAlarmModelVersionsResponse> listAlarmModelVersions(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest)
Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
listAlarmModelVersionsRequest - default CompletableFuture<ListAlarmModelVersionsResponse> listAlarmModelVersions(Consumer<ListAlarmModelVersionsRequest.Builder> listAlarmModelVersionsRequest)
Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
This is a convenience which creates an instance of the ListAlarmModelVersionsRequest.Builder avoiding the
need to create one manually via ListAlarmModelVersionsRequest.builder()
listAlarmModelVersionsRequest - A Consumer that will call methods on ListAlarmModelVersionsRequest.Builder to create a
request.default CompletableFuture<ListAlarmModelsResponse> listAlarmModels(ListAlarmModelsRequest listAlarmModelsRequest)
Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
listAlarmModelsRequest - default CompletableFuture<ListAlarmModelsResponse> listAlarmModels(Consumer<ListAlarmModelsRequest.Builder> listAlarmModelsRequest)
Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
This is a convenience which creates an instance of the ListAlarmModelsRequest.Builder avoiding the need
to create one manually via ListAlarmModelsRequest.builder()
listAlarmModelsRequest - A Consumer that will call methods on ListAlarmModelsRequest.Builder to create a request.default CompletableFuture<ListDetectorModelVersionsResponse> listDetectorModelVersions(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest)
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
listDetectorModelVersionsRequest - default CompletableFuture<ListDetectorModelVersionsResponse> listDetectorModelVersions(Consumer<ListDetectorModelVersionsRequest.Builder> listDetectorModelVersionsRequest)
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
This is a convenience which creates an instance of the ListDetectorModelVersionsRequest.Builder avoiding
the need to create one manually via ListDetectorModelVersionsRequest.builder()
listDetectorModelVersionsRequest - A Consumer that will call methods on ListDetectorModelVersionsRequest.Builder to create a
request.default CompletableFuture<ListDetectorModelsResponse> listDetectorModels(ListDetectorModelsRequest listDetectorModelsRequest)
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
listDetectorModelsRequest - default CompletableFuture<ListDetectorModelsResponse> listDetectorModels(Consumer<ListDetectorModelsRequest.Builder> listDetectorModelsRequest)
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
This is a convenience which creates an instance of the ListDetectorModelsRequest.Builder avoiding the
need to create one manually via ListDetectorModelsRequest.builder()
listDetectorModelsRequest - A Consumer that will call methods on ListDetectorModelsRequest.Builder to create a
request.default CompletableFuture<ListInputRoutingsResponse> listInputRoutings(ListInputRoutingsRequest listInputRoutingsRequest)
Lists one or more input routings.
listInputRoutingsRequest - default CompletableFuture<ListInputRoutingsResponse> listInputRoutings(Consumer<ListInputRoutingsRequest.Builder> listInputRoutingsRequest)
Lists one or more input routings.
This is a convenience which creates an instance of the ListInputRoutingsRequest.Builder avoiding the need
to create one manually via ListInputRoutingsRequest.builder()
listInputRoutingsRequest - A Consumer that will call methods on ListInputRoutingsRequest.Builder to create a request.default CompletableFuture<ListInputsResponse> listInputs(ListInputsRequest listInputsRequest)
Lists the inputs you have created.
listInputsRequest - default CompletableFuture<ListInputsResponse> listInputs(Consumer<ListInputsRequest.Builder> listInputsRequest)
Lists the inputs you have created.
This is a convenience which creates an instance of the ListInputsRequest.Builder avoiding the need to
create one manually via ListInputsRequest.builder()
listInputsRequest - A Consumer that will call methods on ListInputsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
Sets or updates the AWS IoT Events logging options.
If you update the value of any loggingOptions field, it takes up to one minute for the change to
take effect. If you change the policy attached to the role you specified in the roleArn field (for
example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
putLoggingOptionsRequest - default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)
Sets or updates the AWS IoT Events logging options.
If you update the value of any loggingOptions field, it takes up to one minute for the change to
take effect. If you change the policy attached to the role you specified in the roleArn field (for
example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
This is a convenience which creates an instance of the PutLoggingOptionsRequest.Builder avoiding the need
to create one manually via PutLoggingOptionsRequest.builder()
putLoggingOptionsRequest - A Consumer that will call methods on PutLoggingOptionsRequest.Builder to create a request.default CompletableFuture<StartDetectorModelAnalysisResponse> startDetectorModelAnalysis(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest)
Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
startDetectorModelAnalysisRequest - default CompletableFuture<StartDetectorModelAnalysisResponse> startDetectorModelAnalysis(Consumer<StartDetectorModelAnalysisRequest.Builder> startDetectorModelAnalysisRequest)
Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
This is a convenience which creates an instance of the StartDetectorModelAnalysisRequest.Builder avoiding
the need to create one manually via StartDetectorModelAnalysisRequest.builder()
startDetectorModelAnalysisRequest - A Consumer that will call methods on StartDetectorModelAnalysisRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the given tags (metadata) from the resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the given tags (metadata) from the resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateAlarmModelResponse> updateAlarmModel(UpdateAlarmModelRequest updateAlarmModelRequest)
Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
updateAlarmModelRequest - default CompletableFuture<UpdateAlarmModelResponse> updateAlarmModel(Consumer<UpdateAlarmModelRequest.Builder> updateAlarmModelRequest)
Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
This is a convenience which creates an instance of the UpdateAlarmModelRequest.Builder avoiding the need
to create one manually via UpdateAlarmModelRequest.builder()
updateAlarmModelRequest - A Consumer that will call methods on UpdateAlarmModelRequest.Builder to create a request.default CompletableFuture<UpdateDetectorModelResponse> updateDetectorModel(UpdateDetectorModelRequest updateDetectorModelRequest)
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
updateDetectorModelRequest - default CompletableFuture<UpdateDetectorModelResponse> updateDetectorModel(Consumer<UpdateDetectorModelRequest.Builder> updateDetectorModelRequest)
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
This is a convenience which creates an instance of the UpdateDetectorModelRequest.Builder avoiding the
need to create one manually via UpdateDetectorModelRequest.builder()
updateDetectorModelRequest - A Consumer that will call methods on UpdateDetectorModelRequest.Builder to create a
request.default CompletableFuture<UpdateInputResponse> updateInput(UpdateInputRequest updateInputRequest)
Updates an input.
updateInputRequest - default CompletableFuture<UpdateInputResponse> updateInput(Consumer<UpdateInputRequest.Builder> updateInputRequest)
Updates an input.
This is a convenience which creates an instance of the UpdateInputRequest.Builder avoiding the need to
create one manually via UpdateInputRequest.builder()
updateInputRequest - A Consumer that will call methods on UpdateInputRequest.Builder to create a request.Copyright © 2022. All rights reserved.