Documentation

Overview

    Package marketplacecatalog provides the API client, operations, and parameter types for AWS Marketplace Catalog Service.

    Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace. You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-09-17"
    View Source
    const ServiceID = "Marketplace Catalog"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

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

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

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

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

          Types

          type CancelChangeSetInput

          type CancelChangeSetInput struct {
          
          	// Required. The catalog related to the request. Fixed value: AWSMarketplace.
          	//
          	// This member is required.
          	Catalog *string
          
          	// Required. The unique identifier of the StartChangeSet request that you want to
          	// cancel.
          	//
          	// This member is required.
          	ChangeSetId *string
          }

          type CancelChangeSetOutput

          type CancelChangeSetOutput struct {
          
          	// The ARN associated with the change set referenced in this request.
          	ChangeSetArn *string
          
          	// The unique identifier for the change set referenced in this request.
          	ChangeSetId *string
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

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

            Client provides the API client to make operations call for AWS Marketplace Catalog 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) CancelChangeSet

                func (c *Client) CancelChangeSet(ctx context.Context, params *CancelChangeSetInput, optFns ...func(*Options)) (*CancelChangeSetOutput, error)

                  Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.

                  func (*Client) DescribeChangeSet

                  func (c *Client) DescribeChangeSet(ctx context.Context, params *DescribeChangeSetInput, optFns ...func(*Options)) (*DescribeChangeSetOutput, error)

                    Provides information about a given change set.

                    func (*Client) DescribeEntity

                    func (c *Client) DescribeEntity(ctx context.Context, params *DescribeEntityInput, optFns ...func(*Options)) (*DescribeEntityOutput, error)

                      Returns the metadata and content of the entity.

                      func (*Client) ListChangeSets

                      func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput, optFns ...func(*Options)) (*ListChangeSetsOutput, error)

                        Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. You can describe a change during the 60-day request history retention period for API calls.

                        func (*Client) ListEntities

                        func (c *Client) ListEntities(ctx context.Context, params *ListEntitiesInput, optFns ...func(*Options)) (*ListEntitiesOutput, error)

                          Provides the list of entities of a given type.

                          func (*Client) StartChangeSet

                          func (c *Client) StartChangeSet(ctx context.Context, params *StartChangeSetInput, optFns ...func(*Options)) (*StartChangeSetOutput, error)

                            This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a ResourceInUseException. For example, you cannot start the ChangeSet described in the example (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples) below because it contains two changes to execute the same change type (AddRevisions) against the same entity (entity-id@1).

                            type DescribeChangeSetInput

                            type DescribeChangeSetInput struct {
                            
                            	// Required. The catalog related to the request. Fixed value: AWSMarketplace
                            	//
                            	// This member is required.
                            	Catalog *string
                            
                            	// Required. The unique identifier for the StartChangeSet request that you want to
                            	// describe the details for.
                            	//
                            	// This member is required.
                            	ChangeSetId *string
                            }

                            type DescribeChangeSetOutput

                            type DescribeChangeSetOutput struct {
                            
                            	// An array of ChangeSummary objects.
                            	ChangeSet []types.ChangeSummary
                            
                            	// The ARN associated with the unique identifier for the change set referenced in
                            	// this request.
                            	ChangeSetArn *string
                            
                            	// Required. The unique identifier for the change set referenced in this request.
                            	ChangeSetId *string
                            
                            	// The optional name provided in the StartChangeSet request. If you do not provide
                            	// a name, one is set by default.
                            	ChangeSetName *string
                            
                            	// The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request
                            	// transitioned to a terminal state. The change cannot transition to a different
                            	// state. Null if the request is not in a terminal state.
                            	EndTime *string
                            
                            	// Returned if the change set is in FAILED status. Can be either CLIENT_ERROR,
                            	// which means that there are issues with the request (see the ErrorDetailList), or
                            	// SERVER_FAULT, which means that there is a problem in the system, and you should
                            	// retry your request.
                            	FailureCode types.FailureCode
                            
                            	// Returned if there is a failure on the change set, but that failure is not
                            	// related to any of the changes in the request.
                            	FailureDescription *string
                            
                            	// The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request
                            	// started.
                            	StartTime *string
                            
                            	// The status of the change request.
                            	Status types.ChangeStatus
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type DescribeEntityInput

                            type DescribeEntityInput struct {
                            
                            	// Required. The catalog related to the request. Fixed value: AWSMarketplace
                            	//
                            	// This member is required.
                            	Catalog *string
                            
                            	// Required. The unique ID of the entity to describe.
                            	//
                            	// This member is required.
                            	EntityId *string
                            }

                            type DescribeEntityOutput

                            type DescribeEntityOutput struct {
                            
                            	// This stringified JSON object includes the details of the entity.
                            	Details *string
                            
                            	// The ARN associated to the unique identifier for the change set referenced in
                            	// this request.
                            	EntityArn *string
                            
                            	// The identifier of the entity, in the format of EntityId@RevisionId.
                            	EntityIdentifier *string
                            
                            	// The named type of the entity, in the format of EntityType@Version.
                            	EntityType *string
                            
                            	// The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
                            	LastModifiedDate *string
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type EndpointResolver

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

                              EndpointResolver interface for resolving service endpoints.

                              func EndpointResolverFromURL

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

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

                                type EndpointResolverFunc

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

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

                                  func (EndpointResolverFunc) ResolveEndpoint

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

                                  type EndpointResolverOptions

                                  type EndpointResolverOptions = internalendpoints.Options

                                    EndpointResolverOptions is the service endpoint resolver options

                                    type HTTPClient

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

                                    type HTTPSignerV4

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

                                    type ListChangeSetsAPIClient

                                    type ListChangeSetsAPIClient interface {
                                    	ListChangeSets(context.Context, *ListChangeSetsInput, ...func(*Options)) (*ListChangeSetsOutput, error)
                                    }

                                      ListChangeSetsAPIClient is a client that implements the ListChangeSets operation.

                                      type ListChangeSetsInput

                                      type ListChangeSetsInput struct {
                                      
                                      	// The catalog related to the request. Fixed value: AWSMarketplace
                                      	//
                                      	// This member is required.
                                      	Catalog *string
                                      
                                      	// An array of filter objects.
                                      	FilterList []types.Filter
                                      
                                      	// The maximum number of results returned by a single call. This value must be
                                      	// provided in the next call to retrieve the next set of results. By default, this
                                      	// value is 20.
                                      	MaxResults *int32
                                      
                                      	// The token value retrieved from a previous call to access the next page of
                                      	// results.
                                      	NextToken *string
                                      
                                      	// An object that contains two attributes, SortBy and SortOrder.
                                      	Sort *types.Sort
                                      }

                                      type ListChangeSetsOutput

                                      type ListChangeSetsOutput struct {
                                      
                                      	// Array of ChangeSetSummaryListItem objects.
                                      	ChangeSetSummaryList []types.ChangeSetSummaryListItem
                                      
                                      	// The value of the next token, if it exists. Null if there are no more results.
                                      	NextToken *string
                                      
                                      	// Metadata pertaining to the operation's result.
                                      	ResultMetadata middleware.Metadata
                                      }

                                      type ListChangeSetsPaginator

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

                                        ListChangeSetsPaginator is a paginator for ListChangeSets

                                        func NewListChangeSetsPaginator

                                        func NewListChangeSetsPaginator(client ListChangeSetsAPIClient, params *ListChangeSetsInput, optFns ...func(*ListChangeSetsPaginatorOptions)) *ListChangeSetsPaginator

                                          NewListChangeSetsPaginator returns a new ListChangeSetsPaginator

                                          func (*ListChangeSetsPaginator) HasMorePages

                                          func (p *ListChangeSetsPaginator) HasMorePages() bool

                                            HasMorePages returns a boolean indicating whether more pages are available

                                            func (*ListChangeSetsPaginator) NextPage

                                            func (p *ListChangeSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChangeSetsOutput, error)

                                              NextPage retrieves the next ListChangeSets page.

                                              type ListChangeSetsPaginatorOptions

                                              type ListChangeSetsPaginatorOptions struct {
                                              	// The maximum number of results returned by a single call. This value must be
                                              	// provided in the next call to retrieve the next set of results. By default, this
                                              	// value is 20.
                                              	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
                                              }

                                                ListChangeSetsPaginatorOptions is the paginator options for ListChangeSets

                                                type ListEntitiesAPIClient

                                                type ListEntitiesAPIClient interface {
                                                	ListEntities(context.Context, *ListEntitiesInput, ...func(*Options)) (*ListEntitiesOutput, error)
                                                }

                                                  ListEntitiesAPIClient is a client that implements the ListEntities operation.

                                                  type ListEntitiesInput

                                                  type ListEntitiesInput struct {
                                                  
                                                  	// The catalog related to the request. Fixed value: AWSMarketplace
                                                  	//
                                                  	// This member is required.
                                                  	Catalog *string
                                                  
                                                  	// The type of entities to retrieve.
                                                  	//
                                                  	// This member is required.
                                                  	EntityType *string
                                                  
                                                  	// An array of filter objects. Each filter object contains two attributes,
                                                  	// filterName and filterValues.
                                                  	FilterList []types.Filter
                                                  
                                                  	// Specifies the upper limit of the elements on a single page. If a value isn't
                                                  	// provided, the default value is 20.
                                                  	MaxResults *int32
                                                  
                                                  	// The value of the next token, if it exists. Null if there are no more results.
                                                  	NextToken *string
                                                  
                                                  	// An object that contains two attributes, SortBy and SortOrder.
                                                  	Sort *types.Sort
                                                  }

                                                  type ListEntitiesOutput

                                                  type ListEntitiesOutput struct {
                                                  
                                                  	// Array of EntitySummary object.
                                                  	EntitySummaryList []types.EntitySummary
                                                  
                                                  	// The value of the next token if it exists. Null if there is no more result.
                                                  	NextToken *string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type ListEntitiesPaginator

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

                                                    ListEntitiesPaginator is a paginator for ListEntities

                                                    func NewListEntitiesPaginator

                                                    func NewListEntitiesPaginator(client ListEntitiesAPIClient, params *ListEntitiesInput, optFns ...func(*ListEntitiesPaginatorOptions)) *ListEntitiesPaginator

                                                      NewListEntitiesPaginator returns a new ListEntitiesPaginator

                                                      func (*ListEntitiesPaginator) HasMorePages

                                                      func (p *ListEntitiesPaginator) HasMorePages() bool

                                                        HasMorePages returns a boolean indicating whether more pages are available

                                                        func (*ListEntitiesPaginator) NextPage

                                                        func (p *ListEntitiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEntitiesOutput, error)

                                                          NextPage retrieves the next ListEntities page.

                                                          type ListEntitiesPaginatorOptions

                                                          type ListEntitiesPaginatorOptions struct {
                                                          	// Specifies the upper limit of the elements on a single page. If a value isn't
                                                          	// provided, the default value is 20.
                                                          	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
                                                          }

                                                            ListEntitiesPaginatorOptions is the paginator options for ListEntities

                                                            type Options

                                                            type Options struct {
                                                            	// Set of options to modify how an operation is invoked. These apply to all
                                                            	// operations invoked for this client. Use functional options on operation call to
                                                            	// modify this list for per operation behavior.
                                                            	APIOptions []func(*middleware.Stack) error
                                                            
                                                            	// Configures the events that will be sent to the configured logger.
                                                            	ClientLogMode aws.ClientLogMode
                                                            
                                                            	// The credentials object to use when signing requests.
                                                            	Credentials aws.CredentialsProvider
                                                            
                                                            	// The endpoint options to be used when attempting to resolve an endpoint.
                                                            	EndpointOptions EndpointResolverOptions
                                                            
                                                            	// The service endpoint resolver.
                                                            	EndpointResolver EndpointResolver
                                                            
                                                            	// Signature Version 4 (SigV4) Signer
                                                            	HTTPSignerV4 HTTPSignerV4
                                                            
                                                            	// The logger writer interface to write logging messages to.
                                                            	Logger logging.Logger
                                                            
                                                            	// The region to send requests to. (Required)
                                                            	Region string
                                                            
                                                            	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                            	// failures. When nil the API client will use a default retryer.
                                                            	Retryer aws.Retryer
                                                            
                                                            	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                            	// implementation if nil.
                                                            	HTTPClient HTTPClient
                                                            }

                                                            func (Options) Copy

                                                            func (o Options) Copy() Options

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

                                                              type ResolveEndpoint

                                                              type ResolveEndpoint struct {
                                                              	Resolver EndpointResolver
                                                              	Options  EndpointResolverOptions
                                                              }

                                                              func (*ResolveEndpoint) HandleSerialize

                                                              func (*ResolveEndpoint) ID

                                                              func (*ResolveEndpoint) ID() string

                                                              type StartChangeSetInput

                                                              type StartChangeSetInput struct {
                                                              
                                                              	// The catalog related to the request. Fixed value: AWSMarketplace
                                                              	//
                                                              	// This member is required.
                                                              	Catalog *string
                                                              
                                                              	// Array of change object.
                                                              	//
                                                              	// This member is required.
                                                              	ChangeSet []types.Change
                                                              
                                                              	// Optional case sensitive string of up to 100 ASCII characters. The change set
                                                              	// name can be used to filter the list of change sets.
                                                              	ChangeSetName *string
                                                              
                                                              	// A unique token to identify the request to ensure idempotency.
                                                              	ClientRequestToken *string
                                                              }

                                                              type StartChangeSetOutput

                                                              type StartChangeSetOutput struct {
                                                              
                                                              	// The ARN associated to the unique identifier generated for the request.
                                                              	ChangeSetArn *string
                                                              
                                                              	// Unique identifier generated for the request.
                                                              	ChangeSetId *string
                                                              
                                                              	// Metadata pertaining to the operation's result.
                                                              	ResultMetadata middleware.Metadata
                                                              }

                                                              Directories

                                                              Path Synopsis
                                                              internal