software.amazon.awssdk.services.iotfleethub.IoTFleetHubClient Maven / Gradle / Ivy
Show all versions of iotfleethub Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.iotfleethub;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.iotfleethub.model.ConflictException;
import software.amazon.awssdk.services.iotfleethub.model.CreateApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.CreateApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.model.DeleteApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.DeleteApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.model.DescribeApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.DescribeApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.model.InternalFailureException;
import software.amazon.awssdk.services.iotfleethub.model.InvalidRequestException;
import software.amazon.awssdk.services.iotfleethub.model.IoTFleetHubException;
import software.amazon.awssdk.services.iotfleethub.model.LimitExceededException;
import software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest;
import software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse;
import software.amazon.awssdk.services.iotfleethub.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.iotfleethub.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.iotfleethub.model.ResourceNotFoundException;
import software.amazon.awssdk.services.iotfleethub.model.TagResourceRequest;
import software.amazon.awssdk.services.iotfleethub.model.TagResourceResponse;
import software.amazon.awssdk.services.iotfleethub.model.ThrottlingException;
import software.amazon.awssdk.services.iotfleethub.model.UntagResourceRequest;
import software.amazon.awssdk.services.iotfleethub.model.UntagResourceResponse;
import software.amazon.awssdk.services.iotfleethub.model.UpdateApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.UpdateApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsIterable;
/**
* Service client for accessing AWS IoT Fleet Hub. This can be created using the static {@link #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.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface IoTFleetHubClient extends SdkClient {
String SERVICE_NAME = "iotfleethub";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "api.fleethub.iot";
/**
* Create a {@link IoTFleetHubClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static IoTFleetHubClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link IoTFleetHubClient}.
*/
static IoTFleetHubClientBuilder builder() {
return new DefaultIoTFleetHubClientBuilder();
}
/**
*
* 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.
*
*
*
* @param createApplicationRequest
* @return Result of the CreateApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.CreateApplication
* @see AWS
* API Documentation
*/
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest)
throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException,
AwsServiceException, SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateApplicationRequest.Builder} avoiding the need
* to create one manually via {@link CreateApplicationRequest#builder()}
*
*
* @param createApplicationRequest
* A {@link Consumer} that will call methods on {@link CreateApplicationRequest.Builder} to create a request.
* @return Result of the CreateApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.CreateApplication
* @see AWS
* API Documentation
*/
default CreateApplicationResponse createApplication(Consumer createApplicationRequest)
throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException,
AwsServiceException, SdkClientException, IoTFleetHubException {
return createApplication(CreateApplicationRequest.builder().applyMutation(createApplicationRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteApplicationRequest
* @return Result of the DeleteApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.DeleteApplication
* @see AWS
* API Documentation
*/
default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException,
AwsServiceException, SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteApplicationRequest.Builder} avoiding the need
* to create one manually via {@link DeleteApplicationRequest#builder()}
*
*
* @param deleteApplicationRequest
* A {@link Consumer} that will call methods on {@link DeleteApplicationRequest.Builder} to create a request.
* @return Result of the DeleteApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.DeleteApplication
* @see AWS
* API Documentation
*/
default DeleteApplicationResponse deleteApplication(Consumer deleteApplicationRequest)
throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException,
AwsServiceException, SdkClientException, IoTFleetHubException {
return deleteApplication(DeleteApplicationRequest.builder().applyMutation(deleteApplicationRequest).build());
}
/**
*
* 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.
*
*
*
* @param describeApplicationRequest
* @return Result of the DescribeApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.DescribeApplication
* @see AWS API Documentation
*/
default DescribeApplicationResponse describeApplication(DescribeApplicationRequest describeApplicationRequest)
throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException,
AwsServiceException, SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeApplicationRequest.Builder} avoiding the
* need to create one manually via {@link DescribeApplicationRequest#builder()}
*
*
* @param describeApplicationRequest
* A {@link Consumer} that will call methods on {@link DescribeApplicationRequest.Builder} to create a
* request.
* @return Result of the DescribeApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.DescribeApplication
* @see AWS API Documentation
*/
default DescribeApplicationResponse describeApplication(
Consumer describeApplicationRequest) throws InvalidRequestException,
ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException,
IoTFleetHubException {
return describeApplication(DescribeApplicationRequest.builder().applyMutation(describeApplicationRequest).build());
}
/**
*
* 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.
*
*
*
* @param listApplicationsRequest
* @return Result of the ListApplications operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.ListApplications
* @see AWS
* API Documentation
*/
default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest)
throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException,
SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListApplicationsRequest.Builder} avoiding the need
* to create one manually via {@link ListApplicationsRequest#builder()}
*
*
* @param listApplicationsRequest
* A {@link Consumer} that will call methods on {@link ListApplicationsRequest.Builder} to create a request.
* @return Result of the ListApplications operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.ListApplications
* @see AWS
* API Documentation
*/
default ListApplicationsResponse listApplications(Consumer listApplicationsRequest)
throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException,
SdkClientException, IoTFleetHubException {
return listApplications(ListApplicationsRequest.builder().applyMutation(listApplicationsRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest)}
* operation.
*
*
* @param listApplicationsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.ListApplications
* @see AWS
* API Documentation
*/
default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)
throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException,
SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListApplicationsRequest.Builder} avoiding the need
* to create one manually via {@link ListApplicationsRequest#builder()}
*
*
* @param listApplicationsRequest
* A {@link Consumer} that will call methods on {@link ListApplicationsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.ListApplications
* @see AWS
* API Documentation
*/
default ListApplicationsIterable listApplicationsPaginator(Consumer listApplicationsRequest)
throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException,
SdkClientException, IoTFleetHubException {
return listApplicationsPaginator(ListApplicationsRequest.builder().applyMutation(listApplicationsRequest).build());
}
/**
*
* Lists the tags for the specified resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws InternalFailureException,
InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTFleetHubException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* 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.
*
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalFailureException,
InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IoTFleetHubException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes the specified tags (metadata) from the resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalFailureException,
InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IoTFleetHubException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* 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.
*
*
*
* @param updateApplicationRequest
* @return Result of the UpdateApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ConflictException
* The request conflicts with the current state of the resource.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.UpdateApplication
* @see AWS
* API Documentation
*/
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest)
throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ConflictException,
ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateApplicationRequest.Builder} avoiding the need
* to create one manually via {@link UpdateApplicationRequest#builder()}
*
*
* @param updateApplicationRequest
* A {@link Consumer} that will call methods on {@link UpdateApplicationRequest.Builder} to create a request.
* @return Result of the UpdateApplication operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ConflictException
* The request conflicts with the current state of the resource.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IoTFleetHubException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IoTFleetHubClient.UpdateApplication
* @see AWS
* API Documentation
*/
default UpdateApplicationResponse updateApplication(Consumer updateApplicationRequest)
throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ConflictException,
ThrottlingException, AwsServiceException, SdkClientException, IoTFleetHubException {
return updateApplication(UpdateApplicationRequest.builder().applyMutation(updateApplicationRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
}