com.amazonaws.services.iotevents

Interface AWSIoTEvents

All Known Subinterfaces:

AWSIoTEventsAsync

All Known Implementing Classes:

AbstractAWSIoTEvents, AbstractAWSIoTEventsAsync, AWSIoTEventsAsyncClient, AWSIoTEventsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTEvents

Interface for accessing AWS IoT Events.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTEvents instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAlarmModelResult	createAlarmModel(CreateAlarmModelRequest createAlarmModelRequest) Creates an alarm model to monitor an AWS IoT Events input attribute.
CreateDetectorModelResult	createDetectorModel(CreateDetectorModelRequest createDetectorModelRequest) Creates a detector model.
CreateInputResult	createInput(CreateInputRequest createInputRequest) Creates an input.
DeleteAlarmModelResult	deleteAlarmModel(DeleteAlarmModelRequest deleteAlarmModelRequest) Deletes an alarm model.
DeleteDetectorModelResult	deleteDetectorModel(DeleteDetectorModelRequest deleteDetectorModelRequest) Deletes a detector model.
DeleteInputResult	deleteInput(DeleteInputRequest deleteInputRequest) Deletes an input.
DescribeAlarmModelResult	describeAlarmModel(DescribeAlarmModelRequest describeAlarmModelRequest) Retrieves information about an alarm model.
DescribeDetectorModelResult	describeDetectorModel(DescribeDetectorModelRequest describeDetectorModelRequest) Describes a detector model.
DescribeDetectorModelAnalysisResult	describeDetectorModelAnalysis(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest) Retrieves runtime information about a detector model analysis.
DescribeInputResult	describeInput(DescribeInputRequest describeInputRequest) Describes an input.
DescribeLoggingOptionsResult	describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Events logging options.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDetectorModelAnalysisResultsResult	getDetectorModelAnalysisResults(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest) Retrieves one or more analysis results of the detector model.
ListAlarmModelsResult	listAlarmModels(ListAlarmModelsRequest listAlarmModelsRequest) Lists the alarm models that you created.
ListAlarmModelVersionsResult	listAlarmModelVersions(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest) Lists all the versions of an alarm model.
ListDetectorModelsResult	listDetectorModels(ListDetectorModelsRequest listDetectorModelsRequest) Lists the detector models you have created.
ListDetectorModelVersionsResult	listDetectorModelVersions(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest) Lists all the versions of a detector model.
ListInputRoutingsResult	listInputRoutings(ListInputRoutingsRequest listInputRoutingsRequest) Lists one or more input routings.
ListInputsResult	listInputs(ListInputsRequest listInputsRequest) Lists the inputs you have created.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.
PutLoggingOptionsResult	putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest) Sets or updates the AWS IoT Events logging options.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDetectorModelAnalysisResult	startDetectorModelAnalysis(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest) Performs an analysis of your detector model.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds to or modifies the tags of the given resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.
UpdateAlarmModelResult	updateAlarmModel(UpdateAlarmModelRequest updateAlarmModelRequest) Updates an alarm model.
UpdateDetectorModelResult	updateDetectorModel(UpdateDetectorModelRequest updateDetectorModelRequest) Updates a detector model.
UpdateInputResult	updateInput(UpdateInputRequest updateInputRequest) Updates an input.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createAlarmModel

CreateAlarmModelResult createAlarmModel(CreateAlarmModelRequest createAlarmModelRequest)

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.

Parameters:

createAlarmModelRequest -

Returns:

Result of the CreateAlarmModel operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceInUseException - The resource is in use.

ResourceAlreadyExistsException - The resource already exists.

LimitExceededException - A limit was exceeded.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

createDetectorModel

CreateDetectorModelResult createDetectorModel(CreateDetectorModelRequest createDetectorModelRequest)

Creates a detector model.

Parameters:

createDetectorModelRequest -

Returns:

Result of the CreateDetectorModel operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceInUseException - The resource is in use.

ResourceAlreadyExistsException - The resource already exists.

LimitExceededException - A limit was exceeded.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

createInput

CreateInputResult createInput(CreateInputRequest createInputRequest)

Creates an input.

Parameters:

createInputRequest -

Returns:

Result of the CreateInput operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

ResourceAlreadyExistsException - The resource already exists.

See Also:

AWS API Documentation

deleteAlarmModel

DeleteAlarmModelResult deleteAlarmModel(DeleteAlarmModelRequest deleteAlarmModelRequest)

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

Parameters:

deleteAlarmModelRequest -

Returns:

Result of the DeleteAlarmModel operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceInUseException - The resource is in use.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

deleteDetectorModel

DeleteDetectorModelResult deleteDetectorModel(DeleteDetectorModelRequest deleteDetectorModelRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ResourceInUseException - The resource is in use.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

deleteInput

DeleteInputResult deleteInput(DeleteInputRequest deleteInputRequest)

Deletes an input.

Parameters:

deleteInputRequest -

Returns:

Result of the DeleteInput operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

ResourceInUseException - The resource is in use.

See Also:

AWS API Documentation

describeAlarmModel

DescribeAlarmModelResult describeAlarmModel(DescribeAlarmModelRequest describeAlarmModelRequest)

Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

Parameters:

describeAlarmModelRequest -

Returns:

Result of the DescribeAlarmModel operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

describeDetectorModel

DescribeDetectorModelResult describeDetectorModel(DescribeDetectorModelRequest describeDetectorModelRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

describeDetectorModelAnalysis

DescribeDetectorModelAnalysisResult describeDetectorModelAnalysis(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest)

Retrieves runtime information about a detector model analysis.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Parameters:

describeDetectorModelAnalysisRequest -

Returns:

Result of the DescribeDetectorModelAnalysis operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

describeInput

DescribeInputResult describeInput(DescribeInputRequest describeInputRequest)

Describes an input.

Parameters:

describeInputRequest -

Returns:

Result of the DescribeInput operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

describeLoggingOptions

DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)

Retrieves the current settings of the AWS IoT Events logging options.

Parameters:

describeLoggingOptionsRequest -

Returns:

Result of the DescribeLoggingOptions operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ResourceNotFoundException - The resource was not found.

ServiceUnavailableException - The service is currently unavailable.

UnsupportedOperationException - The requested operation is not supported.

See Also:

AWS API Documentation

getDetectorModelAnalysisResults

GetDetectorModelAnalysisResultsResult getDetectorModelAnalysisResults(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest)

Retrieves one or more analysis results of the detector model.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Parameters:

getDetectorModelAnalysisResultsRequest -

Returns:

Result of the GetDetectorModelAnalysisResults operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

listAlarmModelVersions

ListAlarmModelVersionsResult listAlarmModelVersions(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

listAlarmModels

ListAlarmModelsResult listAlarmModels(ListAlarmModelsRequest listAlarmModelsRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

listDetectorModelVersions

ListDetectorModelVersionsResult listDetectorModelVersions(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

listDetectorModels

ListDetectorModelsResult listDetectorModels(ListDetectorModelsRequest listDetectorModelsRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

listInputRoutings

ListInputRoutingsResult listInputRoutings(ListInputRoutingsRequest listInputRoutingsRequest)

Lists one or more input routings.

Parameters:

listInputRoutingsRequest -

Returns:

Result of the ListInputRoutings operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

ResourceNotFoundException - The resource was not found.

See Also:

AWS API Documentation

listInputs

ListInputsResult listInputs(ListInputsRequest listInputsRequest)

Lists the inputs you have created.

Parameters:

listInputsRequest -

Returns:

Result of the ListInputs operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags (metadata) you have assigned to the resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ResourceInUseException - The resource is in use.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

See Also:

AWS API Documentation

putLoggingOptions

PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)

Sets or updates the AWS IoT Events logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

Parameters:

putLoggingOptionsRequest -

Returns:

Result of the PutLoggingOptions operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

UnsupportedOperationException - The requested operation is not supported.

ResourceInUseException - The resource is in use.

See Also:

AWS API Documentation

startDetectorModelAnalysis

StartDetectorModelAnalysisResult startDetectorModelAnalysis(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest)

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.

Parameters:

startDetectorModelAnalysisRequest -

Returns:

Result of the StartDetectorModelAnalysis operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

LimitExceededException - A limit was exceeded.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ResourceInUseException - The resource is in use.

ThrottlingException - The request could not be completed due to throttling.

LimitExceededException - A limit was exceeded.

InternalFailureException - An internal failure occurred.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the given tags (metadata) from the resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceNotFoundException - The resource was not found.

ResourceInUseException - The resource is in use.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

See Also:

AWS API Documentation

updateAlarmModel

UpdateAlarmModelResult updateAlarmModel(UpdateAlarmModelRequest updateAlarmModelRequest)

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

Parameters:

updateAlarmModelRequest -

Returns:

Result of the UpdateAlarmModel operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ResourceInUseException - The resource is in use.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

updateDetectorModel

UpdateDetectorModelResult updateDetectorModel(UpdateDetectorModelRequest updateDetectorModelRequest)

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.

Throws:

InvalidRequestException - The request was invalid.

ResourceInUseException - The resource is in use.

ResourceNotFoundException - The resource was not found.

ThrottlingException - The request could not be completed due to throttling.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

See Also:

AWS API Documentation

updateInput

UpdateInputResult updateInput(UpdateInputRequest updateInputRequest)

Updates an input.

Parameters:

updateInputRequest -

Returns:

Result of the UpdateInput operation returned by the service.

Throws:

InvalidRequestException - The request was invalid.

ThrottlingException - The request could not be completed due to throttling.

ResourceNotFoundException - The resource was not found.

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is currently unavailable.

ResourceInUseException - The resource is in use.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.