docs: fix various tsdoc tags (#6765)

Author: kuhe

packages/credential-providers/src/createCredentialChain.ts

@@ -55,6 +55,8 @@ type Mutable<Type> = {
  * @param credentialProviders - one or more credential providers.
  * @returns a single AwsCredentialIdentityProvider that calls the given
  * providers in sequence until one succeeds or all fail.
+ *
+ * @public
  */
 export const createCredentialChain = (
   ...credentialProviders: RuntimeConfigAwsCredentialIdentityProvider[]

packages/credential-providers/src/fromCognitoIdentity.ts

@@ -5,6 +5,9 @@ import {
   FromCognitoIdentityParameters as _FromCognitoIdentityParameters,
 } from "@aws-sdk/credential-provider-cognito-identity";
 
+/**
+ * @public
+ */
 export interface FromCognitoIdentityParameters extends Omit<_FromCognitoIdentityParameters, "client"> {
   /**
    * Custom client configuration if you need overwrite default Cognito Identity client configuration.
@@ -48,6 +51,8 @@ export type CognitoIdentityCredentialProvider = _CognitoIdentityCredentialProvid
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromCognitoIdentity = (options: FromCognitoIdentityParameters): CognitoIdentityCredentialProvider =>
   _fromCognitoIdentity({

packages/credential-providers/src/fromCognitoIdentityPool.ts

@@ -48,6 +48,8 @@ export interface FromCognitoIdentityPoolParameters extends Omit<_FromCognitoIden
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromCognitoIdentityPool = (
   options: FromCognitoIdentityPoolParameters

packages/credential-providers/src/fromContainerMetadata.ts

@@ -25,6 +25,8 @@ export interface RemoteProviderInit extends _RemoteProviderInit, CredentialProvi
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromContainerMetadata = (init?: RemoteProviderInit): AwsCredentialIdentityProvider => {
   init?.logger?.debug("@smithy/credential-provider-imds", "fromContainerMetadata");

packages/credential-providers/src/fromEnv.ts

@@ -24,5 +24,7 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
  *   credentials: fromEnv(),
  * });
  * ```
+ *
+ * @public
  */
 export const fromEnv = (init?: FromEnvInit): AwsCredentialIdentityProvider => _fromEnv(init);

packages/credential-providers/src/fromIni.ts

@@ -39,6 +39,8 @@ import type { RuntimeConfigAwsCredentialIdentityProvider } from "@aws-sdk/types"
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromIni = (init: FromIniInit = {}): RuntimeConfigAwsCredentialIdentityProvider =>
   _fromIni({

packages/credential-providers/src/fromInstanceMetadata.ts

@@ -24,6 +24,8 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromInstanceMetadata = (
   init?: _RemoteProviderInit & CredentialProviderOptions

packages/credential-providers/src/fromNodeProviderChain.ts

@@ -31,6 +31,8 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
  *   clientPlugins: [addFooHeadersPlugin],
  * })
  * ```
+ *
+ * @public
  */
 export const fromNodeProviderChain = (init: DefaultProviderInit = {}): AwsCredentialIdentityProvider =>
   defaultProvider({

packages/credential-providers/src/fromProcess.ts

@@ -23,5 +23,7 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromProcess = (init?: FromProcessInit): AwsCredentialIdentityProvider => _fromProcess(init);

packages/credential-providers/src/fromSSO.ts

@@ -41,6 +41,8 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromSSO = (init: FromSSOInit = {}): AwsCredentialIdentityProvider => {
   return _fromSSO({ ...init });

packages/credential-providers/src/fromTemporaryCredentials.ts

@@ -50,6 +50,8 @@ export interface FromTemporaryCredentialsOptions extends CredentialProviderOptio
  *   ),
  * });
  * ```
+ *
+ * @public
  */
 export const fromTemporaryCredentials = (options: FromTemporaryCredentialsOptions): AwsCredentialIdentityProvider => {
   let stsClient: STSClient;

packages/credential-providers/src/fromTokenFile.ts

@@ -28,6 +28,8 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
  *   });
  * });
  * ```
+ *
+ * @public
  */
 export const fromTokenFile = (init: FromTokenFileInit = {}): AwsCredentialIdentityProvider =>
   _fromTokenFile({

packages/credential-providers/src/fromWebToken.ts

@@ -37,6 +37,8 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
  *   }),
  * });
  * ```
+ *
+ * @public
  */
 export const fromWebToken = (init: FromWebTokenInit): AwsCredentialIdentityProvider =>
   _fromWebToken({

packages/credential-providers/src/loadSts.ts

@@ -1,4 +1,7 @@
 import { AssumeRoleCommand, STSClient } from "@aws-sdk/client-sts";
 
 // This file must be loaded dynamically.
+/**
+ * @internal
+ */
 export { AssumeRoleCommand, STSClient };

packages/middleware-bucket-endpoint/src/bucketHostnameUtils.ts

@@ -249,7 +249,7 @@ export const validateNoFIPS = (useFipsEndpoint?: boolean) => {
 
 /**
  * Validate the multi-region access point alias.
- * @private
+ * @internal
  */
 export const validateMrapAlias = (name: string) => {
   try {

packages/middleware-user-agent/src/user-agent-middleware.ts

@@ -99,7 +99,7 @@ export const userAgentMiddleware =
 /**
  * Escape the each pair according to https://tools.ietf.org/html/rfc5234 and join the pair with pattern `name/version`.
  * User agent name may include prefix like `md/`, `api/`, `os/` etc., we should not escape the `/` after the prefix.
- * @private
+ * @internal
  */
 const escapeUserAgent = (userAgentPair: UserAgentPair): string => {
   const name = userAgentPair[0]

packages/token-providers/src/fromStatic.ts

@@ -7,6 +7,7 @@ export interface FromStaticInit extends CredentialProviderOptions {
 
 /**
  * Creates a token provider that will read from static token.
+ * @public
  */
 export const fromStatic =
   ({ token, logger }: FromStaticInit): TokenIdentityProvider =>

packages/xhr-http-handler/src/xhr-http-handler.ts

@@ -282,7 +282,7 @@ export class XhrHttpHandler extends EventEmitter implements HttpHandler<XhrHttpH
 
 /**
  * Used to omit headers that will be ignored by XHR to prevent excessive logging.
- * @private
+ * @internal
  */
 const isForbiddenRequestHeader = (header: string): boolean => {
   header = header.toLowerCase();
@@ -296,7 +296,7 @@ const isForbiddenRequestHeader = (header: string): boolean => {
 };
 
 /**
- * @private
+ * @internal
  */
 const forbiddenHeaders = [
   "Accept-Charset",