1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package marketplacemetering
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Paid container software products sold through AWS Marketplace must integrate
// with the AWS Marketplace Metering Service and call the RegisterUsage operation
// for software entitlement and metering. Free and BYOL products for Amazon ECS or
// Amazon EKS aren't required to call RegisterUsage , but you may choose to do so
// if you would like to receive usage data in your seller reports. The sections
// below explain the behavior of RegisterUsage . RegisterUsage performs two
// primary functions: metering and entitlement.
//
// - Entitlement: RegisterUsage allows you to verify that the customer running
// your paid software is subscribed to your product on AWS Marketplace, enabling
// you to guard against unauthorized use. Your container image that integrates with
// RegisterUsage is only required to guard against unauthorized use at container
// startup, as such a CustomerNotSubscribedException or
// PlatformNotSupportedException will only be thrown on the initial call to
// RegisterUsage . Subsequent calls from the same Amazon ECS task instance (e.g.
// task-id) or Amazon EKS pod will not throw a CustomerNotSubscribedException ,
// even if the customer unsubscribes while the Amazon ECS task or Amazon EKS pod is
// still running.
//
// - Metering: RegisterUsage meters software use per ECS task, per hour, or per
// pod for Amazon EKS with usage prorated to the second. A minimum of 1 minute of
// usage applies to tasks that are short lived. For example, if a customer has a 10
// node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon Set,
// then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and the
// customer will be charged: (10 * hourly_rate). Metering for software use is
// automatically handled by the AWS Marketplace Metering Control Plane -- your
// software is not required to perform any metering specific actions, other than
// call RegisterUsage once for metering of software use to commence. The AWS
// Marketplace Metering Control Plane will also continue to bill customers for
// running ECS tasks and Amazon EKS pods, regardless of the customers subscription
// state, removing the need for your software to perform entitlement checks at
// runtime.
func (c *Client) RegisterUsage(ctx context.Context, params *RegisterUsageInput, optFns ...func(*Options)) (*RegisterUsageOutput, error) {
if params == nil {
params = &RegisterUsageInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RegisterUsage", params, optFns, c.addOperationRegisterUsageMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RegisterUsageOutput)
out.ResultMetadata = metadata
return out, nil
}
type RegisterUsageInput struct {
// Product code is used to uniquely identify a product in AWS Marketplace. The
// product code should be the same as the one used during the publishing of a new
// product.
//
// This member is required.
ProductCode *string
// Public Key Version provided by AWS Marketplace
//
// This member is required.
PublicKeyVersion *int32
// (Optional) To scope down the registration to a specific running software
// instance and guard against replay attacks.
Nonce *string
noSmithyDocumentSerde
}
type RegisterUsageOutput struct {
// (Optional) Only included when public key version has expired
PublicKeyRotationTimestamp *time.Time
// JWT Token
Signature *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRegisterUsageMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpRegisterUsage{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpRegisterUsage{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "RegisterUsage"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpRegisterUsageValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRegisterUsage(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRegisterUsage(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "RegisterUsage",
}
}
|
