Interface FreeTierClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
You can use the Amazon Web Services Free Tier API to query programmatically your Free Tier usage data.
Free Tier tracks your monthly usage data for all free tier offers that are associated with your Amazon Web Services account. You can use the Free Tier API to filter and show only the data that you want.
Service endpoint
The Free Tier API provides the following endpoint:
-
https://freetier.us-east-1.api.aws
For more information, see Using the Amazon Web Services Free Tier in the Billing User Guide.
-
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 FreeTierClientBuilder
builder()
Create a builder that can be used to configure and create aFreeTierClient
.static FreeTierClient
create()
Create aFreeTierClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default GetFreeTierUsageResponse
getFreeTierUsage
(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest) Returns a list of all Free Tier usage objects that match your filters.default GetFreeTierUsageResponse
getFreeTierUsage
(GetFreeTierUsageRequest getFreeTierUsageRequest) Returns a list of all Free Tier usage objects that match your filters.default GetFreeTierUsageIterable
getFreeTierUsagePaginator
(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest) This is a variant ofgetFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest)
operation.default GetFreeTierUsageIterable
getFreeTierUsagePaginator
(GetFreeTierUsageRequest getFreeTierUsageRequest) This is a variant ofgetFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
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
-
getFreeTierUsage
default GetFreeTierUsageResponse getFreeTierUsage(GetFreeTierUsageRequest getFreeTierUsageRequest) throws InternalServerException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, FreeTierException Returns a list of all Free Tier usage objects that match your filters.
- Parameters:
getFreeTierUsageRequest
-- Returns:
- Result of the GetFreeTierUsage operation returned by the service.
- See Also:
-
getFreeTierUsage
default GetFreeTierUsageResponse getFreeTierUsage(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest) throws InternalServerException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, FreeTierException Returns a list of all Free Tier usage objects that match your filters.
This is a convenience which creates an instance of the
GetFreeTierUsageRequest.Builder
avoiding the need to create one manually viaGetFreeTierUsageRequest.builder()
- Parameters:
getFreeTierUsageRequest
- AConsumer
that will call methods onGetFreeTierUsageRequest.Builder
to create a request.- Returns:
- Result of the GetFreeTierUsage operation returned by the service.
- See Also:
-
getFreeTierUsagePaginator
default GetFreeTierUsageIterable getFreeTierUsagePaginator(GetFreeTierUsageRequest getFreeTierUsageRequest) throws InternalServerException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, FreeTierException This is a variant of
getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest)
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.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client .getFreeTierUsagePaginator(request); for (software.amazon.awssdk.services.freetier.model.GetFreeTierUsageResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest)
operation.- Parameters:
getFreeTierUsageRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getFreeTierUsagePaginator
default GetFreeTierUsageIterable getFreeTierUsagePaginator(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest) throws InternalServerException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, FreeTierException This is a variant of
getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest)
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.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client .getFreeTierUsagePaginator(request); for (software.amazon.awssdk.services.freetier.model.GetFreeTierUsageResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest)
operation.
This is a convenience which creates an instance of the
GetFreeTierUsageRequest.Builder
avoiding the need to create one manually viaGetFreeTierUsageRequest.builder()
- Parameters:
getFreeTierUsageRequest
- AConsumer
that will call methods onGetFreeTierUsageRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
create
Create aFreeTierClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aFreeTierClient
. -
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
-