com.amazonaws.services.iotfleethub

Class AWSIoTFleetHubClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotfleethub.AWSIoTFleetHubClient

All Implemented Interfaces:

AWSIoTFleetHub

Direct Known Subclasses:

AWSIoTFleetHubAsyncClient

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

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

With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.iotfleethub.AWSIoTFleetHub

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSIoTFleetHubClientBuilder	builder()
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates a Fleet Hub for IoT Device Management web application.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes a Fleet Hub for IoT Device Management web application.
DescribeApplicationResult	describeApplication(DescribeApplicationRequest request) Gets information about a Fleet Hub for IoT Device Management web application.
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.
ListApplicationsResult	listApplications(ListApplicationsRequest request) Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds to or modifies the tags of the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags (metadata) from the resource.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates information about a Fleet Hub for IoT Device Management web application.

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 AWSIoTFleetHubClientBuilder builder()

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

Creates a Fleet Hub for IoT Device Management web application.

When creating a Fleet Hub application, you must create an organization instance of IAM Identity Center if you don't already have one. The Fleet Hub application you create must also be in the same Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see Enabling IAM Identity Center and Organization instances of IAM Identity Center.

Specified by:

createApplication in interface AWSIoTFleetHub

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalFailureException - An unexpected error has occurred.

ThrottlingException - The rate exceeds the limit.

LimitExceededException - A limit has been exceeded.

See Also:

AWS API Documentation

deleteApplication

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

Deletes a Fleet Hub for IoT Device Management web application.

Specified by:

deleteApplication in interface AWSIoTFleetHub

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

InternalFailureException - An unexpected error has occurred.

ThrottlingException - The rate exceeds the limit.

See Also:

AWS API Documentation

describeApplication

public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)

Gets information about a Fleet Hub for IoT Device Management web application.

Specified by:

describeApplication in interface AWSIoTFleetHub

Parameters:

describeApplicationRequest -

Returns:

Result of the DescribeApplication operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

InternalFailureException - An unexpected error has occurred.

ThrottlingException - The rate exceeds the limit.

See Also:

AWS API Documentation

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Gets a list of Fleet Hub for IoT Device Management web applications for the current account.

Specified by:

listApplications in interface AWSIoTFleetHub

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalFailureException - An unexpected error has occurred.

ThrottlingException - The rate exceeds the limit.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AWSIoTFleetHub

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalFailureException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

Specified by:

tagResource in interface AWSIoTFleetHub

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalFailureException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags (metadata) from the resource.

Specified by:

untagResource in interface AWSIoTFleetHub

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalFailureException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

updateApplication

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Updates information about a Fleet Hub for IoT Device Management web application.

Specified by:

updateApplication in interface AWSIoTFleetHub

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

InternalFailureException - An unexpected error has occurred.

ConflictException - The request conflicts with the current state of the resource.

ThrottlingException - The rate exceeds the limit.

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 AWSIoTFleetHub

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 AWSIoTFleetHub

Overrides:

shutdown in class AmazonWebServiceClient