marketplaceagreement

package
v1.52.2 Latest Latest
Warning

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

 Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package marketplaceagreement provides the client and types for making API requests to AWS Marketplace Agreement Service.

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.

To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and Access Management (IAM) policies and roles are set up. The user must have the required policies/permissions that allow them to carry out the actions in AWS:

  • DescribeAgreement – Grants permission to users to obtain detailed meta data about any of their agreements.

  • GetAgreementTerms – Grants permission to users to obtain details about the terms of an agreement.

  • SearchAgreements – Grants permission to users to search through all their agreements.

See https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01 for more information on this service.

See marketplaceagreement package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplaceagreement/

Using the Client

To contact AWS Marketplace Agreement Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Marketplace Agreement Service client MarketplaceAgreement for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplaceagreement/#New

Index

Constants

View Source 
const (
	// AgreementStatusActive is a AgreementStatus enum value
	AgreementStatusActive = "ACTIVE"

	// AgreementStatusArchived is a AgreementStatus enum value
	AgreementStatusArchived = "ARCHIVED"

	// AgreementStatusCancelled is a AgreementStatus enum value
	AgreementStatusCancelled = "CANCELLED"

	// AgreementStatusExpired is a AgreementStatus enum value
	AgreementStatusExpired = "EXPIRED"

	// AgreementStatusRenewed is a AgreementStatus enum value
	AgreementStatusRenewed = "RENEWED"

	// AgreementStatusReplaced is a AgreementStatus enum value
	AgreementStatusReplaced = "REPLACED"

	// AgreementStatusRolledBack is a AgreementStatus enum value
	AgreementStatusRolledBack = "ROLLED_BACK"

	// AgreementStatusSuperseded is a AgreementStatus enum value
	AgreementStatusSuperseded = "SUPERSEDED"

	// AgreementStatusTerminated is a AgreementStatus enum value
	AgreementStatusTerminated = "TERMINATED"
)
View Source 
const (
	// SortOrderAscending is a SortOrder enum value
	SortOrderAscending = "ASCENDING"

	// SortOrderDescending is a SortOrder enum value
	SortOrderDescending = "DESCENDING"
)
View Source 
const (
	// ValidationExceptionReasonInvalidAgreementId is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidAgreementId = "INVALID_AGREEMENT_ID"

	// ValidationExceptionReasonMissingAgreementId is a ValidationExceptionReason enum value
	ValidationExceptionReasonMissingAgreementId = "MISSING_AGREEMENT_ID"

	// ValidationExceptionReasonInvalidCatalog is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidCatalog = "INVALID_CATALOG"

	// ValidationExceptionReasonInvalidFilterName is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidFilterName = "INVALID_FILTER_NAME"

	// ValidationExceptionReasonInvalidFilterValues is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidFilterValues = "INVALID_FILTER_VALUES"

	// ValidationExceptionReasonInvalidSortBy is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidSortBy = "INVALID_SORT_BY"

	// ValidationExceptionReasonInvalidSortOrder is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidSortOrder = "INVALID_SORT_ORDER"

	// ValidationExceptionReasonInvalidNextToken is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidNextToken = "INVALID_NEXT_TOKEN"

	// ValidationExceptionReasonInvalidMaxResults is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidMaxResults = "INVALID_MAX_RESULTS"

	// ValidationExceptionReasonUnsupportedFilters is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnsupportedFilters = "UNSUPPORTED_FILTERS"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// User does not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Unexpected error during processing of request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Request references a resource which does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by the service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Marketplace Agreement" // Name of service.
	EndpointsID = "agreement-marketplace" // ID to lookup a service endpoint with.
	ServiceID   = "Marketplace Agreement" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ResourceTypeAgreement is a ResourceType enum value
	ResourceTypeAgreement = "Agreement"
)

Variables

This section is empty.

Functions

func AgreementStatus_Values 

func AgreementStatus_Values() []string

AgreementStatus_Values returns all elements of the AgreementStatus enum

func ResourceType_Values 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func SortOrder_Values 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type AcceptedTerm 

type AcceptedTerm struct {

	// Enables you and your customers to move your existing agreements to AWS Marketplace.
	// The customer won't be charged for product usage in AWS Marketplace because
	// they already paid for the product outside of AWS Marketplace.
	ByolPricingTerm *ByolPricingTerm `locationName:"byolPricingTerm" type:"structure"`

	// Defines a prepaid payment model that allows buyers to configure the entitlements
	// they want to purchase and the duration.
	ConfigurableUpfrontPricingTerm *ConfigurableUpfrontPricingTerm `locationName:"configurableUpfrontPricingTerm" type:"structure"`

	// Defines a pre-paid pricing model where the customers are charged a fixed
	// upfront amount.
	FixedUpfrontPricingTerm *FixedUpfrontPricingTerm `locationName:"fixedUpfrontPricingTerm" type:"structure"`

	// Defines a short-term free pricing model where the buyers aren’t charged
	// anything within a specified limit.
	FreeTrialPricingTerm *FreeTrialPricingTerm `locationName:"freeTrialPricingTerm" type:"structure"`

	// Defines the list of text agreements proposed to the acceptors. An example
	// is the end user license agreement (EULA).
	LegalTerm *LegalTerm `locationName:"legalTerm" type:"structure"`

	// Defines an installment-based pricing model where customers are charged a
	// fixed price on different dates during the agreement validity period. This
	// is used most commonly for flexible payment schedule pricing.
	PaymentScheduleTerm *PaymentScheduleTerm `locationName:"paymentScheduleTerm" type:"structure"`

	// Defines a pricing model where customers are charged a fixed recurring price
	// at the end of each billing period.
	RecurringPaymentTerm *RecurringPaymentTerm `locationName:"recurringPaymentTerm" type:"structure"`

	// Defines that on graceful expiration of the agreement (when the agreement
	// ends on its pre-defined end date), a new agreement will be created using
	// the accepted terms on the existing agreement. In other words, the agreement
	// will be renewed. Presence of RenewalTerm in the offer document means that
	// auto-renewal is allowed. Buyers will have the option to accept or decline
	// auto-renewal at the offer acceptance/agreement creation. Buyers can also
	// change this flag from True to False or False to True at anytime during the
	// agreement's lifecycle.
	RenewalTerm *RenewalTerm `locationName:"renewalTerm" type:"structure"`

	// Defines the customer support available for the acceptors when they purchase
	// the software.
	SupportTerm *SupportTerm `locationName:"supportTerm" type:"structure"`

	// Defines a usage-based pricing model (typically, pay-as-you-go pricing), where
	// the customers are charged based on product usage.
	UsageBasedPricingTerm *UsageBasedPricingTerm `locationName:"usageBasedPricingTerm" type:"structure"`

	// Defines the conditions that will keep an agreement created from this offer
	// valid.
	ValidityTerm *ValidityTerm `locationName:"validityTerm" type:"structure"`
	// contains filtered or unexported fields
}

A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.

func (AcceptedTerm) GoString 

func (s AcceptedTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptedTerm) SetByolPricingTerm 

func (s *AcceptedTerm) SetByolPricingTerm(v *ByolPricingTerm) *AcceptedTerm

SetByolPricingTerm sets the ByolPricingTerm field's value.

func (*AcceptedTerm) SetConfigurableUpfrontPricingTerm 

func (s *AcceptedTerm) SetConfigurableUpfrontPricingTerm(v *ConfigurableUpfrontPricingTerm) *AcceptedTerm

SetConfigurableUpfrontPricingTerm sets the ConfigurableUpfrontPricingTerm field's value.

func (*AcceptedTerm) SetFixedUpfrontPricingTerm 

func (s *AcceptedTerm) SetFixedUpfrontPricingTerm(v *FixedUpfrontPricingTerm) *AcceptedTerm

SetFixedUpfrontPricingTerm sets the FixedUpfrontPricingTerm field's value.

func (*AcceptedTerm) SetFreeTrialPricingTerm 

func (s *AcceptedTerm) SetFreeTrialPricingTerm(v *FreeTrialPricingTerm) *AcceptedTerm

SetFreeTrialPricingTerm sets the FreeTrialPricingTerm field's value.

func (*AcceptedTerm) SetLegalTerm 

func (s *AcceptedTerm) SetLegalTerm(v *LegalTerm) *AcceptedTerm

SetLegalTerm sets the LegalTerm field's value.

func (*AcceptedTerm) SetPaymentScheduleTerm 

func (s *AcceptedTerm) SetPaymentScheduleTerm(v *PaymentScheduleTerm) *AcceptedTerm

SetPaymentScheduleTerm sets the PaymentScheduleTerm field's value.

func (*AcceptedTerm) SetRecurringPaymentTerm 

func (s *AcceptedTerm) SetRecurringPaymentTerm(v *RecurringPaymentTerm) *AcceptedTerm

SetRecurringPaymentTerm sets the RecurringPaymentTerm field's value.

func (*AcceptedTerm) SetRenewalTerm 

func (s *AcceptedTerm) SetRenewalTerm(v *RenewalTerm) *AcceptedTerm

SetRenewalTerm sets the RenewalTerm field's value.

func (*AcceptedTerm) SetSupportTerm 

func (s *AcceptedTerm) SetSupportTerm(v *SupportTerm) *AcceptedTerm

SetSupportTerm sets the SupportTerm field's value.

func (*AcceptedTerm) SetUsageBasedPricingTerm 

func (s *AcceptedTerm) SetUsageBasedPricingTerm(v *UsageBasedPricingTerm) *AcceptedTerm

SetUsageBasedPricingTerm sets the UsageBasedPricingTerm field's value.

func (*AcceptedTerm) SetValidityTerm 

func (s *AcceptedTerm) SetValidityTerm(v *ValidityTerm) *AcceptedTerm

SetValidityTerm sets the ValidityTerm field's value.

func (AcceptedTerm) String 

func (s AcceptedTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Acceptor 

type Acceptor struct {

	// The AWS account ID of the acceptor.
	AccountId *string `locationName:"accountId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

func (Acceptor) GoString 

func (s Acceptor) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Acceptor) SetAccountId 

func (s *Acceptor) SetAccountId(v string) *Acceptor

SetAccountId sets the AccountId field's value.

func (Acceptor) String 

func (s Acceptor) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The unique identifier for the error.
	RequestId *string `locationName:"requestId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

User does not have sufficient access to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgreementViewSummary 

type AgreementViewSummary struct {

	// The date and time that the agreement was accepted.
	AcceptanceTime *time.Time `locationName:"acceptanceTime" type:"timestamp"`

	// Details of the party accepting the agreement terms. This is commonly the
	// buyer for PurchaseAgreement.
	Acceptor *Acceptor `locationName:"acceptor" type:"structure"`

	// The unique identifier of the agreement.
	AgreementId *string `locationName:"agreementId" min:"1" type:"string"`

	// The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
	AgreementType *string `locationName:"agreementType" min:"1" type:"string"`

	// The date and time when the agreement ends. The field is null for pay-as-you-go
	// agreements, which don’t have end dates.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// A summary of the proposal
	ProposalSummary *ProposalSummary `locationName:"proposalSummary" type:"structure"`

	// Details of the party proposing the agreement terms, most commonly the seller
	// for PurchaseAgreement.
	Proposer *Proposer `locationName:"proposer" type:"structure"`

	// The date and time when the agreement starts.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The current status of the agreement.
	Status *string `locationName:"status" type:"string" enum:"AgreementStatus"`
	// contains filtered or unexported fields
}

A summary of the agreement, including top-level attributes (for example, the agreement ID, version, proposer, and acceptor).

func (AgreementViewSummary) GoString 

func (s AgreementViewSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgreementViewSummary) SetAcceptanceTime 

func (s *AgreementViewSummary) SetAcceptanceTime(v time.Time) *AgreementViewSummary

SetAcceptanceTime sets the AcceptanceTime field's value.

func (*AgreementViewSummary) SetAcceptor 

func (s *AgreementViewSummary) SetAcceptor(v *Acceptor) *AgreementViewSummary

SetAcceptor sets the Acceptor field's value.

func (*AgreementViewSummary) SetAgreementId 

func (s *AgreementViewSummary) SetAgreementId(v string) *AgreementViewSummary

SetAgreementId sets the AgreementId field's value.

func (*AgreementViewSummary) SetAgreementType 

func (s *AgreementViewSummary) SetAgreementType(v string) *AgreementViewSummary

SetAgreementType sets the AgreementType field's value.

func (*AgreementViewSummary) SetEndTime 

func (s *AgreementViewSummary) SetEndTime(v time.Time) *AgreementViewSummary

SetEndTime sets the EndTime field's value.

func (*AgreementViewSummary) SetProposalSummary 

func (s *AgreementViewSummary) SetProposalSummary(v *ProposalSummary) *AgreementViewSummary

SetProposalSummary sets the ProposalSummary field's value.

func (*AgreementViewSummary) SetProposer 

func (s *AgreementViewSummary) SetProposer(v *Proposer) *AgreementViewSummary

SetProposer sets the Proposer field's value.

func (*AgreementViewSummary) SetStartTime 

func (s *AgreementViewSummary) SetStartTime(v time.Time) *AgreementViewSummary

SetStartTime sets the StartTime field's value.

func (*AgreementViewSummary) SetStatus 

func (s *AgreementViewSummary) SetStatus(v string) *AgreementViewSummary

SetStatus sets the Status field's value.

func (AgreementViewSummary) String 

func (s AgreementViewSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ByolPricingTerm 

type ByolPricingTerm struct {

	// Type of the term being updated.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won't be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.

func (ByolPricingTerm) GoString 

func (s ByolPricingTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ByolPricingTerm) SetType 

func (s *ByolPricingTerm) SetType(v string) *ByolPricingTerm

SetType sets the Type field's value.

func (ByolPricingTerm) String 

func (s ByolPricingTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfigurableUpfrontPricingTerm 

type ConfigurableUpfrontPricingTerm struct {

	// Additional parameters specified by the acceptor while accepting the term.
	Configuration *ConfigurableUpfrontPricingTermConfiguration `locationName:"configuration" type:"structure"`

	// Defines the currency for the prices mentioned in the term.
	CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`

	// A rate card defines the per unit rates for product dimensions.
	RateCards []*ConfigurableUpfrontRateCardItem `locationName:"rateCards" type:"list"`

	// Category of selector.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

func (ConfigurableUpfrontPricingTerm) GoString 

func (s ConfigurableUpfrontPricingTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigurableUpfrontPricingTerm) SetConfiguration 

func (s *ConfigurableUpfrontPricingTerm) SetConfiguration(v *ConfigurableUpfrontPricingTermConfiguration) *ConfigurableUpfrontPricingTerm

SetConfiguration sets the Configuration field's value.

func (*ConfigurableUpfrontPricingTerm) SetCurrencyCode 

func (s *ConfigurableUpfrontPricingTerm) SetCurrencyCode(v string) *ConfigurableUpfrontPricingTerm

SetCurrencyCode sets the CurrencyCode field's value.

func (*ConfigurableUpfrontPricingTerm) SetRateCards 

func (s *ConfigurableUpfrontPricingTerm) SetRateCards(v []*ConfigurableUpfrontRateCardItem) *ConfigurableUpfrontPricingTerm

SetRateCards sets the RateCards field's value.

func (*ConfigurableUpfrontPricingTerm) SetType 

func (s *ConfigurableUpfrontPricingTerm) SetType(v string) *ConfigurableUpfrontPricingTerm

SetType sets the Type field's value.

func (ConfigurableUpfrontPricingTerm) String 

func (s ConfigurableUpfrontPricingTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfigurableUpfrontPricingTermConfiguration 

type ConfigurableUpfrontPricingTermConfiguration struct {

	// Defines the dimensions that the acceptor has purchased from the overall set
	// of dimensions presented in the rate card.
	//
	// Dimensions is a required field
	Dimensions []*Dimension `locationName:"dimensions" min:"1" type:"list" required:"true"`

	// Defines the length of time for which the particular pricing/dimension is
	// being purchased by the acceptor.
	//
	// SelectorValue is a required field
	SelectorValue *string `locationName:"selectorValue" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

func (ConfigurableUpfrontPricingTermConfiguration) GoString 

func (s ConfigurableUpfrontPricingTermConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigurableUpfrontPricingTermConfiguration) SetDimensions 

func (s *ConfigurableUpfrontPricingTermConfiguration) SetDimensions(v []*Dimension) *ConfigurableUpfrontPricingTermConfiguration

SetDimensions sets the Dimensions field's value.

func (*ConfigurableUpfrontPricingTermConfiguration) SetSelectorValue 

func (s *ConfigurableUpfrontPricingTermConfiguration) SetSelectorValue(v string) *ConfigurableUpfrontPricingTermConfiguration

SetSelectorValue sets the SelectorValue field's value.

func (ConfigurableUpfrontPricingTermConfiguration) String 

func (s ConfigurableUpfrontPricingTermConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfigurableUpfrontRateCardItem 

type ConfigurableUpfrontRateCardItem struct {

	// Defines limits on how the term can be configured by acceptors.
	Constraints *Constraints `locationName:"constraints" type:"structure"`

	// Defines the per unit rates for product dimensions.
	RateCard []*RateCardItem `locationName:"rateCard" type:"list"`

	// Differentiates between the mutually exclusive rate cards in the same pricing
	// term to be selected by the buyer.
	Selector *Selector `locationName:"selector" type:"structure"`
	// contains filtered or unexported fields
}

Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm, the RateCardItem defines all the various rate cards (including pricing and dimensions) that have been proposed.

func (ConfigurableUpfrontRateCardItem) GoString 

func (s ConfigurableUpfrontRateCardItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigurableUpfrontRateCardItem) SetConstraints 

func (s *ConfigurableUpfrontRateCardItem) SetConstraints(v *Constraints) *ConfigurableUpfrontRateCardItem

SetConstraints sets the Constraints field's value.

func (*ConfigurableUpfrontRateCardItem) SetRateCard 

func (s *ConfigurableUpfrontRateCardItem) SetRateCard(v []*RateCardItem) *ConfigurableUpfrontRateCardItem

SetRateCard sets the RateCard field's value.

func (*ConfigurableUpfrontRateCardItem) SetSelector 

func (s *ConfigurableUpfrontRateCardItem) SetSelector(v *Selector) *ConfigurableUpfrontRateCardItem

SetSelector sets the Selector field's value.

func (ConfigurableUpfrontRateCardItem) String 

func (s ConfigurableUpfrontRateCardItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Constraints 

type Constraints struct {

	// Determines if buyers are allowed to select multiple dimensions in the rate
	// card. The possible values are Allowed and Disallowed. The default value is
	// Allowed.
	MultipleDimensionSelection *string `locationName:"multipleDimensionSelection" min:"1" type:"string"`

	// Determines if acceptors are allowed to configure quantity for each dimension
	// in rate card. The possible values are Allowed and Disallowed. The default
	// value is Allowed.
	QuantityConfiguration *string `locationName:"quantityConfiguration" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines limits on how the term can be configured by acceptors.

func (Constraints) GoString 

func (s Constraints) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Constraints) SetMultipleDimensionSelection 

func (s *Constraints) SetMultipleDimensionSelection(v string) *Constraints

SetMultipleDimensionSelection sets the MultipleDimensionSelection field's value.

func (*Constraints) SetQuantityConfiguration 

func (s *Constraints) SetQuantityConfiguration(v string) *Constraints

SetQuantityConfiguration sets the QuantityConfiguration field's value.

func (Constraints) String 

func (s Constraints) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAgreementInput 

type DescribeAgreementInput struct {

	// The unique identifier of the agreement.
	//
	// AgreementId is a required field
	AgreementId *string `locationName:"agreementId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAgreementInput) GoString 

func (s DescribeAgreementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAgreementInput) SetAgreementId 

func (s *DescribeAgreementInput) SetAgreementId(v string) *DescribeAgreementInput

SetAgreementId sets the AgreementId field's value.

func (DescribeAgreementInput) String 

func (s DescribeAgreementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAgreementInput) Validate 

func (s *DescribeAgreementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAgreementOutput 

type DescribeAgreementOutput struct {

	// The date and time the offer was accepted or the agreement was created.
	//
	// AcceptanceTime and StartTime can differ for future dated agreements (FDAs).
	AcceptanceTime *time.Time `locationName:"acceptanceTime" type:"timestamp"`

	// The details of the party accepting the agreement terms. This is commonly
	// the buyer for PurchaseAgreement.
	Acceptor *Acceptor `locationName:"acceptor" type:"structure"`

	// The unique identifier of the agreement.
	AgreementId *string `locationName:"agreementId" min:"1" type:"string"`

	// The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
	AgreementType *string `locationName:"agreementType" min:"1" type:"string"`

	// The date and time when the agreement ends. The field is null for pay-as-you-go
	// agreements, which don’t have end dates.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// The estimated cost of the agreement.
	EstimatedCharges *EstimatedCharges `locationName:"estimatedCharges" type:"structure"`

	// A summary of the proposal received from the proposer.
	ProposalSummary *ProposalSummary `locationName:"proposalSummary" type:"structure"`

	// The details of the party proposing the agreement terms. This is commonly
	// the seller for PurchaseAgreement.
	Proposer *Proposer `locationName:"proposer" type:"structure"`

	// The date and time when the agreement starts.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The current status of the agreement.
	//
	// Statuses include:
	//
	//    * ACTIVE – The terms of the agreement are active.
	//
	//    * ARCHIVED – The agreement ended without a specified reason.
	//
	//    * CANCELLED – The acceptor ended the agreement before the defined end
	//    date.
	//
	//    * EXPIRED – The agreement ended on the defined end date.
	//
	//    * RENEWED – The agreement was renewed into a new agreement (for example,
	//    an auto-renewal).
	//
	//    * REPLACED – The agreement was replaced using an agreement replacement
	//    offer.
	//
	//    * ROLLED_BACK (Only applicable to inactive agreement revisions) – The
	//    agreement revision has been rolled back because of an error. An earlier
	//    revision is now active.
	//
	//    * SUPERCEDED (Only applicable to inactive agreement revisions) – The
	//    agreement revision is no longer active and another agreement revision
	//    is now active.
	//
	//    * TERMINATED – The agreement ended before the defined end date because
	//    of an AWS termination (for example, a payment failure).
	Status *string `locationName:"status" type:"string" enum:"AgreementStatus"`
	// contains filtered or unexported fields
}

func (DescribeAgreementOutput) GoString 

func (s DescribeAgreementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAgreementOutput) SetAcceptanceTime 

func (s *DescribeAgreementOutput) SetAcceptanceTime(v time.Time) *DescribeAgreementOutput

SetAcceptanceTime sets the AcceptanceTime field's value.

func (*DescribeAgreementOutput) SetAcceptor 

func (s *DescribeAgreementOutput) SetAcceptor(v *Acceptor) *DescribeAgreementOutput

SetAcceptor sets the Acceptor field's value.

func (*DescribeAgreementOutput) SetAgreementId 

func (s *DescribeAgreementOutput) SetAgreementId(v string) *DescribeAgreementOutput

SetAgreementId sets the AgreementId field's value.

func (*DescribeAgreementOutput) SetAgreementType 

func (s *DescribeAgreementOutput) SetAgreementType(v string) *DescribeAgreementOutput

SetAgreementType sets the AgreementType field's value.

func (*DescribeAgreementOutput) SetEndTime 

func (s *DescribeAgreementOutput) SetEndTime(v time.Time) *DescribeAgreementOutput

SetEndTime sets the EndTime field's value.

func (*DescribeAgreementOutput) SetEstimatedCharges 

func (s *DescribeAgreementOutput) SetEstimatedCharges(v *EstimatedCharges) *DescribeAgreementOutput

SetEstimatedCharges sets the EstimatedCharges field's value.

func (*DescribeAgreementOutput) SetProposalSummary 

func (s *DescribeAgreementOutput) SetProposalSummary(v *ProposalSummary) *DescribeAgreementOutput

SetProposalSummary sets the ProposalSummary field's value.

func (*DescribeAgreementOutput) SetProposer 

func (s *DescribeAgreementOutput) SetProposer(v *Proposer) *DescribeAgreementOutput

SetProposer sets the Proposer field's value.

func (*DescribeAgreementOutput) SetStartTime 

func (s *DescribeAgreementOutput) SetStartTime(v time.Time) *DescribeAgreementOutput

SetStartTime sets the StartTime field's value.

func (*DescribeAgreementOutput) SetStatus 

func (s *DescribeAgreementOutput) SetStatus(v string) *DescribeAgreementOutput

SetStatus sets the Status field's value.

func (DescribeAgreementOutput) String 

func (s DescribeAgreementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Dimension 

type Dimension struct {

	// The name of key value of the dimension.
	//
	// DimensionKey is a required field
	DimensionKey *string `locationName:"dimensionKey" min:"1" type:"string" required:"true"`

	// The number of units of the dimension the acceptor has purchased.
	//
	// For Agreements with ConfigurableUpfrontPricingTerm, the RateCard section
	// will define the prices and dimensions defined by the seller (proposer), whereas
	// the Configuration section will define the actual dimensions, prices, and
	// units the buyer has chosen to accept.
	//
	// DimensionValue is a required field
	DimensionValue *int64 `locationName:"dimensionValue" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

func (Dimension) GoString 

func (s Dimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Dimension) SetDimensionKey 

func (s *Dimension) SetDimensionKey(v string) *Dimension

SetDimensionKey sets the DimensionKey field's value.

func (*Dimension) SetDimensionValue 

func (s *Dimension) SetDimensionValue(v int64) *Dimension

SetDimensionValue sets the DimensionValue field's value.

func (Dimension) String 

func (s Dimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentItem 

type DocumentItem struct {

	// Category of the document. Document types include:
	//
	//    * CustomEula – A custom EULA provided by you as seller. A URL for a
	//    EULA stored in an accessible Amazon S3 bucket is required for this document
	//    type.
	//
	//    * CustomDsa – A custom Data Subscription Agreement (DSA) provided by
	//    you as seller. A URL for a DSA stored in an accessible Amazon S3 bucket
	//    is required for this document type.
	//
	//    * StandardEula – The Standard Contract for AWS Marketplace (SCMP). For
	//    more information about SCMP, see the AWS Marketplace Seller Guide. You
	//    don’t provide a URL for this type because it’s managed by AWS Marketplace.
	//
	//    * StandardDsa – DSA for AWS Marketplace. For more information about
	//    the DSA, see the AWS Data Exchange User Guide. You don’t provide a URL
	//    for this type because it’s managed by AWS Marketplace.
	Type *string `locationName:"type" min:"1" type:"string"`

	// A URL to the legal document for buyers to read. Required when Type is CustomEula.
	Url *string `locationName:"url" min:"1" type:"string"`

	// Version of standard contracts provided by AWS Marketplace. Required when
	// Type is StandardEula or StandardDsa.
	Version *string `locationName:"version" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Includes the list of references to legal resources proposed by the proposer to the acceptor. Each DocumentItem refers to an individual reference.

func (DocumentItem) GoString 

func (s DocumentItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentItem) SetType 

func (s *DocumentItem) SetType(v string) *DocumentItem

SetType sets the Type field's value.

func (*DocumentItem) SetUrl 

func (s *DocumentItem) SetUrl(v string) *DocumentItem

SetUrl sets the Url field's value.

func (*DocumentItem) SetVersion 

func (s *DocumentItem) SetVersion(v string) *DocumentItem

SetVersion sets the Version field's value.

func (DocumentItem) String 

func (s DocumentItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EstimatedCharges 

type EstimatedCharges struct {

	// The total known amount customer has to pay across the lifecycle of the agreement.
	//
	// This is the total contract value if accepted terms contain ConfigurableUpfrontPricingTerm
	// or FixedUpfrontPricingTerm. In the case of pure contract pricing, this will
	// be the total value of the contract. In the case of contracts with consumption
	// pricing, this will only include the committed value and not include any overages
	// that occur.
	//
	// If the accepted terms contain PaymentScheduleTerm, it will be the total payment
	// schedule amount. This occurs when flexible payment schedule is used, and
	// is the sum of all invoice charges in the payment schedule.
	//
	// In case a customer has amended an agreement, by purchasing more units of
	// any dimension, this will include both the original cost as well as the added
	// cost incurred due to addition of new units.
	//
	// This is 0 if the accepted terms contain UsageBasedPricingTerm without ConfigurableUpfrontPricingTerm
	// or RecurringPaymentTerm. This occurs for usage-based pricing (such as SaaS
	// metered or AMI/container hourly or monthly), because the exact usage is not
	// known upfront.
	AgreementValue *string `locationName:"agreementValue" min:"1" type:"string"`

	// Defines the currency code for the charge.
	CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`
	// contains filtered or unexported fields
}

Estimated cost of the agreement.

func (EstimatedCharges) GoString 

func (s EstimatedCharges) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EstimatedCharges) SetAgreementValue 

func (s *EstimatedCharges) SetAgreementValue(v string) *EstimatedCharges

SetAgreementValue sets the AgreementValue field's value.

func (*EstimatedCharges) SetCurrencyCode 

func (s *EstimatedCharges) SetCurrencyCode(v string) *EstimatedCharges

SetCurrencyCode sets the CurrencyCode field's value.

func (EstimatedCharges) String 

func (s EstimatedCharges) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filter 

type Filter struct {

	// The name of the filter.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The filter value.
	Values []*string `locationName:"values" min:"1" type:"list"`
	// contains filtered or unexported fields
}

The filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as offerId or productId.

func (Filter) GoString 

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName 

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetValues 

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String 

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate 

func (s *Filter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FixedUpfrontPricingTerm 

type FixedUpfrontPricingTerm struct {

	// Defines the currency for the prices mentioned in this term.
	CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`

	// Contract duration for the terms.
	Duration *string `locationName:"duration" min:"1" type:"string"`

	// Entitlements granted to the acceptor of fixed upfront as part of agreement
	// execution.
	Grants []*GrantItem `locationName:"grants" type:"list"`

	// Fixed amount to be charged to the customer when this term is accepted.
	Price *string `locationName:"price" min:"1" type:"string"`

	// Category of the term being updated.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines a prepaid pricing model where the customers are charged a fixed upfront amount.

func (FixedUpfrontPricingTerm) GoString 

func (s FixedUpfrontPricingTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FixedUpfrontPricingTerm) SetCurrencyCode 

func (s *FixedUpfrontPricingTerm) SetCurrencyCode(v string) *FixedUpfrontPricingTerm

SetCurrencyCode sets the CurrencyCode field's value.

func (*FixedUpfrontPricingTerm) SetDuration 

func (s *FixedUpfrontPricingTerm) SetDuration(v string) *FixedUpfrontPricingTerm

SetDuration sets the Duration field's value.

func (*FixedUpfrontPricingTerm) SetGrants 

func (s *FixedUpfrontPricingTerm) SetGrants(v []*GrantItem) *FixedUpfrontPricingTerm

SetGrants sets the Grants field's value.

func (*FixedUpfrontPricingTerm) SetPrice 

func (s *FixedUpfrontPricingTerm) SetPrice(v string) *FixedUpfrontPricingTerm

SetPrice sets the Price field's value.

func (*FixedUpfrontPricingTerm) SetType 

func (s *FixedUpfrontPricingTerm) SetType(v string) *FixedUpfrontPricingTerm

SetType sets the Type field's value.

func (FixedUpfrontPricingTerm) String 

func (s FixedUpfrontPricingTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FreeTrialPricingTerm 

type FreeTrialPricingTerm struct {

	// Duration of the free trial period (5–31 days).
	Duration *string `locationName:"duration" min:"1" type:"string"`

	// Entitlements granted to the acceptor of a free trial as part of an agreement
	// execution.
	Grants []*GrantItem `locationName:"grants" type:"list"`

	// Category of the term.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.

func (FreeTrialPricingTerm) GoString 

func (s FreeTrialPricingTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FreeTrialPricingTerm) SetDuration 

func (s *FreeTrialPricingTerm) SetDuration(v string) *FreeTrialPricingTerm

SetDuration sets the Duration field's value.

func (*FreeTrialPricingTerm) SetGrants 

func (s *FreeTrialPricingTerm) SetGrants(v []*GrantItem) *FreeTrialPricingTerm

SetGrants sets the Grants field's value.

func (*FreeTrialPricingTerm) SetType 

func (s *FreeTrialPricingTerm) SetType(v string) *FreeTrialPricingTerm

SetType sets the Type field's value.

func (FreeTrialPricingTerm) String 

func (s FreeTrialPricingTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAgreementTermsInput 

type GetAgreementTermsInput struct {

	// The unique identifier of the agreement.
	//
	// AgreementId is a required field
	AgreementId *string `locationName:"agreementId" min:"1" type:"string" required:"true"`

	// The maximum number of agreements to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token to specify where to start pagination
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetAgreementTermsInput) GoString 

func (s GetAgreementTermsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgreementTermsInput) SetAgreementId 

func (s *GetAgreementTermsInput) SetAgreementId(v string) *GetAgreementTermsInput

SetAgreementId sets the AgreementId field's value.

func (*GetAgreementTermsInput) SetMaxResults 

func (s *GetAgreementTermsInput) SetMaxResults(v int64) *GetAgreementTermsInput

SetMaxResults sets the MaxResults field's value.

func (*GetAgreementTermsInput) SetNextToken 

func (s *GetAgreementTermsInput) SetNextToken(v string) *GetAgreementTermsInput

SetNextToken sets the NextToken field's value.

func (GetAgreementTermsInput) String 

func (s GetAgreementTermsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgreementTermsInput) Validate 

func (s *GetAgreementTermsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAgreementTermsOutput 

type GetAgreementTermsOutput struct {

	// A subset of terms proposed by the proposer that have been accepted by the
	// acceptor as part of the agreement creation.
	AcceptedTerms []*AcceptedTerm `locationName:"acceptedTerms" type:"list"`

	// A token to specify where to start pagination
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetAgreementTermsOutput) GoString 

func (s GetAgreementTermsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgreementTermsOutput) SetAcceptedTerms 

func (s *GetAgreementTermsOutput) SetAcceptedTerms(v []*AcceptedTerm) *GetAgreementTermsOutput

SetAcceptedTerms sets the AcceptedTerms field's value.

func (*GetAgreementTermsOutput) SetNextToken 

func (s *GetAgreementTermsOutput) SetNextToken(v string) *GetAgreementTermsOutput

SetNextToken sets the NextToken field's value.

func (GetAgreementTermsOutput) String 

func (s GetAgreementTermsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GrantItem 

type GrantItem struct {

	// Unique dimension key defined in the product document. Dimensions represent
	// categories of capacity in a product and are specified when the product is
	// listed in AWS Marketplace.
	DimensionKey *string `locationName:"dimensionKey" min:"1" type:"string"`

	// Maximum amount of capacity that the buyer can be entitled to the given dimension
	// of the product. If MaxQuantity is not provided, the buyer will be able to
	// use an unlimited amount of the given dimension.
	MaxQuantity *int64 `locationName:"maxQuantity" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

func (GrantItem) GoString 

func (s GrantItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GrantItem) SetDimensionKey 

func (s *GrantItem) SetDimensionKey(v string) *GrantItem

SetDimensionKey sets the DimensionKey field's value.

func (*GrantItem) SetMaxQuantity 

func (s *GrantItem) SetMaxQuantity(v int64) *GrantItem

SetMaxQuantity sets the MaxQuantity field's value.

func (GrantItem) String 

func (s GrantItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The unique identifier for the error.
	RequestId *string `locationName:"requestId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Unexpected error during processing of request.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LegalTerm 

type LegalTerm struct {

	// List of references to legal resources proposed to the buyers. An example
	// is the EULA.
	Documents []*DocumentItem `locationName:"documents" type:"list"`

	// Category of the term being updated.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).

func (LegalTerm) GoString 

func (s LegalTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LegalTerm) SetDocuments 

func (s *LegalTerm) SetDocuments(v []*DocumentItem) *LegalTerm

SetDocuments sets the Documents field's value.

func (*LegalTerm) SetType 

func (s *LegalTerm) SetType(v string) *LegalTerm

SetType sets the Type field's value.

func (LegalTerm) String 

func (s LegalTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MarketplaceAgreement 

type MarketplaceAgreement struct {
	*client.Client
}

MarketplaceAgreement provides the API operation methods for making requests to AWS Marketplace Agreement Service. See this package's package overview docs for details on the service.

MarketplaceAgreement methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *MarketplaceAgreement

New creates a new instance of the MarketplaceAgreement client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a MarketplaceAgreement client from just a session.
svc := marketplaceagreement.New(mySession)

// Create a MarketplaceAgreement client with additional configuration
svc := marketplaceagreement.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*MarketplaceAgreement) DescribeAgreement 

func (c *MarketplaceAgreement) DescribeAgreement(input *DescribeAgreementInput) (*DescribeAgreementOutput, error)

DescribeAgreement API operation for AWS Marketplace Agreement Service.

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Marketplace Agreement Service's API operation DescribeAgreement for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by the service.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

  • ResourceNotFoundException Request references a resource which does not exist.

  • InternalServerException Unexpected error during processing of request.

See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/DescribeAgreement

func (*MarketplaceAgreement) DescribeAgreementRequest 

func (c *MarketplaceAgreement) DescribeAgreementRequest(input *DescribeAgreementInput) (req *request.Request, output *DescribeAgreementOutput)

DescribeAgreementRequest generates a "aws/request.Request" representing the client's request for the DescribeAgreement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAgreement for more information on using the DescribeAgreement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAgreementRequest method.
req, resp := client.DescribeAgreementRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/DescribeAgreement

func (*MarketplaceAgreement) DescribeAgreementWithContext 

func (c *MarketplaceAgreement) DescribeAgreementWithContext(ctx aws.Context, input *DescribeAgreementInput, opts ...request.Option) (*DescribeAgreementOutput, error)

DescribeAgreementWithContext is the same as DescribeAgreement with the addition of the ability to pass a context and additional request options.

See DescribeAgreement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MarketplaceAgreement) GetAgreementTerms 

func (c *MarketplaceAgreement) GetAgreementTerms(input *GetAgreementTermsInput) (*GetAgreementTermsOutput, error)

GetAgreementTerms API operation for AWS Marketplace Agreement Service.

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

  • TermType – The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.

  • TermID – The ID of the particular term, which is common between offer and agreement.

  • TermPayload – The key information contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.

  • Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Marketplace Agreement Service's API operation GetAgreementTerms for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by the service.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

  • ResourceNotFoundException Request references a resource which does not exist.

  • InternalServerException Unexpected error during processing of request.

See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/GetAgreementTerms

func (*MarketplaceAgreement) GetAgreementTermsPages 

func (c *MarketplaceAgreement) GetAgreementTermsPages(input *GetAgreementTermsInput, fn func(*GetAgreementTermsOutput, bool) bool) error

GetAgreementTermsPages iterates over the pages of a GetAgreementTerms operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetAgreementTerms method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetAgreementTerms operation.
pageNum := 0
err := client.GetAgreementTermsPages(params,
    func(page *marketplaceagreement.GetAgreementTermsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*MarketplaceAgreement) GetAgreementTermsPagesWithContext 

func (c *MarketplaceAgreement) GetAgreementTermsPagesWithContext(ctx aws.Context, input *GetAgreementTermsInput, fn func(*GetAgreementTermsOutput, bool) bool, opts ...request.Option) error

GetAgreementTermsPagesWithContext same as GetAgreementTermsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MarketplaceAgreement) GetAgreementTermsRequest 

func (c *MarketplaceAgreement) GetAgreementTermsRequest(input *GetAgreementTermsInput) (req *request.Request, output *GetAgreementTermsOutput)

GetAgreementTermsRequest generates a "aws/request.Request" representing the client's request for the GetAgreementTerms operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAgreementTerms for more information on using the GetAgreementTerms API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAgreementTermsRequest method.
req, resp := client.GetAgreementTermsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/GetAgreementTerms

func (*MarketplaceAgreement) GetAgreementTermsWithContext 

func (c *MarketplaceAgreement) GetAgreementTermsWithContext(ctx aws.Context, input *GetAgreementTermsInput, opts ...request.Option) (*GetAgreementTermsOutput, error)

GetAgreementTermsWithContext is the same as GetAgreementTerms with the addition of the ability to pass a context and additional request options.

See GetAgreementTerms for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MarketplaceAgreement) SearchAgreements 

func (c *MarketplaceAgreement) SearchAgreements(input *SearchAgreementsInput) (*SearchAgreementsOutput, error)

SearchAgreements API operation for AWS Marketplace Agreement Service.

Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information.

The following filter combinations are supported:

  • PartyType as Proposer + AgreementType + ResourceIdentifier

  • PartyType as Proposer + AgreementType + OfferId

  • PartyType as Proposer + AgreementType + AcceptorAccountId

  • PartyType as Proposer + AgreementType + Status

  • PartyType as Proposer + AgreementType + ResourceIdentifier + Status

  • PartyType as Proposer + AgreementType + OfferId + Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + Status

  • PartyType as Proposer + AgreementType + ResourceType + Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType

  • Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId

  • PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId

  • Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier

  • Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Marketplace Agreement Service's API operation SearchAgreements for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by the service.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

  • InternalServerException Unexpected error during processing of request.

See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/SearchAgreements

func (*MarketplaceAgreement) SearchAgreementsPages 

func (c *MarketplaceAgreement) SearchAgreementsPages(input *SearchAgreementsInput, fn func(*SearchAgreementsOutput, bool) bool) error

SearchAgreementsPages iterates over the pages of a SearchAgreements operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchAgreements method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a SearchAgreements operation.
pageNum := 0
err := client.SearchAgreementsPages(params,
    func(page *marketplaceagreement.SearchAgreementsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*MarketplaceAgreement) SearchAgreementsPagesWithContext 

func (c *MarketplaceAgreement) SearchAgreementsPagesWithContext(ctx aws.Context, input *SearchAgreementsInput, fn func(*SearchAgreementsOutput, bool) bool, opts ...request.Option) error

SearchAgreementsPagesWithContext same as SearchAgreementsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MarketplaceAgreement) SearchAgreementsRequest 

func (c *MarketplaceAgreement) SearchAgreementsRequest(input *SearchAgreementsInput) (req *request.Request, output *SearchAgreementsOutput)

SearchAgreementsRequest generates a "aws/request.Request" representing the client's request for the SearchAgreements operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchAgreements for more information on using the SearchAgreements API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchAgreementsRequest method.
req, resp := client.SearchAgreementsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/SearchAgreements

func (*MarketplaceAgreement) SearchAgreementsWithContext 

func (c *MarketplaceAgreement) SearchAgreementsWithContext(ctx aws.Context, input *SearchAgreementsInput, opts ...request.Option) (*SearchAgreementsOutput, error)

SearchAgreementsWithContext is the same as SearchAgreements with the addition of the ability to pass a context and additional request options.

See SearchAgreements for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PaymentScheduleTerm 

type PaymentScheduleTerm struct {

	// Defines the currency for the prices mentioned in the term.
	CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`

	// List of the payment schedule where each element defines one installment of
	// payment. It contains the information necessary for calculating the price.
	Schedule []*ScheduleItem `locationName:"schedule" type:"list"`

	// Type of the term.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.

func (PaymentScheduleTerm) GoString 

func (s PaymentScheduleTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PaymentScheduleTerm) SetCurrencyCode 

func (s *PaymentScheduleTerm) SetCurrencyCode(v string) *PaymentScheduleTerm

SetCurrencyCode sets the CurrencyCode field's value.

func (*PaymentScheduleTerm) SetSchedule 

func (s *PaymentScheduleTerm) SetSchedule(v []*ScheduleItem) *PaymentScheduleTerm

SetSchedule sets the Schedule field's value.

func (*PaymentScheduleTerm) SetType 

func (s *PaymentScheduleTerm) SetType(v string) *PaymentScheduleTerm

SetType sets the Type field's value.

func (PaymentScheduleTerm) String 

func (s PaymentScheduleTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProposalSummary 

type ProposalSummary struct {

	// The unique identifier of the offer in AWS Marketplace.
	OfferId *string `locationName:"offerId" min:"1" type:"string"`

	// The list of resources involved in the agreement.
	Resources []*Resource `locationName:"resources" type:"list"`
	// contains filtered or unexported fields
}

A summary of the proposal received from the proposer.

func (ProposalSummary) GoString 

func (s ProposalSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProposalSummary) SetOfferId 

func (s *ProposalSummary) SetOfferId(v string) *ProposalSummary

SetOfferId sets the OfferId field's value.

func (*ProposalSummary) SetResources 

func (s *ProposalSummary) SetResources(v []*Resource) *ProposalSummary

SetResources sets the Resources field's value.

func (ProposalSummary) String 

func (s ProposalSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Proposer 

type Proposer struct {

	// The AWS account ID of the proposer.
	AccountId *string `locationName:"accountId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Details of the party proposing the agreement terms,. This is commonly the seller for PurchaseAgreement.

func (Proposer) GoString 

func (s Proposer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Proposer) SetAccountId 

func (s *Proposer) SetAccountId(v string) *Proposer

SetAccountId sets the AccountId field's value.

func (Proposer) String 

func (s Proposer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RateCardItem 

type RateCardItem struct {

	// Dimension for which the given entitlement applies. Dimensions represent categories
	// of capacity in a product and are specified when the product is listed in
	// AWS Marketplace.
	DimensionKey *string `locationName:"dimensionKey" min:"1" type:"string"`

	// Per unit price for the product dimension that’s used for calculating the
	// amount to be charged.
	Price *string `locationName:"price" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines the per unit rates for each individual product dimension.

func (RateCardItem) GoString 

func (s RateCardItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RateCardItem) SetDimensionKey 

func (s *RateCardItem) SetDimensionKey(v string) *RateCardItem

SetDimensionKey sets the DimensionKey field's value.

func (*RateCardItem) SetPrice 

func (s *RateCardItem) SetPrice(v string) *RateCardItem

SetPrice sets the Price field's value.

func (RateCardItem) String 

func (s RateCardItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecurringPaymentTerm 

type RecurringPaymentTerm struct {

	// Defines the recurrence at which buyers are charged.
	BillingPeriod *string `locationName:"billingPeriod" min:"1" type:"string"`

	// Defines the currency for the prices mentioned in this term.
	CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`

	// Amount charged to the buyer every billing period.
	Price *string `locationName:"price" min:"1" type:"string"`

	// Type of the term being updated.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.

func (RecurringPaymentTerm) GoString 

func (s RecurringPaymentTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecurringPaymentTerm) SetBillingPeriod 

func (s *RecurringPaymentTerm) SetBillingPeriod(v string) *RecurringPaymentTerm

SetBillingPeriod sets the BillingPeriod field's value.

func (*RecurringPaymentTerm) SetCurrencyCode 

func (s *RecurringPaymentTerm) SetCurrencyCode(v string) *RecurringPaymentTerm

SetCurrencyCode sets the CurrencyCode field's value.

func (*RecurringPaymentTerm) SetPrice 

func (s *RecurringPaymentTerm) SetPrice(v string) *RecurringPaymentTerm

SetPrice sets the Price field's value.

func (*RecurringPaymentTerm) SetType 

func (s *RecurringPaymentTerm) SetType(v string) *RecurringPaymentTerm

SetType sets the Type field's value.

func (RecurringPaymentTerm) String 

func (s RecurringPaymentTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RenewalTerm 

type RenewalTerm struct {

	// Additional parameters specified by the acceptor while accepting the term.
	Configuration *RenewalTermConfiguration `locationName:"configuration" type:"structure"`

	// Category of the term being updated.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. The presence of RenewalTerm in the offer document means that auto-renewal is allowed. Buyers will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. Buyers can also change this flag from True to False or False to True at anytime during the agreement's lifecycle.

func (RenewalTerm) GoString 

func (s RenewalTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RenewalTerm) SetConfiguration 

func (s *RenewalTerm) SetConfiguration(v *RenewalTermConfiguration) *RenewalTerm

SetConfiguration sets the Configuration field's value.

func (*RenewalTerm) SetType 

func (s *RenewalTerm) SetType(v string) *RenewalTerm

SetType sets the Type field's value.

func (RenewalTerm) String 

func (s RenewalTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RenewalTermConfiguration 

type RenewalTermConfiguration struct {

	// Defines whether the acceptor has chosen to auto-renew the agreement at the
	// end of its lifecycle. Can be set to True or False.
	//
	// EnableAutoRenew is a required field
	EnableAutoRenew *bool `locationName:"enableAutoRenew" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Additional parameters specified by the acceptor while accepting the term.

func (RenewalTermConfiguration) GoString 

func (s RenewalTermConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RenewalTermConfiguration) SetEnableAutoRenew 

func (s *RenewalTermConfiguration) SetEnableAutoRenew(v bool) *RenewalTermConfiguration

SetEnableAutoRenew sets the EnableAutoRenew field's value.

func (RenewalTermConfiguration) String 

func (s RenewalTermConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Resource 

type Resource struct {

	// The unique identifier of the resource.
	//
	// We mention the term resource, which is most commonly a product, so a resourceId
	// is also a productId.
	Id *string `locationName:"id" min:"1" type:"string"`

	// Type of the resource, which is the product. Values include SaaSProduct or
	// AmiProduct.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The list of resources involved in the agreement.

func (Resource) GoString 

func (s Resource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Resource) SetId 

func (s *Resource) SetId(v string) *Resource

SetId sets the Id field's value.

func (*Resource) SetType 

func (s *Resource) SetType(v string) *Resource

SetType sets the Type field's value.

func (Resource) String 

func (s Resource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The unique identifier for the error.
	RequestId *string `locationName:"requestId" min:"1" type:"string"`

	// The unique identifier for the resource.
	ResourceId *string `locationName:"resourceId" min:"1" type:"string"`

	// The type of resource.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

Request references a resource which does not exist.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScheduleItem 

type ScheduleItem struct {

	// The price that the customer would pay on the scheduled date (chargeDate).
	ChargeAmount *string `locationName:"chargeAmount" min:"1" type:"string"`

	// The date that the customer would pay the price defined in this payment schedule
	// term. Invoices are generated on the date provided.
	ChargeDate *time.Time `locationName:"chargeDate" type:"timestamp"`
	// contains filtered or unexported fields
}

An individual installment of the payment that includes the date and amount of the charge.

func (ScheduleItem) GoString 

func (s ScheduleItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduleItem) SetChargeAmount 

func (s *ScheduleItem) SetChargeAmount(v string) *ScheduleItem

SetChargeAmount sets the ChargeAmount field's value.

func (*ScheduleItem) SetChargeDate 

func (s *ScheduleItem) SetChargeDate(v time.Time) *ScheduleItem

SetChargeDate sets the ChargeDate field's value.

func (ScheduleItem) String 

func (s ScheduleItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchAgreementsInput 

type SearchAgreementsInput struct {

	// The catalog in which the agreement was created.
	Catalog *string `locationName:"catalog" min:"1" type:"string"`

	// The filter name and value pair used to return a specific list of results.
	//
	// The following filters are supported:
	//
	//    * ResourceIdentifier – The unique identifier of the resource.
	//
	//    * ResourceType – Type of the resource, which is the product (AmiProduct,
	//    ContainerProduct, or SaaSProduct).
	//
	//    * PartyType – The party type (either Acceptor or Proposer) of the caller.
	//    For agreements where the caller is the proposer, use the Proposer filter.
	//    For agreements where the caller is the acceptor, use the Acceptor filter.
	//
	//    * AcceptorAccountId – The AWS account ID of the party accepting the
	//    agreement terms.
	//
	//    * OfferId – The unique identifier of the offer in which the terms are
	//    registered in the agreement token.
	//
	//    * Status – The current status of the agreement. Values include ACTIVE,
	//    ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.
	//
	//    * BeforeEndTime – A date used to filter agreements with a date before
	//    the endTime of an agreement.
	//
	//    * AfterEndTime – A date used to filter agreements with a date after
	//    the endTime of an agreement.
	//
	//    * AgreementType – The type of agreement. Values include PurchaseAgreement
	//    or VendorInsightsAgreement.
	Filters []*Filter `locationName:"filters" min:"1" type:"list"`

	// The maximum number of agreements to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token to specify where to start pagination.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An object that contains the SortBy and SortOrder attributes.
	Sort *Sort `locationName:"sort" type:"structure"`
	// contains filtered or unexported fields
}

func (SearchAgreementsInput) GoString 

func (s SearchAgreementsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchAgreementsInput) SetCatalog 

func (s *SearchAgreementsInput) SetCatalog(v string) *SearchAgreementsInput

SetCatalog sets the Catalog field's value.

func (*SearchAgreementsInput) SetFilters 

func (s *SearchAgreementsInput) SetFilters(v []*Filter) *SearchAgreementsInput

SetFilters sets the Filters field's value.

func (*SearchAgreementsInput) SetMaxResults 

func (s *SearchAgreementsInput) SetMaxResults(v int64) *SearchAgreementsInput

SetMaxResults sets the MaxResults field's value.

func (*SearchAgreementsInput) SetNextToken 

func (s *SearchAgreementsInput) SetNextToken(v string) *SearchAgreementsInput

SetNextToken sets the NextToken field's value.

func (*SearchAgreementsInput) SetSort 

func (s *SearchAgreementsInput) SetSort(v *Sort) *SearchAgreementsInput

SetSort sets the Sort field's value.

func (SearchAgreementsInput) String 

func (s SearchAgreementsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchAgreementsInput) Validate 

func (s *SearchAgreementsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchAgreementsOutput 

type SearchAgreementsOutput struct {

	// A summary of the agreement, including top-level attributes (for example,
	// the agreement ID, version, proposer, and acceptor).
	AgreementViewSummaries []*AgreementViewSummary `locationName:"agreementViewSummaries" type:"list"`

	// The token used for pagination. The field is null if there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchAgreementsOutput) GoString 

func (s SearchAgreementsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchAgreementsOutput) SetAgreementViewSummaries 

func (s *SearchAgreementsOutput) SetAgreementViewSummaries(v []*AgreementViewSummary) *SearchAgreementsOutput

SetAgreementViewSummaries sets the AgreementViewSummaries field's value.

func (*SearchAgreementsOutput) SetNextToken 

func (s *SearchAgreementsOutput) SetNextToken(v string) *SearchAgreementsOutput

SetNextToken sets the NextToken field's value.

func (SearchAgreementsOutput) String 

func (s SearchAgreementsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Selector 

type Selector struct {

	// Category of selector.
	Type *string `locationName:"type" min:"1" type:"string"`

	// Contract duration. This field supports the ISO 8601 format.
	Value *string `locationName:"value" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.

func (Selector) GoString 

func (s Selector) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Selector) SetType 

func (s *Selector) SetType(v string) *Selector

SetType sets the Type field's value.

func (*Selector) SetValue 

func (s *Selector) SetValue(v string) *Selector

SetValue sets the Value field's value.

func (Selector) String 

func (s Selector) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Sort 

type Sort struct {

	// The attribute on which the data is grouped, which can be by StartTime and
	// EndTime. The default value is EndTime.
	SortBy *string `locationName:"sortBy" min:"1" type:"string"`

	// The sorting order, which can be ASCENDING or DESCENDING. The default value
	// is DESCENDING.
	SortOrder *string `locationName:"sortOrder" type:"string" enum:"SortOrder"`
	// contains filtered or unexported fields
}

An object that contains the SortBy and SortOrder attributes.

func (Sort) GoString 

func (s Sort) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Sort) SetSortBy 

func (s *Sort) SetSortBy(v string) *Sort

SetSortBy sets the SortBy field's value.

func (*Sort) SetSortOrder 

func (s *Sort) SetSortOrder(v string) *Sort

SetSortOrder sets the SortOrder field's value.

func (Sort) String 

func (s Sort) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Sort) Validate 

func (s *Sort) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SupportTerm 

type SupportTerm struct {

	// Free-text field about the refund policy description that will be shown to
	// customers as is on the website and console.
	RefundPolicy *string `locationName:"refundPolicy" min:"1" type:"string"`

	// Category of the term being updated.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines the customer support available for the acceptors when they purchase the software.

func (SupportTerm) GoString 

func (s SupportTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SupportTerm) SetRefundPolicy 

func (s *SupportTerm) SetRefundPolicy(v string) *SupportTerm

SetRefundPolicy sets the RefundPolicy field's value.

func (*SupportTerm) SetType 

func (s *SupportTerm) SetType(v string) *SupportTerm

SetType sets the Type field's value.

func (SupportTerm) String 

func (s SupportTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The unique identifier for the error.
	RequestId *string `locationName:"requestId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Request was denied due to request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UsageBasedPricingTerm 

type UsageBasedPricingTerm struct {

	// Defines the currency for the prices mentioned in the term.
	CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`

	// List of rate cards.
	RateCards []*UsageBasedRateCardItem `locationName:"rateCards" type:"list"`

	// Category of the term.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.

func (UsageBasedPricingTerm) GoString 

func (s UsageBasedPricingTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UsageBasedPricingTerm) SetCurrencyCode 

func (s *UsageBasedPricingTerm) SetCurrencyCode(v string) *UsageBasedPricingTerm

SetCurrencyCode sets the CurrencyCode field's value.

func (*UsageBasedPricingTerm) SetRateCards 

func (s *UsageBasedPricingTerm) SetRateCards(v []*UsageBasedRateCardItem) *UsageBasedPricingTerm

SetRateCards sets the RateCards field's value.

func (*UsageBasedPricingTerm) SetType 

func (s *UsageBasedPricingTerm) SetType(v string) *UsageBasedPricingTerm

SetType sets the Type field's value.

func (UsageBasedPricingTerm) String 

func (s UsageBasedPricingTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UsageBasedRateCardItem 

type UsageBasedRateCardItem struct {

	// Defines the per unit rates for product dimensions.
	RateCard []*RateCardItem `locationName:"rateCard" type:"list"`
	// contains filtered or unexported fields
}

Within the pay-as-you-go model defined under UsageBasedPricingTerm, the UsageBasedRateCardItem defines an individual rate for a product dimension.

func (UsageBasedRateCardItem) GoString 

func (s UsageBasedRateCardItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UsageBasedRateCardItem) SetRateCard 

func (s *UsageBasedRateCardItem) SetRateCard(v []*RateCardItem) *UsageBasedRateCardItem

SetRateCard sets the RateCard field's value.

func (UsageBasedRateCardItem) String 

func (s UsageBasedRateCardItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The fields associated with the error.
	Fields []*ValidationExceptionField `locationName:"fields" type:"list"`

	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The reason associated with the error.
	Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"`

	// The unique identifier associated with the error.
	RequestId *string `locationName:"requestId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by the service.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField 

type ValidationExceptionField struct {

	// See applicable actions.
	//
	// Message is a required field
	Message *string `locationName:"message" min:"1" type:"string" required:"true"`

	// The name of the field associated with the error.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by the service.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidityTerm 

type ValidityTerm struct {

	// Defines the duration that the agreement remains active. If AgreementStartDate
	// isn’t provided, the agreement duration is relative to the agreement signature
	// time. The duration is represented in the ISO_8601 format.
	AgreementDuration *string `locationName:"agreementDuration" min:"1" type:"string"`

	// Defines the date when the agreement ends. The agreement ends at 23:59:59.999
	// UTC on the date provided. If AgreementEndDate isn’t provided, the agreement
	// end date is determined by the validity of individual terms.
	AgreementEndDate *time.Time `locationName:"agreementEndDate" type:"timestamp"`

	// Defines the date when agreement starts. The agreement starts at 00:00:00.000
	// UTC on the date provided. If AgreementStartDate isn’t provided, the agreement
	// start date is determined based on agreement signature time.
	AgreementStartDate *time.Time `locationName:"agreementStartDate" type:"timestamp"`

	// Category of the term being updated.
	Type *string `locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Defines the conditions that will keep an agreement created from this offer valid.

func (ValidityTerm) GoString 

func (s ValidityTerm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidityTerm) SetAgreementDuration 

func (s *ValidityTerm) SetAgreementDuration(v string) *ValidityTerm

SetAgreementDuration sets the AgreementDuration field's value.

func (*ValidityTerm) SetAgreementEndDate 

func (s *ValidityTerm) SetAgreementEndDate(v time.Time) *ValidityTerm

SetAgreementEndDate sets the AgreementEndDate field's value.

func (*ValidityTerm) SetAgreementStartDate 

func (s *ValidityTerm) SetAgreementStartDate(v time.Time) *ValidityTerm

SetAgreementStartDate sets the AgreementStartDate field's value.

func (*ValidityTerm) SetType 

func (s *ValidityTerm) SetType(v string) *ValidityTerm

SetType sets the Type field's value.

func (ValidityTerm) String 

func (s ValidityTerm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package marketplaceagreementiface provides an interface to enable mocking the AWS Marketplace Agreement Service service client for testing your code.
 Package marketplaceagreementiface provides an interface to enable mocking the AWS Marketplace Agreement Service service client for testing your code.

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.