com.amazonaws.services.iotfleethub

Interface AWSIoTFleetHub

All Known Subinterfaces:

AWSIoTFleetHubAsync

All Known Implementing Classes:

AbstractAWSIoTFleetHub, AbstractAWSIoTFleetHubAsync, AWSIoTFleetHubAsyncClient, AWSIoTFleetHubClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTFleetHub

Interface for accessing AWS IoT Fleet Hub.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTFleetHub instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates a Fleet Hub for IoT Device Management web application.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes a Fleet Hub for IoT Device Management web application.
DescribeApplicationResult	describeApplication(DescribeApplicationRequest describeApplicationRequest) 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 listApplicationsRequest) Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 tagResourceRequest) Adds to or modifies the tags of the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags (metadata) from the resource.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates information about a Fleet Hub for IoT Device Management web application.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

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.

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

DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

Deletes a Fleet Hub for IoT Device Management web application.

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

DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest)

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

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

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

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

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags (metadata) from the resource.

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

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

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

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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