@aws-sdk/client-workmailmessageflow 3.296.0 → 3.297.0

package/dist-types/WorkMailMessageFlow.d.ts

@@ -3,6 +3,7 @@ import { GetRawMessageContentCommandInput, GetRawMessageContentCommandOutput } f
 import { PutRawMessageContentCommandInput, PutRawMessageContentCommandOutput } from "./commands/PutRawMessageContentCommand";
 import { WorkMailMessageFlowClient } from "./WorkMailMessageFlowClient";
 /**
+ * @public
  * <p>The WorkMail Message Flow API provides access to email messages as they are
  *       being
  *       sent and received by
@@ -11,12 +12,14 @@ import { WorkMailMessageFlowClient } from "./WorkMailMessageFlowClient";
  */
 export declare class WorkMailMessageFlow extends WorkMailMessageFlowClient {
     /**
+     * @public
      * <p>Retrieves the raw content of an in-transit email message, in MIME format.</p>
      */
     getRawMessageContent(args: GetRawMessageContentCommandInput, options?: __HttpHandlerOptions): Promise<GetRawMessageContentCommandOutput>;
     getRawMessageContent(args: GetRawMessageContentCommandInput, cb: (err: any, data?: GetRawMessageContentCommandOutput) => void): void;
     getRawMessageContent(args: GetRawMessageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRawMessageContentCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the raw content of an in-transit email message, in MIME format.</p>
      *          <p>This example describes how to update in-transit email message. For more information and examples for using this API, see
      *       <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html">

package/dist-types/WorkMailMessageFlowClient.d.ts

@@ -10,15 +10,24 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
 import { GetRawMessageContentCommandInput, GetRawMessageContentCommandOutput } from "./commands/GetRawMessageContentCommand";
 import { PutRawMessageContentCommandInput, PutRawMessageContentCommandOutput } from "./commands/PutRawMessageContentCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = GetRawMessageContentCommandInput | PutRawMessageContentCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = GetRawMessageContentCommandOutput | PutRawMessageContentCommandOutput;
+/**
+ * @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
      */
@@ -108,7 +117,7 @@ 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>;
     /**
@@ -117,19 +126,30 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     sdkStreamMixin?: __SdkStreamMixinInjector;
 }
+/**
+ * @public
+ */
 type WorkMailMessageFlowClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of WorkMailMessageFlowClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of WorkMailMessageFlowClient class constructor that set the region, credentials and other options.
  */
 export interface WorkMailMessageFlowClientConfig extends WorkMailMessageFlowClientConfigType {
 }
+/**
+ * @public
+ */
 type WorkMailMessageFlowClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of WorkMailMessageFlowClient class. This is resolved and normalized from the {@link WorkMailMessageFlowClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of WorkMailMessageFlowClient class. This is resolved and normalized from the {@link WorkMailMessageFlowClientConfig | constructor configuration interface}.
  */
 export interface WorkMailMessageFlowClientResolvedConfig extends WorkMailMessageFlowClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>The WorkMail Message Flow API provides access to email messages as they are
  *       being
  *       sent and received by

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetRawMessageContentRequest, GetRawMessageContentResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailMessageFlowClientResolvedConfig } from "../WorkMailMessageFlowClient";
 /**
+ * @public
+ *
  * The input for {@link GetRawMessageContentCommand}.
  */
 export interface GetRawMessageContentCommandInput extends GetRawMessageContentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetRawMessageContentCommand}.
  */
 export interface GetRawMessageContentCommandOutput extends __WithSdkStreamMixin<GetRawMessageContentResponse, "messageContent">, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the raw content of an in-transit email message, in MIME format.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetRawMessageContentCommandOutput extends __WithSdkStreamMixin<
  * const response = await client.send(command);
  * ```
  *
+ * @param GetRawMessageContentCommandInput - {@link GetRawMessageContentCommandInput}
+ * @returns {@link GetRawMessageContentCommandOutput}
  * @see {@link GetRawMessageContentCommandInput} for command's `input` shape.
  * @see {@link GetRawMessageContentCommandOutput} for command's `response` shape.
  * @see {@link WorkMailMessageFlowClientResolvedConfig | config} for WorkMailMessageFlowClient's `config` shape.
@@ -37,11 +44,20 @@ export interface GetRawMessageContentCommandOutput extends __WithSdkStreamMixin<
 export declare class GetRawMessageContentCommand extends $Command<GetRawMessageContentCommandInput, GetRawMessageContentCommandOutput, WorkMailMessageFlowClientResolvedConfig> {
     readonly input: GetRawMessageContentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetRawMessageContentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailMessageFlowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRawMessageContentCommandInput, GetRawMessageContentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutRawMessageContentRequest, PutRawMessageContentResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailMessageFlowClientResolvedConfig } from "../WorkMailMessageFlowClient";
 /**
+ * @public
+ *
  * The input for {@link PutRawMessageContentCommand}.
  */
 export interface PutRawMessageContentCommandInput extends PutRawMessageContentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutRawMessageContentCommand}.
  */
 export interface PutRawMessageContentCommandOutput extends PutRawMessageContentResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the raw content of an in-transit email message, in MIME format.</p>
  *          <p>This example describes how to update in-transit email message. For more information and examples for using this API, see
  *       <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html">
@@ -38,6 +43,8 @@ export interface PutRawMessageContentCommandOutput extends PutRawMessageContentR
  * const response = await client.send(command);
  * ```
  *
+ * @param PutRawMessageContentCommandInput - {@link PutRawMessageContentCommandInput}
+ * @returns {@link PutRawMessageContentCommandOutput}
  * @see {@link PutRawMessageContentCommandInput} for command's `input` shape.
  * @see {@link PutRawMessageContentCommandOutput} for command's `response` shape.
  * @see {@link WorkMailMessageFlowClientResolvedConfig | config} for WorkMailMessageFlowClient's `config` shape.
@@ -76,11 +83,20 @@ export interface PutRawMessageContentCommandOutput extends PutRawMessageContentR
 export declare class PutRawMessageContentCommand extends $Command<PutRawMessageContentCommandInput, PutRawMessageContentCommandOutput, WorkMailMessageFlowClientResolvedConfig> {
     readonly input: PutRawMessageContentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutRawMessageContentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailMessageFlowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutRawMessageContentCommandInput, PutRawMessageContentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/WorkMailMessageFlowServiceException.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 WorkMailMessageFlow service.
  */
 export declare class WorkMailMessageFlowServiceException extends __ServiceException {

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

@@ -2,12 +2,18 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { Readable } from "stream";
 import { WorkMailMessageFlowServiceException as __BaseException } from "./WorkMailMessageFlowServiceException";
+/**
+ * @public
+ */
 export interface GetRawMessageContentRequest {
     /**
      * <p>The identifier of the email message to retrieve.</p>
      */
     messageId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetRawMessageContentResponse {
     /**
      * <p>The raw content of the email message, in MIME format.</p>
@@ -15,6 +21,7 @@ export interface GetRawMessageContentResponse {
     messageContent: Readable | ReadableStream | Blob | undefined;
 }
 /**
+ * @public
  * <p>The requested email message is not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -26,6 +33,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>WorkMail could not access the updated email content. Possible reasons:</p>
  *          <ul>
  *             <li>
@@ -53,6 +61,7 @@ export declare class InvalidContentLocation extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidContentLocation, __BaseException>);
 }
 /**
+ * @public
  * <p>The requested email is not eligible for update. This is usually the case for a redirected email.</p>
  */
 export declare class MessageFrozen extends __BaseException {
@@ -64,6 +73,7 @@ export declare class MessageFrozen extends __BaseException {
     constructor(opts: __ExceptionOptionType<MessageFrozen, __BaseException>);
 }
 /**
+ * @public
  * <p>The requested email could not be updated due to an error in the MIME content. Check the error message for more information about
  *       what caused the error.</p>
  */
@@ -76,6 +86,7 @@ export declare class MessageRejected extends __BaseException {
     constructor(opts: __ExceptionOptionType<MessageRejected, __BaseException>);
 }
 /**
+ * @public
  * <p>Amazon S3 object representing the updated message content, in MIME format.</p>
  *          <note>
  *             <p>The region for the S3 bucket containing the S3 object must match the region used for WorkMail operations. Also, for WorkMail to process
@@ -99,6 +110,7 @@ export interface S3Reference {
     objectVersion?: string;
 }
 /**
+ * @public
  * <p>Provides the MIME content of the updated email message as an S3 object. All MIME content must meet the following criteria:</p>
  *          <ul>
  *             <li>
@@ -133,6 +145,9 @@ export interface RawMessageContent {
      */
     s3Reference: S3Reference | undefined;
 }
+/**
+ * @public
+ */
 export interface PutRawMessageContentRequest {
     /**
      * <p>The identifier of the email message being updated.</p>
@@ -143,6 +158,9 @@ export interface PutRawMessageContentRequest {
      */
     content: RawMessageContent | undefined;
 }
+/**
+ * @public
+ */
 export interface PutRawMessageContentResponse {
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-workmailmessageflow",
   "description": "AWS SDK for JavaScript Workmailmessageflow 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",