Interface IotEventsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic IotEventsClientBuilder
builder()
Create a builder that can be used to configure and create aIotEventsClient
.static IotEventsClient
create()
Create aIotEventsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAlarmModelResponse
createAlarmModel
(Consumer<CreateAlarmModelRequest.Builder> createAlarmModelRequest) Creates an alarm model to monitor an AWS IoT Events input attribute.default CreateAlarmModelResponse
createAlarmModel
(CreateAlarmModelRequest createAlarmModelRequest) Creates an alarm model to monitor an AWS IoT Events input attribute.default CreateDetectorModelResponse
createDetectorModel
(Consumer<CreateDetectorModelRequest.Builder> createDetectorModelRequest) Creates a detector model.default CreateDetectorModelResponse
createDetectorModel
(CreateDetectorModelRequest createDetectorModelRequest) Creates a detector model.default CreateInputResponse
createInput
(Consumer<CreateInputRequest.Builder> createInputRequest) Creates an input.default CreateInputResponse
createInput
(CreateInputRequest createInputRequest) Creates an input.default DeleteAlarmModelResponse
deleteAlarmModel
(Consumer<DeleteAlarmModelRequest.Builder> deleteAlarmModelRequest) Deletes an alarm model.default DeleteAlarmModelResponse
deleteAlarmModel
(DeleteAlarmModelRequest deleteAlarmModelRequest) Deletes an alarm model.default DeleteDetectorModelResponse
deleteDetectorModel
(Consumer<DeleteDetectorModelRequest.Builder> deleteDetectorModelRequest) Deletes a detector model.default DeleteDetectorModelResponse
deleteDetectorModel
(DeleteDetectorModelRequest deleteDetectorModelRequest) Deletes a detector model.default DeleteInputResponse
deleteInput
(Consumer<DeleteInputRequest.Builder> deleteInputRequest) Deletes an input.default DeleteInputResponse
deleteInput
(DeleteInputRequest deleteInputRequest) Deletes an input.default DescribeAlarmModelResponse
describeAlarmModel
(Consumer<DescribeAlarmModelRequest.Builder> describeAlarmModelRequest) Retrieves information about an alarm model.default DescribeAlarmModelResponse
describeAlarmModel
(DescribeAlarmModelRequest describeAlarmModelRequest) Retrieves information about an alarm model.default DescribeDetectorModelResponse
describeDetectorModel
(Consumer<DescribeDetectorModelRequest.Builder> describeDetectorModelRequest) Describes a detector model.default DescribeDetectorModelResponse
describeDetectorModel
(DescribeDetectorModelRequest describeDetectorModelRequest) Describes a detector model.describeDetectorModelAnalysis
(Consumer<DescribeDetectorModelAnalysisRequest.Builder> describeDetectorModelAnalysisRequest) Retrieves runtime information about a detector model analysis.describeDetectorModelAnalysis
(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest) Retrieves runtime information about a detector model analysis.default DescribeInputResponse
describeInput
(Consumer<DescribeInputRequest.Builder> describeInputRequest) Describes an input.default DescribeInputResponse
describeInput
(DescribeInputRequest describeInputRequest) Describes an input.default DescribeLoggingOptionsResponse
describeLoggingOptions
(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Events logging options.default DescribeLoggingOptionsResponse
describeLoggingOptions
(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Events logging options.getDetectorModelAnalysisResults
(Consumer<GetDetectorModelAnalysisResultsRequest.Builder> getDetectorModelAnalysisResultsRequest) Retrieves one or more analysis results of the detector model.getDetectorModelAnalysisResults
(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest) Retrieves one or more analysis results of the detector model.default ListAlarmModelsResponse
listAlarmModels
(Consumer<ListAlarmModelsRequest.Builder> listAlarmModelsRequest) Lists the alarm models that you created.default ListAlarmModelsResponse
listAlarmModels
(ListAlarmModelsRequest listAlarmModelsRequest) Lists the alarm models that you created.default ListAlarmModelVersionsResponse
listAlarmModelVersions
(Consumer<ListAlarmModelVersionsRequest.Builder> listAlarmModelVersionsRequest) Lists all the versions of an alarm model.default ListAlarmModelVersionsResponse
listAlarmModelVersions
(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest) Lists all the versions of an alarm model.default ListDetectorModelsResponse
listDetectorModels
(Consumer<ListDetectorModelsRequest.Builder> listDetectorModelsRequest) Lists the detector models you have created.default ListDetectorModelsResponse
listDetectorModels
(ListDetectorModelsRequest listDetectorModelsRequest) Lists the detector models you have created.listDetectorModelVersions
(Consumer<ListDetectorModelVersionsRequest.Builder> listDetectorModelVersionsRequest) Lists all the versions of a detector model.listDetectorModelVersions
(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest) Lists all the versions of a detector model.default ListInputRoutingsResponse
listInputRoutings
(Consumer<ListInputRoutingsRequest.Builder> listInputRoutingsRequest) Lists one or more input routings.default ListInputRoutingsResponse
listInputRoutings
(ListInputRoutingsRequest listInputRoutingsRequest) Lists one or more input routings.default ListInputsResponse
listInputs
(Consumer<ListInputsRequest.Builder> listInputsRequest) Lists the inputs you have created.default ListInputsResponse
listInputs
(ListInputsRequest listInputsRequest) Lists the inputs you have created.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.default PutLoggingOptionsResponse
putLoggingOptions
(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest) Sets or updates the AWS IoT Events logging options.default PutLoggingOptionsResponse
putLoggingOptions
(PutLoggingOptionsRequest putLoggingOptionsRequest) Sets or updates the AWS IoT Events logging options.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
startDetectorModelAnalysis
(Consumer<StartDetectorModelAnalysisRequest.Builder> startDetectorModelAnalysisRequest) Performs an analysis of your detector model.startDetectorModelAnalysis
(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest) Performs an analysis of your detector model.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds to or modifies the tags of the given resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the given tags (metadata) from the resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.default UpdateAlarmModelResponse
updateAlarmModel
(Consumer<UpdateAlarmModelRequest.Builder> updateAlarmModelRequest) Updates an alarm model.default UpdateAlarmModelResponse
updateAlarmModel
(UpdateAlarmModelRequest updateAlarmModelRequest) Updates an alarm model.default UpdateDetectorModelResponse
updateDetectorModel
(Consumer<UpdateDetectorModelRequest.Builder> updateDetectorModelRequest) Updates a detector model.default UpdateDetectorModelResponse
updateDetectorModel
(UpdateDetectorModelRequest updateDetectorModelRequest) Updates a detector model.default UpdateInputResponse
updateInput
(Consumer<UpdateInputRequest.Builder> updateInputRequest) Updates an input.default UpdateInputResponse
updateInput
(UpdateInputRequest updateInputRequest) Updates an input.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createAlarmModel
default CreateAlarmModelResponse createAlarmModel(CreateAlarmModelRequest createAlarmModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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.
- Parameters:
createAlarmModelRequest
-- Returns:
- Result of the CreateAlarmModel operation returned by the service.
- See Also:
-
createAlarmModel
default CreateAlarmModelResponse createAlarmModel(Consumer<CreateAlarmModelRequest.Builder> createAlarmModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaCreateAlarmModelRequest.builder()
- Parameters:
createAlarmModelRequest
- AConsumer
that will call methods onCreateAlarmModelRequest.Builder
to create a request.- Returns:
- Result of the CreateAlarmModel operation returned by the service.
- See Also:
-
createDetectorModel
default CreateDetectorModelResponse createDetectorModel(CreateDetectorModelRequest createDetectorModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Creates a detector model.
- Parameters:
createDetectorModelRequest
-- Returns:
- Result of the CreateDetectorModel operation returned by the service.
- See Also:
-
createDetectorModel
default CreateDetectorModelResponse createDetectorModel(Consumer<CreateDetectorModelRequest.Builder> createDetectorModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Creates a detector model.
This is a convenience which creates an instance of the
CreateDetectorModelRequest.Builder
avoiding the need to create one manually viaCreateDetectorModelRequest.builder()
- Parameters:
createDetectorModelRequest
- AConsumer
that will call methods onCreateDetectorModelRequest.Builder
to create a request.- Returns:
- Result of the CreateDetectorModel operation returned by the service.
- See Also:
-
createInput
default CreateInputResponse createInput(CreateInputRequest createInputRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotEventsException Creates an input.
- Parameters:
createInputRequest
-- Returns:
- Result of the CreateInput operation returned by the service.
- See Also:
-
createInput
default CreateInputResponse createInput(Consumer<CreateInputRequest.Builder> createInputRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotEventsException Creates an input.
This is a convenience which creates an instance of the
CreateInputRequest.Builder
avoiding the need to create one manually viaCreateInputRequest.builder()
- Parameters:
createInputRequest
- AConsumer
that will call methods onCreateInputRequest.Builder
to create a request.- Returns:
- Result of the CreateInput operation returned by the service.
- See Also:
-
deleteAlarmModel
default DeleteAlarmModelResponse deleteAlarmModel(DeleteAlarmModelRequest deleteAlarmModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
- Parameters:
deleteAlarmModelRequest
-- Returns:
- Result of the DeleteAlarmModel operation returned by the service.
- See Also:
-
deleteAlarmModel
default DeleteAlarmModelResponse deleteAlarmModel(Consumer<DeleteAlarmModelRequest.Builder> deleteAlarmModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaDeleteAlarmModelRequest.builder()
- Parameters:
deleteAlarmModelRequest
- AConsumer
that will call methods onDeleteAlarmModelRequest.Builder
to create a request.- Returns:
- Result of the DeleteAlarmModel operation returned by the service.
- See Also:
-
deleteDetectorModel
default DeleteDetectorModelResponse deleteDetectorModel(DeleteDetectorModelRequest deleteDetectorModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Deletes a detector model. Any active instances of the detector model are also deleted.
- Parameters:
deleteDetectorModelRequest
-- Returns:
- Result of the DeleteDetectorModel operation returned by the service.
- See Also:
-
deleteDetectorModel
default DeleteDetectorModelResponse deleteDetectorModel(Consumer<DeleteDetectorModelRequest.Builder> deleteDetectorModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaDeleteDetectorModelRequest.builder()
- Parameters:
deleteDetectorModelRequest
- AConsumer
that will call methods onDeleteDetectorModelRequest.Builder
to create a request.- Returns:
- Result of the DeleteDetectorModel operation returned by the service.
- See Also:
-
deleteInput
default DeleteInputResponse deleteInput(DeleteInputRequest deleteInputRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, ResourceInUseException, AwsServiceException, SdkClientException, IotEventsException Deletes an input.
- Parameters:
deleteInputRequest
-- Returns:
- Result of the DeleteInput operation returned by the service.
- See Also:
-
deleteInput
default DeleteInputResponse deleteInput(Consumer<DeleteInputRequest.Builder> deleteInputRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, ResourceInUseException, AwsServiceException, SdkClientException, IotEventsException Deletes an input.
This is a convenience which creates an instance of the
DeleteInputRequest.Builder
avoiding the need to create one manually viaDeleteInputRequest.builder()
- Parameters:
deleteInputRequest
- AConsumer
that will call methods onDeleteInputRequest.Builder
to create a request.- Returns:
- Result of the DeleteInput operation returned by the service.
- See Also:
-
describeAlarmModel
default DescribeAlarmModelResponse describeAlarmModel(DescribeAlarmModelRequest describeAlarmModelRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Retrieves information about an alarm model. If you don't specify a value for the
alarmModelVersion
parameter, the latest version is returned.- Parameters:
describeAlarmModelRequest
-- Returns:
- Result of the DescribeAlarmModel operation returned by the service.
- See Also:
-
describeAlarmModel
default DescribeAlarmModelResponse describeAlarmModel(Consumer<DescribeAlarmModelRequest.Builder> describeAlarmModelRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaDescribeAlarmModelRequest.builder()
- Parameters:
describeAlarmModelRequest
- AConsumer
that will call methods onDescribeAlarmModelRequest.Builder
to create a request.- Returns:
- Result of the DescribeAlarmModel operation returned by the service.
- See Also:
-
describeDetectorModel
default DescribeDetectorModelResponse describeDetectorModel(DescribeDetectorModelRequest describeDetectorModelRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Describes a detector model. If the
version
parameter is not specified, information about the latest version is returned.- Parameters:
describeDetectorModelRequest
-- Returns:
- Result of the DescribeDetectorModel operation returned by the service.
- See Also:
-
describeDetectorModel
default DescribeDetectorModelResponse describeDetectorModel(Consumer<DescribeDetectorModelRequest.Builder> describeDetectorModelRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaDescribeDetectorModelRequest.builder()
- Parameters:
describeDetectorModelRequest
- AConsumer
that will call methods onDescribeDetectorModelRequest.Builder
to create a request.- Returns:
- Result of the DescribeDetectorModel operation returned by the service.
- See Also:
-
describeDetectorModelAnalysis
default DescribeDetectorModelAnalysisResponse describeDetectorModelAnalysis(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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.
- Parameters:
describeDetectorModelAnalysisRequest
-- Returns:
- Result of the DescribeDetectorModelAnalysis operation returned by the service.
- See Also:
-
describeDetectorModelAnalysis
default DescribeDetectorModelAnalysisResponse describeDetectorModelAnalysis(Consumer<DescribeDetectorModelAnalysisRequest.Builder> describeDetectorModelAnalysisRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaDescribeDetectorModelAnalysisRequest.builder()
- Parameters:
describeDetectorModelAnalysisRequest
- AConsumer
that will call methods onDescribeDetectorModelAnalysisRequest.Builder
to create a request.- Returns:
- Result of the DescribeDetectorModelAnalysis operation returned by the service.
- See Also:
-
describeInput
default DescribeInputResponse describeInput(DescribeInputRequest describeInputRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Describes an input.
- Parameters:
describeInputRequest
-- Returns:
- Result of the DescribeInput operation returned by the service.
- See Also:
-
describeInput
default DescribeInputResponse describeInput(Consumer<DescribeInputRequest.Builder> describeInputRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Describes an input.
This is a convenience which creates an instance of the
DescribeInputRequest.Builder
avoiding the need to create one manually viaDescribeInputRequest.builder()
- Parameters:
describeInputRequest
- AConsumer
that will call methods onDescribeInputRequest.Builder
to create a request.- Returns:
- Result of the DescribeInput operation returned by the service.
- See Also:
-
describeLoggingOptions
default DescribeLoggingOptionsResponse describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, ServiceUnavailableException, UnsupportedOperationException, AwsServiceException, SdkClientException, IotEventsException Retrieves the current settings of the AWS IoT Events logging options.
- Parameters:
describeLoggingOptionsRequest
-- Returns:
- Result of the DescribeLoggingOptions operation returned by the service.
- See Also:
-
describeLoggingOptions
default DescribeLoggingOptionsResponse describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, ServiceUnavailableException, UnsupportedOperationException, AwsServiceException, SdkClientException, IotEventsException 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 viaDescribeLoggingOptionsRequest.builder()
- Parameters:
describeLoggingOptionsRequest
- AConsumer
that will call methods onDescribeLoggingOptionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeLoggingOptions operation returned by the service.
- See Also:
-
getDetectorModelAnalysisResults
default GetDetectorModelAnalysisResultsResponse getDetectorModelAnalysisResults(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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.
- Parameters:
getDetectorModelAnalysisResultsRequest
-- Returns:
- Result of the GetDetectorModelAnalysisResults operation returned by the service.
- See Also:
-
getDetectorModelAnalysisResults
default GetDetectorModelAnalysisResultsResponse getDetectorModelAnalysisResults(Consumer<GetDetectorModelAnalysisResultsRequest.Builder> getDetectorModelAnalysisResultsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaGetDetectorModelAnalysisResultsRequest.builder()
- Parameters:
getDetectorModelAnalysisResultsRequest
- AConsumer
that will call methods onGetDetectorModelAnalysisResultsRequest.Builder
to create a request.- Returns:
- Result of the GetDetectorModelAnalysisResults operation returned by the service.
- See Also:
-
listAlarmModelVersions
default ListAlarmModelVersionsResponse listAlarmModelVersions(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
- Parameters:
listAlarmModelVersionsRequest
-- Returns:
- Result of the ListAlarmModelVersions operation returned by the service.
- See Also:
-
listAlarmModelVersions
default ListAlarmModelVersionsResponse listAlarmModelVersions(Consumer<ListAlarmModelVersionsRequest.Builder> listAlarmModelVersionsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaListAlarmModelVersionsRequest.builder()
- Parameters:
listAlarmModelVersionsRequest
- AConsumer
that will call methods onListAlarmModelVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListAlarmModelVersions operation returned by the service.
- See Also:
-
listAlarmModels
default ListAlarmModelsResponse listAlarmModels(ListAlarmModelsRequest listAlarmModelsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
- Parameters:
listAlarmModelsRequest
-- Returns:
- Result of the ListAlarmModels operation returned by the service.
- See Also:
-
listAlarmModels
default ListAlarmModelsResponse listAlarmModels(Consumer<ListAlarmModelsRequest.Builder> listAlarmModelsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaListAlarmModelsRequest.builder()
- Parameters:
listAlarmModelsRequest
- AConsumer
that will call methods onListAlarmModelsRequest.Builder
to create a request.- Returns:
- Result of the ListAlarmModels operation returned by the service.
- See Also:
-
listDetectorModelVersions
default ListDetectorModelVersionsResponse listDetectorModelVersions(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
- Parameters:
listDetectorModelVersionsRequest
-- Returns:
- Result of the ListDetectorModelVersions operation returned by the service.
- See Also:
-
listDetectorModelVersions
default ListDetectorModelVersionsResponse listDetectorModelVersions(Consumer<ListDetectorModelVersionsRequest.Builder> listDetectorModelVersionsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaListDetectorModelVersionsRequest.builder()
- Parameters:
listDetectorModelVersionsRequest
- AConsumer
that will call methods onListDetectorModelVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListDetectorModelVersions operation returned by the service.
- See Also:
-
listDetectorModels
default ListDetectorModelsResponse listDetectorModels(ListDetectorModelsRequest listDetectorModelsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Lists the detector models you have created. Only the metadata associated with each detector model is returned.
- Parameters:
listDetectorModelsRequest
-- Returns:
- Result of the ListDetectorModels operation returned by the service.
- See Also:
-
listDetectorModels
default ListDetectorModelsResponse listDetectorModels(Consumer<ListDetectorModelsRequest.Builder> listDetectorModelsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaListDetectorModelsRequest.builder()
- Parameters:
listDetectorModelsRequest
- AConsumer
that will call methods onListDetectorModelsRequest.Builder
to create a request.- Returns:
- Result of the ListDetectorModels operation returned by the service.
- See Also:
-
listInputRoutings
default ListInputRoutingsResponse listInputRoutings(ListInputRoutingsRequest listInputRoutingsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotEventsException Lists one or more input routings.
- Parameters:
listInputRoutingsRequest
-- Returns:
- Result of the ListInputRoutings operation returned by the service.
- See Also:
-
listInputRoutings
default ListInputRoutingsResponse listInputRoutings(Consumer<ListInputRoutingsRequest.Builder> listInputRoutingsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotEventsException 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 viaListInputRoutingsRequest.builder()
- Parameters:
listInputRoutingsRequest
- AConsumer
that will call methods onListInputRoutingsRequest.Builder
to create a request.- Returns:
- Result of the ListInputRoutings operation returned by the service.
- See Also:
-
listInputs
default ListInputsResponse listInputs(ListInputsRequest listInputsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Lists the inputs you have created.
- Parameters:
listInputsRequest
-- Returns:
- Result of the ListInputs operation returned by the service.
- See Also:
-
listInputs
default ListInputsResponse listInputs(Consumer<ListInputsRequest.Builder> listInputsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaListInputsRequest.builder()
- Parameters:
listInputsRequest
- AConsumer
that will call methods onListInputsRequest.Builder
to create a request.- Returns:
- Result of the ListInputs operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotEventsException Lists the tags (metadata) you have assigned to the resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotEventsException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putLoggingOptions
default PutLoggingOptionsResponse putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, UnsupportedOperationException, ResourceInUseException, AwsServiceException, SdkClientException, IotEventsException 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 theroleArn
field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.- Parameters:
putLoggingOptionsRequest
-- Returns:
- Result of the PutLoggingOptions operation returned by the service.
- See Also:
-
putLoggingOptions
default PutLoggingOptionsResponse putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ServiceUnavailableException, UnsupportedOperationException, ResourceInUseException, AwsServiceException, SdkClientException, IotEventsException 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 theroleArn
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 viaPutLoggingOptionsRequest.builder()
- Parameters:
putLoggingOptionsRequest
- AConsumer
that will call methods onPutLoggingOptionsRequest.Builder
to create a request.- Returns:
- Result of the PutLoggingOptions operation returned by the service.
- See Also:
-
startDetectorModelAnalysis
default StartDetectorModelAnalysisResponse startDetectorModelAnalysis(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest) throws InvalidRequestException, LimitExceededException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
- Parameters:
startDetectorModelAnalysisRequest
-- Returns:
- Result of the StartDetectorModelAnalysis operation returned by the service.
- See Also:
-
startDetectorModelAnalysis
default StartDetectorModelAnalysisResponse startDetectorModelAnalysis(Consumer<StartDetectorModelAnalysisRequest.Builder> startDetectorModelAnalysisRequest) throws InvalidRequestException, LimitExceededException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaStartDetectorModelAnalysisRequest.builder()
- Parameters:
startDetectorModelAnalysisRequest
- AConsumer
that will call methods onStartDetectorModelAnalysisRequest.Builder
to create a request.- Returns:
- Result of the StartDetectorModelAnalysis operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, IotEventsException Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, IotEventsException 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotEventsException Removes the given tags (metadata) from the resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotEventsException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAlarmModel
default UpdateAlarmModelResponse updateAlarmModel(UpdateAlarmModelRequest updateAlarmModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
- Parameters:
updateAlarmModelRequest
-- Returns:
- Result of the UpdateAlarmModel operation returned by the service.
- See Also:
-
updateAlarmModel
default UpdateAlarmModelResponse updateAlarmModel(Consumer<UpdateAlarmModelRequest.Builder> updateAlarmModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaUpdateAlarmModelRequest.builder()
- Parameters:
updateAlarmModelRequest
- AConsumer
that will call methods onUpdateAlarmModelRequest.Builder
to create a request.- Returns:
- Result of the UpdateAlarmModel operation returned by the service.
- See Also:
-
updateDetectorModel
default UpdateDetectorModelResponse updateDetectorModel(UpdateDetectorModelRequest updateDetectorModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
- Parameters:
updateDetectorModelRequest
-- Returns:
- Result of the UpdateDetectorModel operation returned by the service.
- See Also:
-
updateDetectorModel
default UpdateDetectorModelResponse updateDetectorModel(Consumer<UpdateDetectorModelRequest.Builder> updateDetectorModelRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsException 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 viaUpdateDetectorModelRequest.builder()
- Parameters:
updateDetectorModelRequest
- AConsumer
that will call methods onUpdateDetectorModelRequest.Builder
to create a request.- Returns:
- Result of the UpdateDetectorModel operation returned by the service.
- See Also:
-
updateInput
default UpdateInputResponse updateInput(UpdateInputRequest updateInputRequest) throws InvalidRequestException, ThrottlingException, ResourceNotFoundException, InternalFailureException, ServiceUnavailableException, ResourceInUseException, AwsServiceException, SdkClientException, IotEventsException Updates an input.
- Parameters:
updateInputRequest
-- Returns:
- Result of the UpdateInput operation returned by the service.
- See Also:
-
updateInput
default UpdateInputResponse updateInput(Consumer<UpdateInputRequest.Builder> updateInputRequest) throws InvalidRequestException, ThrottlingException, ResourceNotFoundException, InternalFailureException, ServiceUnavailableException, ResourceInUseException, AwsServiceException, SdkClientException, IotEventsException Updates an input.
This is a convenience which creates an instance of the
UpdateInputRequest.Builder
avoiding the need to create one manually viaUpdateInputRequest.builder()
- Parameters:
updateInputRequest
- AConsumer
that will call methods onUpdateInputRequest.Builder
to create a request.- Returns:
- Result of the UpdateInput operation returned by the service.
- See Also:
-
create
Create aIotEventsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotEventsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-