Interface IotEventsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IotEventsClient
extends AwsClient

Service client for accessing AWS IoT Events. This can be created using the static 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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static IotEventsClientBuilder	builder()	Create a builder that can be used to configure and create a IotEventsClient.
static IotEventsClient	create()	Create a IotEventsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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.
default DescribeDetectorModelAnalysisResponse	describeDetectorModelAnalysis(Consumer<DescribeDetectorModelAnalysisRequest.Builder> describeDetectorModelAnalysisRequest)	Retrieves runtime information about a detector model analysis.
default DescribeDetectorModelAnalysisResponse	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.
default GetDetectorModelAnalysisResultsResponse	getDetectorModelAnalysisResults(Consumer<GetDetectorModelAnalysisResultsRequest.Builder> getDetectorModelAnalysisResultsRequest)	Retrieves one or more analysis results of the detector model.
default GetDetectorModelAnalysisResultsResponse	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.
default ListDetectorModelVersionsResponse	listDetectorModelVersions(Consumer<ListDetectorModelVersionsRequest.Builder> listDetectorModelVersionsRequest)	Lists all the versions of a detector model.
default ListDetectorModelVersionsResponse	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.
default IotEventsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartDetectorModelAnalysisResponse	startDetectorModelAnalysis(Consumer<StartDetectorModelAnalysisRequest.Builder> startDetectorModelAnalysisRequest)	Performs an analysis of your detector model.
default StartDetectorModelAnalysisResponse	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

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:

• AWS API Documentation

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 via CreateAlarmModelRequest.builder()

Parameters:

createAlarmModelRequest - A Consumer that will call methods on CreateAlarmModelRequest.Builder to create a request.

Returns:

Result of the CreateAlarmModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via CreateDetectorModelRequest.builder()

Parameters:

createDetectorModelRequest - A Consumer that will call methods on CreateDetectorModelRequest.Builder to create a request.

Returns:

Result of the CreateDetectorModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via CreateInputRequest.builder()

Parameters:

createInputRequest - A Consumer that will call methods on CreateInputRequest.Builder to create a request.

Returns:

Result of the CreateInput operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteAlarmModelRequest.builder()

Parameters:

deleteAlarmModelRequest - A Consumer that will call methods on DeleteAlarmModelRequest.Builder to create a request.

Returns:

Result of the DeleteAlarmModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteDetectorModelRequest.builder()

Parameters:

deleteDetectorModelRequest - A Consumer that will call methods on DeleteDetectorModelRequest.Builder to create a request.

Returns:

Result of the DeleteDetectorModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteInputRequest.builder()

Parameters:

deleteInputRequest - A Consumer that will call methods on DeleteInputRequest.Builder to create a request.

Returns:

Result of the DeleteInput operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeAlarmModelRequest.builder()

Parameters:

describeAlarmModelRequest - A Consumer that will call methods on DescribeAlarmModelRequest.Builder to create a request.

Returns:

Result of the DescribeAlarmModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeDetectorModelRequest.builder()

Parameters:

describeDetectorModelRequest - A Consumer that will call methods on DescribeDetectorModelRequest.Builder to create a request.

Returns:

Result of the DescribeDetectorModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeDetectorModelAnalysisRequest.builder()

Parameters:

describeDetectorModelAnalysisRequest - A Consumer that will call methods on DescribeDetectorModelAnalysisRequest.Builder to create a request.

Returns:

Result of the DescribeDetectorModelAnalysis operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeInputRequest.builder()

Parameters:

describeInputRequest - A Consumer that will call methods on DescribeInputRequest.Builder to create a request.

Returns:

Result of the DescribeInput operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeLoggingOptionsRequest.builder()

Parameters:

describeLoggingOptionsRequest - A Consumer that will call methods on DescribeLoggingOptionsRequest.Builder to create a request.

Returns:

Result of the DescribeLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetDetectorModelAnalysisResultsRequest.builder()

Parameters:

getDetectorModelAnalysisResultsRequest - A Consumer that will call methods on GetDetectorModelAnalysisResultsRequest.Builder to create a request.

Returns:

Result of the GetDetectorModelAnalysisResults operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListAlarmModelVersionsRequest.builder()

Parameters:

listAlarmModelVersionsRequest - A Consumer that will call methods on ListAlarmModelVersionsRequest.Builder to create a request.

Returns:

Result of the ListAlarmModelVersions operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListAlarmModelsRequest.builder()

Parameters:

listAlarmModelsRequest - A Consumer that will call methods on ListAlarmModelsRequest.Builder to create a request.

Returns:

Result of the ListAlarmModels operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListDetectorModelVersionsRequest.builder()

Parameters:

listDetectorModelVersionsRequest - A Consumer that will call methods on ListDetectorModelVersionsRequest.Builder to create a request.

Returns:

Result of the ListDetectorModelVersions operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListDetectorModelsRequest.builder()

Parameters:

listDetectorModelsRequest - A Consumer that will call methods on ListDetectorModelsRequest.Builder to create a request.

Returns:

Result of the ListDetectorModels operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListInputRoutingsRequest.builder()

Parameters:

listInputRoutingsRequest - A Consumer that will call methods on ListInputRoutingsRequest.Builder to create a request.

Returns:

Result of the ListInputRoutings operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListInputsRequest.builder()

Parameters:

listInputsRequest - A Consumer that will call methods on ListInputsRequest.Builder to create a request.

Returns:

Result of the ListInputs operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

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 the roleArn 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:

• AWS API Documentation

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 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()

Parameters:

putLoggingOptionsRequest - A Consumer that will call methods on PutLoggingOptionsRequest.Builder to create a request.

Returns:

Result of the PutLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via StartDetectorModelAnalysisRequest.builder()

Parameters:

startDetectorModelAnalysisRequest - A Consumer that will call methods on StartDetectorModelAnalysisRequest.Builder to create a request.

Returns:

Result of the StartDetectorModelAnalysis operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateAlarmModelRequest.builder()

Parameters:

updateAlarmModelRequest - A Consumer that will call methods on UpdateAlarmModelRequest.Builder to create a request.

Returns:

Result of the UpdateAlarmModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateDetectorModelRequest.builder()

Parameters:

updateDetectorModelRequest - A Consumer that will call methods on UpdateDetectorModelRequest.Builder to create a request.

Returns:

Result of the UpdateDetectorModel operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateInputRequest.builder()

Parameters:

updateInputRequest - A Consumer that will call methods on UpdateInputRequest.Builder to create a request.

Returns:

Result of the UpdateInput operation returned by the service.

See Also:

• AWS API Documentation

create

static IotEventsClient create()

Create a IotEventsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IotEventsClientBuilder builder()

Create a builder that can be used to configure and create a IotEventsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IotEventsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration