com.amazonaws.services.iotwireless

Class AWSIoTWirelessClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotwireless.AWSIoTWirelessClient

All Implemented Interfaces:

AWSIoTWireless

Direct Known Subclasses:

AWSIoTWirelessAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoTWirelessClient
extends AmazonWebServiceClient
implements AWSIoTWireless

Client for accessing AWS IoT Wireless. All service calls made using this client are blocking, and will not return until the service call completes.

AWS IoT Wireless API documentation

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.iotwireless.AWSIoTWireless

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateAwsAccountWithPartnerAccountResult	associateAwsAccountWithPartnerAccount(AssociateAwsAccountWithPartnerAccountRequest request) Associates a partner account with your AWS account.
AssociateWirelessDeviceWithThingResult	associateWirelessDeviceWithThing(AssociateWirelessDeviceWithThingRequest request) Associates a wireless device with a thing.
AssociateWirelessGatewayWithCertificateResult	associateWirelessGatewayWithCertificate(AssociateWirelessGatewayWithCertificateRequest request) Associates a wireless gateway with a certificate.
AssociateWirelessGatewayWithThingResult	associateWirelessGatewayWithThing(AssociateWirelessGatewayWithThingRequest request) Associates a wireless gateway with a thing.
static AWSIoTWirelessClientBuilder	builder()
CreateDestinationResult	createDestination(CreateDestinationRequest request) Creates a new destination that maps a device message to an AWS IoT rule.
CreateDeviceProfileResult	createDeviceProfile(CreateDeviceProfileRequest request) Creates a new device profile.
CreateServiceProfileResult	createServiceProfile(CreateServiceProfileRequest request) Creates a new service profile.
CreateWirelessDeviceResult	createWirelessDevice(CreateWirelessDeviceRequest request) Provisions a wireless device.
CreateWirelessGatewayResult	createWirelessGateway(CreateWirelessGatewayRequest request) Provisions a wireless gateway.
CreateWirelessGatewayTaskResult	createWirelessGatewayTask(CreateWirelessGatewayTaskRequest request) Creates a task for a wireless gateway.
CreateWirelessGatewayTaskDefinitionResult	createWirelessGatewayTaskDefinition(CreateWirelessGatewayTaskDefinitionRequest request) Creates a gateway task definition.
DeleteDestinationResult	deleteDestination(DeleteDestinationRequest request) Deletes a destination.
DeleteDeviceProfileResult	deleteDeviceProfile(DeleteDeviceProfileRequest request) Deletes a device profile.
DeleteServiceProfileResult	deleteServiceProfile(DeleteServiceProfileRequest request) Deletes a service profile.
DeleteWirelessDeviceResult	deleteWirelessDevice(DeleteWirelessDeviceRequest request) Deletes a wireless device.
DeleteWirelessGatewayResult	deleteWirelessGateway(DeleteWirelessGatewayRequest request) Deletes a wireless gateway.
DeleteWirelessGatewayTaskResult	deleteWirelessGatewayTask(DeleteWirelessGatewayTaskRequest request) Deletes a wireless gateway task.
DeleteWirelessGatewayTaskDefinitionResult	deleteWirelessGatewayTaskDefinition(DeleteWirelessGatewayTaskDefinitionRequest request) Deletes a wireless gateway task definition.
DisassociateAwsAccountFromPartnerAccountResult	disassociateAwsAccountFromPartnerAccount(DisassociateAwsAccountFromPartnerAccountRequest request) Disassociates your AWS account from a partner account.
DisassociateWirelessDeviceFromThingResult	disassociateWirelessDeviceFromThing(DisassociateWirelessDeviceFromThingRequest request) Disassociates a wireless device from its currently associated thing.
DisassociateWirelessGatewayFromCertificateResult	disassociateWirelessGatewayFromCertificate(DisassociateWirelessGatewayFromCertificateRequest request) Disassociates a wireless gateway from its currently associated certificate.
DisassociateWirelessGatewayFromThingResult	disassociateWirelessGatewayFromThing(DisassociateWirelessGatewayFromThingRequest request) Disassociates a wireless gateway from its currently associated thing.
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.
GetDestinationResult	getDestination(GetDestinationRequest request) Gets information about a destination.
GetDeviceProfileResult	getDeviceProfile(GetDeviceProfileRequest request) Gets information about a device profile.
GetPartnerAccountResult	getPartnerAccount(GetPartnerAccountRequest request) Gets information about a partner account.
GetServiceEndpointResult	getServiceEndpoint(GetServiceEndpointRequest request) Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
GetServiceProfileResult	getServiceProfile(GetServiceProfileRequest request) Gets information about a service profile.
GetWirelessDeviceResult	getWirelessDevice(GetWirelessDeviceRequest request) Gets information about a wireless device.
GetWirelessDeviceStatisticsResult	getWirelessDeviceStatistics(GetWirelessDeviceStatisticsRequest request) Gets operating information about a wireless device.
GetWirelessGatewayResult	getWirelessGateway(GetWirelessGatewayRequest request) Gets information about a wireless gateway.
GetWirelessGatewayCertificateResult	getWirelessGatewayCertificate(GetWirelessGatewayCertificateRequest request) Gets the ID of the certificate that is currently associated with a wireless gateway.
GetWirelessGatewayFirmwareInformationResult	getWirelessGatewayFirmwareInformation(GetWirelessGatewayFirmwareInformationRequest request) Gets the firmware version and other information about a wireless gateway.
GetWirelessGatewayStatisticsResult	getWirelessGatewayStatistics(GetWirelessGatewayStatisticsRequest request) Gets operating information about a wireless gateway.
GetWirelessGatewayTaskResult	getWirelessGatewayTask(GetWirelessGatewayTaskRequest request) Gets information about a wireless gateway task.
GetWirelessGatewayTaskDefinitionResult	getWirelessGatewayTaskDefinition(GetWirelessGatewayTaskDefinitionRequest request) Gets information about a wireless gateway task definition.
ListDestinationsResult	listDestinations(ListDestinationsRequest request) Lists the destinations registered to your AWS account.
ListDeviceProfilesResult	listDeviceProfiles(ListDeviceProfilesRequest request) Lists the device profiles registered to your AWS account.
ListPartnerAccountsResult	listPartnerAccounts(ListPartnerAccountsRequest request) Lists the partner accounts associated with your AWS account.
ListServiceProfilesResult	listServiceProfiles(ListServiceProfilesRequest request) Lists the service profiles registered to your AWS account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags (metadata) you have assigned to the resource.
ListWirelessDevicesResult	listWirelessDevices(ListWirelessDevicesRequest request) Lists the wireless devices registered to your AWS account.
ListWirelessGatewaysResult	listWirelessGateways(ListWirelessGatewaysRequest request) Lists the wireless gateways registered to your AWS account.
ListWirelessGatewayTaskDefinitionsResult	listWirelessGatewayTaskDefinitions(ListWirelessGatewayTaskDefinitionsRequest request) List the wireless gateway tasks definitions registered to your AWS account.
SendDataToWirelessDeviceResult	sendDataToWirelessDevice(SendDataToWirelessDeviceRequest request) Sends a decrypted application data frame to a device.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds a tag to a resource.
TestWirelessDeviceResult	testWirelessDevice(TestWirelessDeviceRequest request) Simulates a provisioned device by sending an uplink data payload of Hello.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from a resource.
UpdateDestinationResult	updateDestination(UpdateDestinationRequest request) Updates properties of a destination.
UpdatePartnerAccountResult	updatePartnerAccount(UpdatePartnerAccountRequest request) Updates properties of a partner account.
UpdateWirelessDeviceResult	updateWirelessDevice(UpdateWirelessDeviceRequest request) Updates properties of a wireless device.
UpdateWirelessGatewayResult	updateWirelessGateway(UpdateWirelessGatewayRequest request) Updates properties of a wireless gateway.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSIoTWirelessClientBuilder builder()

associateAwsAccountWithPartnerAccount

public AssociateAwsAccountWithPartnerAccountResult associateAwsAccountWithPartnerAccount(AssociateAwsAccountWithPartnerAccountRequest request)

Associates a partner account with your AWS account.

Specified by:

associateAwsAccountWithPartnerAccount in interface AWSIoTWireless

Parameters:

associateAwsAccountWithPartnerAccountRequest -

Returns:

Result of the AssociateAwsAccountWithPartnerAccount operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

AccessDeniedException - User does not have permission to perform this action.

See Also:

AWS API Documentation

associateWirelessDeviceWithThing

public AssociateWirelessDeviceWithThingResult associateWirelessDeviceWithThing(AssociateWirelessDeviceWithThingRequest request)

Associates a wireless device with a thing.

Specified by:

associateWirelessDeviceWithThing in interface AWSIoTWireless

Parameters:

associateWirelessDeviceWithThingRequest -

Returns:

Result of the AssociateWirelessDeviceWithThing operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

InternalServerException - An unexpected error occurred while processing a request.

See Also:

AWS API Documentation

associateWirelessGatewayWithCertificate

public AssociateWirelessGatewayWithCertificateResult associateWirelessGatewayWithCertificate(AssociateWirelessGatewayWithCertificateRequest request)

Associates a wireless gateway with a certificate.

Specified by:

associateWirelessGatewayWithCertificate in interface AWSIoTWireless

Parameters:

associateWirelessGatewayWithCertificateRequest -

Returns:

Result of the AssociateWirelessGatewayWithCertificate operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

associateWirelessGatewayWithThing

public AssociateWirelessGatewayWithThingResult associateWirelessGatewayWithThing(AssociateWirelessGatewayWithThingRequest request)

Associates a wireless gateway with a thing.

Specified by:

associateWirelessGatewayWithThing in interface AWSIoTWireless

Parameters:

associateWirelessGatewayWithThingRequest -

Returns:

Result of the AssociateWirelessGatewayWithThing operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

InternalServerException - An unexpected error occurred while processing a request.

See Also:

AWS API Documentation

createDestination

public CreateDestinationResult createDestination(CreateDestinationRequest request)

Creates a new destination that maps a device message to an AWS IoT rule.

Specified by:

createDestination in interface AWSIoTWireless

Parameters:

createDestinationRequest -

Returns:

Result of the CreateDestination operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

createDeviceProfile

public CreateDeviceProfileResult createDeviceProfile(CreateDeviceProfileRequest request)

Creates a new device profile.

Specified by:

createDeviceProfile in interface AWSIoTWireless

Parameters:

createDeviceProfileRequest -

Returns:

Result of the CreateDeviceProfile operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

createServiceProfile

public CreateServiceProfileResult createServiceProfile(CreateServiceProfileRequest request)

Creates a new service profile.

Specified by:

createServiceProfile in interface AWSIoTWireless

Parameters:

createServiceProfileRequest -

Returns:

Result of the CreateServiceProfile operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

createWirelessDevice

public CreateWirelessDeviceResult createWirelessDevice(CreateWirelessDeviceRequest request)

Provisions a wireless device.

Specified by:

createWirelessDevice in interface AWSIoTWireless

Parameters:

createWirelessDeviceRequest -

Returns:

Result of the CreateWirelessDevice operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

createWirelessGateway

public CreateWirelessGatewayResult createWirelessGateway(CreateWirelessGatewayRequest request)

Provisions a wireless gateway.

Specified by:

createWirelessGateway in interface AWSIoTWireless

Parameters:

createWirelessGatewayRequest -

Returns:

Result of the CreateWirelessGateway operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

createWirelessGatewayTask

public CreateWirelessGatewayTaskResult createWirelessGatewayTask(CreateWirelessGatewayTaskRequest request)

Creates a task for a wireless gateway.

Specified by:

createWirelessGatewayTask in interface AWSIoTWireless

Parameters:

createWirelessGatewayTaskRequest -

Returns:

Result of the CreateWirelessGatewayTask operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

createWirelessGatewayTaskDefinition

public CreateWirelessGatewayTaskDefinitionResult createWirelessGatewayTaskDefinition(CreateWirelessGatewayTaskDefinitionRequest request)

Creates a gateway task definition.

Specified by:

createWirelessGatewayTaskDefinition in interface AWSIoTWireless

Parameters:

createWirelessGatewayTaskDefinitionRequest -

Returns:

Result of the CreateWirelessGatewayTaskDefinition operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

deleteDestination

public DeleteDestinationResult deleteDestination(DeleteDestinationRequest request)

Deletes a destination.

Specified by:

deleteDestination in interface AWSIoTWireless

Parameters:

deleteDestinationRequest -

Returns:

Result of the DeleteDestination operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

deleteDeviceProfile

public DeleteDeviceProfileResult deleteDeviceProfile(DeleteDeviceProfileRequest request)

Deletes a device profile.

Specified by:

deleteDeviceProfile in interface AWSIoTWireless

Parameters:

deleteDeviceProfileRequest -

Returns:

Result of the DeleteDeviceProfile operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

deleteServiceProfile

public DeleteServiceProfileResult deleteServiceProfile(DeleteServiceProfileRequest request)

Deletes a service profile.

Specified by:

deleteServiceProfile in interface AWSIoTWireless

Parameters:

deleteServiceProfileRequest -

Returns:

Result of the DeleteServiceProfile operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

deleteWirelessDevice

public DeleteWirelessDeviceResult deleteWirelessDevice(DeleteWirelessDeviceRequest request)

Deletes a wireless device.

Specified by:

deleteWirelessDevice in interface AWSIoTWireless

Parameters:

deleteWirelessDeviceRequest -

Returns:

Result of the DeleteWirelessDevice operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

deleteWirelessGateway

public DeleteWirelessGatewayResult deleteWirelessGateway(DeleteWirelessGatewayRequest request)

Deletes a wireless gateway.

Specified by:

deleteWirelessGateway in interface AWSIoTWireless

Parameters:

deleteWirelessGatewayRequest -

Returns:

Result of the DeleteWirelessGateway operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

deleteWirelessGatewayTask

public DeleteWirelessGatewayTaskResult deleteWirelessGatewayTask(DeleteWirelessGatewayTaskRequest request)

Deletes a wireless gateway task.

Specified by:

deleteWirelessGatewayTask in interface AWSIoTWireless

Parameters:

deleteWirelessGatewayTaskRequest -

Returns:

Result of the DeleteWirelessGatewayTask operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

deleteWirelessGatewayTaskDefinition

public DeleteWirelessGatewayTaskDefinitionResult deleteWirelessGatewayTaskDefinition(DeleteWirelessGatewayTaskDefinitionRequest request)

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

Specified by:

deleteWirelessGatewayTaskDefinition in interface AWSIoTWireless

Parameters:

deleteWirelessGatewayTaskDefinitionRequest -

Returns:

Result of the DeleteWirelessGatewayTaskDefinition operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

disassociateAwsAccountFromPartnerAccount

public DisassociateAwsAccountFromPartnerAccountResult disassociateAwsAccountFromPartnerAccount(DisassociateAwsAccountFromPartnerAccountRequest request)

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

Specified by:

disassociateAwsAccountFromPartnerAccount in interface AWSIoTWireless

Parameters:

disassociateAwsAccountFromPartnerAccountRequest -

Returns:

Result of the DisassociateAwsAccountFromPartnerAccount operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

disassociateWirelessDeviceFromThing

public DisassociateWirelessDeviceFromThingResult disassociateWirelessDeviceFromThing(DisassociateWirelessDeviceFromThingRequest request)

Disassociates a wireless device from its currently associated thing.

Specified by:

disassociateWirelessDeviceFromThing in interface AWSIoTWireless

Parameters:

disassociateWirelessDeviceFromThingRequest -

Returns:

Result of the DisassociateWirelessDeviceFromThing operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

InternalServerException - An unexpected error occurred while processing a request.

See Also:

AWS API Documentation

disassociateWirelessGatewayFromCertificate

public DisassociateWirelessGatewayFromCertificateResult disassociateWirelessGatewayFromCertificate(DisassociateWirelessGatewayFromCertificateRequest request)

Disassociates a wireless gateway from its currently associated certificate.

Specified by:

disassociateWirelessGatewayFromCertificate in interface AWSIoTWireless

Parameters:

disassociateWirelessGatewayFromCertificateRequest -

Returns:

Result of the DisassociateWirelessGatewayFromCertificate operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

disassociateWirelessGatewayFromThing

public DisassociateWirelessGatewayFromThingResult disassociateWirelessGatewayFromThing(DisassociateWirelessGatewayFromThingRequest request)

Disassociates a wireless gateway from its currently associated thing.

Specified by:

disassociateWirelessGatewayFromThing in interface AWSIoTWireless

Parameters:

disassociateWirelessGatewayFromThingRequest -

Returns:

Result of the DisassociateWirelessGatewayFromThing operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

InternalServerException - An unexpected error occurred while processing a request.

See Also:

AWS API Documentation

getDestination

public GetDestinationResult getDestination(GetDestinationRequest request)

Gets information about a destination.

Specified by:

getDestination in interface AWSIoTWireless

Parameters:

getDestinationRequest -

Returns:

Result of the GetDestination operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getDeviceProfile

public GetDeviceProfileResult getDeviceProfile(GetDeviceProfileRequest request)

Gets information about a device profile.

Specified by:

getDeviceProfile in interface AWSIoTWireless

Parameters:

getDeviceProfileRequest -

Returns:

Result of the GetDeviceProfile operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getPartnerAccount

public GetPartnerAccountResult getPartnerAccount(GetPartnerAccountRequest request)

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

Specified by:

getPartnerAccount in interface AWSIoTWireless

Parameters:

getPartnerAccountRequest -

Returns:

Result of the GetPartnerAccount operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getServiceEndpoint

public GetServiceEndpointResult getServiceEndpoint(GetServiceEndpointRequest request)

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

Specified by:

getServiceEndpoint in interface AWSIoTWireless

Parameters:

getServiceEndpointRequest -

Returns:

Result of the GetServiceEndpoint operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getServiceProfile

public GetServiceProfileResult getServiceProfile(GetServiceProfileRequest request)

Gets information about a service profile.

Specified by:

getServiceProfile in interface AWSIoTWireless

Parameters:

getServiceProfileRequest -

Returns:

Result of the GetServiceProfile operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessDevice

public GetWirelessDeviceResult getWirelessDevice(GetWirelessDeviceRequest request)

Gets information about a wireless device.

Specified by:

getWirelessDevice in interface AWSIoTWireless

Parameters:

getWirelessDeviceRequest -

Returns:

Result of the GetWirelessDevice operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessDeviceStatistics

public GetWirelessDeviceStatisticsResult getWirelessDeviceStatistics(GetWirelessDeviceStatisticsRequest request)

Gets operating information about a wireless device.

Specified by:

getWirelessDeviceStatistics in interface AWSIoTWireless

Parameters:

getWirelessDeviceStatisticsRequest -

Returns:

Result of the GetWirelessDeviceStatistics operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessGateway

public GetWirelessGatewayResult getWirelessGateway(GetWirelessGatewayRequest request)

Gets information about a wireless gateway.

Specified by:

getWirelessGateway in interface AWSIoTWireless

Parameters:

getWirelessGatewayRequest -

Returns:

Result of the GetWirelessGateway operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessGatewayCertificate

public GetWirelessGatewayCertificateResult getWirelessGatewayCertificate(GetWirelessGatewayCertificateRequest request)

Gets the ID of the certificate that is currently associated with a wireless gateway.

Specified by:

getWirelessGatewayCertificate in interface AWSIoTWireless

Parameters:

getWirelessGatewayCertificateRequest -

Returns:

Result of the GetWirelessGatewayCertificate operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessGatewayFirmwareInformation

public GetWirelessGatewayFirmwareInformationResult getWirelessGatewayFirmwareInformation(GetWirelessGatewayFirmwareInformationRequest request)

Gets the firmware version and other information about a wireless gateway.

Specified by:

getWirelessGatewayFirmwareInformation in interface AWSIoTWireless

Parameters:

getWirelessGatewayFirmwareInformationRequest -

Returns:

Result of the GetWirelessGatewayFirmwareInformation operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessGatewayStatistics

public GetWirelessGatewayStatisticsResult getWirelessGatewayStatistics(GetWirelessGatewayStatisticsRequest request)

Gets operating information about a wireless gateway.

Specified by:

getWirelessGatewayStatistics in interface AWSIoTWireless

Parameters:

getWirelessGatewayStatisticsRequest -

Returns:

Result of the GetWirelessGatewayStatistics operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessGatewayTask

public GetWirelessGatewayTaskResult getWirelessGatewayTask(GetWirelessGatewayTaskRequest request)

Gets information about a wireless gateway task.

Specified by:

getWirelessGatewayTask in interface AWSIoTWireless

Parameters:

getWirelessGatewayTaskRequest -

Returns:

Result of the GetWirelessGatewayTask operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getWirelessGatewayTaskDefinition

public GetWirelessGatewayTaskDefinitionResult getWirelessGatewayTaskDefinition(GetWirelessGatewayTaskDefinitionRequest request)

Gets information about a wireless gateway task definition.

Specified by:

getWirelessGatewayTaskDefinition in interface AWSIoTWireless

Parameters:

getWirelessGatewayTaskDefinitionRequest -

Returns:

Result of the GetWirelessGatewayTaskDefinition operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

listDestinations

public ListDestinationsResult listDestinations(ListDestinationsRequest request)

Lists the destinations registered to your AWS account.

Specified by:

listDestinations in interface AWSIoTWireless

Parameters:

listDestinationsRequest -

Returns:

Result of the ListDestinations operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

listDeviceProfiles

public ListDeviceProfilesResult listDeviceProfiles(ListDeviceProfilesRequest request)

Lists the device profiles registered to your AWS account.

Specified by:

listDeviceProfiles in interface AWSIoTWireless

Parameters:

listDeviceProfilesRequest -

Returns:

Result of the ListDeviceProfiles operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

listPartnerAccounts

public ListPartnerAccountsResult listPartnerAccounts(ListPartnerAccountsRequest request)

Lists the partner accounts associated with your AWS account.

Specified by:

listPartnerAccounts in interface AWSIoTWireless

Parameters:

listPartnerAccountsRequest -

Returns:

Result of the ListPartnerAccounts operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

listServiceProfiles

public ListServiceProfilesResult listServiceProfiles(ListServiceProfilesRequest request)

Lists the service profiles registered to your AWS account.

Specified by:

listServiceProfiles in interface AWSIoTWireless

Parameters:

listServiceProfilesRequest -

Returns:

Result of the ListServiceProfiles operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AWSIoTWireless

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

listWirelessDevices

public ListWirelessDevicesResult listWirelessDevices(ListWirelessDevicesRequest request)

Lists the wireless devices registered to your AWS account.

Specified by:

listWirelessDevices in interface AWSIoTWireless

Parameters:

listWirelessDevicesRequest -

Returns:

Result of the ListWirelessDevices operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

AccessDeniedException - User does not have permission to perform this action.

See Also:

AWS API Documentation

listWirelessGatewayTaskDefinitions

public ListWirelessGatewayTaskDefinitionsResult listWirelessGatewayTaskDefinitions(ListWirelessGatewayTaskDefinitionsRequest request)

List the wireless gateway tasks definitions registered to your AWS account.

Specified by:

listWirelessGatewayTaskDefinitions in interface AWSIoTWireless

Parameters:

listWirelessGatewayTaskDefinitionsRequest -

Returns:

Result of the ListWirelessGatewayTaskDefinitions operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

listWirelessGateways

public ListWirelessGatewaysResult listWirelessGateways(ListWirelessGatewaysRequest request)

Lists the wireless gateways registered to your AWS account.

Specified by:

listWirelessGateways in interface AWSIoTWireless

Parameters:

listWirelessGatewaysRequest -

Returns:

Result of the ListWirelessGateways operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

AccessDeniedException - User does not have permission to perform this action.

See Also:

AWS API Documentation

sendDataToWirelessDevice

public SendDataToWirelessDeviceResult sendDataToWirelessDevice(SendDataToWirelessDeviceRequest request)

Sends a decrypted application data frame to a device.

Specified by:

sendDataToWirelessDevice in interface AWSIoTWireless

Parameters:

sendDataToWirelessDeviceRequest -

Returns:

Result of the SendDataToWirelessDevice operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

InternalServerException - An unexpected error occurred while processing a request.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds a tag to a resource.

Specified by:

tagResource in interface AWSIoTWireless

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

TooManyTagsException - The request was denied because the resource can't have any more tags.

See Also:

AWS API Documentation

testWirelessDevice

public TestWirelessDeviceResult testWirelessDevice(TestWirelessDeviceRequest request)

Simulates a provisioned device by sending an uplink data payload of Hello.

Specified by:

testWirelessDevice in interface AWSIoTWireless

Parameters:

testWirelessDeviceRequest -

Returns:

Result of the TestWirelessDevice operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

InternalServerException - An unexpected error occurred while processing a request.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes one or more tags from a resource.

Specified by:

untagResource in interface AWSIoTWireless

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

ConflictException - Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

updateDestination

public UpdateDestinationResult updateDestination(UpdateDestinationRequest request)

Updates properties of a destination.

Specified by:

updateDestination in interface AWSIoTWireless

Parameters:

updateDestinationRequest -

Returns:

Result of the UpdateDestination operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

updatePartnerAccount

public UpdatePartnerAccountResult updatePartnerAccount(UpdatePartnerAccountRequest request)

Updates properties of a partner account.

Specified by:

updatePartnerAccount in interface AWSIoTWireless

Parameters:

updatePartnerAccountRequest -

Returns:

Result of the UpdatePartnerAccount operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

updateWirelessDevice

public UpdateWirelessDeviceResult updateWirelessDevice(UpdateWirelessDeviceRequest request)

Updates properties of a wireless device.

Specified by:

updateWirelessDevice in interface AWSIoTWireless

Parameters:

updateWirelessDeviceRequest -

Returns:

Result of the UpdateWirelessDevice operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

updateWirelessGateway

public UpdateWirelessGatewayResult updateWirelessGateway(UpdateWirelessGatewayRequest request)

Updates properties of a wireless gateway.

Specified by:

updateWirelessGateway in interface AWSIoTWireless

Parameters:

updateWirelessGatewayRequest -

Returns:

Result of the UpdateWirelessGateway operation returned by the service.

Throws:

ValidationException - The input did not meet the specified constraints.

ResourceNotFoundException - Resource does not exist.

AccessDeniedException - User does not have permission to perform this action.

InternalServerException - An unexpected error occurred while processing a request.

ThrottlingException - The request was denied because it exceeded the allowed API request rate.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSIoTWireless

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSIoTWireless

Overrides:

shutdown in class AmazonWebServiceClient