com.amazonaws.services.iotwireless.AWSIoTWireless Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.iotwireless;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.iotwireless.model.*;
/**
* Interface for accessing AWS IoT Wireless.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.iotwireless.AbstractAWSIoTWireless} instead.
*
*
*
* AWS IoT Wireless API documentation
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTWireless {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "api.iotwireless";
/**
*
* Associates a partner account with your AWS account.
*
*
* @param associateAwsAccountWithPartnerAccountRequest
* @return Result of the AssociateAwsAccountWithPartnerAccount operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @sample AWSIoTWireless.AssociateAwsAccountWithPartnerAccount
* @see AWS API Documentation
*/
AssociateAwsAccountWithPartnerAccountResult associateAwsAccountWithPartnerAccount(
AssociateAwsAccountWithPartnerAccountRequest associateAwsAccountWithPartnerAccountRequest);
/**
*
* Associates a wireless device with a thing.
*
*
* @param associateWirelessDeviceWithThingRequest
* @return Result of the AssociateWirelessDeviceWithThing operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @sample AWSIoTWireless.AssociateWirelessDeviceWithThing
* @see AWS API Documentation
*/
AssociateWirelessDeviceWithThingResult associateWirelessDeviceWithThing(AssociateWirelessDeviceWithThingRequest associateWirelessDeviceWithThingRequest);
/**
*
* Associates a wireless gateway with a certificate.
*
*
* @param associateWirelessGatewayWithCertificateRequest
* @return Result of the AssociateWirelessGatewayWithCertificate operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.AssociateWirelessGatewayWithCertificate
* @see AWS API Documentation
*/
AssociateWirelessGatewayWithCertificateResult associateWirelessGatewayWithCertificate(
AssociateWirelessGatewayWithCertificateRequest associateWirelessGatewayWithCertificateRequest);
/**
*
* Associates a wireless gateway with a thing.
*
*
* @param associateWirelessGatewayWithThingRequest
* @return Result of the AssociateWirelessGatewayWithThing operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @sample AWSIoTWireless.AssociateWirelessGatewayWithThing
* @see AWS API Documentation
*/
AssociateWirelessGatewayWithThingResult associateWirelessGatewayWithThing(AssociateWirelessGatewayWithThingRequest associateWirelessGatewayWithThingRequest);
/**
*
* Creates a new destination that maps a device message to an AWS IoT rule.
*
*
* @param createDestinationRequest
* @return Result of the CreateDestination operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.CreateDestination
* @see AWS
* API Documentation
*/
CreateDestinationResult createDestination(CreateDestinationRequest createDestinationRequest);
/**
*
* Creates a new device profile.
*
*
* @param createDeviceProfileRequest
* @return Result of the CreateDeviceProfile operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.CreateDeviceProfile
* @see AWS API Documentation
*/
CreateDeviceProfileResult createDeviceProfile(CreateDeviceProfileRequest createDeviceProfileRequest);
/**
*
* Creates a new service profile.
*
*
* @param createServiceProfileRequest
* @return Result of the CreateServiceProfile operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.CreateServiceProfile
* @see AWS API Documentation
*/
CreateServiceProfileResult createServiceProfile(CreateServiceProfileRequest createServiceProfileRequest);
/**
*
* Provisions a wireless device.
*
*
* @param createWirelessDeviceRequest
* @return Result of the CreateWirelessDevice operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.CreateWirelessDevice
* @see AWS API Documentation
*/
CreateWirelessDeviceResult createWirelessDevice(CreateWirelessDeviceRequest createWirelessDeviceRequest);
/**
*
* Provisions a wireless gateway.
*
*
* @param createWirelessGatewayRequest
* @return Result of the CreateWirelessGateway operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.CreateWirelessGateway
* @see AWS API Documentation
*/
CreateWirelessGatewayResult createWirelessGateway(CreateWirelessGatewayRequest createWirelessGatewayRequest);
/**
*
* Creates a task for a wireless gateway.
*
*
* @param createWirelessGatewayTaskRequest
* @return Result of the CreateWirelessGatewayTask operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.CreateWirelessGatewayTask
* @see AWS API Documentation
*/
CreateWirelessGatewayTaskResult createWirelessGatewayTask(CreateWirelessGatewayTaskRequest createWirelessGatewayTaskRequest);
/**
*
* Creates a gateway task definition.
*
*
* @param createWirelessGatewayTaskDefinitionRequest
* @return Result of the CreateWirelessGatewayTaskDefinition operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.CreateWirelessGatewayTaskDefinition
* @see AWS API Documentation
*/
CreateWirelessGatewayTaskDefinitionResult createWirelessGatewayTaskDefinition(
CreateWirelessGatewayTaskDefinitionRequest createWirelessGatewayTaskDefinitionRequest);
/**
*
* Deletes a destination.
*
*
* @param deleteDestinationRequest
* @return Result of the DeleteDestination operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DeleteDestination
* @see AWS
* API Documentation
*/
DeleteDestinationResult deleteDestination(DeleteDestinationRequest deleteDestinationRequest);
/**
*
* Deletes a device profile.
*
*
* @param deleteDeviceProfileRequest
* @return Result of the DeleteDeviceProfile operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DeleteDeviceProfile
* @see AWS API Documentation
*/
DeleteDeviceProfileResult deleteDeviceProfile(DeleteDeviceProfileRequest deleteDeviceProfileRequest);
/**
*
* Deletes a service profile.
*
*
* @param deleteServiceProfileRequest
* @return Result of the DeleteServiceProfile operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DeleteServiceProfile
* @see AWS API Documentation
*/
DeleteServiceProfileResult deleteServiceProfile(DeleteServiceProfileRequest deleteServiceProfileRequest);
/**
*
* Deletes a wireless device.
*
*
* @param deleteWirelessDeviceRequest
* @return Result of the DeleteWirelessDevice operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DeleteWirelessDevice
* @see AWS API Documentation
*/
DeleteWirelessDeviceResult deleteWirelessDevice(DeleteWirelessDeviceRequest deleteWirelessDeviceRequest);
/**
*
* Deletes a wireless gateway.
*
*
* @param deleteWirelessGatewayRequest
* @return Result of the DeleteWirelessGateway operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DeleteWirelessGateway
* @see AWS API Documentation
*/
DeleteWirelessGatewayResult deleteWirelessGateway(DeleteWirelessGatewayRequest deleteWirelessGatewayRequest);
/**
*
* Deletes a wireless gateway task.
*
*
* @param deleteWirelessGatewayTaskRequest
* @return Result of the DeleteWirelessGatewayTask operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DeleteWirelessGatewayTask
* @see AWS API Documentation
*/
DeleteWirelessGatewayTaskResult deleteWirelessGatewayTask(DeleteWirelessGatewayTaskRequest deleteWirelessGatewayTaskRequest);
/**
*
* Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are
* currently in progress.
*
*
* @param deleteWirelessGatewayTaskDefinitionRequest
* @return Result of the DeleteWirelessGatewayTaskDefinition operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DeleteWirelessGatewayTaskDefinition
* @see AWS API Documentation
*/
DeleteWirelessGatewayTaskDefinitionResult deleteWirelessGatewayTaskDefinition(
DeleteWirelessGatewayTaskDefinitionRequest deleteWirelessGatewayTaskDefinitionRequest);
/**
*
* Disassociates your AWS account from a partner account. If PartnerAccountId and
* PartnerType are null, disassociates your AWS account from all partner accounts.
*
*
* @param disassociateAwsAccountFromPartnerAccountRequest
* @return Result of the DisassociateAwsAccountFromPartnerAccount operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DisassociateAwsAccountFromPartnerAccount
* @see AWS API Documentation
*/
DisassociateAwsAccountFromPartnerAccountResult disassociateAwsAccountFromPartnerAccount(
DisassociateAwsAccountFromPartnerAccountRequest disassociateAwsAccountFromPartnerAccountRequest);
/**
*
* Disassociates a wireless device from its currently associated thing.
*
*
* @param disassociateWirelessDeviceFromThingRequest
* @return Result of the DisassociateWirelessDeviceFromThing operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @sample AWSIoTWireless.DisassociateWirelessDeviceFromThing
* @see AWS API Documentation
*/
DisassociateWirelessDeviceFromThingResult disassociateWirelessDeviceFromThing(
DisassociateWirelessDeviceFromThingRequest disassociateWirelessDeviceFromThingRequest);
/**
*
* Disassociates a wireless gateway from its currently associated certificate.
*
*
* @param disassociateWirelessGatewayFromCertificateRequest
* @return Result of the DisassociateWirelessGatewayFromCertificate operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.DisassociateWirelessGatewayFromCertificate
* @see AWS API Documentation
*/
DisassociateWirelessGatewayFromCertificateResult disassociateWirelessGatewayFromCertificate(
DisassociateWirelessGatewayFromCertificateRequest disassociateWirelessGatewayFromCertificateRequest);
/**
*
* Disassociates a wireless gateway from its currently associated thing.
*
*
* @param disassociateWirelessGatewayFromThingRequest
* @return Result of the DisassociateWirelessGatewayFromThing operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @sample AWSIoTWireless.DisassociateWirelessGatewayFromThing
* @see AWS API Documentation
*/
DisassociateWirelessGatewayFromThingResult disassociateWirelessGatewayFromThing(
DisassociateWirelessGatewayFromThingRequest disassociateWirelessGatewayFromThingRequest);
/**
*
* Gets information about a destination.
*
*
* @param getDestinationRequest
* @return Result of the GetDestination operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetDestination
* @see AWS API
* Documentation
*/
GetDestinationResult getDestination(GetDestinationRequest getDestinationRequest);
/**
*
* Gets information about a device profile.
*
*
* @param getDeviceProfileRequest
* @return Result of the GetDeviceProfile operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetDeviceProfile
* @see AWS
* API Documentation
*/
GetDeviceProfileResult getDeviceProfile(GetDeviceProfileRequest getDeviceProfileRequest);
/**
*
* Gets information about a partner account. If PartnerAccountId and PartnerType are
* null, returns all partner accounts.
*
*
* @param getPartnerAccountRequest
* @return Result of the GetPartnerAccount operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetPartnerAccount
* @see AWS
* API Documentation
*/
GetPartnerAccountResult getPartnerAccount(GetPartnerAccountRequest getPartnerAccountRequest);
/**
*
* Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server
* (LNS) connections.
*
*
* @param getServiceEndpointRequest
* @return Result of the GetServiceEndpoint operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetServiceEndpoint
* @see AWS
* API Documentation
*/
GetServiceEndpointResult getServiceEndpoint(GetServiceEndpointRequest getServiceEndpointRequest);
/**
*
* Gets information about a service profile.
*
*
* @param getServiceProfileRequest
* @return Result of the GetServiceProfile operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetServiceProfile
* @see AWS
* API Documentation
*/
GetServiceProfileResult getServiceProfile(GetServiceProfileRequest getServiceProfileRequest);
/**
*
* Gets information about a wireless device.
*
*
* @param getWirelessDeviceRequest
* @return Result of the GetWirelessDevice operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessDevice
* @see AWS
* API Documentation
*/
GetWirelessDeviceResult getWirelessDevice(GetWirelessDeviceRequest getWirelessDeviceRequest);
/**
*
* Gets operating information about a wireless device.
*
*
* @param getWirelessDeviceStatisticsRequest
* @return Result of the GetWirelessDeviceStatistics operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessDeviceStatistics
* @see AWS API Documentation
*/
GetWirelessDeviceStatisticsResult getWirelessDeviceStatistics(GetWirelessDeviceStatisticsRequest getWirelessDeviceStatisticsRequest);
/**
*
* Gets information about a wireless gateway.
*
*
* @param getWirelessGatewayRequest
* @return Result of the GetWirelessGateway operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessGateway
* @see AWS
* API Documentation
*/
GetWirelessGatewayResult getWirelessGateway(GetWirelessGatewayRequest getWirelessGatewayRequest);
/**
*
* Gets the ID of the certificate that is currently associated with a wireless gateway.
*
*
* @param getWirelessGatewayCertificateRequest
* @return Result of the GetWirelessGatewayCertificate operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessGatewayCertificate
* @see AWS API Documentation
*/
GetWirelessGatewayCertificateResult getWirelessGatewayCertificate(GetWirelessGatewayCertificateRequest getWirelessGatewayCertificateRequest);
/**
*
* Gets the firmware version and other information about a wireless gateway.
*
*
* @param getWirelessGatewayFirmwareInformationRequest
* @return Result of the GetWirelessGatewayFirmwareInformation operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessGatewayFirmwareInformation
* @see AWS API Documentation
*/
GetWirelessGatewayFirmwareInformationResult getWirelessGatewayFirmwareInformation(
GetWirelessGatewayFirmwareInformationRequest getWirelessGatewayFirmwareInformationRequest);
/**
*
* Gets operating information about a wireless gateway.
*
*
* @param getWirelessGatewayStatisticsRequest
* @return Result of the GetWirelessGatewayStatistics operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessGatewayStatistics
* @see AWS API Documentation
*/
GetWirelessGatewayStatisticsResult getWirelessGatewayStatistics(GetWirelessGatewayStatisticsRequest getWirelessGatewayStatisticsRequest);
/**
*
* Gets information about a wireless gateway task.
*
*
* @param getWirelessGatewayTaskRequest
* @return Result of the GetWirelessGatewayTask operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessGatewayTask
* @see AWS API Documentation
*/
GetWirelessGatewayTaskResult getWirelessGatewayTask(GetWirelessGatewayTaskRequest getWirelessGatewayTaskRequest);
/**
*
* Gets information about a wireless gateway task definition.
*
*
* @param getWirelessGatewayTaskDefinitionRequest
* @return Result of the GetWirelessGatewayTaskDefinition operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.GetWirelessGatewayTaskDefinition
* @see AWS API Documentation
*/
GetWirelessGatewayTaskDefinitionResult getWirelessGatewayTaskDefinition(GetWirelessGatewayTaskDefinitionRequest getWirelessGatewayTaskDefinitionRequest);
/**
*
* Lists the destinations registered to your AWS account.
*
*
* @param listDestinationsRequest
* @return Result of the ListDestinations operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.ListDestinations
* @see AWS
* API Documentation
*/
ListDestinationsResult listDestinations(ListDestinationsRequest listDestinationsRequest);
/**
*
* Lists the device profiles registered to your AWS account.
*
*
* @param listDeviceProfilesRequest
* @return Result of the ListDeviceProfiles operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.ListDeviceProfiles
* @see AWS
* API Documentation
*/
ListDeviceProfilesResult listDeviceProfiles(ListDeviceProfilesRequest listDeviceProfilesRequest);
/**
*
* Lists the partner accounts associated with your AWS account.
*
*
* @param listPartnerAccountsRequest
* @return Result of the ListPartnerAccounts operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.ListPartnerAccounts
* @see AWS API Documentation
*/
ListPartnerAccountsResult listPartnerAccounts(ListPartnerAccountsRequest listPartnerAccountsRequest);
/**
*
* Lists the service profiles registered to your AWS account.
*
*
* @param listServiceProfilesRequest
* @return Result of the ListServiceProfiles operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.ListServiceProfiles
* @see AWS API Documentation
*/
ListServiceProfilesResult listServiceProfiles(ListServiceProfilesRequest listServiceProfilesRequest);
/**
*
* Lists the tags (metadata) you have assigned to the resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the wireless devices registered to your AWS account.
*
*
* @param listWirelessDevicesRequest
* @return Result of the ListWirelessDevices operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @sample AWSIoTWireless.ListWirelessDevices
* @see AWS API Documentation
*/
ListWirelessDevicesResult listWirelessDevices(ListWirelessDevicesRequest listWirelessDevicesRequest);
/**
*
* List the wireless gateway tasks definitions registered to your AWS account.
*
*
* @param listWirelessGatewayTaskDefinitionsRequest
* @return Result of the ListWirelessGatewayTaskDefinitions operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.ListWirelessGatewayTaskDefinitions
* @see AWS API Documentation
*/
ListWirelessGatewayTaskDefinitionsResult listWirelessGatewayTaskDefinitions(
ListWirelessGatewayTaskDefinitionsRequest listWirelessGatewayTaskDefinitionsRequest);
/**
*
* Lists the wireless gateways registered to your AWS account.
*
*
* @param listWirelessGatewaysRequest
* @return Result of the ListWirelessGateways operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @sample AWSIoTWireless.ListWirelessGateways
* @see AWS API Documentation
*/
ListWirelessGatewaysResult listWirelessGateways(ListWirelessGatewaysRequest listWirelessGatewaysRequest);
/**
*
* Sends a decrypted application data frame to a device.
*
*
* @param sendDataToWirelessDeviceRequest
* @return Result of the SendDataToWirelessDevice operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @sample AWSIoTWireless.SendDataToWirelessDevice
* @see AWS API Documentation
*/
SendDataToWirelessDeviceResult sendDataToWirelessDevice(SendDataToWirelessDeviceRequest sendDataToWirelessDeviceRequest);
/**
*
* Adds a tag to a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws TooManyTagsException
* The request was denied because the resource can't have any more tags.
* @sample AWSIoTWireless.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Simulates a provisioned device by sending an uplink data payload of Hello.
*
*
* @param testWirelessDeviceRequest
* @return Result of the TestWirelessDevice operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @sample AWSIoTWireless.TestWirelessDevice
* @see AWS
* API Documentation
*/
TestWirelessDeviceResult testWirelessDevice(TestWirelessDeviceRequest testWirelessDeviceRequest);
/**
*
* Removes one or more tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws ConflictException
* Adding, updating, or deleting the resource can cause an inconsistent state.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates properties of a destination.
*
*
* @param updateDestinationRequest
* @return Result of the UpdateDestination operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.UpdateDestination
* @see AWS
* API Documentation
*/
UpdateDestinationResult updateDestination(UpdateDestinationRequest updateDestinationRequest);
/**
*
* Updates properties of a partner account.
*
*
* @param updatePartnerAccountRequest
* @return Result of the UpdatePartnerAccount operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.UpdatePartnerAccount
* @see AWS API Documentation
*/
UpdatePartnerAccountResult updatePartnerAccount(UpdatePartnerAccountRequest updatePartnerAccountRequest);
/**
*
* Updates properties of a wireless device.
*
*
* @param updateWirelessDeviceRequest
* @return Result of the UpdateWirelessDevice operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.UpdateWirelessDevice
* @see AWS API Documentation
*/
UpdateWirelessDeviceResult updateWirelessDevice(UpdateWirelessDeviceRequest updateWirelessDeviceRequest);
/**
*
* Updates properties of a wireless gateway.
*
*
* @param updateWirelessGatewayRequest
* @return Result of the UpdateWirelessGateway operation returned by the service.
* @throws ValidationException
* The input did not meet the specified constraints.
* @throws ResourceNotFoundException
* Resource does not exist.
* @throws AccessDeniedException
* User does not have permission to perform this action.
* @throws InternalServerException
* An unexpected error occurred while processing a request.
* @throws ThrottlingException
* The request was denied because it exceeded the allowed API request rate.
* @sample AWSIoTWireless.UpdateWirelessGateway
* @see AWS API Documentation
*/
UpdateWirelessGatewayResult updateWirelessGateway(UpdateWirelessGatewayRequest updateWirelessGatewayRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy