freetier

package module
v1.12.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2025 License: Apache-2.0 Imports: 45 Imported by: 5

Documentation

Overview

Package freetier provides the API client, operations, and parameter types for AWS Free Tier.

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:

For more information, see Using the Amazon Web Services Free Tier in the Billing User Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-09-07"
View Source 
const ServiceID = "FreeTier"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Free Tier.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) GetAccountActivity added in v1.9.0 

func (c *Client) GetAccountActivity(ctx context.Context, params *GetAccountActivityInput, optFns ...func(*Options)) (*GetAccountActivityOutput, error)

Returns a specific activity record that is available to the customer.

func (*Client) GetAccountPlanState added in v1.9.0 

func (c *Client) GetAccountPlanState(ctx context.Context, params *GetAccountPlanStateInput, optFns ...func(*Options)) (*GetAccountPlanStateOutput, error)
This returns all of the information related to the state of the account plan

related to Free Tier.

func (*Client) GetFreeTierUsage 

func (c *Client) GetFreeTierUsage(ctx context.Context, params *GetFreeTierUsageInput, optFns ...func(*Options)) (*GetFreeTierUsageOutput, error)

Returns a list of all Free Tier usage objects that match your filters.

func (*Client) ListAccountActivities added in v1.9.0 

func (c *Client) ListAccountActivities(ctx context.Context, params *ListAccountActivitiesInput, optFns ...func(*Options)) (*ListAccountActivitiesOutput, error)
Returns a list of activities that are available. This operation supports

pagination and filtering by status.

func (*Client) Options added in v1.1.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) UpgradeAccountPlan added in v1.9.0 

func (c *Client) UpgradeAccountPlan(ctx context.Context, params *UpgradeAccountPlanInput, optFns ...func(*Options)) (*UpgradeAccountPlanOutput, error)

The account plan type for the Amazon Web Services account.

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccountActivityInput added in v1.9.0 

type GetAccountActivityInput struct {

	//  A unique identifier that identifies the activity.
	//
	// This member is required.
	ActivityId *string

	//  The language code used to return translated title and description fields.
	LanguageCode types.LanguageCode
	// contains filtered or unexported fields
}

type GetAccountActivityOutput added in v1.9.0 

type GetAccountActivityOutput struct {

	//  A unique identifier that identifies the activity.
	//
	// This member is required.
	ActivityId *string

	//  Provides detailed information about the activity and its expected outcomes.
	//
	// This member is required.
	Description *string

	//  The URL resource that provides guidance on activity requirements and
	// completion.
	//
	// This member is required.
	InstructionsUrl *string

	//  A reward granted upon activity completion.
	//
	// This member is required.
	Reward types.ActivityReward

	//  The current activity status.
	//
	// This member is required.
	Status types.ActivityStatus

	//  A short activity title.
	//
	// This member is required.
	Title *string

	//  The timestamp when the activity is completed. This field appears only for
	// activities in the COMPLETED state.
	CompletedAt *time.Time

	//  The estimated time to complete the activity. This is the duration in minutes.
	EstimatedTimeToCompleteInMinutes *int32

	//  The time by which the activity must be completed to receive a reward.
	ExpiresAt *time.Time

	//  The timestamp when the activity started. This field appears only for
	// activities in the IN_PROGRESS or COMPLETED states.
	StartedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAccountPlanStateInput added in v1.9.0 

type GetAccountPlanStateInput struct {
	// contains filtered or unexported fields
}

type GetAccountPlanStateOutput added in v1.9.0 

type GetAccountPlanStateOutput struct {

	//  A unique identifier that identifies the account.
	//
	// This member is required.
	AccountId *string

	//  The current status for the account plan.
	//
	// This member is required.
	AccountPlanStatus types.AccountPlanStatus

	//  The plan type for the account.
	//
	// This member is required.
	AccountPlanType types.AccountPlanType

	//  The timestamp for when the current account plan expires.
	AccountPlanExpirationDate *time.Time

	//  The amount of credits remaining for the account.
	AccountPlanRemainingCredits *types.MonetaryAmount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFreeTierUsageAPIClient 

type GetFreeTierUsageAPIClient interface {
	GetFreeTierUsage(context.Context, *GetFreeTierUsageInput, ...func(*Options)) (*GetFreeTierUsageOutput, error)
}

GetFreeTierUsageAPIClient is a client that implements the GetFreeTierUsage operation.

type GetFreeTierUsageInput 

type GetFreeTierUsageInput struct {

	// An expression that specifies the conditions that you want each FreeTierUsage
	// object to meet.
	Filter *types.Expression

	// The maximum number of results to return in the response. MaxResults means that
	// there can be up to the specified number of values, but there might be fewer
	// results based on your filters.
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string
	// contains filtered or unexported fields
}

type GetFreeTierUsageOutput 

type GetFreeTierUsageOutput struct {

	// The list of Free Tier usage objects that meet your filter expression.
	//
	// This member is required.
	FreeTierUsages []types.FreeTierUsage

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFreeTierUsagePaginator 

type GetFreeTierUsagePaginator struct {
	// contains filtered or unexported fields
}

GetFreeTierUsagePaginator is a paginator for GetFreeTierUsage

func NewGetFreeTierUsagePaginator 

func NewGetFreeTierUsagePaginator(client GetFreeTierUsageAPIClient, params *GetFreeTierUsageInput, optFns ...func(*GetFreeTierUsagePaginatorOptions)) *GetFreeTierUsagePaginator

NewGetFreeTierUsagePaginator returns a new GetFreeTierUsagePaginator

func (*GetFreeTierUsagePaginator) HasMorePages 

func (p *GetFreeTierUsagePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetFreeTierUsagePaginator) NextPage 

func (p *GetFreeTierUsagePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFreeTierUsageOutput, error)

NextPage retrieves the next GetFreeTierUsage page.

type GetFreeTierUsagePaginatorOptions 

type GetFreeTierUsagePaginatorOptions struct {
	// The maximum number of results to return in the response. MaxResults means that
	// there can be up to the specified number of values, but there might be fewer
	// results based on your filters.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetFreeTierUsagePaginatorOptions is the paginator options for GetFreeTierUsage

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAccountActivitiesAPIClient added in v1.9.0 

type ListAccountActivitiesAPIClient interface {
	ListAccountActivities(context.Context, *ListAccountActivitiesInput, ...func(*Options)) (*ListAccountActivitiesOutput, error)
}

ListAccountActivitiesAPIClient is a client that implements the ListAccountActivities operation.

type ListAccountActivitiesInput added in v1.9.0 

type ListAccountActivitiesInput struct {

	//  The activity status filter. This field can be used to filter the response by
	// activities status.
	FilterActivityStatuses []types.ActivityStatus

	//  The language code used to return translated titles.
	LanguageCode types.LanguageCode

	//  The maximum number of items to return for this request. To get the next page
	// of items, make another request with the token returned in the output.
	MaxResults *int32

	//  A token from a previous paginated response. If this is specified, the response
	// includes records beginning from this token (inclusive), up to the number
	// specified by maxResults .
	NextToken *string
	// contains filtered or unexported fields
}

type ListAccountActivitiesOutput added in v1.9.0 

type ListAccountActivitiesOutput struct {

	//  A brief information about the activities.
	//
	// This member is required.
	Activities []types.ActivitySummary

	//  The token to include in another request to get the next page of items. This
	// value is null when there are no more items to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAccountActivitiesPaginator added in v1.9.0 

type ListAccountActivitiesPaginator struct {
	// contains filtered or unexported fields
}

ListAccountActivitiesPaginator is a paginator for ListAccountActivities

func NewListAccountActivitiesPaginator added in v1.9.0 

func NewListAccountActivitiesPaginator(client ListAccountActivitiesAPIClient, params *ListAccountActivitiesInput, optFns ...func(*ListAccountActivitiesPaginatorOptions)) *ListAccountActivitiesPaginator

NewListAccountActivitiesPaginator returns a new ListAccountActivitiesPaginator

func (*ListAccountActivitiesPaginator) HasMorePages added in v1.9.0 

func (p *ListAccountActivitiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccountActivitiesPaginator) NextPage added in v1.9.0 

func (p *ListAccountActivitiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccountActivitiesOutput, error)

NextPage retrieves the next ListAccountActivities page.

type ListAccountActivitiesPaginatorOptions added in v1.9.0 

type ListAccountActivitiesPaginatorOptions struct {
	//  The maximum number of items to return for this request. To get the next page
	// of items, make another request with the token returned in the output.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAccountActivitiesPaginatorOptions is the paginator options for ListAccountActivities

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type UpgradeAccountPlanInput added in v1.9.0 

type UpgradeAccountPlanInput struct {

	//  The target account plan type. This makes it explicit about the change and
	// latest value of the accountPlanType .
	//
	// This member is required.
	AccountPlanType types.AccountPlanType
	// contains filtered or unexported fields
}

type UpgradeAccountPlanOutput added in v1.9.0 

type UpgradeAccountPlanOutput struct {

	//  A unique identifier that identifies the account.
	//
	// This member is required.
	AccountId *string

	//  This indicates the latest state of the account plan within its lifecycle.
	//
	// This member is required.
	AccountPlanStatus types.AccountPlanStatus

	//  The type of plan for the account.
	//
	// This member is required.
	AccountPlanType types.AccountPlanType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.