@aws-sdk/client-marketplace-entitlement-service 3.296.0 → 3.297.0

package/dist-types/MarketplaceEntitlementService.d.ts

@@ -2,6 +2,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
 import { GetEntitlementsCommandInput, GetEntitlementsCommandOutput } from "./commands/GetEntitlementsCommand";
 import { MarketplaceEntitlementServiceClient } from "./MarketplaceEntitlementServiceClient";
 /**
+ * @public
  * <fullname>AWS Marketplace Entitlement Service</fullname>
  *          <p>This reference provides descriptions of the AWS Marketplace Entitlement Service
  *    API.</p>
@@ -22,6 +23,7 @@ import { MarketplaceEntitlementServiceClient } from "./MarketplaceEntitlementSer
  */
 export declare class MarketplaceEntitlementService extends MarketplaceEntitlementServiceClient {
     /**
+     * @public
      * <p>GetEntitlements retrieves entitlement values for a given product. The results can be
      *       filtered based on customer identifier or product dimensions.</p>
      */

package/dist-types/MarketplaceEntitlementServiceClient.d.ts

@@ -9,15 +9,24 @@ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration
 import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Credentials as __Credentials, 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 "@aws-sdk/types";
 import { GetEntitlementsCommandInput, GetEntitlementsCommandOutput } from "./commands/GetEntitlementsCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = GetEntitlementsCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = GetEntitlementsCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -107,23 +116,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type MarketplaceEntitlementServiceClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of MarketplaceEntitlementServiceClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of MarketplaceEntitlementServiceClient class constructor that set the region, credentials and other options.
  */
 export interface MarketplaceEntitlementServiceClientConfig extends MarketplaceEntitlementServiceClientConfigType {
 }
+/**
+ * @public
+ */
 type MarketplaceEntitlementServiceClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of MarketplaceEntitlementServiceClient class. This is resolved and normalized from the {@link MarketplaceEntitlementServiceClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of MarketplaceEntitlementServiceClient class. This is resolved and normalized from the {@link MarketplaceEntitlementServiceClientConfig | constructor configuration interface}.
  */
 export interface MarketplaceEntitlementServiceClientResolvedConfig extends MarketplaceEntitlementServiceClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>AWS Marketplace Entitlement Service</fullname>
  *          <p>This reference provides descriptions of the AWS Marketplace Entitlement Service
  *    API.</p>

package/dist-types/commands/GetEntitlementsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { MarketplaceEntitlementServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MarketplaceEntitlementServiceClient";
 import { GetEntitlementsRequest, GetEntitlementsResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetEntitlementsCommand}.
  */
 export interface GetEntitlementsCommandInput extends GetEntitlementsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetEntitlementsCommand}.
  */
 export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>GetEntitlements retrieves entitlement values for a given product. The results can be
  *       filtered based on customer identifier or product dimensions.</p>
  * @example
@@ -26,6 +31,8 @@ export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param GetEntitlementsCommandInput - {@link GetEntitlementsCommandInput}
+ * @returns {@link GetEntitlementsCommandOutput}
  * @see {@link GetEntitlementsCommandInput} for command's `input` shape.
  * @see {@link GetEntitlementsCommandOutput} for command's `response` shape.
  * @see {@link MarketplaceEntitlementServiceClientResolvedConfig | config} for MarketplaceEntitlementServiceClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __M
 export declare class GetEntitlementsCommand extends $Command<GetEntitlementsCommandInput, GetEntitlementsCommandOutput, MarketplaceEntitlementServiceClientResolvedConfig> {
     readonly input: GetEntitlementsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetEntitlementsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MarketplaceEntitlementServiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEntitlementsCommandInput, GetEntitlementsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/MarketplaceEntitlementServiceServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from MarketplaceEntitlementService service.
  */
 export declare class MarketplaceEntitlementServiceServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -1,10 +1,14 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { MarketplaceEntitlementServiceServiceException as __BaseException } from "./MarketplaceEntitlementServiceServiceException";
+/**
+ * @public
+ */
 export declare enum GetEntitlementFilterName {
     CUSTOMER_IDENTIFIER = "CUSTOMER_IDENTIFIER",
     DIMENSION = "DIMENSION"
 }
 /**
+ * @public
  * <p>The GetEntitlementsRequest contains parameters for the GetEntitlements
  *    operation.</p>
  */
@@ -33,6 +37,7 @@ export interface GetEntitlementsRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>The EntitlementValue represents the amount of capacity that the customer is entitled to
  *    for the product.</p>
  */
@@ -59,6 +64,7 @@ export interface EntitlementValue {
     StringValue?: string;
 }
 /**
+ * @public
  * <p>An entitlement represents capacity in a product owned by the customer. For example, a
  *       customer might own some number of users or seats in an SaaS application or  some amount of
  *       data capacity in a multi-tenant database.</p>
@@ -95,6 +101,7 @@ export interface Entitlement {
     ExpirationDate?: Date;
 }
 /**
+ * @public
  * <p>The GetEntitlementsRequest contains results from the GetEntitlements operation.</p>
  */
 export interface GetEntitlementsResult {
@@ -112,6 +119,7 @@ export interface GetEntitlementsResult {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>An internal error has occurred. Retry your request. If the problem persists, post a
  *    message with details on the AWS forums.</p>
  */
@@ -124,6 +132,7 @@ export declare class InternalServiceErrorException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServiceErrorException, __BaseException>);
 }
 /**
+ * @public
  * <p>One or more parameters in your request was invalid.</p>
  */
 export declare class InvalidParameterException extends __BaseException {
@@ -135,6 +144,7 @@ export declare class InvalidParameterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 /**
+ * @public
  * <p>The calls to the GetEntitlements API are throttled.</p>
  */
 export declare class ThrottlingException extends __BaseException {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-marketplace-entitlement-service",
   "description": "AWS SDK for JavaScript Marketplace Entitlement Service Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",