Interface IoTFleetHubClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic IoTFleetHubClientBuilder
builder()
Create a builder that can be used to configure and create aIoTFleetHubClient
.static IoTFleetHubClient
create()
Create aIoTFleetHubClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateApplicationResponse
createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates a Fleet Hub for AWS IoT Device Management web application.default CreateApplicationResponse
createApplication
(CreateApplicationRequest createApplicationRequest) Creates a Fleet Hub for AWS IoT Device Management web application.default DeleteApplicationResponse
deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes a Fleet Hub for AWS IoT Device Management web application.default DeleteApplicationResponse
deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes a Fleet Hub for AWS IoT Device Management web application.default DescribeApplicationResponse
describeApplication
(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest) Gets information about a Fleet Hub for AWS IoT Device Management web application.default DescribeApplicationResponse
describeApplication
(DescribeApplicationRequest describeApplicationRequest) Gets information about a Fleet Hub for AWS IoT Device Management web application.default ListApplicationsResponse
listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.default ListApplicationsResponse
listApplications
(ListApplicationsRequest listApplicationsRequest) Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.default ListApplicationsIterable
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest)
operation.default ListApplicationsIterable
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 a AWS IoT Device Management web application.default UpdateApplicationResponse
updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates information about a Fleet Hub for a AWS 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
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createApplication
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTFleetHubException Creates a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
createApplicationRequest
-- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
-
createApplication
default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTFleetHubException Creates a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request.- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
-
deleteApplication
default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Deletes a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
deleteApplicationRequest
-- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
-
deleteApplication
default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Deletes a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request.- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
-
describeApplication
default DescribeApplicationResponse describeApplication(DescribeApplicationRequest describeApplicationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Gets information about a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
describeApplicationRequest
-- Returns:
- Result of the DescribeApplication operation returned by the service.
- See Also:
-
describeApplication
default DescribeApplicationResponse describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Gets information about a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
DescribeApplicationRequest.Builder
avoiding the need to create one manually viaDescribeApplicationRequest.builder()
- Parameters:
describeApplicationRequest
- AConsumer
that will call methods onDescribeApplicationRequest.Builder
to create a request.- Returns:
- Result of the DescribeApplication operation returned by the service.
- See Also:
-
listApplications
default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
listApplicationsRequest
-- Returns:
- Result of the ListApplications operation returned by the service.
- See Also:
-
listApplications
default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- Result of the ListApplications operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTFleetHubException Lists the tags for the specified resource.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTFleetHubException Lists the tags for the specified resource.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTFleetHubException Removes the specified tags (metadata) from the resource.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTFleetHubException Removes the specified tags (metadata) from the resource.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateApplication
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Updates information about a Fleet Hub for a AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
- Parameters:
updateApplicationRequest
-- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
-
updateApplication
default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException Updates information about a Fleet Hub for a AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request.- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
-
create
Create aIoTFleetHubClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIoTFleetHubClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-