Package software.amazon.awssdk.services.iotfleethub

Interface IoTFleetHubClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IoTFleetHubClient
extends AwsClient

Service client for accessing AWS IoT Fleet Hub. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static IoTFleetHubClientBuilder	builder()	Create a builder that can be used to configure and create a IoTFleetHubClient.
static IoTFleetHubClient	create()	Create a IoTFleetHubClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateApplicationResponse	createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)	Creates a Fleet Hub for IoT Device Management web application.
default CreateApplicationResponse	createApplication(CreateApplicationRequest createApplicationRequest)	Creates a Fleet Hub for IoT Device Management web application.
default DeleteApplicationResponse	deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)	Deletes a Fleet Hub for IoT Device Management web application.
default DeleteApplicationResponse	deleteApplication(DeleteApplicationRequest deleteApplicationRequest)	Deletes a Fleet Hub for IoT Device Management web application.
default DescribeApplicationResponse	describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest)	Gets information about a Fleet Hub for IoT Device Management web application.
default DescribeApplicationResponse	describeApplication(DescribeApplicationRequest describeApplicationRequest)	Gets information about a Fleet Hub for IoT Device Management web application.
default ListApplicationsResponse	listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)	Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
default ListApplicationsResponse	listApplications(ListApplicationsRequest listApplicationsRequest)	Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
default ListApplicationsIterable	listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)	This is a variant of listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation.
default ListApplicationsIterable	listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)	This is a variant of listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags for the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags for the specified resource.
default IoTFleetHubServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds to or modifies the tags of the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds to or modifies the tags of the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified tags (metadata) from the resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified tags (metadata) from the resource.
default UpdateApplicationResponse	updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)	Updates information about a Fleet Hub for IoT Device Management web application.
default UpdateApplicationResponse	updateApplication(UpdateApplicationRequest updateApplicationRequest)	Updates information about a Fleet Hub for IoT Device Management web application.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createApplication

default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest)
                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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.

See Also:

• AWS API Documentation

createApplication

default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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.

This is a convenience which creates an instance of the CreateApplicationRequest.Builder avoiding the need to create one manually via CreateApplicationRequest.builder()

Parameters:

createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

Deletes a Fleet Hub for IoT Device Management web application.

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

Deletes a Fleet Hub for IoT Device Management web application.

This is a convenience which creates an instance of the DeleteApplicationRequest.Builder avoiding the need to create one manually via DeleteApplicationRequest.builder()

Parameters:

deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

describeApplication

default DescribeApplicationResponse describeApplication(DescribeApplicationRequest describeApplicationRequest)
                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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

Parameters:

describeApplicationRequest -

Returns:

Result of the DescribeApplication operation returned by the service.

See Also:

• AWS API Documentation

describeApplication

default DescribeApplicationResponse describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest)
                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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

This is a convenience which creates an instance of the DescribeApplicationRequest.Builder avoiding the need to create one manually via DescribeApplicationRequest.builder()

Parameters:

describeApplicationRequest - A Consumer that will call methods on DescribeApplicationRequest.Builder to create a request.

Returns:

Result of the DescribeApplication operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest)
                                           throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
                                           throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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

This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

Parameters:

listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.

Returns:

Result of the ListApplications operation returned by the service.

See Also:

• AWS API Documentation

listApplicationsPaginator

default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)
                                                    throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

This is a variant of listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client
             .listApplicationsPaginator(request);
     for (software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation.

Parameters:

listApplicationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listApplicationsPaginator

default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
                                                    throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

This is a variant of listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client
             .listApplicationsPaginator(request);
     for (software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation.

This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

Parameters:

listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalFailureException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalFailureException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

Lists the tags for the specified resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalFailureException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalFailureException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalFailureException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

Removes the specified tags (metadata) from the resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalFailureException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

Removes the specified tags (metadata) from the resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTFleetHubException

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

This is a convenience which creates an instance of the UpdateApplicationRequest.Builder avoiding the need to create one manually via UpdateApplicationRequest.builder()

Parameters:

updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.

Returns:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

create

static IoTFleetHubClient create()

Create a IoTFleetHubClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IoTFleetHubClientBuilder builder()

Create a builder that can be used to configure and create a IoTFleetHubClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IoTFleetHubServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration