marketplacecatalog

package
v1.38.28 Latest Latest
Warning

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

 Go to latest Published: Apr 28, 2021 License: Apache-2.0 Imports: 9 Imported by: 27

Documentation

Overview

Package marketplacecatalog provides the client and types for making API requests to 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.

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 contact AWS Marketplace Catalog Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

See the AWS Marketplace Catalog Service client MarketplaceCatalog 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 (
	// ChangeStatusPreparing is a ChangeStatus enum value
	ChangeStatusPreparing = "PREPARING"

	// ChangeStatusApplying is a ChangeStatus enum value
	ChangeStatusApplying = "APPLYING"

	// ChangeStatusSucceeded is a ChangeStatus enum value
	ChangeStatusSucceeded = "SUCCEEDED"

	// ChangeStatusCancelled is a ChangeStatus enum value
	ChangeStatusCancelled = "CANCELLED"

	// ChangeStatusFailed is a ChangeStatus enum value
	ChangeStatusFailed = "FAILED"
)
View Source 
const (
	// FailureCodeClientError is a FailureCode enum value
	FailureCodeClientError = "CLIENT_ERROR"

	// FailureCodeServerFault is a FailureCode enum value
	FailureCodeServerFault = "SERVER_FAULT"
)
View Source 
const (
	// SortOrderAscending is a SortOrder enum value
	SortOrderAscending = "ASCENDING"

	// SortOrderDescending is a SortOrder enum value
	SortOrderDescending = "DESCENDING"
)
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"
)
View Source 
const (
	ServiceName = "Marketplace Catalog" // Name of service.
	EndpointsID = "catalog.marketplace" // ID to lookup a service endpoint with.
	ServiceID   = "Marketplace Catalog" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ChangeStatus_Values added in v1.34.3 

func ChangeStatus_Values() []string

ChangeStatus_Values returns all elements of the ChangeStatus enum

func FailureCode_Values added in v1.35.4 

func FailureCode_Values() []string

FailureCode_Values returns all elements of the FailureCode enum

func SortOrder_Values added in v1.34.3 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

Types

type AccessDeniedException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Access is denied.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation

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

func (s CancelChangeSetInput) GoString() string

GoString returns the string representation

func (*CancelChangeSetInput) SetCatalog 

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

SetCatalog sets the Catalog field's value.

func (*CancelChangeSetInput) SetChangeSetId 

func (s *CancelChangeSetInput) SetChangeSetId(v string) *CancelChangeSetInput

SetChangeSetId sets the ChangeSetId field's value.

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

func (s CancelChangeSetOutput) GoString() string

GoString returns the string representation

func (*CancelChangeSetOutput) SetChangeSetArn 

func (s *CancelChangeSetOutput) SetChangeSetArn(v string) *CancelChangeSetOutput

SetChangeSetArn sets the ChangeSetArn field's value.

func (*CancelChangeSetOutput) SetChangeSetId 

func (s *CancelChangeSetOutput) SetChangeSetId(v string) *CancelChangeSetOutput

SetChangeSetId sets the ChangeSetId field's value.

func (CancelChangeSetOutput) String 

func (s CancelChangeSetOutput) String() string

String returns the string representation

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

func (s Change) GoString() string

GoString returns the string representation

func (*Change) SetChangeType 

func (s *Change) SetChangeType(v string) *Change

SetChangeType sets the ChangeType field's value.

func (*Change) SetDetails 

func (s *Change) SetDetails(v string) *Change

SetDetails sets the Details field's value.

func (*Change) SetEntity 

func (s *Change) SetEntity(v *Entity) *Change

SetEntity sets the Entity field's value.

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"`

	// 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
	// of DescribeChangeSet), or SERVER_FAULT, which means that there is a problem
	// in the system, and you should retry your request.
	FailureCode *string `type:"string" enum:"FailureCode"`

	// 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 *string `type:"string" enum:"ChangeStatus"`
	// 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) GoString 

func (s ChangeSetSummaryListItem) GoString() string

GoString returns the string representation

func (*ChangeSetSummaryListItem) SetChangeSetArn 

func (s *ChangeSetSummaryListItem) SetChangeSetArn(v string) *ChangeSetSummaryListItem

SetChangeSetArn sets the ChangeSetArn field's value.

func (*ChangeSetSummaryListItem) SetChangeSetId 

func (s *ChangeSetSummaryListItem) SetChangeSetId(v string) *ChangeSetSummaryListItem

SetChangeSetId sets the ChangeSetId field's value.

func (*ChangeSetSummaryListItem) SetChangeSetName 

func (s *ChangeSetSummaryListItem) SetChangeSetName(v string) *ChangeSetSummaryListItem

SetChangeSetName sets the ChangeSetName field's value.

func (*ChangeSetSummaryListItem) SetEndTime 

func (s *ChangeSetSummaryListItem) SetEndTime(v string) *ChangeSetSummaryListItem

SetEndTime sets the EndTime field's value.

func (*ChangeSetSummaryListItem) SetEntityIdList 

func (s *ChangeSetSummaryListItem) SetEntityIdList(v []*string) *ChangeSetSummaryListItem

SetEntityIdList sets the EntityIdList field's value.

func (*ChangeSetSummaryListItem) SetFailureCode added in v1.35.4 

func (s *ChangeSetSummaryListItem) SetFailureCode(v string) *ChangeSetSummaryListItem

SetFailureCode sets the FailureCode field's value.

func (*ChangeSetSummaryListItem) SetStartTime 

func (s *ChangeSetSummaryListItem) SetStartTime(v string) *ChangeSetSummaryListItem

SetStartTime sets the StartTime field's value.

func (*ChangeSetSummaryListItem) SetStatus 

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

SetStatus sets the Status field's value.

func (ChangeSetSummaryListItem) String 

func (s ChangeSetSummaryListItem) String() string

String returns the string representation

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

func (s ChangeSummary) GoString() string

GoString returns the string representation

func (*ChangeSummary) SetChangeType 

func (s *ChangeSummary) SetChangeType(v string) *ChangeSummary

SetChangeType sets the ChangeType field's value.

func (*ChangeSummary) SetDetails added in v1.31.7 

func (s *ChangeSummary) SetDetails(v string) *ChangeSummary

SetDetails sets the Details field's value.

func (*ChangeSummary) SetEntity 

func (s *ChangeSummary) SetEntity(v *Entity) *ChangeSummary

SetEntity sets the Entity field's value.

func (*ChangeSummary) SetErrorDetailList 

func (s *ChangeSummary) SetErrorDetailList(v []*ErrorDetail) *ChangeSummary

SetErrorDetailList sets the ErrorDetailList field's value.

func (ChangeSummary) String 

func (s ChangeSummary) String() string

String returns the string representation

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

func (s DescribeChangeSetInput) GoString() string

GoString returns the string representation

func (*DescribeChangeSetInput) SetCatalog 

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

SetCatalog sets the Catalog field's value.

func (*DescribeChangeSetInput) SetChangeSetId 

func (s *DescribeChangeSetInput) SetChangeSetId(v string) *DescribeChangeSetInput

SetChangeSetId sets the ChangeSetId field's value.

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 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 *string `type:"string" enum:"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 `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 *string `type:"string" enum:"ChangeStatus"`
	// contains filtered or unexported fields
}

func (DescribeChangeSetOutput) GoString 

func (s DescribeChangeSetOutput) GoString() string

GoString returns the string representation

func (*DescribeChangeSetOutput) SetChangeSet 

func (s *DescribeChangeSetOutput) SetChangeSet(v []*ChangeSummary) *DescribeChangeSetOutput

SetChangeSet sets the ChangeSet field's value.

func (*DescribeChangeSetOutput) SetChangeSetArn 

func (s *DescribeChangeSetOutput) SetChangeSetArn(v string) *DescribeChangeSetOutput

SetChangeSetArn sets the ChangeSetArn field's value.

func (*DescribeChangeSetOutput) SetChangeSetId 

func (s *DescribeChangeSetOutput) SetChangeSetId(v string) *DescribeChangeSetOutput

SetChangeSetId sets the ChangeSetId field's value.

func (*DescribeChangeSetOutput) SetChangeSetName 

func (s *DescribeChangeSetOutput) SetChangeSetName(v string) *DescribeChangeSetOutput

SetChangeSetName sets the ChangeSetName field's value.

func (*DescribeChangeSetOutput) SetEndTime 

func (s *DescribeChangeSetOutput) SetEndTime(v string) *DescribeChangeSetOutput

SetEndTime sets the EndTime field's value.

func (*DescribeChangeSetOutput) SetFailureCode added in v1.35.4 

func (s *DescribeChangeSetOutput) SetFailureCode(v string) *DescribeChangeSetOutput

SetFailureCode sets the FailureCode field's value.

func (*DescribeChangeSetOutput) SetFailureDescription 

func (s *DescribeChangeSetOutput) SetFailureDescription(v string) *DescribeChangeSetOutput

SetFailureDescription sets the FailureDescription field's value.

func (*DescribeChangeSetOutput) SetStartTime 

func (s *DescribeChangeSetOutput) SetStartTime(v string) *DescribeChangeSetOutput

SetStartTime sets the StartTime field's value.

func (*DescribeChangeSetOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (DescribeChangeSetOutput) String 

func (s DescribeChangeSetOutput) String() string

String returns the string representation

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

func (s DescribeEntityInput) GoString() string

GoString returns the string representation

func (*DescribeEntityInput) SetCatalog 

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

SetCatalog sets the Catalog field's value.

func (*DescribeEntityInput) SetEntityId 

func (s *DescribeEntityInput) SetEntityId(v string) *DescribeEntityInput

SetEntityId sets the EntityId field's value.

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

func (s DescribeEntityOutput) GoString() string

GoString returns the string representation

func (*DescribeEntityOutput) SetDetails 

func (s *DescribeEntityOutput) SetDetails(v string) *DescribeEntityOutput

SetDetails sets the Details field's value.

func (*DescribeEntityOutput) SetEntityArn 

func (s *DescribeEntityOutput) SetEntityArn(v string) *DescribeEntityOutput

SetEntityArn sets the EntityArn field's value.

func (*DescribeEntityOutput) SetEntityIdentifier 

func (s *DescribeEntityOutput) SetEntityIdentifier(v string) *DescribeEntityOutput

SetEntityIdentifier sets the EntityIdentifier field's value.

func (*DescribeEntityOutput) SetEntityType 

func (s *DescribeEntityOutput) SetEntityType(v string) *DescribeEntityOutput

SetEntityType sets the EntityType field's value.

func (*DescribeEntityOutput) SetLastModifiedDate 

func (s *DescribeEntityOutput) SetLastModifiedDate(v string) *DescribeEntityOutput

SetLastModifiedDate sets the LastModifiedDate field's value.

func (DescribeEntityOutput) String 

func (s DescribeEntityOutput) String() string

String returns the string representation

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

func (s Entity) GoString() string

GoString returns the string representation

func (*Entity) SetIdentifier 

func (s *Entity) SetIdentifier(v string) *Entity

SetIdentifier sets the Identifier field's value.

func (*Entity) SetType 

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

SetType sets the Type field's value.

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

func (s EntitySummary) GoString() string

GoString returns the string representation

func (*EntitySummary) SetEntityArn 

func (s *EntitySummary) SetEntityArn(v string) *EntitySummary

SetEntityArn sets the EntityArn field's value.

func (*EntitySummary) SetEntityId 

func (s *EntitySummary) SetEntityId(v string) *EntitySummary

SetEntityId sets the EntityId field's value.

func (*EntitySummary) SetEntityType 

func (s *EntitySummary) SetEntityType(v string) *EntitySummary

SetEntityType sets the EntityType field's value.

func (*EntitySummary) SetLastModifiedDate 

func (s *EntitySummary) SetLastModifiedDate(v string) *EntitySummary

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*EntitySummary) SetName 

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

SetName sets the Name field's value.

func (*EntitySummary) SetVisibility 

func (s *EntitySummary) SetVisibility(v string) *EntitySummary

SetVisibility sets the Visibility field's value.

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

func (s ErrorDetail) GoString() string

GoString returns the string representation

func (*ErrorDetail) SetErrorCode 

func (s *ErrorDetail) SetErrorCode(v string) *ErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*ErrorDetail) SetErrorMessage 

func (s *ErrorDetail) SetErrorMessage(v string) *ErrorDetail

SetErrorMessage sets the ErrorMessage field's value.

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

func (s Filter) GoString() string

GoString returns the string representation

func (*Filter) SetName 

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

SetName sets the Name field's value.

func (*Filter) SetValueList 

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

SetValueList sets the ValueList field's value.

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 InternalServiceException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

There was an internal service exception.

func (*InternalServiceException) Code added in v1.28.0 

func (s *InternalServiceException) Code() string

Code returns the exception type name.

func (*InternalServiceException) Error added in v1.28.0 

func (s *InternalServiceException) Error() string

func (InternalServiceException) GoString added in v1.28.0 

func (s InternalServiceException) GoString() string

GoString returns the string representation

func (*InternalServiceException) Message added in v1.28.0 

func (s *InternalServiceException) Message() string

Message returns the exception's message.

func (*InternalServiceException) OrigErr added in v1.28.0 

func (s *InternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceException) RequestID added in v1.28.0 

func (s *InternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceException) StatusCode added in v1.28.0 

func (s *InternalServiceException) StatusCode() int

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

func (InternalServiceException) String added in v1.28.0 

func (s InternalServiceException) String() string

String returns the string representation

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

func (s ListChangeSetsInput) GoString() string

GoString returns the string representation

func (*ListChangeSetsInput) SetCatalog 

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

SetCatalog sets the Catalog field's value.

func (*ListChangeSetsInput) SetFilterList 

func (s *ListChangeSetsInput) SetFilterList(v []*Filter) *ListChangeSetsInput

SetFilterList sets the FilterList field's value.

func (*ListChangeSetsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChangeSetsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListChangeSetsInput) SetSort 

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

SetSort sets the Sort field's value.

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

func (s ListChangeSetsOutput) GoString() string

GoString returns the string representation

func (*ListChangeSetsOutput) SetChangeSetSummaryList 

func (s *ListChangeSetsOutput) SetChangeSetSummaryList(v []*ChangeSetSummaryListItem) *ListChangeSetsOutput

SetChangeSetSummaryList sets the ChangeSetSummaryList field's value.

func (*ListChangeSetsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChangeSetsOutput) String 

func (s ListChangeSetsOutput) String() string

String returns the string representation

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

func (s ListEntitiesInput) GoString() string

GoString returns the string representation

func (*ListEntitiesInput) SetCatalog 

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

SetCatalog sets the Catalog field's value.

func (*ListEntitiesInput) SetEntityType 

func (s *ListEntitiesInput) SetEntityType(v string) *ListEntitiesInput

SetEntityType sets the EntityType field's value.

func (*ListEntitiesInput) SetFilterList 

func (s *ListEntitiesInput) SetFilterList(v []*Filter) *ListEntitiesInput

SetFilterList sets the FilterList field's value.

func (*ListEntitiesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListEntitiesInput) SetSort 

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

SetSort sets the Sort field's value.

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

func (s ListEntitiesOutput) GoString() string

GoString returns the string representation

func (*ListEntitiesOutput) SetEntitySummaryList 

func (s *ListEntitiesOutput) SetEntitySummaryList(v []*EntitySummary) *ListEntitiesOutput

SetEntitySummaryList sets the EntitySummaryList field's value.

func (*ListEntitiesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListEntitiesOutput) String 

func (s ListEntitiesOutput) String() string

String returns the string representation

type MarketplaceCatalog 

type MarketplaceCatalog struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

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

// Create a MarketplaceCatalog client from just a session.
svc := marketplacecatalog.New(mySession)

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

func (*MarketplaceCatalog) CancelChangeSet 

func (c *MarketplaceCatalog) CancelChangeSet(input *CancelChangeSetInput) (*CancelChangeSetOutput, error)

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

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

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

Returned Error Types:

  • InternalServiceException There was an internal service exception.

  • AccessDeniedException Access is denied.

  • ValidationException An error occurred during validation.

  • ResourceNotFoundException The specified resource wasn't found.

  • ResourceInUseException The resource is currently in use.

  • ThrottlingException Too many requests.

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

func (*MarketplaceCatalog) CancelChangeSetRequest 

func (c *MarketplaceCatalog) CancelChangeSetRequest(input *CancelChangeSetInput) (req *request.Request, output *CancelChangeSetOutput)

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

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

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

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

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

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

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

func (*MarketplaceCatalog) CancelChangeSetWithContext 

func (c *MarketplaceCatalog) CancelChangeSetWithContext(ctx aws.Context, input *CancelChangeSetInput, opts ...request.Option) (*CancelChangeSetOutput, error)

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

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

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

func (*MarketplaceCatalog) DescribeChangeSet 

func (c *MarketplaceCatalog) DescribeChangeSet(input *DescribeChangeSetInput) (*DescribeChangeSetOutput, error)

DescribeChangeSet API operation for AWS Marketplace Catalog Service.

Provides information about a given change set.

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

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

Returned Error Types:

  • InternalServiceException There was an internal service exception.

  • AccessDeniedException Access is denied.

  • ValidationException An error occurred during validation.

  • ResourceNotFoundException The specified resource wasn't found.

  • ThrottlingException Too many requests.

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

func (*MarketplaceCatalog) DescribeChangeSetRequest 

func (c *MarketplaceCatalog) DescribeChangeSetRequest(input *DescribeChangeSetInput) (req *request.Request, output *DescribeChangeSetOutput)

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

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

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

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

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

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

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

func (*MarketplaceCatalog) DescribeChangeSetWithContext 

func (c *MarketplaceCatalog) DescribeChangeSetWithContext(ctx aws.Context, input *DescribeChangeSetInput, opts ...request.Option) (*DescribeChangeSetOutput, error)

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

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

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

func (*MarketplaceCatalog) DescribeEntity 

func (c *MarketplaceCatalog) DescribeEntity(input *DescribeEntityInput) (*DescribeEntityOutput, error)

DescribeEntity API operation for AWS Marketplace Catalog Service.

Returns the metadata and content of the entity.

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

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

Returned Error Types:

  • InternalServiceException There was an internal service exception.

  • AccessDeniedException Access is denied.

  • ValidationException An error occurred during validation.

  • ResourceNotSupportedException Currently, the specified resource is not supported.

  • ResourceNotFoundException The specified resource wasn't found.

  • ThrottlingException Too many requests.

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

func (*MarketplaceCatalog) DescribeEntityRequest 

func (c *MarketplaceCatalog) DescribeEntityRequest(input *DescribeEntityInput) (req *request.Request, output *DescribeEntityOutput)

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

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

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

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

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

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

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

func (*MarketplaceCatalog) DescribeEntityWithContext 

func (c *MarketplaceCatalog) DescribeEntityWithContext(ctx aws.Context, input *DescribeEntityInput, opts ...request.Option) (*DescribeEntityOutput, error)

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

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

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

func (*MarketplaceCatalog) ListChangeSets 

func (c *MarketplaceCatalog) ListChangeSets(input *ListChangeSetsInput) (*ListChangeSetsOutput, error)

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

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

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

Returned Error Types:

  • InternalServiceException There was an internal service exception.

  • AccessDeniedException Access is denied.

  • ValidationException An error occurred during validation.

  • ThrottlingException Too many requests.

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

func (*MarketplaceCatalog) ListChangeSetsPages 

func (c *MarketplaceCatalog) ListChangeSetsPages(input *ListChangeSetsInput, fn func(*ListChangeSetsOutput, bool) bool) error

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

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

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

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

func (*MarketplaceCatalog) ListChangeSetsPagesWithContext 

func (c *MarketplaceCatalog) ListChangeSetsPagesWithContext(ctx aws.Context, input *ListChangeSetsInput, fn func(*ListChangeSetsOutput, bool) bool, opts ...request.Option) error

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

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

func (*MarketplaceCatalog) ListChangeSetsRequest 

func (c *MarketplaceCatalog) ListChangeSetsRequest(input *ListChangeSetsInput) (req *request.Request, output *ListChangeSetsOutput)

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

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

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

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

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

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

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

func (*MarketplaceCatalog) ListChangeSetsWithContext 

func (c *MarketplaceCatalog) ListChangeSetsWithContext(ctx aws.Context, input *ListChangeSetsInput, opts ...request.Option) (*ListChangeSetsOutput, error)

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

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

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

func (*MarketplaceCatalog) ListEntities 

func (c *MarketplaceCatalog) ListEntities(input *ListEntitiesInput) (*ListEntitiesOutput, error)

ListEntities API operation for AWS Marketplace Catalog Service.

Provides the list of entities of a given type.

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

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

Returned Error Types:

  • InternalServiceException There was an internal service exception.

  • AccessDeniedException Access is denied.

  • ValidationException An error occurred during validation.

  • ResourceNotFoundException The specified resource wasn't found.

  • ThrottlingException Too many requests.

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

func (*MarketplaceCatalog) ListEntitiesPages 

func (c *MarketplaceCatalog) ListEntitiesPages(input *ListEntitiesInput, fn func(*ListEntitiesOutput, bool) bool) error

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

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

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

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

func (*MarketplaceCatalog) ListEntitiesPagesWithContext 

func (c *MarketplaceCatalog) ListEntitiesPagesWithContext(ctx aws.Context, input *ListEntitiesInput, fn func(*ListEntitiesOutput, bool) bool, opts ...request.Option) error

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

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

func (*MarketplaceCatalog) ListEntitiesRequest 

func (c *MarketplaceCatalog) ListEntitiesRequest(input *ListEntitiesInput) (req *request.Request, output *ListEntitiesOutput)

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

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

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

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

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

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

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

func (*MarketplaceCatalog) ListEntitiesWithContext 

func (c *MarketplaceCatalog) ListEntitiesWithContext(ctx aws.Context, input *ListEntitiesInput, opts ...request.Option) (*ListEntitiesOutput, error)

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

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

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

func (*MarketplaceCatalog) StartChangeSet 

func (c *MarketplaceCatalog) StartChangeSet(input *StartChangeSetInput) (*StartChangeSetOutput, error)

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

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

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

Returned Error Types:

  • InternalServiceException There was an internal service exception.

  • AccessDeniedException Access is denied.

  • ValidationException An error occurred during validation.

  • ResourceNotFoundException The specified resource wasn't found.

  • ResourceInUseException The resource is currently in use.

  • ThrottlingException Too many requests.

  • ServiceQuotaExceededException The maximum number of open requests per account has been exceeded.

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

func (*MarketplaceCatalog) StartChangeSetRequest 

func (c *MarketplaceCatalog) StartChangeSetRequest(input *StartChangeSetInput) (req *request.Request, output *StartChangeSetOutput)

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

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

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

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

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

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

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

func (*MarketplaceCatalog) StartChangeSetWithContext 

func (c *MarketplaceCatalog) StartChangeSetWithContext(ctx aws.Context, input *StartChangeSetInput, opts ...request.Option) (*StartChangeSetOutput, error)

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

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

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

type ResourceInUseException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource is currently in use.

func (*ResourceInUseException) Code added in v1.28.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0 

func (s ResourceInUseException) GoString() string

GoString returns the string representation

func (*ResourceInUseException) Message added in v1.28.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

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

func (ResourceInUseException) String added in v1.28.0 

func (s ResourceInUseException) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource wasn't found.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResourceNotSupportedException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Currently, the specified resource is not supported.

func (*ResourceNotSupportedException) Code added in v1.28.0 

func (s *ResourceNotSupportedException) Code() string

Code returns the exception type name.

func (*ResourceNotSupportedException) Error added in v1.28.0 

func (s *ResourceNotSupportedException) Error() string

func (ResourceNotSupportedException) GoString added in v1.28.0 

func (s ResourceNotSupportedException) GoString() string

GoString returns the string representation

func (*ResourceNotSupportedException) Message added in v1.28.0 

func (s *ResourceNotSupportedException) Message() string

Message returns the exception's message.

func (*ResourceNotSupportedException) OrigErr added in v1.28.0 

func (s *ResourceNotSupportedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotSupportedException) RequestID added in v1.28.0 

func (s *ResourceNotSupportedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotSupportedException) StatusCode added in v1.28.0 

func (s *ResourceNotSupportedException) StatusCode() int

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

func (ResourceNotSupportedException) String added in v1.28.0 

func (s ResourceNotSupportedException) String() string

String returns the string representation

type ServiceQuotaExceededException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The maximum number of open requests per account has been exceeded.

func (*ServiceQuotaExceededException) Code added in v1.28.0 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.28.0 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.28.0 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message added in v1.28.0 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.28.0 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.28.0 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.28.0 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String added in v1.28.0 

func (s ServiceQuotaExceededException) String() string

String returns the string representation

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 *string `type:"string" enum:"SortOrder"`
	// contains filtered or unexported fields
}

An object that contains two attributes, SortBy and SortOrder.

func (Sort) GoString 

func (s Sort) GoString() string

GoString returns the string representation

func (*Sort) SetSortBy 

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

SetSortBy sets the SortBy field's value.

func (*Sort) SetSortOrder 

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

SetSortOrder sets the SortOrder field's value.

func (Sort) String 

func (s Sort) String() string

String returns the string representation

func (*Sort) Validate 

func (s *Sort) Validate() error

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

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

func (s StartChangeSetInput) GoString() string

GoString returns the string representation

func (*StartChangeSetInput) SetCatalog 

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

SetCatalog sets the Catalog field's value.

func (*StartChangeSetInput) SetChangeSet 

func (s *StartChangeSetInput) SetChangeSet(v []*Change) *StartChangeSetInput

SetChangeSet sets the ChangeSet field's value.

func (*StartChangeSetInput) SetChangeSetName 

func (s *StartChangeSetInput) SetChangeSetName(v string) *StartChangeSetInput

SetChangeSetName sets the ChangeSetName field's value.

func (*StartChangeSetInput) SetClientRequestToken 

func (s *StartChangeSetInput) SetClientRequestToken(v string) *StartChangeSetInput

SetClientRequestToken sets the ClientRequestToken field's value.

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

func (s StartChangeSetOutput) GoString() string

GoString returns the string representation

func (*StartChangeSetOutput) SetChangeSetArn 

func (s *StartChangeSetOutput) SetChangeSetArn(v string) *StartChangeSetOutput

SetChangeSetArn sets the ChangeSetArn field's value.

func (*StartChangeSetOutput) SetChangeSetId 

func (s *StartChangeSetOutput) SetChangeSetId(v string) *StartChangeSetOutput

SetChangeSetId sets the ChangeSetId field's value.

func (StartChangeSetOutput) String 

func (s StartChangeSetOutput) String() string

String returns the string representation

type ThrottlingException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Too many requests.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation

type ValidationException added in v1.28.0 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred during validation.

func (*ValidationException) Code added in v1.28.0 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.28.0 

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.28.0 

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message added in v1.28.0 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.28.0 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.28.0 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.28.0 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String added in v1.28.0 

func (s ValidationException) String() string

String returns the string representation

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.