savingsplans – github.com/aws/aws-sdk-go-v2/service/savingsplans Index | Files | Directories

package savingsplans

import "github.com/aws/aws-sdk-go-v2/service/savingsplans"

Index

Constants

const ServiceAPIVersion = "2019-06-28"
const ServiceID = "savingsplans"

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type Client

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

Savings Plans are a pricing model that offer significant savings on AWS usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For more information, see the AWS Savings Plans User Guide (https://docs.aws.amazon.com/savingsplans/latest/userguide/).

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) CreateSavingsPlan

func (c *Client) CreateSavingsPlan(ctx context.Context, params *CreateSavingsPlanInput, optFns ...func(*Options)) (*CreateSavingsPlanOutput, error)

Creates a Savings Plan.

func (*Client) DescribeSavingsPlanRates

func (c *Client) DescribeSavingsPlanRates(ctx context.Context, params *DescribeSavingsPlanRatesInput, optFns ...func(*Options)) (*DescribeSavingsPlanRatesOutput, error)

Describes the specified Savings Plans rates.

func (*Client) DescribeSavingsPlans

func (c *Client) DescribeSavingsPlans(ctx context.Context, params *DescribeSavingsPlansInput, optFns ...func(*Options)) (*DescribeSavingsPlansOutput, error)

Describes the specified Savings Plans.

func (*Client) DescribeSavingsPlansOfferingRates

func (c *Client) DescribeSavingsPlansOfferingRates(ctx context.Context, params *DescribeSavingsPlansOfferingRatesInput, optFns ...func(*Options)) (*DescribeSavingsPlansOfferingRatesOutput, error)

Describes the specified Savings Plans offering rates.

func (*Client) DescribeSavingsPlansOfferings

func (c *Client) DescribeSavingsPlansOfferings(ctx context.Context, params *DescribeSavingsPlansOfferingsInput, optFns ...func(*Options)) (*DescribeSavingsPlansOfferingsOutput, error)

Describes the specified Savings Plans offerings.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags for the specified resource.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds the specified tags to the specified resource.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the specified tags from the specified resource.

type CreateSavingsPlanInput

type CreateSavingsPlanInput struct {
	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientToken *string
	// The ID of the offering.
	SavingsPlanOfferingId *string
	// The hourly commitment, in USD. This is a value between 0.001 and 1 million. You
	// cannot specify more than three digits after the decimal point.
	Commitment *string
	// The up-front payment amount. This is a whole number between 50 and 99 percent of
	// the total value of the Savings Plan. This parameter is supported only if the
	// payment option is Partial Upfront.
	UpfrontPaymentAmount *string
	// One or more tags.
	Tags map[string]*string
}

type CreateSavingsPlanOutput

type CreateSavingsPlanOutput struct {
	// The ID of the Savings Plan.
	SavingsPlanId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSavingsPlanRatesInput

type DescribeSavingsPlanRatesInput struct {
	// The maximum number of results to return with a single call. To retrieve
	// additional results, make another call with the returned token value.
	MaxResults *int32
	// The ID of the Savings Plan.
	SavingsPlanId *string
	// The token for the next page of results.
	NextToken *string
	// The filters.
	Filters []*types.SavingsPlanRateFilter
}

type DescribeSavingsPlanRatesOutput

type DescribeSavingsPlanRatesOutput struct {
	// Information about the Savings Plans rates.
	SearchResults []*types.SavingsPlanRate
	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string
	// The ID of the Savings Plan.
	SavingsPlanId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSavingsPlansInput

type DescribeSavingsPlansInput struct {
	// The maximum number of results to return with a single call. To retrieve
	// additional results, make another call with the returned token value.
	MaxResults *int32
	// The Amazon Resource Names (ARN) of the Savings Plans.
	SavingsPlanArns []*string
	// The IDs of the Savings Plans.
	SavingsPlanIds []*string
	// The token for the next page of results.
	NextToken *string
	// The states.
	States []types.SavingsPlanState
	// The filters.
	Filters []*types.SavingsPlanFilter
}

type DescribeSavingsPlansOfferingRatesInput

type DescribeSavingsPlansOfferingRatesInput struct {
	// The services.
	ServiceCodes []types.SavingsPlanRateServiceCode
	// The payment options.
	SavingsPlanPaymentOptions []types.SavingsPlanPaymentOption
	// The AWS products.
	Products []types.SavingsPlanProductType
	// The token for the next page of results.
	NextToken *string
	// The IDs of the offerings.
	SavingsPlanOfferingIds []*string
	// The maximum number of results to return with a single call. To retrieve
	// additional results, make another call with the returned token value.
	MaxResults *int32
	// The usage details of the line item in the billing report.
	UsageTypes []*string
	// The specific AWS operation for the line item in the billing report.
	Operations []*string
	// The plan types.
	SavingsPlanTypes []types.SavingsPlanType
	// The filters.
	Filters []*types.SavingsPlanOfferingRateFilterElement
}

type DescribeSavingsPlansOfferingRatesOutput

type DescribeSavingsPlansOfferingRatesOutput struct {
	// Information about the Savings Plans offering rates.
	SearchResults []*types.SavingsPlanOfferingRate
	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSavingsPlansOfferingsInput

type DescribeSavingsPlansOfferingsInput struct {
	// The descriptions.
	Descriptions []*string
	// The IDs of the offerings.
	OfferingIds []*string
	// The currencies.
	Currencies []types.CurrencyCode
	// The usage details of the line item in the billing report.
	UsageTypes []*string
	// The plan type.
	PlanTypes []types.SavingsPlanType
	// The durations, in seconds.
	Durations []*int64
	// The payment options.
	PaymentOptions []types.SavingsPlanPaymentOption
	// The specific AWS operation for the line item in the billing report.
	Operations []*string
	// The filters.
	Filters []*types.SavingsPlanOfferingFilterElement
	// The product type.
	ProductType types.SavingsPlanProductType
	// The services.
	ServiceCodes []*string
	// The maximum number of results to return with a single call. To retrieve
	// additional results, make another call with the returned token value.
	MaxResults *int32
	// The token for the next page of results.
	NextToken *string
}

type DescribeSavingsPlansOfferingsOutput

type DescribeSavingsPlansOfferingsOutput struct {
	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string
	// Information about the Savings Plans offerings.
	SearchResults []*types.SavingsPlanOffering

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSavingsPlansOutput

type DescribeSavingsPlansOutput struct {
	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string
	// Information about the Savings Plans.
	SavingsPlans []*types.SavingsPlan

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)

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) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// Information about the tags.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

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

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetIdempotencyTokenProvider

func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type TagResourceInput

type TagResourceInput struct {
	// One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags map[string]*string
	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {
	// The tag keys.
	TagKeys []*string
	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_CreateSavingsPlan.go api_op_DescribeSavingsPlanRates.go api_op_DescribeSavingsPlans.go api_op_DescribeSavingsPlansOfferingRates.go api_op_DescribeSavingsPlansOfferings.go api_op_ListTagsForResource.go api_op_TagResource.go api_op_UntagResource.go deserializers.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.1.0
Published
Sep 29, 2020
Platform
js/wasm
Imports
26 packages
Last checked
now

Tools for package owners.