AbstractAWSIoTEvents (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotevents.AbstractAWSIoTEvents

All Implemented Interfaces:

AWSIoTEvents

Direct Known Subclasses:

AbstractAWSIoTEventsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSIoTEvents
extends Object
implements AWSIoTEvents
```
Abstract implementation of AWSIoTEvents. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.iotevents.AWSIoTEvents
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAlarmModelResult`	`createAlarmModel(CreateAlarmModelRequest request)` Creates an alarm model to monitor an AWS IoT Events input attribute.
`CreateDetectorModelResult`	`createDetectorModel(CreateDetectorModelRequest request)` Creates a detector model.
`CreateInputResult`	`createInput(CreateInputRequest request)` Creates an input.
`DeleteAlarmModelResult`	`deleteAlarmModel(DeleteAlarmModelRequest request)` Deletes an alarm model.
`DeleteDetectorModelResult`	`deleteDetectorModel(DeleteDetectorModelRequest request)` Deletes a detector model.
`DeleteInputResult`	`deleteInput(DeleteInputRequest request)` Deletes an input.
`DescribeAlarmModelResult`	`describeAlarmModel(DescribeAlarmModelRequest request)` Retrieves information about an alarm model.
`DescribeDetectorModelResult`	`describeDetectorModel(DescribeDetectorModelRequest request)` Describes a detector model.
`DescribeDetectorModelAnalysisResult`	`describeDetectorModelAnalysis(DescribeDetectorModelAnalysisRequest request)` Retrieves runtime information about a detector model analysis.
`DescribeInputResult`	`describeInput(DescribeInputRequest request)` Describes an input.
`DescribeLoggingOptionsResult`	`describeLoggingOptions(DescribeLoggingOptionsRequest request)` 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 request)` Retrieves one or more analysis results of the detector model.
`ListAlarmModelsResult`	`listAlarmModels(ListAlarmModelsRequest request)` Lists the alarm models that you created.
`ListAlarmModelVersionsResult`	`listAlarmModelVersions(ListAlarmModelVersionsRequest request)` Lists all the versions of an alarm model.
`ListDetectorModelsResult`	`listDetectorModels(ListDetectorModelsRequest request)` Lists the detector models you have created.
`ListDetectorModelVersionsResult`	`listDetectorModelVersions(ListDetectorModelVersionsRequest request)` Lists all the versions of a detector model.
`ListInputRoutingsResult`	`listInputRoutings(ListInputRoutingsRequest request)` Lists one or more input routings.
`ListInputsResult`	`listInputs(ListInputsRequest request)` Lists the inputs you have created.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags (metadata) you have assigned to the resource.
`PutLoggingOptionsResult`	`putLoggingOptions(PutLoggingOptionsRequest request)` 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 request)` Performs an analysis of your detector model.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds to or modifies the tags of the given resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the given tags (metadata) from the resource.
`UpdateAlarmModelResult`	`updateAlarmModel(UpdateAlarmModelRequest request)` Updates an alarm model.
`UpdateDetectorModelResult`	`updateDetectorModel(UpdateDetectorModelRequest request)` Updates a detector model.
`UpdateInputResult`	`updateInput(UpdateInputRequest request)` Updates an input.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createAlarmModel
```
public CreateAlarmModelResult createAlarmModel(CreateAlarmModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    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.
    
    Specified by:
    
    createAlarmModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the CreateAlarmModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDetectorModel
```
public CreateDetectorModelResult createDetectorModel(CreateDetectorModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Creates a detector model.
    
    Specified by:
    
    createDetectorModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the CreateDetectorModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createInput
```
public CreateInputResult createInput(CreateInputRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Creates an input.
    
    Specified by:
    
    createInput in interface AWSIoTEvents
    
    Returns:
    
    Result of the CreateInput operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAlarmModel
```
public DeleteAlarmModelResult deleteAlarmModel(DeleteAlarmModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
    
    Specified by:
    
    deleteAlarmModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the DeleteAlarmModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDetectorModel
```
public DeleteDetectorModelResult deleteDetectorModel(DeleteDetectorModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Deletes a detector model. Any active instances of the detector model are also deleted.
    
    Specified by:
    
    deleteDetectorModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the DeleteDetectorModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteInput
```
public DeleteInputResult deleteInput(DeleteInputRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Deletes an input.
    
    Specified by:
    
    deleteInput in interface AWSIoTEvents
    
    Returns:
    
    Result of the DeleteInput operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAlarmModel
```
public DescribeAlarmModelResult describeAlarmModel(DescribeAlarmModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.
    
    Specified by:
    
    describeAlarmModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the DescribeAlarmModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDetectorModel
```
public DescribeDetectorModelResult describeDetectorModel(DescribeDetectorModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
    
    Specified by:
    
    describeDetectorModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the DescribeDetectorModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDetectorModelAnalysis
```
public DescribeDetectorModelAnalysisResult describeDetectorModelAnalysis(DescribeDetectorModelAnalysisRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    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.
    
    Specified by:
    
    describeDetectorModelAnalysis in interface AWSIoTEvents
    
    Returns:
    
    Result of the DescribeDetectorModelAnalysis operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeInput
```
public DescribeInputResult describeInput(DescribeInputRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Describes an input.
    
    Specified by:
    
    describeInput in interface AWSIoTEvents
    
    Returns:
    
    Result of the DescribeInput operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLoggingOptions
```
public DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Retrieves the current settings of the AWS IoT Events logging options.
    
    Specified by:
    
    describeLoggingOptions in interface AWSIoTEvents
    
    Returns:
    
    Result of the DescribeLoggingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDetectorModelAnalysisResults
```
public GetDetectorModelAnalysisResultsResult getDetectorModelAnalysisResults(GetDetectorModelAnalysisResultsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    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.
    
    Specified by:
    
    getDetectorModelAnalysisResults in interface AWSIoTEvents
    
    Returns:
    
    Result of the GetDetectorModelAnalysisResults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAlarmModelVersions
```
public ListAlarmModelVersionsResult listAlarmModelVersions(ListAlarmModelVersionsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
    
    Specified by:
    
    listAlarmModelVersions in interface AWSIoTEvents
    
    Returns:
    
    Result of the ListAlarmModelVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAlarmModels
```
public ListAlarmModelsResult listAlarmModels(ListAlarmModelsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
    
    Specified by:
    
    listAlarmModels in interface AWSIoTEvents
    
    Returns:
    
    Result of the ListAlarmModels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDetectorModelVersions
```
public ListDetectorModelVersionsResult listDetectorModelVersions(ListDetectorModelVersionsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
    
    Specified by:
    
    listDetectorModelVersions in interface AWSIoTEvents
    
    Returns:
    
    Result of the ListDetectorModelVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDetectorModels
```
public ListDetectorModelsResult listDetectorModels(ListDetectorModelsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Lists the detector models you have created. Only the metadata associated with each detector model is returned.
    
    Specified by:
    
    listDetectorModels in interface AWSIoTEvents
    
    Returns:
    
    Result of the ListDetectorModels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listInputRoutings
```
public ListInputRoutingsResult listInputRoutings(ListInputRoutingsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Lists one or more input routings.
    
    Specified by:
    
    listInputRoutings in interface AWSIoTEvents
    
    Returns:
    
    Result of the ListInputRoutings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listInputs
```
public ListInputsResult listInputs(ListInputsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Lists the inputs you have created.
    
    Specified by:
    
    listInputs in interface AWSIoTEvents
    
    Returns:
    
    Result of the ListInputs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Lists the tags (metadata) you have assigned to the resource.
    
    Specified by:
    
    listTagsForResource in interface AWSIoTEvents
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putLoggingOptions
```
public PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    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.
    
    Specified by:
    
    putLoggingOptions in interface AWSIoTEvents
    
    Returns:
    
    Result of the PutLoggingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDetectorModelAnalysis
```
public StartDetectorModelAnalysisResult startDetectorModelAnalysis(StartDetectorModelAnalysisRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
    
    Specified by:
    
    startDetectorModelAnalysis in interface AWSIoTEvents
    
    Returns:
    
    Result of the StartDetectorModelAnalysis operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
    
    Specified by:
    
    tagResource in interface AWSIoTEvents
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Removes the given tags (metadata) from the resource.
    
    Specified by:
    
    untagResource in interface AWSIoTEvents
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAlarmModel
```
public UpdateAlarmModelResult updateAlarmModel(UpdateAlarmModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
    
    Specified by:
    
    updateAlarmModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the UpdateAlarmModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDetectorModel
```
public UpdateDetectorModelResult updateDetectorModel(UpdateDetectorModelRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
    
    Specified by:
    
    updateDetectorModel in interface AWSIoTEvents
    
    Returns:
    
    Result of the UpdateDetectorModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateInput
```
public UpdateInputResult updateInput(UpdateInputRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    Updates an input.
    
    Specified by:
    
    updateInput in interface AWSIoTEvents
    
    Returns:
    
    Result of the UpdateInput operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSIoTEvents
    
    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.
    
    Specified by:
    
    shutdown in interface AWSIoTEvents
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSIoTEvents
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSIoTEvents
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSIoTEvents

Field Summary

Fields inherited from interface com.amazonaws.services.iotevents.AWSIoTEvents

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createAlarmModel

createDetectorModel

createInput

deleteAlarmModel

deleteDetectorModel

deleteInput

describeAlarmModel

describeDetectorModel

describeDetectorModelAnalysis

describeInput

describeLoggingOptions

getDetectorModelAnalysisResults

listAlarmModelVersions

listAlarmModels

listDetectorModelVersions

listDetectorModels

listInputRoutings

listInputs

listTagsForResource

putLoggingOptions

startDetectorModelAnalysis

tagResource

untagResource

updateAlarmModel

updateDetectorModel

updateInput

shutdown

getCachedResponseMetadata