marketplacecatalog

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 3

Documentation

Overview

Package marketplacecatalog provides the client and types for making API requests to AWS Marketplace Catalog.

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.

See https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17 for more information on this service.

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

Using the Client

To use AWS Marketplace Catalog 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 Catalog client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacecatalog/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS Marketplace Catalog" // Service's name
	ServiceID   = "MarketplaceCatalog"      // Service's identifier
	EndpointsID = "catalog.marketplace"     // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Access is denied.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// There was an internal service exception.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The resource is currently in use.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource wasn't found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceNotSupportedException for service response error code
	// "ResourceNotSupportedException".
	//
	// Currently, the specified resource is not supported.
	ErrCodeResourceNotSupportedException = "ResourceNotSupportedException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The maximum number of open requests per account has been exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Too many requests.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// An error occurred during validation.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelChangeSetInput 

type CancelChangeSetInput struct {

	// Required. The catalog related to the request. Fixed value: AWSMarketplace.
	//
	// Catalog is a required field
	Catalog *string `location:"querystring" locationName:"catalog" min:"1" type:"string" required:"true"`

	// Required. The unique identifier of the StartChangeSet request that you want
	// to cancel.
	//
	// ChangeSetId is a required field
	ChangeSetId *string `location:"querystring" locationName:"changeSetId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelChangeSetInput) MarshalFields 

func (s CancelChangeSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CancelChangeSetInput) String 

func (s CancelChangeSetInput) String() string

String returns the string representation

func (*CancelChangeSetInput) Validate 

func (s *CancelChangeSetInput) Validate() error

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

type CancelChangeSetOutput 

type CancelChangeSetOutput struct {

	// The ARN associated with the change set referenced in this request.
	ChangeSetArn *string `min:"1" type:"string"`

	// The unique identifier for the change set referenced in this request.
	ChangeSetId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CancelChangeSetOutput) MarshalFields 

func (s CancelChangeSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CancelChangeSetOutput) String 

func (s CancelChangeSetOutput) String() string

String returns the string representation

type CancelChangeSetRequest 

type CancelChangeSetRequest struct {
	*aws.Request
	Input *CancelChangeSetInput
	Copy  func(*CancelChangeSetInput) CancelChangeSetRequest
}

CancelChangeSetRequest is the request type for the CancelChangeSet API operation.

func (CancelChangeSetRequest) Send 

func (r CancelChangeSetRequest) Send(ctx context.Context) (*CancelChangeSetResponse, error)

Send marshals and sends the CancelChangeSet API request.

type CancelChangeSetResponse 

type CancelChangeSetResponse struct {
	*CancelChangeSetOutput
	// contains filtered or unexported fields
}

CancelChangeSetResponse is the response type for the CancelChangeSet API operation.

func (*CancelChangeSetResponse) SDKResponseMetdata 

func (r *CancelChangeSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CancelChangeSet request.

type Change 

type Change struct {

	// Change types are single string values that describe your intention for the
	// change. Each change type is unique for each EntityType provided in the change's
	// scope.
	//
	// ChangeType is a required field
	ChangeType *string `min:"1" type:"string" required:"true"`

	// This object contains details specific to the change type of the requested
	// change.
	//
	// Details is a required field
	Details *string `min:"2" type:"string" required:"true"`

	// The entity to be changed.
	//
	// Entity is a required field
	Entity *Entity `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

An object that contains the ChangeType, Details, and Entity.

func (Change) MarshalFields 

func (s Change) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Change) String 

func (s Change) String() string

String returns the string representation

func (*Change) Validate 

func (s *Change) Validate() error

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

type ChangeSetSummaryListItem 

type ChangeSetSummaryListItem struct {

	// The ARN associated with the unique identifier for the change set referenced
	// in this request.
	ChangeSetArn *string `min:"1" type:"string"`

	// The unique identifier for a change set.
	ChangeSetId *string `min:"1" type:"string"`

	// The non-unique name for the change set.
	ChangeSetName *string `min:"1" type:"string"`

	// The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set
	// was finished.
	EndTime *string `min:"20" type:"string"`

	// This object is a list of entity IDs (string) that are a part of a change
	// set. The entity ID list is a maximum of 20 entities. It must contain at least
	// one entity.
	EntityIdList []string `type:"list"`

	// The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set
	// was started.
	StartTime *string `min:"20" type:"string"`

	// The current status of the change set.
	Status ChangeStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A summary of a change set returned in a list of change sets when the ListChangeSets action is called.

func (ChangeSetSummaryListItem) MarshalFields 

func (s ChangeSetSummaryListItem) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChangeSetSummaryListItem) String 

func (s ChangeSetSummaryListItem) String() string

String returns the string representation

type ChangeStatus 

type ChangeStatus string
const (
	ChangeStatusPreparing ChangeStatus = "PREPARING"
	ChangeStatusApplying  ChangeStatus = "APPLYING"
	ChangeStatusSucceeded ChangeStatus = "SUCCEEDED"
	ChangeStatusCancelled ChangeStatus = "CANCELLED"
	ChangeStatusFailed    ChangeStatus = "FAILED"
)

Enum values for ChangeStatus

func (ChangeStatus) MarshalValue 

func (enum ChangeStatus) MarshalValue() (string, error)

func (ChangeStatus) MarshalValueBuf 

func (enum ChangeStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ChangeSummary 

type ChangeSummary struct {

	// The type of the change.
	ChangeType *string `min:"1" type:"string"`

	// This object contains details specific to the change type of the requested
	// change.
	Details *string `min:"2" type:"string"`

	// The entity to be changed.
	Entity *Entity `type:"structure"`

	// An array of ErrorDetail objects associated with the change.
	ErrorDetailList []ErrorDetail `type:"list"`
	// contains filtered or unexported fields
}

This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.

func (ChangeSummary) MarshalFields 

func (s ChangeSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChangeSummary) String 

func (s ChangeSummary) String() string

String returns the string representation

type Client 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := marketplacecatalog.New(myConfig)

func (*Client) CancelChangeSetRequest 

func (c *Client) CancelChangeSetRequest(input *CancelChangeSetInput) CancelChangeSetRequest

CancelChangeSetRequest returns a request value for making API operation for AWS Marketplace Catalog Service.

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. 

// Example sending a request using CancelChangeSetRequest.
req := client.CancelChangeSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/CancelChangeSet

func (*Client) DescribeChangeSetRequest 

func (c *Client) DescribeChangeSetRequest(input *DescribeChangeSetInput) DescribeChangeSetRequest

DescribeChangeSetRequest returns a request value for making API operation for AWS Marketplace Catalog Service.

Provides information about a given change set. 

// Example sending a request using DescribeChangeSetRequest.
req := client.DescribeChangeSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeChangeSet

func (*Client) DescribeEntityRequest 

func (c *Client) DescribeEntityRequest(input *DescribeEntityInput) DescribeEntityRequest

DescribeEntityRequest returns a request value for making API operation for AWS Marketplace Catalog Service.

Returns the metadata and content of the entity. 

// Example sending a request using DescribeEntityRequest.
req := client.DescribeEntityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeEntity

func (*Client) ListChangeSetsRequest 

func (c *Client) ListChangeSetsRequest(input *ListChangeSetsInput) ListChangeSetsRequest

ListChangeSetsRequest returns a request value for making API operation for AWS Marketplace Catalog Service.

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. 

// Example sending a request using ListChangeSetsRequest.
req := client.ListChangeSetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListChangeSets

func (*Client) ListEntitiesRequest 

func (c *Client) ListEntitiesRequest(input *ListEntitiesInput) ListEntitiesRequest

ListEntitiesRequest returns a request value for making API operation for AWS Marketplace Catalog Service.

Provides the list of entities of a given type. 

// Example sending a request using ListEntitiesRequest.
req := client.ListEntitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListEntities

func (*Client) StartChangeSetRequest 

func (c *Client) StartChangeSetRequest(input *StartChangeSetInput) StartChangeSetRequest

StartChangeSetRequest returns a request value for making API operation for AWS Marketplace Catalog Service.

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

// Example sending a request using StartChangeSetRequest.
req := client.StartChangeSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/StartChangeSet

type DescribeChangeSetInput 

type DescribeChangeSetInput struct {

	// Required. The catalog related to the request. Fixed value: AWSMarketplace
	//
	// Catalog is a required field
	Catalog *string `location:"querystring" locationName:"catalog" min:"1" type:"string" required:"true"`

	// Required. The unique identifier for the StartChangeSet request that you want
	// to describe the details for.
	//
	// ChangeSetId is a required field
	ChangeSetId *string `location:"querystring" locationName:"changeSetId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeChangeSetInput) MarshalFields 

func (s DescribeChangeSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeChangeSetInput) String 

func (s DescribeChangeSetInput) String() string

String returns the string representation

func (*DescribeChangeSetInput) Validate 

func (s *DescribeChangeSetInput) Validate() error

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

type DescribeChangeSetOutput 

type DescribeChangeSetOutput struct {

	// An array of ChangeSummary objects.
	ChangeSet []ChangeSummary `type:"list"`

	// The ARN associated with the unique identifier for the change set referenced
	// in this request.
	ChangeSetArn *string `min:"1" type:"string"`

	// Required. The unique identifier for the change set referenced in this request.
	ChangeSetId *string `min:"1" type:"string"`

	// The optional name provided in the StartChangeSet request. If you do not provide
	// a name, one is set by default.
	ChangeSetName *string `min:"1" type:"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 `min:"20" type:"string"`

	// 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 `type:"string"`

	// The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request
	// started.
	StartTime *string `min:"20" type:"string"`

	// The status of the change request.
	Status ChangeStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (DescribeChangeSetOutput) MarshalFields 

func (s DescribeChangeSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeChangeSetOutput) String 

func (s DescribeChangeSetOutput) String() string

String returns the string representation

type DescribeChangeSetRequest 

type DescribeChangeSetRequest struct {
	*aws.Request
	Input *DescribeChangeSetInput
	Copy  func(*DescribeChangeSetInput) DescribeChangeSetRequest
}

DescribeChangeSetRequest is the request type for the DescribeChangeSet API operation.

func (DescribeChangeSetRequest) Send 

func (r DescribeChangeSetRequest) Send(ctx context.Context) (*DescribeChangeSetResponse, error)

Send marshals and sends the DescribeChangeSet API request.

type DescribeChangeSetResponse 

type DescribeChangeSetResponse struct {
	*DescribeChangeSetOutput
	// contains filtered or unexported fields
}

DescribeChangeSetResponse is the response type for the DescribeChangeSet API operation.

func (*DescribeChangeSetResponse) SDKResponseMetdata 

func (r *DescribeChangeSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeChangeSet request.

type DescribeEntityInput 

type DescribeEntityInput struct {

	// Required. The catalog related to the request. Fixed value: AWSMarketplace
	//
	// Catalog is a required field
	Catalog *string `location:"querystring" locationName:"catalog" min:"1" type:"string" required:"true"`

	// Required. The unique ID of the entity to describe.
	//
	// EntityId is a required field
	EntityId *string `location:"querystring" locationName:"entityId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEntityInput) MarshalFields 

func (s DescribeEntityInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeEntityInput) String 

func (s DescribeEntityInput) String() string

String returns the string representation

func (*DescribeEntityInput) Validate 

func (s *DescribeEntityInput) Validate() error

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

type DescribeEntityOutput 

type DescribeEntityOutput struct {

	// This stringified JSON object includes the details of the entity.
	Details *string `min:"2" type:"string"`

	// The ARN associated to the unique identifier for the change set referenced
	// in this request.
	EntityArn *string `min:"1" type:"string"`

	// The identifier of the entity, in the format of EntityId@RevisionId.
	EntityIdentifier *string `min:"1" type:"string"`

	// The named type of the entity, in the format of EntityType@Version.
	EntityType *string `min:"1" type:"string"`

	// The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
	LastModifiedDate *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEntityOutput) MarshalFields 

func (s DescribeEntityOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeEntityOutput) String 

func (s DescribeEntityOutput) String() string

String returns the string representation

type DescribeEntityRequest 

type DescribeEntityRequest struct {
	*aws.Request
	Input *DescribeEntityInput
	Copy  func(*DescribeEntityInput) DescribeEntityRequest
}

DescribeEntityRequest is the request type for the DescribeEntity API operation.

func (DescribeEntityRequest) Send 

func (r DescribeEntityRequest) Send(ctx context.Context) (*DescribeEntityResponse, error)

Send marshals and sends the DescribeEntity API request.

type DescribeEntityResponse 

type DescribeEntityResponse struct {
	*DescribeEntityOutput
	// contains filtered or unexported fields
}

DescribeEntityResponse is the response type for the DescribeEntity API operation.

func (*DescribeEntityResponse) SDKResponseMetdata 

func (r *DescribeEntityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEntity request.

type Entity 

type Entity struct {

	// The identifier for the entity.
	Identifier *string `min:"1" type:"string"`

	// The type of entity.
	//
	// Type is a required field
	Type *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A product entity contains data that describes your product, its supported features, and how it can be used or launched by your customer.

func (Entity) MarshalFields 

func (s Entity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Entity) String 

func (s Entity) String() string

String returns the string representation

func (*Entity) Validate 

func (s *Entity) Validate() error

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

type EntitySummary 

type EntitySummary struct {

	// The ARN associated with the unique identifier for the entity.
	EntityArn *string `min:"1" type:"string"`

	// The unique identifier for the entity.
	EntityId *string `min:"1" type:"string"`

	// The type of the entity.
	EntityType *string `min:"1" type:"string"`

	// The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
	LastModifiedDate *string `type:"string"`

	// The name for the entity. This value is not unique. It is defined by the seller.
	Name *string `type:"string"`

	// The visibility status of the entity to buyers. This value can be Public (everyone
	// can view the entity), Limited (the entity is visible to limited accounts
	// only), or Restricted (the entity was published and then unpublished and only
	// existing buyers can view it).
	Visibility *string `type:"string"`
	// contains filtered or unexported fields
}

This object is a container for common summary information about the entity. The summary doesn't contain the whole entity structure, but it does contain information common across all entities.

func (EntitySummary) MarshalFields 

func (s EntitySummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EntitySummary) String 

func (s EntitySummary) String() string

String returns the string representation

type ErrorDetail 

type ErrorDetail struct {

	// The error code that identifies the type of error.
	ErrorCode *string `type:"string"`

	// The message for the error.
	ErrorMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the error.

func (ErrorDetail) MarshalFields 

func (s ErrorDetail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorDetail) String 

func (s ErrorDetail) String() string

String returns the string representation

type Filter 

type Filter struct {

	// For ListEntities, the supported value for this is an EntityId.
	//
	// For ListChangeSets, the supported values are as follows:
	Name *string `min:"1" type:"string"`

	// ListEntities - This is a list of unique EntityIds.
	//
	// ListChangeSets - The supported filter names and associated ValueLists is
	// as follows:
	//
	//    * ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames.
	//    These are defined when you call the StartChangeSet action.
	//
	//    * Status - The supported ValueList is a list of statuses for all change
	//    set requests.
	//
	//    * EntityId - The supported ValueList is a list of unique EntityIds.
	//
	//    * BeforeStartTime - The supported ValueList is a list of all change sets
	//    that started before the filter value.
	//
	//    * AfterStartTime - The supported ValueList is a list of all change sets
	//    that started after the filter value.
	//
	//    * BeforeEndTime - The supported ValueList is a list of all change sets
	//    that ended before the filter value.
	//
	//    * AfterEndTime - The supported ValueList is a list of all change sets
	//    that ended after the filter value.
	ValueList []string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.

func (Filter) MarshalFields 

func (s Filter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Filter) String 

func (s Filter) String() string

String returns the string representation

func (*Filter) Validate 

func (s *Filter) Validate() error

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

type ListChangeSetsInput 

type ListChangeSetsInput struct {

	// The catalog related to the request. Fixed value: AWSMarketplace
	//
	// Catalog is a required field
	Catalog *string `min:"1" type:"string" required:"true"`

	// An array of filter objects.
	FilterList []Filter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `min:"1" type:"string"`

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

func (ListChangeSetsInput) MarshalFields 

func (s ListChangeSetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListChangeSetsInput) String 

func (s ListChangeSetsInput) String() string

String returns the string representation

func (*ListChangeSetsInput) Validate 

func (s *ListChangeSetsInput) Validate() error

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

type ListChangeSetsOutput 

type ListChangeSetsOutput struct {

	// Array of ChangeSetSummaryListItem objects.
	ChangeSetSummaryList []ChangeSetSummaryListItem `type:"list"`

	// The value of the next token, if it exists. Null if there are no more results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListChangeSetsOutput) MarshalFields 

func (s ListChangeSetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListChangeSetsOutput) String 

func (s ListChangeSetsOutput) String() string

String returns the string representation

type ListChangeSetsPaginator 

type ListChangeSetsPaginator struct {
	aws.Pager
}

ListChangeSetsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListChangeSetsPaginator 

func NewListChangeSetsPaginator(req ListChangeSetsRequest) ListChangeSetsPaginator

NewListChangeSetsRequestPaginator returns a paginator for ListChangeSets. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListChangeSetsRequest(input)
p := marketplacecatalog.NewListChangeSetsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListChangeSetsPaginator) CurrentPage 

func (p *ListChangeSetsPaginator) CurrentPage() *ListChangeSetsOutput

type ListChangeSetsRequest 

type ListChangeSetsRequest struct {
	*aws.Request
	Input *ListChangeSetsInput
	Copy  func(*ListChangeSetsInput) ListChangeSetsRequest
}

ListChangeSetsRequest is the request type for the ListChangeSets API operation.

func (ListChangeSetsRequest) Send 

func (r ListChangeSetsRequest) Send(ctx context.Context) (*ListChangeSetsResponse, error)

Send marshals and sends the ListChangeSets API request.

type ListChangeSetsResponse 

type ListChangeSetsResponse struct {
	*ListChangeSetsOutput
	// contains filtered or unexported fields
}

ListChangeSetsResponse is the response type for the ListChangeSets API operation.

func (*ListChangeSetsResponse) SDKResponseMetdata 

func (r *ListChangeSetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListChangeSets request.

type ListEntitiesInput 

type ListEntitiesInput struct {

	// The catalog related to the request. Fixed value: AWSMarketplace
	//
	// Catalog is a required field
	Catalog *string `min:"1" type:"string" required:"true"`

	// The type of entities to retrieve.
	//
	// EntityType is a required field
	EntityType *string `min:"1" type:"string" required:"true"`

	// An array of filter objects. Each filter object contains two attributes, filterName
	// and filterValues.
	FilterList []Filter `min:"1" type:"list"`

	// Specifies the upper limit of the elements on a single page. If a value isn't
	// provided, the default value is 20.
	MaxResults *int64 `min:"1" type:"integer"`

	// The value of the next token, if it exists. Null if there are no more results.
	NextToken *string `min:"1" type:"string"`

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

func (ListEntitiesInput) MarshalFields 

func (s ListEntitiesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListEntitiesInput) String 

func (s ListEntitiesInput) String() string

String returns the string representation

func (*ListEntitiesInput) Validate 

func (s *ListEntitiesInput) Validate() error

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

type ListEntitiesOutput 

type ListEntitiesOutput struct {

	// Array of EntitySummary object.
	EntitySummaryList []EntitySummary `type:"list"`

	// The value of the next token if it exists. Null if there is no more result.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesOutput) MarshalFields 

func (s ListEntitiesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListEntitiesOutput) String 

func (s ListEntitiesOutput) String() string

String returns the string representation

type ListEntitiesPaginator 

type ListEntitiesPaginator struct {
	aws.Pager
}

ListEntitiesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListEntitiesPaginator 

func NewListEntitiesPaginator(req ListEntitiesRequest) ListEntitiesPaginator

NewListEntitiesRequestPaginator returns a paginator for ListEntities. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListEntitiesRequest(input)
p := marketplacecatalog.NewListEntitiesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListEntitiesPaginator) CurrentPage 

func (p *ListEntitiesPaginator) CurrentPage() *ListEntitiesOutput

type ListEntitiesRequest 

type ListEntitiesRequest struct {
	*aws.Request
	Input *ListEntitiesInput
	Copy  func(*ListEntitiesInput) ListEntitiesRequest
}

ListEntitiesRequest is the request type for the ListEntities API operation.

func (ListEntitiesRequest) Send 

func (r ListEntitiesRequest) Send(ctx context.Context) (*ListEntitiesResponse, error)

Send marshals and sends the ListEntities API request.

type ListEntitiesResponse 

type ListEntitiesResponse struct {
	*ListEntitiesOutput
	// contains filtered or unexported fields
}

ListEntitiesResponse is the response type for the ListEntities API operation.

func (*ListEntitiesResponse) SDKResponseMetdata 

func (r *ListEntitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListEntities request.

type Sort 

type Sort struct {

	// For ListEntities, supported attributes include LastModifiedDate (default),
	// Visibility, EntityId, and Name.
	//
	// For ListChangeSets, supported attributes include StartTime and EndTime.
	SortBy *string `min:"1" type:"string"`

	// The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
	SortOrder SortOrder `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

An object that contains two attributes, SortBy and SortOrder.

func (Sort) MarshalFields 

func (s Sort) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Sort) String 

func (s Sort) String() string

String returns the string representation

func (*Sort) Validate 

func (s *Sort) Validate() error

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

type SortOrder 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) MarshalValue 

func (enum SortOrder) MarshalValue() (string, error)

func (SortOrder) MarshalValueBuf 

func (enum SortOrder) MarshalValueBuf(b []byte) ([]byte, error)

type StartChangeSetInput 

type StartChangeSetInput struct {

	// The catalog related to the request. Fixed value: AWSMarketplace
	//
	// Catalog is a required field
	Catalog *string `min:"1" type:"string" required:"true"`

	// Array of change object.
	//
	// ChangeSet is a required field
	ChangeSet []Change `min:"1" type:"list" required:"true"`

	// 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 `min:"1" type:"string"`

	// A unique token to identify the request to ensure idempotency.
	ClientRequestToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartChangeSetInput) MarshalFields 

func (s StartChangeSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartChangeSetInput) String 

func (s StartChangeSetInput) String() string

String returns the string representation

func (*StartChangeSetInput) Validate 

func (s *StartChangeSetInput) Validate() error

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

type StartChangeSetOutput 

type StartChangeSetOutput struct {

	// The ARN associated to the unique identifier generated for the request.
	ChangeSetArn *string `min:"1" type:"string"`

	// Unique identifier generated for the request.
	ChangeSetId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartChangeSetOutput) MarshalFields 

func (s StartChangeSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartChangeSetOutput) String 

func (s StartChangeSetOutput) String() string

String returns the string representation

type StartChangeSetRequest 

type StartChangeSetRequest struct {
	*aws.Request
	Input *StartChangeSetInput
	Copy  func(*StartChangeSetInput) StartChangeSetRequest
}

StartChangeSetRequest is the request type for the StartChangeSet API operation.

func (StartChangeSetRequest) Send 

func (r StartChangeSetRequest) Send(ctx context.Context) (*StartChangeSetResponse, error)

Send marshals and sends the StartChangeSet API request.

type StartChangeSetResponse 

type StartChangeSetResponse struct {
	*StartChangeSetOutput
	// contains filtered or unexported fields
}

StartChangeSetResponse is the response type for the StartChangeSet API operation.

func (*StartChangeSetResponse) SDKResponseMetdata 

func (r *StartChangeSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartChangeSet request.

Source Files

View all Source files

Directories

Path Synopsis
Package marketplacecatalogiface provides an interface to enable mocking the AWS Marketplace Catalog Service service client for testing your code.
 Package marketplacecatalogiface provides an interface to enable mocking the AWS Marketplace Catalog 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.