Documentation

Overview

    Package savingsplans provides the API client, operations, and parameter types for AWS Savings Plans.

    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/).

    Index

    Constants

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

    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

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

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

            Client provides the API client to make operations call for AWS Savings Plans.

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

                  func (c *Client) DeleteQueuedSavingsPlan(ctx context.Context, params *DeleteQueuedSavingsPlanInput, optFns ...func(*Options)) (*DeleteQueuedSavingsPlanOutput, error)

                    Deletes the queued purchase for the specified 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 {
                                  
                                  	// 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.
                                  	//
                                  	// This member is required.
                                  	Commitment *string
                                  
                                  	// The ID of the offering.
                                  	//
                                  	// This member is required.
                                  	SavingsPlanOfferingId *string
                                  
                                  	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
                                  	// the request.
                                  	ClientToken *string
                                  
                                  	// The time at which to purchase the Savings Plan, in UTC format
                                  	// (YYYY-MM-DDTHH:MM:SSZ).
                                  	PurchaseTime *time.Time
                                  
                                  	// One or more tags.
                                  	Tags map[string]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
                                  }

                                  type CreateSavingsPlanOutput

                                  type CreateSavingsPlanOutput struct {
                                  
                                  	// The ID of the Savings Plan.
                                  	SavingsPlanId *string
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type DeleteQueuedSavingsPlanInput

                                  type DeleteQueuedSavingsPlanInput struct {
                                  
                                  	// The ID of the Savings Plan.
                                  	//
                                  	// This member is required.
                                  	SavingsPlanId *string
                                  }

                                  type DeleteQueuedSavingsPlanOutput

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

                                  type DescribeSavingsPlanRatesInput

                                  type DescribeSavingsPlanRatesInput struct {
                                  
                                  	// The ID of the Savings Plan.
                                  	//
                                  	// This member is required.
                                  	SavingsPlanId *string
                                  
                                  	// The filters.
                                  	Filters []types.SavingsPlanRateFilter
                                  
                                  	// 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 DescribeSavingsPlanRatesOutput

                                  type DescribeSavingsPlanRatesOutput 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
                                  
                                  	// The ID of the Savings Plan.
                                  	SavingsPlanId *string
                                  
                                  	// Information about the Savings Plans rates.
                                  	SearchResults []types.SavingsPlanRate
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type DescribeSavingsPlansInput

                                  type DescribeSavingsPlansInput struct {
                                  
                                  	// The filters.
                                  	Filters []types.SavingsPlanFilter
                                  
                                  	// 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
                                  
                                  	// The Amazon Resource Names (ARN) of the Savings Plans.
                                  	SavingsPlanArns []string
                                  
                                  	// The IDs of the Savings Plans.
                                  	SavingsPlanIds []string
                                  
                                  	// The states.
                                  	States []types.SavingsPlanState
                                  }

                                  type DescribeSavingsPlansOfferingRatesInput

                                  type DescribeSavingsPlansOfferingRatesInput struct {
                                  
                                  	// The filters.
                                  	Filters []types.SavingsPlanOfferingRateFilterElement
                                  
                                  	// 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
                                  
                                  	// The specific AWS operation for the line item in the billing report.
                                  	Operations []string
                                  
                                  	// The AWS products.
                                  	Products []types.SavingsPlanProductType
                                  
                                  	// The IDs of the offerings.
                                  	SavingsPlanOfferingIds []string
                                  
                                  	// The payment options.
                                  	SavingsPlanPaymentOptions []types.SavingsPlanPaymentOption
                                  
                                  	// The plan types.
                                  	SavingsPlanTypes []types.SavingsPlanType
                                  
                                  	// The services.
                                  	ServiceCodes []types.SavingsPlanRateServiceCode
                                  
                                  	// The usage details of the line item in the billing report.
                                  	UsageTypes []string
                                  }

                                  type DescribeSavingsPlansOfferingRatesOutput

                                  type DescribeSavingsPlansOfferingRatesOutput 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 offering rates.
                                  	SearchResults []types.SavingsPlanOfferingRate
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type DescribeSavingsPlansOfferingsInput

                                  type DescribeSavingsPlansOfferingsInput struct {
                                  
                                  	// The currencies.
                                  	Currencies []types.CurrencyCode
                                  
                                  	// The descriptions.
                                  	Descriptions []string
                                  
                                  	// The durations, in seconds.
                                  	Durations []int64
                                  
                                  	// The filters.
                                  	Filters []types.SavingsPlanOfferingFilterElement
                                  
                                  	// 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
                                  
                                  	// The IDs of the offerings.
                                  	OfferingIds []string
                                  
                                  	// The specific AWS operation for the line item in the billing report.
                                  	Operations []string
                                  
                                  	// The payment options.
                                  	PaymentOptions []types.SavingsPlanPaymentOption
                                  
                                  	// The plan type.
                                  	PlanTypes []types.SavingsPlanType
                                  
                                  	// The product type.
                                  	ProductType types.SavingsPlanProductType
                                  
                                  	// The services.
                                  	ServiceCodes []string
                                  
                                  	// The usage details of the line item in the billing report.
                                  	UsageTypes []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 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 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 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.
                                            	//
                                            	// This member is required.
                                            	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
                                            
                                            	// 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 endpoint options to be used when attempting to resolve an endpoint.
                                            	EndpointOptions EndpointResolverOptions
                                            
                                            	// 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 logger writer interface to write logging messages to.
                                            	Logger logging.Logger
                                            
                                            	// 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 aws.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.

                                              type ResolveEndpoint

                                              type ResolveEndpoint struct {
                                              	Resolver EndpointResolver
                                              	Options  EndpointResolverOptions
                                              }

                                              func (*ResolveEndpoint) HandleSerialize

                                              func (*ResolveEndpoint) ID

                                              func (*ResolveEndpoint) ID() string

                                              type TagResourceInput

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

                                              type TagResourceOutput

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

                                              type UntagResourceInput

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

                                              type UntagResourceOutput

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

                                              Directories

                                              Path Synopsis
                                              internal