marketplaceagreement

package module
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2024 License: Apache-2.0 Imports: 43 Imported by: 5

Documentation

Overview

Package marketplaceagreement provides the API client, operations, and parameter types for 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.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-03-01"
View Source 
const ServiceID = "Marketplace Agreement"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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

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

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

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

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

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

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

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

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

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

Types

type AuthResolverParameters 

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

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

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

type AuthSchemeResolver 

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

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

type Client 

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

Client provides the API client to make operations call for AWS Marketplace Agreement Service.

func New 

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

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

func NewFromConfig 

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

NewFromConfig returns a new client from the provided config.

func (*Client) DescribeAgreement 

func (c *Client) DescribeAgreement(ctx context.Context, params *DescribeAgreementInput, optFns ...func(*Options)) (*DescribeAgreementOutput, error)

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

func (*Client) GetAgreementTerms 

func (c *Client) GetAgreementTerms(ctx context.Context, params *GetAgreementTermsInput, optFns ...func(*Options)) (*GetAgreementTermsOutput, error)

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.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

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

func (*Client) SearchAgreements 

func (c *Client) SearchAgreements(ctx context.Context, params *SearchAgreementsInput, optFns ...func(*Options)) (*SearchAgreementsOutput, error)

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

type DescribeAgreementInput 

type DescribeAgreementInput struct {

	// The unique identifier of the agreement.
	//
	// This member is required.
	AgreementId *string
	// contains filtered or unexported fields
}

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

	// The details of the party accepting the agreement terms. This is commonly the
	// buyer for PurchaseAgreement .
	Acceptor *types.Acceptor

	// The unique identifier of the agreement.
	AgreementId *string

	// The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement .
	AgreementType *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

	// The estimated cost of the agreement.
	EstimatedCharges *types.EstimatedCharges

	// A summary of the proposal received from the proposer.
	ProposalSummary *types.ProposalSummary

	// The details of the party proposing the agreement terms. This is commonly the
	// seller for PurchaseAgreement .
	Proposer *types.Proposer

	// The date and time when the agreement starts.
	StartTime *time.Time

	// 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 types.AgreementStatus

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

type EndpointParameters 

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

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

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

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

type EndpointResolverFunc 

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

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

func (EndpointResolverFunc) ResolveEndpoint 

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

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAgreementTermsAPIClient 

type GetAgreementTermsAPIClient interface {
	GetAgreementTerms(context.Context, *GetAgreementTermsInput, ...func(*Options)) (*GetAgreementTermsOutput, error)
}

GetAgreementTermsAPIClient is a client that implements the GetAgreementTerms operation.

type GetAgreementTermsInput 

type GetAgreementTermsInput struct {

	// The unique identifier of the agreement.
	//
	// This member is required.
	AgreementId *string

	// The maximum number of agreements to return in the response.
	MaxResults *int32

	// A token to specify where to start pagination
	NextToken *string
	// contains filtered or unexported fields
}

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 []types.AcceptedTerm

	// A token to specify where to start pagination
	NextToken *string

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

type GetAgreementTermsPaginator 

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

GetAgreementTermsPaginator is a paginator for GetAgreementTerms

func NewGetAgreementTermsPaginator 

func NewGetAgreementTermsPaginator(client GetAgreementTermsAPIClient, params *GetAgreementTermsInput, optFns ...func(*GetAgreementTermsPaginatorOptions)) *GetAgreementTermsPaginator

NewGetAgreementTermsPaginator returns a new GetAgreementTermsPaginator

func (*GetAgreementTermsPaginator) HasMorePages 

func (p *GetAgreementTermsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetAgreementTermsPaginator) NextPage 

func (p *GetAgreementTermsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetAgreementTermsOutput, error)

NextPage retrieves the next GetAgreementTerms page.

type GetAgreementTermsPaginatorOptions 

type GetAgreementTermsPaginatorOptions struct {
	// The maximum number of agreements to return in the response.
	Limit int32

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

GetAgreementTermsPaginatorOptions is the paginator options for GetAgreementTerms

type HTTPClient 

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

type HTTPSignerV4 

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

type Options 

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

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

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

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

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

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

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchAgreementsAPIClient 

type SearchAgreementsAPIClient interface {
	SearchAgreements(context.Context, *SearchAgreementsInput, ...func(*Options)) (*SearchAgreementsOutput, error)
}

SearchAgreementsAPIClient is a client that implements the SearchAgreements operation.

type SearchAgreementsInput 

type SearchAgreementsInput struct {

	// The catalog in which the agreement was created.
	Catalog *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 []types.Filter

	// The maximum number of agreements to return in the response.
	MaxResults *int32

	// A token to specify where to start pagination.
	NextToken *string

	// An object that contains the SortBy and SortOrder attributes.
	Sort *types.Sort
	// contains filtered or unexported fields
}

type SearchAgreementsOutput 

type SearchAgreementsOutput struct {

	// A summary of the agreement, including top-level attributes (for example, the
	// agreement ID, version, proposer, and acceptor).
	AgreementViewSummaries []types.AgreementViewSummary

	// The token used for pagination. The field is null if there are no more results.
	NextToken *string

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

type SearchAgreementsPaginator 

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

SearchAgreementsPaginator is a paginator for SearchAgreements

func NewSearchAgreementsPaginator 

func NewSearchAgreementsPaginator(client SearchAgreementsAPIClient, params *SearchAgreementsInput, optFns ...func(*SearchAgreementsPaginatorOptions)) *SearchAgreementsPaginator

NewSearchAgreementsPaginator returns a new SearchAgreementsPaginator

func (*SearchAgreementsPaginator) HasMorePages 

func (p *SearchAgreementsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchAgreementsPaginator) NextPage 

func (p *SearchAgreementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAgreementsOutput, error)

NextPage retrieves the next SearchAgreements page.

type SearchAgreementsPaginatorOptions 

type SearchAgreementsPaginatorOptions struct {
	// The maximum number of agreements to return in the response.
	Limit int32

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

SearchAgreementsPaginatorOptions is the paginator options for SearchAgreements

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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