AWSIoT1ClickDevicesClient (AWS Java SDK for AWS IoT 1-Click Devices 1.12.726 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.iot1clickdevices.AWSIoT1ClickDevicesClient

All Implemented Interfaces:

AWSIoT1ClickDevices

Direct Known Subclasses:

AWSIoT1ClickDevicesAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoT1ClickDevicesClient
extends AmazonWebServiceClient
implements AWSIoT1ClickDevices
```
Client for accessing AWS IoT 1-Click Devices Service. All service calls made using this client are blocking, and will not return until the service call completes.

Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.iot1clickdevices.AWSIoT1ClickDevices
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSIoT1ClickDevicesClientBuilder`	`builder()`
`ClaimDevicesByClaimCodeResult`	`claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest request)` Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).
`DescribeDeviceResult`	`describeDevice(DescribeDeviceRequest request)` Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
`FinalizeDeviceClaimResult`	`finalizeDeviceClaim(FinalizeDeviceClaimRequest request)` Given a device ID, finalizes the claim request for the associated device.
`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.
`GetDeviceMethodsResult`	`getDeviceMethods(GetDeviceMethodsRequest request)` Given a device ID, returns the invokable methods associated with the device.
`InitiateDeviceClaimResult`	`initiateDeviceClaim(InitiateDeviceClaimRequest request)` Given a device ID, initiates a claim request for the associated device.
`InvokeDeviceMethodResult`	`invokeDeviceMethod(InvokeDeviceMethodRequest request)` Given a device ID, issues a request to invoke a named device method (with possible parameters).
`ListDeviceEventsResult`	`listDeviceEvents(ListDeviceEventsRequest request)` Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
`ListDevicesResult`	`listDevices(ListDevicesRequest request)` Lists the 1-Click compatible devices associated with your AWS account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags associated with the specified resource ARN.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or updates the tags associated with the resource ARN.
`UnclaimDeviceResult`	`unclaimDevice(UnclaimDeviceRequest request)` Disassociates a device from your AWS account using its device ID.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
`UpdateDeviceStateResult`	`updateDeviceState(UpdateDeviceStateRequest request)` Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

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

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AWSIoT1ClickDevicesClientBuilder builder()
```
  - claimDevicesByClaimCode
```
public ClaimDevicesByClaimCodeResult claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest request)
```
    Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).
    
    Specified by:
    
    claimDevicesByClaimCode in interface AWSIoT1ClickDevices
    
    Parameters:
    
    claimDevicesByClaimCodeRequest -
    
    Returns:
    
    Result of the ClaimDevicesByClaimCode operation returned by the service.
    
    Throws:
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    ForbiddenException - 403 response
    
    See Also:
    
    AWS API Documentation
  - describeDevice
```
public DescribeDeviceResult describeDevice(DescribeDeviceRequest request)
```
    Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
    
    Specified by:
    
    describeDevice in interface AWSIoT1ClickDevices
    
    Parameters:
    
    describeDeviceRequest -
    
    Returns:
    
    Result of the DescribeDevice operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - finalizeDeviceClaim
```
public FinalizeDeviceClaimResult finalizeDeviceClaim(FinalizeDeviceClaimRequest request)
```
    Given a device ID, finalizes the claim request for the associated device.
    
    Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
    
    Specified by:
    
    finalizeDeviceClaim in interface AWSIoT1ClickDevices
    
    Parameters:
    
    finalizeDeviceClaimRequest -
    
    Returns:
    
    Result of the FinalizeDeviceClaim operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    PreconditionFailedException - 412 response
    
    ResourceConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - getDeviceMethods
```
public GetDeviceMethodsResult getDeviceMethods(GetDeviceMethodsRequest request)
```
    Given a device ID, returns the invokable methods associated with the device.
    
    Specified by:
    
    getDeviceMethods in interface AWSIoT1ClickDevices
    
    Parameters:
    
    getDeviceMethodsRequest -
    
    Returns:
    
    Result of the GetDeviceMethods operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - initiateDeviceClaim
```
public InitiateDeviceClaimResult initiateDeviceClaim(InitiateDeviceClaimRequest request)
```
    Given a device ID, initiates a claim request for the associated device.
    
    Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
    
    Specified by:
    
    initiateDeviceClaim in interface AWSIoT1ClickDevices
    
    Parameters:
    
    initiateDeviceClaimRequest -
    
    Returns:
    
    Result of the InitiateDeviceClaim operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    ResourceConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - invokeDeviceMethod
```
public InvokeDeviceMethodResult invokeDeviceMethod(InvokeDeviceMethodRequest request)
```
    Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
    
    Specified by:
    
    invokeDeviceMethod in interface AWSIoT1ClickDevices
    
    Parameters:
    
    invokeDeviceMethodRequest -
    
    Returns:
    
    Result of the InvokeDeviceMethod operation returned by the service.
    
    Throws:
    
    InvalidRequestException - 400 response
    
    PreconditionFailedException - 412 response
    
    InternalFailureException - 500 response
    
    ResourceNotFoundException - 404 response
    
    RangeNotSatisfiableException - 416 response
    
    ResourceConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - listDeviceEvents
```
public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
```
    Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
    
    Specified by:
    
    listDeviceEvents in interface AWSIoT1ClickDevices
    
    Parameters:
    
    listDeviceEventsRequest -
    
    Returns:
    
    Result of the ListDeviceEvents operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    RangeNotSatisfiableException - 416 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - listDevices
```
public ListDevicesResult listDevices(ListDevicesRequest request)
```
    Lists the 1-Click compatible devices associated with your AWS account.
    
    Specified by:
    
    listDevices in interface AWSIoT1ClickDevices
    
    Parameters:
    
    listDevicesRequest -
    
    Returns:
    
    Result of the ListDevices operation returned by the service.
    
    Throws:
    
    RangeNotSatisfiableException - 416 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags associated with the specified resource ARN.
    
    Specified by:
    
    listTagsForResource in interface AWSIoT1ClickDevices
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.
    
    Specified by:
    
    tagResource in interface AWSIoT1ClickDevices
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - unclaimDevice
```
public UnclaimDeviceResult unclaimDevice(UnclaimDeviceRequest request)
```
    Disassociates a device from your AWS account using its device ID.
    
    Specified by:
    
    unclaimDevice in interface AWSIoT1ClickDevices
    
    Parameters:
    
    unclaimDeviceRequest -
    
    Returns:
    
    Result of the UnclaimDevice operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
    
    Specified by:
    
    untagResource in interface AWSIoT1ClickDevices
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    See Also:
    
    AWS API Documentation
  - updateDeviceState
```
public UpdateDeviceStateResult updateDeviceState(UpdateDeviceStateRequest request)
```
    Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
    
    Specified by:
    
    updateDeviceState in interface AWSIoT1ClickDevices
    
    Parameters:
    
    updateDeviceStateRequest -
    
    Returns:
    
    Result of the UpdateDeviceState operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    InvalidRequestException - 400 response
    
    InternalFailureException - 500 response
    
    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 AWSIoT1ClickDevices
    
    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 interface: AWSIoT1ClickDevices
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSIoT1ClickDevices
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AWSIoT1ClickDevicesClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.iot1clickdevices.AWSIoT1ClickDevices

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

claimDevicesByClaimCode

describeDevice

finalizeDeviceClaim

getDeviceMethods

initiateDeviceClaim

invokeDeviceMethod

listDeviceEvents

listDevices

listTagsForResource

tagResource

unclaimDevice

untagResource

updateDeviceState

getCachedResponseMetadata

shutdown