*
* IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when * such events occur. You can use IoT Events Data API commands to send inputs to detectors, list detectors, and view or * update a detector's status. *
** For more information, see What is IoT Events? in * the IoT Events Developer Guide. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSIoTEventsDataClient extends AmazonWebServiceClient implements AWSIoTEventsData { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSIoTEventsData.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "ioteventsdata"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalFailureException").withExceptionUnmarshaller( com.amazonaws.services.ioteventsdata.model.transform.InternalFailureExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidRequestException").withExceptionUnmarshaller( com.amazonaws.services.ioteventsdata.model.transform.InvalidRequestExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.ioteventsdata.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller( com.amazonaws.services.ioteventsdata.model.transform.ThrottlingExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceUnavailableException").withExceptionUnmarshaller( com.amazonaws.services.ioteventsdata.model.transform.ServiceUnavailableExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.ioteventsdata.model.AWSIoTEventsDataException.class)); public static AWSIoTEventsDataClientBuilder builder() { return AWSIoTEventsDataClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS IoT Events Data using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSIoTEventsDataClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS IoT Events Data using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSIoTEventsDataClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("data.iotevents.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/ioteventsdata/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/ioteventsdata/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge
* them.
*
* Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the * detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in * the * ListDetectors API call. *
* * @param batchDeleteDetectorRequest * @return Result of the BatchDeleteDetector operation returned by the service. * @throws InvalidRequestException * The request was invalid. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ThrottlingException * The request could not be completed due to throttling. * @sample AWSIoTEventsData.BatchDeleteDetector * @see AWS API Documentation */ @Override public BatchDeleteDetectorResult batchDeleteDetector(BatchDeleteDetectorRequest request) { request = beforeClientExecution(request); return executeBatchDeleteDetector(request); } @SdkInternalApi final BatchDeleteDetectorResult executeBatchDeleteDetector(BatchDeleteDetectorRequest batchDeleteDetectorRequest) { ExecutionContext executionContext = createExecutionContext(batchDeleteDetectorRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
*
* Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
*
* Sends a set of messages to the IoT Events system. Each message payload is transformed into the input you specify
* ("inputName") and ingested into any detectors that monitor that input. If multiple messages are
* sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send
* messages one at a time and wait for a successful response.
*
* Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
*
* Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after
* you set them to the snooze mode.
*
* Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified * detector model. *
* * @param batchUpdateDetectorRequest * @return Result of the BatchUpdateDetector operation returned by the service. * @throws InvalidRequestException * The request was invalid. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ThrottlingException * The request could not be completed due to throttling. * @sample AWSIoTEventsData.BatchUpdateDetector * @see AWS API Documentation */ @Override public BatchUpdateDetectorResult batchUpdateDetector(BatchUpdateDetectorRequest request) { request = beforeClientExecution(request); return executeBatchUpdateDetector(request); } @SdkInternalApi final BatchUpdateDetectorResult executeBatchUpdateDetector(BatchUpdateDetectorRequest batchUpdateDetectorRequest) { ExecutionContext executionContext = createExecutionContext(batchUpdateDetectorRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Retrieves information about an alarm. *
* * @param describeAlarmRequest * @return Result of the DescribeAlarm operation returned by the service. * @throws InvalidRequestException * The request was invalid. * @throws ResourceNotFoundException * The resource was not found. * @throws ThrottlingException * The request could not be completed due to throttling. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is currently unavailable. * @sample AWSIoTEventsData.DescribeAlarm * @see AWS * API Documentation */ @Override public DescribeAlarmResult describeAlarm(DescribeAlarmRequest request) { request = beforeClientExecution(request); return executeDescribeAlarm(request); } @SdkInternalApi final DescribeAlarmResult executeDescribeAlarm(DescribeAlarmRequest describeAlarmRequest) { ExecutionContext executionContext = createExecutionContext(describeAlarmRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns information about the specified detector (instance). *
* * @param describeDetectorRequest * @return Result of the DescribeDetector operation returned by the service. * @throws InvalidRequestException * The request was invalid. * @throws ResourceNotFoundException * The resource was not found. * @throws ThrottlingException * The request could not be completed due to throttling. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is currently unavailable. * @sample AWSIoTEventsData.DescribeDetector * @see AWS API Documentation */ @Override public DescribeDetectorResult describeDetector(DescribeDetectorRequest request) { request = beforeClientExecution(request); return executeDescribeDetector(request); } @SdkInternalApi final DescribeDetectorResult executeDescribeDetector(DescribeDetectorRequest describeDetectorRequest) { ExecutionContext executionContext = createExecutionContext(describeDetectorRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists one or more alarms. The operation returns only the metadata associated with each alarm. *
* * @param listAlarmsRequest * @return Result of the ListAlarms operation returned by the service. * @throws InvalidRequestException * The request was invalid. * @throws ResourceNotFoundException * The resource was not found. * @throws ThrottlingException * The request could not be completed due to throttling. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is currently unavailable. * @sample AWSIoTEventsData.ListAlarms * @see AWS API * Documentation */ @Override public ListAlarmsResult listAlarms(ListAlarmsRequest request) { request = beforeClientExecution(request); return executeListAlarms(request); } @SdkInternalApi final ListAlarmsResult executeListAlarms(ListAlarmsRequest listAlarmsRequest) { ExecutionContext executionContext = createExecutionContext(listAlarmsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists detectors (the instances of a detector model). *
* * @param listDetectorsRequest * @return Result of the ListDetectors operation returned by the service. * @throws InvalidRequestException * The request was invalid. * @throws ResourceNotFoundException * The resource was not found. * @throws ThrottlingException * The request could not be completed due to throttling. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is currently unavailable. * @sample AWSIoTEventsData.ListDetectors * @see AWS * API Documentation */ @Override public ListDetectorsResult listDetectors(ListDetectorsRequest request) { request = beforeClientExecution(request); return executeListDetectors(request); } @SdkInternalApi final ListDetectorsResult executeListDetectors(ListDetectorsRequest listDetectorsRequest) { ExecutionContext executionContext = createExecutionContext(listDetectorsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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 the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private