@aws-sdk/client-marketplace-agreement 3.463.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +249 -0
  3. package/dist-cjs/MarketplaceAgreement.js +17 -0
  4. package/dist-cjs/MarketplaceAgreementClient.js +43 -0
  5. package/dist-cjs/commands/DescribeAgreementCommand.js +51 -0
  6. package/dist-cjs/commands/GetAgreementTermsCommand.js +51 -0
  7. package/dist-cjs/commands/SearchAgreementsCommand.js +51 -0
  8. package/dist-cjs/commands/index.js +6 -0
  9. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  10. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  11. package/dist-cjs/endpoint/ruleset.js +7 -0
  12. package/dist-cjs/extensionConfiguration.js +2 -0
  13. package/dist-cjs/index.js +12 -0
  14. package/dist-cjs/models/MarketplaceAgreementServiceException.js +12 -0
  15. package/dist-cjs/models/index.js +4 -0
  16. package/dist-cjs/models/models_0.js +137 -0
  17. package/dist-cjs/pagination/GetAgreementTermsPaginator.js +29 -0
  18. package/dist-cjs/pagination/Interfaces.js +2 -0
  19. package/dist-cjs/pagination/SearchAgreementsPaginator.js +29 -0
  20. package/dist-cjs/pagination/index.js +6 -0
  21. package/dist-cjs/protocols/Aws_json1_0.js +420 -0
  22. package/dist-cjs/runtimeConfig.browser.js +39 -0
  23. package/dist-cjs/runtimeConfig.js +50 -0
  24. package/dist-cjs/runtimeConfig.native.js +15 -0
  25. package/dist-cjs/runtimeConfig.shared.js +24 -0
  26. package/dist-cjs/runtimeExtensions.js +22 -0
  27. package/dist-es/MarketplaceAgreement.js +13 -0
  28. package/dist-es/MarketplaceAgreementClient.js +39 -0
  29. package/dist-es/commands/DescribeAgreementCommand.js +47 -0
  30. package/dist-es/commands/GetAgreementTermsCommand.js +47 -0
  31. package/dist-es/commands/SearchAgreementsCommand.js +47 -0
  32. package/dist-es/commands/index.js +3 -0
  33. package/dist-es/endpoint/EndpointParameters.js +8 -0
  34. package/dist-es/endpoint/endpointResolver.js +8 -0
  35. package/dist-es/endpoint/ruleset.js +4 -0
  36. package/dist-es/extensionConfiguration.js +1 -0
  37. package/dist-es/index.js +7 -0
  38. package/dist-es/models/MarketplaceAgreementServiceException.js +8 -0
  39. package/dist-es/models/index.js +1 -0
  40. package/dist-es/models/models_0.js +129 -0
  41. package/dist-es/pagination/GetAgreementTermsPaginator.js +25 -0
  42. package/dist-es/pagination/Interfaces.js +1 -0
  43. package/dist-es/pagination/SearchAgreementsPaginator.js +25 -0
  44. package/dist-es/pagination/index.js +3 -0
  45. package/dist-es/protocols/Aws_json1_0.js +411 -0
  46. package/dist-es/runtimeConfig.browser.js +34 -0
  47. package/dist-es/runtimeConfig.js +45 -0
  48. package/dist-es/runtimeConfig.native.js +11 -0
  49. package/dist-es/runtimeConfig.shared.js +20 -0
  50. package/dist-es/runtimeExtensions.js +18 -0
  51. package/dist-types/MarketplaceAgreement.d.ts +51 -0
  52. package/dist-types/MarketplaceAgreementClient.d.ts +192 -0
  53. package/dist-types/commands/DescribeAgreementCommand.d.ts +112 -0
  54. package/dist-types/commands/GetAgreementTermsCommand.d.ts +235 -0
  55. package/dist-types/commands/SearchAgreementsCommand.d.ts +213 -0
  56. package/dist-types/commands/index.d.ts +3 -0
  57. package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
  58. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  59. package/dist-types/endpoint/ruleset.d.ts +2 -0
  60. package/dist-types/extensionConfiguration.d.ts +8 -0
  61. package/dist-types/index.d.ts +35 -0
  62. package/dist-types/models/MarketplaceAgreementServiceException.d.ts +13 -0
  63. package/dist-types/models/index.d.ts +1 -0
  64. package/dist-types/models/models_0.d.ts +1350 -0
  65. package/dist-types/pagination/GetAgreementTermsPaginator.d.ts +7 -0
  66. package/dist-types/pagination/Interfaces.d.ts +8 -0
  67. package/dist-types/pagination/SearchAgreementsPaginator.d.ts +7 -0
  68. package/dist-types/pagination/index.d.ts +3 -0
  69. package/dist-types/protocols/Aws_json1_0.d.ts +29 -0
  70. package/dist-types/runtimeConfig.browser.d.ts +46 -0
  71. package/dist-types/runtimeConfig.d.ts +46 -0
  72. package/dist-types/runtimeConfig.native.d.ts +45 -0
  73. package/dist-types/runtimeConfig.shared.d.ts +19 -0
  74. package/dist-types/runtimeExtensions.d.ts +17 -0
  75. package/dist-types/ts3.4/MarketplaceAgreement.d.ts +58 -0
  76. package/dist-types/ts3.4/MarketplaceAgreementClient.d.ts +139 -0
  77. package/dist-types/ts3.4/commands/DescribeAgreementCommand.d.ts +38 -0
  78. package/dist-types/ts3.4/commands/GetAgreementTermsCommand.d.ts +38 -0
  79. package/dist-types/ts3.4/commands/SearchAgreementsCommand.d.ts +38 -0
  80. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  81. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
  82. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  83. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  84. package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
  85. package/dist-types/ts3.4/index.d.ts +10 -0
  86. package/dist-types/ts3.4/models/MarketplaceAgreementServiceException.d.ts +8 -0
  87. package/dist-types/ts3.4/models/index.d.ts +1 -0
  88. package/dist-types/ts3.4/models/models_0.d.ts +458 -0
  89. package/dist-types/ts3.4/pagination/GetAgreementTermsPaginator.d.ts +11 -0
  90. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  91. package/dist-types/ts3.4/pagination/SearchAgreementsPaginator.d.ts +11 -0
  92. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  93. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +41 -0
  94. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +99 -0
  95. package/dist-types/ts3.4/runtimeConfig.d.ts +99 -0
  96. package/dist-types/ts3.4/runtimeConfig.native.d.ts +90 -0
  97. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
  98. package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
  99. package/package.json +102 -0
@@ -0,0 +1,192 @@
1
+ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
2
+ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
3
+ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
4
+ import { Credentials as __Credentials } from "@aws-sdk/types";
5
+ import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
6
+ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
7
+ import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
8
+ import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
9
+ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
10
+ import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
11
+ import { DescribeAgreementCommandInput, DescribeAgreementCommandOutput } from "./commands/DescribeAgreementCommand";
12
+ import { GetAgreementTermsCommandInput, GetAgreementTermsCommandOutput } from "./commands/GetAgreementTermsCommand";
13
+ import { SearchAgreementsCommandInput, SearchAgreementsCommandOutput } from "./commands/SearchAgreementsCommand";
14
+ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
15
+ import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
16
+ export { __Client };
17
+ /**
18
+ * @public
19
+ */
20
+ export type ServiceInputTypes = DescribeAgreementCommandInput | GetAgreementTermsCommandInput | SearchAgreementsCommandInput;
21
+ /**
22
+ * @public
23
+ */
24
+ export type ServiceOutputTypes = DescribeAgreementCommandOutput | GetAgreementTermsCommandOutput | SearchAgreementsCommandOutput;
25
+ /**
26
+ * @public
27
+ */
28
+ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
29
+ /**
30
+ * The HTTP handler to use. Fetch in browser and Https in Nodejs.
31
+ */
32
+ requestHandler?: __HttpHandler;
33
+ /**
34
+ * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
35
+ * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
36
+ * @internal
37
+ */
38
+ sha256?: __ChecksumConstructor | __HashConstructor;
39
+ /**
40
+ * The function that will be used to convert strings into HTTP endpoints.
41
+ * @internal
42
+ */
43
+ urlParser?: __UrlParser;
44
+ /**
45
+ * A function that can calculate the length of a request body.
46
+ * @internal
47
+ */
48
+ bodyLengthChecker?: __BodyLengthCalculator;
49
+ /**
50
+ * A function that converts a stream into an array of bytes.
51
+ * @internal
52
+ */
53
+ streamCollector?: __StreamCollector;
54
+ /**
55
+ * The function that will be used to convert a base64-encoded string to a byte array.
56
+ * @internal
57
+ */
58
+ base64Decoder?: __Decoder;
59
+ /**
60
+ * The function that will be used to convert binary data to a base64-encoded string.
61
+ * @internal
62
+ */
63
+ base64Encoder?: __Encoder;
64
+ /**
65
+ * The function that will be used to convert a UTF8-encoded string to a byte array.
66
+ * @internal
67
+ */
68
+ utf8Decoder?: __Decoder;
69
+ /**
70
+ * The function that will be used to convert binary data to a UTF-8 encoded string.
71
+ * @internal
72
+ */
73
+ utf8Encoder?: __Encoder;
74
+ /**
75
+ * The runtime environment.
76
+ * @internal
77
+ */
78
+ runtime?: string;
79
+ /**
80
+ * Disable dynamically changing the endpoint of the client based on the hostPrefix
81
+ * trait of an operation.
82
+ */
83
+ disableHostPrefix?: boolean;
84
+ /**
85
+ * Unique service identifier.
86
+ * @internal
87
+ */
88
+ serviceId?: string;
89
+ /**
90
+ * Enables IPv6/IPv4 dualstack endpoint.
91
+ */
92
+ useDualstackEndpoint?: boolean | __Provider<boolean>;
93
+ /**
94
+ * Enables FIPS compatible endpoints.
95
+ */
96
+ useFipsEndpoint?: boolean | __Provider<boolean>;
97
+ /**
98
+ * The AWS region to which this client will send requests
99
+ */
100
+ region?: string | __Provider<string>;
101
+ /**
102
+ * Default credentials provider; Not available in browser runtime.
103
+ * @internal
104
+ */
105
+ credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
106
+ /**
107
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
108
+ * @internal
109
+ */
110
+ defaultUserAgentProvider?: Provider<__UserAgent>;
111
+ /**
112
+ * Value for how many times a request will be made at most in case of retry.
113
+ */
114
+ maxAttempts?: number | __Provider<number>;
115
+ /**
116
+ * Specifies which retry algorithm to use.
117
+ * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
118
+ *
119
+ */
120
+ retryMode?: string | __Provider<string>;
121
+ /**
122
+ * Optional logger for logging debug/info/warn/error.
123
+ */
124
+ logger?: __Logger;
125
+ /**
126
+ * Optional extensions
127
+ */
128
+ extensions?: RuntimeExtension[];
129
+ /**
130
+ * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
+ */
132
+ defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
133
+ }
134
+ /**
135
+ * @public
136
+ */
137
+ export type MarketplaceAgreementClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
138
+ /**
139
+ * @public
140
+ *
141
+ * The configuration interface of MarketplaceAgreementClient class constructor that set the region, credentials and other options.
142
+ */
143
+ export interface MarketplaceAgreementClientConfig extends MarketplaceAgreementClientConfigType {
144
+ }
145
+ /**
146
+ * @public
147
+ */
148
+ export type MarketplaceAgreementClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
149
+ /**
150
+ * @public
151
+ *
152
+ * The resolved configuration interface of MarketplaceAgreementClient class. This is resolved and normalized from the {@link MarketplaceAgreementClientConfig | constructor configuration interface}.
153
+ */
154
+ export interface MarketplaceAgreementClientResolvedConfig extends MarketplaceAgreementClientResolvedConfigType {
155
+ }
156
+ /**
157
+ * @public
158
+ * <p>AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.</p>
159
+ * <p>To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and
160
+ * Access Management (IAM) policies and roles are set up. The user must have the required
161
+ * policies/permissions that allow them to carry out the actions in AWS:</p>
162
+ * <ul>
163
+ * <li>
164
+ * <p>
165
+ * <code>DescribeAgreement</code> – Grants permission to users to obtain detailed
166
+ * meta data about any of their agreements.</p>
167
+ * </li>
168
+ * <li>
169
+ * <p>
170
+ * <code>GetAgreementTerms</code> – Grants permission to users to obtain details
171
+ * about the terms of an agreement.</p>
172
+ * </li>
173
+ * <li>
174
+ * <p>
175
+ * <code>SearchAgreements</code> – Grants permission to users to search through all
176
+ * their agreements.</p>
177
+ * </li>
178
+ * </ul>
179
+ */
180
+ export declare class MarketplaceAgreementClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, MarketplaceAgreementClientResolvedConfig> {
181
+ /**
182
+ * The resolved configuration of MarketplaceAgreementClient class. This is resolved and normalized from the {@link MarketplaceAgreementClientConfig | constructor configuration interface}.
183
+ */
184
+ readonly config: MarketplaceAgreementClientResolvedConfig;
185
+ constructor(...[configuration]: __CheckOptionalClientConfig<MarketplaceAgreementClientConfig>);
186
+ /**
187
+ * Destroy underlying resources, like sockets. It's usually not necessary to do this.
188
+ * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
189
+ * Otherwise, sockets might stay open for quite a long time before the server terminates them.
190
+ */
191
+ destroy(): void;
192
+ }
@@ -0,0 +1,112 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { MarketplaceAgreementClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MarketplaceAgreementClient";
5
+ import { DescribeAgreementInput, DescribeAgreementOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeAgreementCommand}.
14
+ */
15
+ export interface DescribeAgreementCommandInput extends DescribeAgreementInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeAgreementCommand}.
21
+ */
22
+ export interface DescribeAgreementCommandOutput extends DescribeAgreementOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Provides details about an agreement, such as the proposer, acceptor, start date, and end date.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { MarketplaceAgreementClient, DescribeAgreementCommand } from "@aws-sdk/client-marketplace-agreement"; // ES Modules import
31
+ * // const { MarketplaceAgreementClient, DescribeAgreementCommand } = require("@aws-sdk/client-marketplace-agreement"); // CommonJS import
32
+ * const client = new MarketplaceAgreementClient(config);
33
+ * const input = { // DescribeAgreementInput
34
+ * agreementId: "STRING_VALUE", // required
35
+ * };
36
+ * const command = new DescribeAgreementCommand(input);
37
+ * const response = await client.send(command);
38
+ * // { // DescribeAgreementOutput
39
+ * // agreementId: "STRING_VALUE",
40
+ * // acceptor: { // Acceptor
41
+ * // accountId: "STRING_VALUE",
42
+ * // },
43
+ * // proposer: { // Proposer
44
+ * // accountId: "STRING_VALUE",
45
+ * // },
46
+ * // startTime: new Date("TIMESTAMP"),
47
+ * // endTime: new Date("TIMESTAMP"),
48
+ * // acceptanceTime: new Date("TIMESTAMP"),
49
+ * // agreementType: "STRING_VALUE",
50
+ * // estimatedCharges: { // EstimatedCharges
51
+ * // currencyCode: "STRING_VALUE",
52
+ * // agreementValue: "STRING_VALUE",
53
+ * // },
54
+ * // proposalSummary: { // ProposalSummary
55
+ * // resources: [ // Resources
56
+ * // { // Resource
57
+ * // id: "STRING_VALUE",
58
+ * // type: "STRING_VALUE",
59
+ * // },
60
+ * // ],
61
+ * // offerId: "STRING_VALUE",
62
+ * // },
63
+ * // status: "ACTIVE" || "ARCHIVED" || "CANCELLED" || "EXPIRED" || "RENEWED" || "REPLACED" || "ROLLED_BACK" || "SUPERSEDED" || "TERMINATED",
64
+ * // };
65
+ *
66
+ * ```
67
+ *
68
+ * @param DescribeAgreementCommandInput - {@link DescribeAgreementCommandInput}
69
+ * @returns {@link DescribeAgreementCommandOutput}
70
+ * @see {@link DescribeAgreementCommandInput} for command's `input` shape.
71
+ * @see {@link DescribeAgreementCommandOutput} for command's `response` shape.
72
+ * @see {@link MarketplaceAgreementClientResolvedConfig | config} for MarketplaceAgreementClient's `config` shape.
73
+ *
74
+ * @throws {@link AccessDeniedException} (client fault)
75
+ * <p>User does not have sufficient access to perform this action.</p>
76
+ *
77
+ * @throws {@link InternalServerException} (server fault)
78
+ * <p>Unexpected error during processing of request.</p>
79
+ *
80
+ * @throws {@link ResourceNotFoundException} (client fault)
81
+ * <p>Request references a resource which does not exist.</p>
82
+ *
83
+ * @throws {@link ThrottlingException} (client fault)
84
+ * <p>Request was denied due to request throttling.</p>
85
+ *
86
+ * @throws {@link ValidationException} (client fault)
87
+ * <p>The input fails to satisfy the constraints specified by the service.</p>
88
+ *
89
+ * @throws {@link MarketplaceAgreementServiceException}
90
+ * <p>Base exception class for all service exceptions from MarketplaceAgreement service.</p>
91
+ *
92
+ */
93
+ export declare class DescribeAgreementCommand extends $Command<DescribeAgreementCommandInput, DescribeAgreementCommandOutput, MarketplaceAgreementClientResolvedConfig> {
94
+ readonly input: DescribeAgreementCommandInput;
95
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
96
+ /**
97
+ * @public
98
+ */
99
+ constructor(input: DescribeAgreementCommandInput);
100
+ /**
101
+ * @internal
102
+ */
103
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MarketplaceAgreementClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAgreementCommandInput, DescribeAgreementCommandOutput>;
104
+ /**
105
+ * @internal
106
+ */
107
+ private serialize;
108
+ /**
109
+ * @internal
110
+ */
111
+ private deserialize;
112
+ }
@@ -0,0 +1,235 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { MarketplaceAgreementClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MarketplaceAgreementClient";
5
+ import { GetAgreementTermsInput, GetAgreementTermsOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetAgreementTermsCommand}.
14
+ */
15
+ export interface GetAgreementTermsCommandInput extends GetAgreementTermsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetAgreementTermsCommand}.
21
+ */
22
+ export interface GetAgreementTermsCommandOutput extends GetAgreementTermsOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Obtains details about the terms in an agreement that you participated in as proposer or
27
+ * acceptor.</p>
28
+ * <p>The details include:</p>
29
+ * <ul>
30
+ * <li>
31
+ * <p>
32
+ * <code>TermType</code> – The type of term, such as <code>LegalTerm</code>,
33
+ * <code>RenewalTerm</code>, or <code>ConfigurableUpfrontPricingTerm</code>.</p>
34
+ * </li>
35
+ * <li>
36
+ * <p>
37
+ * <code>TermID</code> – The ID of the particular term, which is common between offer
38
+ * and agreement.</p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <code>TermPayload</code> – The key information contained in the term, such as the
43
+ * EULA for <code>LegalTerm</code> or pricing and dimensions for various pricing terms,
44
+ * such as <code>ConfigurableUpfrontPricingTerm</code> or
45
+ * <code>UsageBasedPricingTerm</code>.</p>
46
+ * </li>
47
+ * </ul>
48
+ * <ul>
49
+ * <li>
50
+ * <p>
51
+ * <code>Configuration</code> – The buyer/acceptor's selection at the time of
52
+ * agreement creation, such as the number of units purchased for a dimension or setting
53
+ * the <code>EnableAutoRenew</code> flag.</p>
54
+ * </li>
55
+ * </ul>
56
+ * @example
57
+ * Use a bare-bones client and the command you need to make an API call.
58
+ * ```javascript
59
+ * import { MarketplaceAgreementClient, GetAgreementTermsCommand } from "@aws-sdk/client-marketplace-agreement"; // ES Modules import
60
+ * // const { MarketplaceAgreementClient, GetAgreementTermsCommand } = require("@aws-sdk/client-marketplace-agreement"); // CommonJS import
61
+ * const client = new MarketplaceAgreementClient(config);
62
+ * const input = { // GetAgreementTermsInput
63
+ * agreementId: "STRING_VALUE", // required
64
+ * maxResults: Number("int"),
65
+ * nextToken: "STRING_VALUE",
66
+ * };
67
+ * const command = new GetAgreementTermsCommand(input);
68
+ * const response = await client.send(command);
69
+ * // { // GetAgreementTermsOutput
70
+ * // acceptedTerms: [ // AcceptedTermList
71
+ * // { // AcceptedTerm Union: only one key present
72
+ * // legalTerm: { // LegalTerm
73
+ * // type: "STRING_VALUE",
74
+ * // documents: [ // DocumentList
75
+ * // { // DocumentItem
76
+ * // type: "STRING_VALUE",
77
+ * // url: "STRING_VALUE",
78
+ * // version: "STRING_VALUE",
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // supportTerm: { // SupportTerm
83
+ * // type: "STRING_VALUE",
84
+ * // refundPolicy: "STRING_VALUE",
85
+ * // },
86
+ * // renewalTerm: { // RenewalTerm
87
+ * // type: "STRING_VALUE",
88
+ * // configuration: { // RenewalTermConfiguration
89
+ * // enableAutoRenew: true || false, // required
90
+ * // },
91
+ * // },
92
+ * // usageBasedPricingTerm: { // UsageBasedPricingTerm
93
+ * // type: "STRING_VALUE",
94
+ * // currencyCode: "STRING_VALUE",
95
+ * // rateCards: [ // UsageBasedRateCardList
96
+ * // { // UsageBasedRateCardItem
97
+ * // rateCard: [ // RateCardList
98
+ * // { // RateCardItem
99
+ * // dimensionKey: "STRING_VALUE",
100
+ * // price: "STRING_VALUE",
101
+ * // },
102
+ * // ],
103
+ * // },
104
+ * // ],
105
+ * // },
106
+ * // configurableUpfrontPricingTerm: { // ConfigurableUpfrontPricingTerm
107
+ * // type: "STRING_VALUE",
108
+ * // currencyCode: "STRING_VALUE",
109
+ * // rateCards: [ // ConfigurableUpfrontRateCardList
110
+ * // { // ConfigurableUpfrontRateCardItem
111
+ * // selector: { // Selector
112
+ * // type: "STRING_VALUE",
113
+ * // value: "STRING_VALUE",
114
+ * // },
115
+ * // constraints: { // Constraints
116
+ * // multipleDimensionSelection: "STRING_VALUE",
117
+ * // quantityConfiguration: "STRING_VALUE",
118
+ * // },
119
+ * // rateCard: [
120
+ * // {
121
+ * // dimensionKey: "STRING_VALUE",
122
+ * // price: "STRING_VALUE",
123
+ * // },
124
+ * // ],
125
+ * // },
126
+ * // ],
127
+ * // configuration: { // ConfigurableUpfrontPricingTermConfiguration
128
+ * // selectorValue: "STRING_VALUE", // required
129
+ * // dimensions: [ // DimensionList // required
130
+ * // { // Dimension
131
+ * // dimensionKey: "STRING_VALUE", // required
132
+ * // dimensionValue: Number("int"), // required
133
+ * // },
134
+ * // ],
135
+ * // },
136
+ * // },
137
+ * // byolPricingTerm: { // ByolPricingTerm
138
+ * // type: "STRING_VALUE",
139
+ * // },
140
+ * // recurringPaymentTerm: { // RecurringPaymentTerm
141
+ * // type: "STRING_VALUE",
142
+ * // currencyCode: "STRING_VALUE",
143
+ * // billingPeriod: "STRING_VALUE",
144
+ * // price: "STRING_VALUE",
145
+ * // },
146
+ * // validityTerm: { // ValidityTerm
147
+ * // type: "STRING_VALUE",
148
+ * // agreementDuration: "STRING_VALUE",
149
+ * // agreementStartDate: new Date("TIMESTAMP"),
150
+ * // agreementEndDate: new Date("TIMESTAMP"),
151
+ * // },
152
+ * // paymentScheduleTerm: { // PaymentScheduleTerm
153
+ * // type: "STRING_VALUE",
154
+ * // currencyCode: "STRING_VALUE",
155
+ * // schedule: [ // ScheduleList
156
+ * // { // ScheduleItem
157
+ * // chargeDate: new Date("TIMESTAMP"),
158
+ * // chargeAmount: "STRING_VALUE",
159
+ * // },
160
+ * // ],
161
+ * // },
162
+ * // freeTrialPricingTerm: { // FreeTrialPricingTerm
163
+ * // type: "STRING_VALUE",
164
+ * // duration: "STRING_VALUE",
165
+ * // grants: [ // GrantList
166
+ * // { // GrantItem
167
+ * // dimensionKey: "STRING_VALUE",
168
+ * // maxQuantity: Number("int"),
169
+ * // },
170
+ * // ],
171
+ * // },
172
+ * // fixedUpfrontPricingTerm: { // FixedUpfrontPricingTerm
173
+ * // type: "STRING_VALUE",
174
+ * // currencyCode: "STRING_VALUE",
175
+ * // duration: "STRING_VALUE",
176
+ * // price: "STRING_VALUE",
177
+ * // grants: [
178
+ * // {
179
+ * // dimensionKey: "STRING_VALUE",
180
+ * // maxQuantity: Number("int"),
181
+ * // },
182
+ * // ],
183
+ * // },
184
+ * // },
185
+ * // ],
186
+ * // nextToken: "STRING_VALUE",
187
+ * // };
188
+ *
189
+ * ```
190
+ *
191
+ * @param GetAgreementTermsCommandInput - {@link GetAgreementTermsCommandInput}
192
+ * @returns {@link GetAgreementTermsCommandOutput}
193
+ * @see {@link GetAgreementTermsCommandInput} for command's `input` shape.
194
+ * @see {@link GetAgreementTermsCommandOutput} for command's `response` shape.
195
+ * @see {@link MarketplaceAgreementClientResolvedConfig | config} for MarketplaceAgreementClient's `config` shape.
196
+ *
197
+ * @throws {@link AccessDeniedException} (client fault)
198
+ * <p>User does not have sufficient access to perform this action.</p>
199
+ *
200
+ * @throws {@link InternalServerException} (server fault)
201
+ * <p>Unexpected error during processing of request.</p>
202
+ *
203
+ * @throws {@link ResourceNotFoundException} (client fault)
204
+ * <p>Request references a resource which does not exist.</p>
205
+ *
206
+ * @throws {@link ThrottlingException} (client fault)
207
+ * <p>Request was denied due to request throttling.</p>
208
+ *
209
+ * @throws {@link ValidationException} (client fault)
210
+ * <p>The input fails to satisfy the constraints specified by the service.</p>
211
+ *
212
+ * @throws {@link MarketplaceAgreementServiceException}
213
+ * <p>Base exception class for all service exceptions from MarketplaceAgreement service.</p>
214
+ *
215
+ */
216
+ export declare class GetAgreementTermsCommand extends $Command<GetAgreementTermsCommandInput, GetAgreementTermsCommandOutput, MarketplaceAgreementClientResolvedConfig> {
217
+ readonly input: GetAgreementTermsCommandInput;
218
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
219
+ /**
220
+ * @public
221
+ */
222
+ constructor(input: GetAgreementTermsCommandInput);
223
+ /**
224
+ * @internal
225
+ */
226
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MarketplaceAgreementClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAgreementTermsCommandInput, GetAgreementTermsCommandOutput>;
227
+ /**
228
+ * @internal
229
+ */
230
+ private serialize;
231
+ /**
232
+ * @internal
233
+ */
234
+ private deserialize;
235
+ }