package marketplacecatalog
import "github.com/aws/aws-sdk-go-v2/service/marketplacecatalog"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type CancelChangeSetInput
- type CancelChangeSetOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CancelChangeSet(ctx context.Context, params *CancelChangeSetInput, optFns ...func(*Options)) (*CancelChangeSetOutput, error)
- func (c *Client) DescribeChangeSet(ctx context.Context, params *DescribeChangeSetInput, optFns ...func(*Options)) (*DescribeChangeSetOutput, error)
- func (c *Client) DescribeEntity(ctx context.Context, params *DescribeEntityInput, optFns ...func(*Options)) (*DescribeEntityOutput, error)
- func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput, optFns ...func(*Options)) (*ListChangeSetsOutput, error)
- func (c *Client) ListEntities(ctx context.Context, params *ListEntitiesInput, optFns ...func(*Options)) (*ListEntitiesOutput, error)
- func (c *Client) StartChangeSet(ctx context.Context, params *StartChangeSetInput, optFns ...func(*Options)) (*StartChangeSetOutput, error)
- type DescribeChangeSetInput
- type DescribeChangeSetOutput
- type DescribeEntityInput
- type DescribeEntityOutput
- type EndpointResolver
- type EndpointResolverFunc
- type HTTPClient
- type HTTPSignerV4
- type ListChangeSetsInput
- type ListChangeSetsOutput
- type ListEntitiesInput
- type ListEntitiesOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type StartChangeSetInput
- type StartChangeSetOutput
Constants ¶
const ServiceAPIVersion = "2018-09-17"
const ServiceID = "Marketplace Catalog"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type CancelChangeSetInput ¶
type CancelChangeSetInput struct { // Required. The unique identifier of the StartChangeSet request that you want to // cancel. ChangeSetId *string // Required. The catalog related to the request. Fixed value: AWSMarketplace. Catalog *string }
type CancelChangeSetOutput ¶
type CancelChangeSetOutput struct { // The unique identifier for the change set referenced in this request. ChangeSetId *string // The ARN associated with the change set referenced in this request. ChangeSetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
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. <p>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.</p>
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CancelChangeSet ¶
func (c *Client) CancelChangeSet(ctx context.Context, params *CancelChangeSetInput, optFns ...func(*Options)) (*CancelChangeSetOutput, error)
Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.
func (*Client) DescribeChangeSet ¶
func (c *Client) DescribeChangeSet(ctx context.Context, params *DescribeChangeSetInput, optFns ...func(*Options)) (*DescribeChangeSetOutput, error)
Provides information about a given change set.
func (*Client) DescribeEntity ¶
func (c *Client) DescribeEntity(ctx context.Context, params *DescribeEntityInput, optFns ...func(*Options)) (*DescribeEntityOutput, error)
Returns the metadata and content of the entity.
func (*Client) ListChangeSets ¶
func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput, optFns ...func(*Options)) (*ListChangeSetsOutput, error)
Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. <p>You can describe a change during the 60-day request history retention period for API calls.</p>
func (*Client) ListEntities ¶
func (c *Client) ListEntities(ctx context.Context, params *ListEntitiesInput, optFns ...func(*Options)) (*ListEntitiesOutput, error)
Provides the list of entities of a given type.
func (*Client) StartChangeSet ¶
func (c *Client) StartChangeSet(ctx context.Context, params *StartChangeSetInput, optFns ...func(*Options)) (*StartChangeSetOutput, error)
This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a ResourceInUseException. <p>For example, you cannot start the ChangeSet described in the <a href="https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples">example</a> below because it contains two changes to execute the same change type (<code>AddRevisions</code>) against the same entity (<code>entity-id@1)</code>.</p>
type DescribeChangeSetInput ¶
type DescribeChangeSetInput struct { // Required. The catalog related to the request. Fixed value: AWSMarketplace Catalog *string // Required. The unique identifier for the StartChangeSet request that you want to // describe the details for. ChangeSetId *string }
type DescribeChangeSetOutput ¶
type DescribeChangeSetOutput struct { // 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 // The optional name provided in the StartChangeSet request. If you do not provide // a name, one is set by default. ChangeSetName *string // The status of the change request. Status types.ChangeStatus // Required. The unique identifier for the change set referenced in this request. ChangeSetId *string // The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request // started. StartTime *string // The ARN associated with the unique identifier for the change set referenced in // this request. ChangeSetArn *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 // An array of ChangeSummary objects. ChangeSet []*types.ChangeSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeEntityInput ¶
type DescribeEntityInput struct { // Required. The catalog related to the request. Fixed value: AWSMarketplace Catalog *string // Required. The unique ID of the entity to describe. EntityId *string }
type DescribeEntityOutput ¶
type DescribeEntityOutput struct { // The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z). LastModifiedDate *string // The named type of the entity, in the format of EntityType@Version. EntityType *string // The identifier of the entity, in the format of EntityId@RevisionId. EntityIdentifier *string // This stringified JSON object includes the details of the entity. Details *string // The ARN associated to the unique identifier for the change set referenced in // this request. EntityArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListChangeSetsInput ¶
type ListChangeSetsInput struct { // The token value retrieved from a previous call to access the next page of // results. NextToken *string // An object that contains two attributes, SortBy and SortOrder. Sort *types.Sort // An array of filter objects. FilterList []*types.Filter // The catalog related to the request. Fixed value: AWSMarketplace Catalog *string // The maximum number of results returned by a single call. This value must be // provided in the next call to retrieve the next set of results. By default, this // value is 20. MaxResults *int32 }
type ListChangeSetsOutput ¶
type ListChangeSetsOutput struct { // The value of the next token, if it exists. Null if there are no more results. NextToken *string // Array of ChangeSetSummaryListItem objects. ChangeSetSummaryList []*types.ChangeSetSummaryListItem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListEntitiesInput ¶
type ListEntitiesInput struct { // The type of entities to retrieve. EntityType *string // The catalog related to the request. Fixed value: AWSMarketplace Catalog *string // The value of the next token, if it exists. Null if there are no more results. NextToken *string // Specifies the upper limit of the elements on a single page. If a value isn't // provided, the default value is 20. MaxResults *int32 // An object that contains two attributes, SortBy and SortOrder. Sort *types.Sort // An array of filter objects. Each filter object contains two attributes, // filterName and filterValues. FilterList []*types.Filter }
type ListEntitiesOutput ¶
type ListEntitiesOutput struct { // Array of EntitySummary object. EntitySummaryList []*types.EntitySummary // The value of the next token if it exists. Null if there is no more result. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type StartChangeSetInput ¶
type StartChangeSetInput struct { // Array of change object. ChangeSet []*types.Change // Optional case sensitive string of up to 100 ASCII characters. The change set // name can be used to filter the list of change sets. ChangeSetName *string // A unique token to identify the request to ensure idempotency. ClientRequestToken *string // The catalog related to the request. Fixed value: AWSMarketplace Catalog *string }
type StartChangeSetOutput ¶
type StartChangeSetOutput struct { // Unique identifier generated for the request. ChangeSetId *string // The ARN associated to the unique identifier generated for the request. ChangeSetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CancelChangeSet.go api_op_DescribeChangeSet.go api_op_DescribeEntity.go api_op_ListChangeSets.go api_op_ListEntities.go api_op_StartChangeSet.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- windows/amd64
- Imports
- 24 packages
- Last checked
- 3 weeks ago –
Tools for package owners.