@aws-sdk/credential-providers 3.213.0 → 3.216.0

package/README.md

@@ -62,7 +62,7 @@ const client = new FooClient({
 
 ## `fromCognitoIdentityPool()`
 
-The function `fromCognitoIdentityPool()` returns `CredentialProvider` that calls [GetId API][getid_api]
+The function `fromCognitoIdentityPool()` returns `AwsCredentialIdentityProvider` that calls [GetId API][getid_api]
 to obtain an `identityId`, then generates temporary AWS credentials with
 [GetCredentialsForIdentity API][getcredentialsforidentity_api], see
 [`fromCognitoIdentity()`](#fromcognitoidentity).
@@ -107,7 +107,7 @@ const client = new FooClient({
 
 ## `fromTemporaryCredentials()`
 
-The function `fromTemporaryCredentials` returns `CredentialProvider` that retrieves temporary
+The function `fromTemporaryCredentials` returns `AwsCredentialIdentityProvider` that retrieves temporary
 credentials from [STS AssumeRole API][assumerole_api].
 
 ```javascript
@@ -146,7 +146,7 @@ const client = new FooClient({
 
 ## `fromWebToken()`
 
-The function `fromWebToken` returns `CredentialProvider` that gets credentials calling
+The function `fromWebToken` returns `AwsCredentialIdentityProvider` that gets credentials calling
 [STS AssumeRoleWithWebIdentity API][assumerolewithwebidentity_api]
 
 ```javascript
@@ -209,7 +209,7 @@ provider, see the documentation for the identity provider.
 
 ## `fromContainerMetadata()` and `fromInstanceMetadata()`
 
-`fromContainerMetadata` and `fromInstanceMetadata` will create `CredentialProvider` functions that
+`fromContainerMetadata` and `fromInstanceMetadata` will create `AwsCredentialIdentityProvider` functions that
 read from the ECS container metadata service and the EC2 instance metadata service, respectively.
 
 ```javascript
@@ -244,12 +244,12 @@ const client = new FooClient({
 });
 ```
 
-A `CredentialProvider` function created with `fromContainerMetadata` will return a promise that will
+A `AwsCredentialIdentityProvider` function created with `fromContainerMetadata` will return a promise that will
 resolve with credentials for the IAM role associated with containers in an Amazon ECS task. Please
 see [IAM Roles for Tasks][iam_roles_for_tasks] for more information on using IAM roles with Amazon
 ECS.
 
-A `CredentialProvider` function created with `fromInstanceMetadata` will return a promise that will
+A `AwsCredentialIdentityProvider` function created with `fromInstanceMetadata` will return a promise that will
 resolve with credentials for the IAM role associated with an EC2 instance.
 Please see [IAM Roles for Amazon EC2][iam_roles_for_ec2] for more information on using IAM roles
 with Amazon EC2. Both IMDSv1 (a request/response method) and IMDSv2 (a session-oriented method) are
@@ -259,7 +259,7 @@ Please see [Configure the instance metadata service][config_instance_metadata] f
 
 ## `fromIni()`
 
-`fromIni` creates `CredentialProvider` functions that read from a shared credentials file at
+`fromIni` creates `AwsCredentialIdentityProvider` functions that read from a shared credentials file at
 `~/.aws/credentials` and a shared configuration file at `~/.aws/config`. Both files are expected to
 be INI formatted with section names corresponding to profiles. Sections in the credentials file are
 treated as profile names, whereas profile sections in the config file must have the format of
@@ -394,7 +394,7 @@ const client = new FooClient({
 });
 ```
 
-`fromEnv` returns a `CredentialProvider` function, that reads credentials from the following
+`fromEnv` returns a `AwsCredentialIdentityProvider` function, that reads credentials from the following
 environment variables:
 
 - `AWS_ACCESS_KEY_ID` - The access key for your AWS account.
@@ -430,7 +430,7 @@ const client = new FooClient({
 });
 ```
 
-`fromSharedConfigFiles` creates a `CredentialProvider` functions that executes a given process and
+`fromSharedConfigFiles` creates a `AwsCredentialIdentityProvider` functions that executes a given process and
 attempt to read its standard output to receive a JSON payload containing the credentials. The
 process command is read from a shared credentials file at `~/.aws/credentials` and a shared
 configuration file at `~/.aws/config`. Both files are expected to be INI formatted with section
@@ -466,7 +466,7 @@ credential_process = /usr/local/bin/awscreds dev
 
 ## `fromTokenFile()`
 
-The function `fromTokenFile` returns `CredentialProvider` that reads credentials as follows:
+The function `fromTokenFile` returns `AwsCredentialIdentityProvider` that reads credentials as follows:
 
 - Reads file location of where the OIDC token is stored from either provided option  
   `webIdentityTokenFile` or environment variable `AWS_WEB_IDENTITY_TOKEN_FILE`.
@@ -502,11 +502,11 @@ const client = new FooClient({
 > profile that assumes a role which derived from the SSO credential, you should use the
 > [`fromIni()`](#fromini), or `@aws-sdk/credential-provider-node` package.
 
-`fromSSO`, that creates `CredentialProvider` functions that read from the _resolved_ access token
+`fromSSO`, that creates `AwsCredentialIdentityProvider` functions that read from the _resolved_ access token
 from local disk then requests temporary AWS credentials. For guidance on the AWS Single Sign-On
 service, please refer to [AWS's Single Sign-On documentation][sso_api].
 
-You can create the `CredentialProvider` functions using the inline SSO parameters(`ssoStartUrl`,
+You can create the `AwsCredentialIdentityProvider` functions using the inline SSO parameters(`ssoStartUrl`,
 `ssoAccountId`, `ssoRegion`, `ssoRoleName`) or load them from
 [AWS SDKs and Tools shared configuration and credentials files][shared_config_files].
 Profiles in the `credentials` file are given precedence over profiles in the `config` file.

package/dist-types/fromContainerMetadata.d.ts

@@ -1,5 +1,5 @@
 import { RemoteProviderInit as _RemoteProviderInit } from "@aws-sdk/credential-provider-imds";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 export interface RemoteProviderInit extends _RemoteProviderInit {
 }
 /**
@@ -21,4 +21,4 @@ export interface RemoteProviderInit extends _RemoteProviderInit {
  * });
  * ```
  */
-export declare const fromContainerMetadata: (init?: RemoteProviderInit | undefined) => CredentialProvider;
+export declare const fromContainerMetadata: (init?: RemoteProviderInit | undefined) => AwsCredentialIdentityProvider;

package/dist-types/fromEnv.d.ts

@@ -1,4 +1,4 @@
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 /**
  * Create a credential provider that reads credentials from the following environment variables:
  *
@@ -23,4 +23,4 @@ import { CredentialProvider } from "@aws-sdk/types";
  * });
  * ```
  */
-export declare const fromEnv: () => CredentialProvider;
+export declare const fromEnv: () => AwsCredentialIdentityProvider;

package/dist-types/fromIni.d.ts

@@ -1,6 +1,6 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { FromIniInit as _FromIniInit } from "@aws-sdk/credential-provider-ini";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface FromIniInit extends _FromIniInit {
     clientConfig?: STSClientConfig;
     clientPlugins?: Pluggable<any, any>[];
@@ -44,4 +44,4 @@ export interface FromIniInit extends _FromIniInit {
  * });
  * ```
  */
-export declare const fromIni: (init?: FromIniInit) => CredentialProvider;
+export declare const fromIni: (init?: FromIniInit) => AwsCredentialIdentityProvider;

package/dist-types/fromInstanceMetadata.d.ts

@@ -1,5 +1,5 @@
 import { RemoteProviderConfig as _RemoteProviderInit } from "@aws-sdk/credential-provider-imds";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 /**
  * Creates a credential provider function that reads from the EC2 instance metadata service.
  *
@@ -19,4 +19,4 @@ import { CredentialProvider } from "@aws-sdk/types";
  * });
  * ```
  */
-export declare const fromInstanceMetadata: (init?: _RemoteProviderInit | undefined) => CredentialProvider;
+export declare const fromInstanceMetadata: (init?: _RemoteProviderInit | undefined) => AwsCredentialIdentityProvider;

package/dist-types/fromNodeProviderChain.d.ts

@@ -1,6 +1,6 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { DefaultProviderInit } from "@aws-sdk/credential-provider-node";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface fromNodeProviderChainInit extends DefaultProviderInit {
     clientConfig?: STSClientConfig;
     clientPlugins?: Pluggable<any, any>[];
@@ -30,4 +30,4 @@ export interface fromNodeProviderChainInit extends DefaultProviderInit {
  * })
  * ```
  */
-export declare const fromNodeProviderChain: (init?: fromNodeProviderChainInit) => CredentialProvider;
+export declare const fromNodeProviderChain: (init?: fromNodeProviderChainInit) => AwsCredentialIdentityProvider;

package/dist-types/fromProcess.d.ts

@@ -1,5 +1,5 @@
 import { FromProcessInit as _FromProcessInit } from "@aws-sdk/credential-provider-process";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 export interface FromProcessInit extends _FromProcessInit {
 }
 /**
@@ -25,4 +25,4 @@ export interface FromProcessInit extends _FromProcessInit {
  * });
  * ```
  */
-export declare const fromProcess: (init?: FromProcessInit | undefined) => CredentialProvider;
+export declare const fromProcess: (init?: FromProcessInit | undefined) => AwsCredentialIdentityProvider;

package/dist-types/fromSSO.d.ts

@@ -1,6 +1,6 @@
 import { SSOClientConfig } from "@aws-sdk/client-sso";
 import { FromSSOInit as _FromSSOInit } from "@aws-sdk/credential-provider-sso";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 export interface FromSSOInit extends Omit<_FromSSOInit, "client"> {
     clientConfig?: SSOClientConfig;
 }
@@ -8,7 +8,7 @@ export interface FromSSOInit extends Omit<_FromSSOInit, "client"> {
  * Creates a credential provider function that reads from the _resolved_ access token from local disk then requests
  * temporary AWS credentials.
  *
- * You can create the `CredentialProvider` functions using the inline SSO parameters(`ssoStartUrl`, `ssoAccountId`,
+ * You can create the `AwsCredentialIdentityProvider` functions using the inline SSO parameters(`ssoStartUrl`, `ssoAccountId`,
  * `ssoRegion`, `ssoRoleName`) or load them from [AWS SDKs and Tools shared configuration and credentials files](https://docs.aws.amazon.com/credref/latest/refdocs/creds-config-files.html).
  * Profiles in the `credentials` file are given precedence over profiles in the `config` file.
  *
@@ -45,4 +45,4 @@ export interface FromSSOInit extends Omit<_FromSSOInit, "client"> {
  * });
  * ```
  */
-export declare const fromSSO: (init?: FromSSOInit) => CredentialProvider;
+export declare const fromSSO: (init?: FromSSOInit) => AwsCredentialIdentityProvider;

package/dist-types/fromTemporaryCredentials.d.ts

@@ -1,10 +1,10 @@
 import { AssumeRoleCommandInput, STSClientConfig } from "@aws-sdk/client-sts";
-import { CredentialProvider, Credentials, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentity, AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface FromTemporaryCredentialsOptions {
     params: Omit<AssumeRoleCommandInput, "RoleSessionName"> & {
         RoleSessionName?: string;
     };
-    masterCredentials?: Credentials | CredentialProvider;
+    masterCredentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
     clientConfig?: STSClientConfig;
     clientPlugins?: Pluggable<any, any>[];
     mfaCodeProvider?: (mfaSerial: string) => Promise<string>;
@@ -49,4 +49,4 @@ export interface FromTemporaryCredentialsOptions {
  * });
  * ```
  */
-export declare const fromTemporaryCredentials: (options: FromTemporaryCredentialsOptions) => CredentialProvider;
+export declare const fromTemporaryCredentials: (options: FromTemporaryCredentialsOptions) => AwsCredentialIdentityProvider;

package/dist-types/fromTokenFile.d.ts

@@ -1,6 +1,6 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { FromTokenFileInit as _FromTokenFileInit } from "@aws-sdk/credential-provider-web-identity";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface FromTokenFileInit extends _FromTokenFileInit {
     clientConfig?: STSClientConfig;
     clientPlugins?: Pluggable<any, any>[];
@@ -33,4 +33,4 @@ export interface FromTokenFileInit extends _FromTokenFileInit {
  * });
  * ```
  */
-export declare const fromTokenFile: (init?: FromTokenFileInit) => CredentialProvider;
+export declare const fromTokenFile: (init?: FromTokenFileInit) => AwsCredentialIdentityProvider;

package/dist-types/fromWebToken.d.ts

@@ -1,6 +1,6 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { FromWebTokenInit as _FromWebTokenInit } from "@aws-sdk/credential-provider-web-identity";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface FromWebTokenInit extends _FromWebTokenInit {
     clientConfig?: STSClientConfig;
     clientPlugins?: Pluggable<any, any>[];
@@ -42,4 +42,4 @@ export interface FromWebTokenInit extends _FromWebTokenInit {
  * });
  * ```
  */
-export declare const fromWebToken: (init: FromWebTokenInit) => CredentialProvider;
+export declare const fromWebToken: (init: FromWebTokenInit) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromContainerMetadata.d.ts

@@ -1,6 +1,6 @@
 import { RemoteProviderInit as _RemoteProviderInit } from "@aws-sdk/credential-provider-imds";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 export interface RemoteProviderInit extends _RemoteProviderInit {}
 export declare const fromContainerMetadata: (
   init?: RemoteProviderInit | undefined
-) => CredentialProvider;
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromEnv.d.ts

@@ -1,2 +1,2 @@
-import { CredentialProvider } from "@aws-sdk/types";
-export declare const fromEnv: () => CredentialProvider;
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
+export declare const fromEnv: () => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromIni.d.ts

@@ -1,8 +1,10 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { FromIniInit as _FromIniInit } from "@aws-sdk/credential-provider-ini";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface FromIniInit extends _FromIniInit {
   clientConfig?: STSClientConfig;
   clientPlugins?: Pluggable<any, any>[];
 }
-export declare const fromIni: (init?: FromIniInit) => CredentialProvider;
+export declare const fromIni: (
+  init?: FromIniInit
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromInstanceMetadata.d.ts

@@ -1,5 +1,5 @@
 import { RemoteProviderConfig as _RemoteProviderInit } from "@aws-sdk/credential-provider-imds";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 export declare const fromInstanceMetadata: (
   init?: _RemoteProviderInit | undefined
-) => CredentialProvider;
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromNodeProviderChain.d.ts

@@ -1,10 +1,10 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { DefaultProviderInit } from "@aws-sdk/credential-provider-node";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface fromNodeProviderChainInit extends DefaultProviderInit {
   clientConfig?: STSClientConfig;
   clientPlugins?: Pluggable<any, any>[];
 }
 export declare const fromNodeProviderChain: (
   init?: fromNodeProviderChainInit
-) => CredentialProvider;
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromProcess.d.ts

@@ -1,6 +1,6 @@
 import { FromProcessInit as _FromProcessInit } from "@aws-sdk/credential-provider-process";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 export interface FromProcessInit extends _FromProcessInit {}
 export declare const fromProcess: (
   init?: FromProcessInit | undefined
-) => CredentialProvider;
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromSSO.d.ts

@@ -1,8 +1,10 @@
 import { SSOClientConfig } from "@aws-sdk/client-sso";
 import { FromSSOInit as _FromSSOInit } from "@aws-sdk/credential-provider-sso";
-import { CredentialProvider } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 export interface FromSSOInit
   extends Pick<_FromSSOInit, Exclude<keyof _FromSSOInit, "client">> {
   clientConfig?: SSOClientConfig;
 }
-export declare const fromSSO: (init?: FromSSOInit) => CredentialProvider;
+export declare const fromSSO: (
+  init?: FromSSOInit
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromTemporaryCredentials.d.ts

@@ -1,5 +1,9 @@
 import { AssumeRoleCommandInput, STSClientConfig } from "@aws-sdk/client-sts";
-import { CredentialProvider, Credentials, Pluggable } from "@aws-sdk/types";
+import {
+  AwsCredentialIdentity,
+  AwsCredentialIdentityProvider,
+  Pluggable,
+} from "@aws-sdk/types";
 export interface FromTemporaryCredentialsOptions {
   params: Pick<
     AssumeRoleCommandInput,
@@ -7,11 +11,11 @@ export interface FromTemporaryCredentialsOptions {
   > & {
     RoleSessionName?: string;
   };
-  masterCredentials?: Credentials | CredentialProvider;
+  masterCredentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
   clientConfig?: STSClientConfig;
   clientPlugins?: Pluggable<any, any>[];
   mfaCodeProvider?: (mfaSerial: string) => Promise<string>;
 }
 export declare const fromTemporaryCredentials: (
   options: FromTemporaryCredentialsOptions
-) => CredentialProvider;
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromTokenFile.d.ts

@@ -1,10 +1,10 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { FromTokenFileInit as _FromTokenFileInit } from "@aws-sdk/credential-provider-web-identity";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface FromTokenFileInit extends _FromTokenFileInit {
   clientConfig?: STSClientConfig;
   clientPlugins?: Pluggable<any, any>[];
 }
 export declare const fromTokenFile: (
   init?: FromTokenFileInit
-) => CredentialProvider;
+) => AwsCredentialIdentityProvider;

package/dist-types/ts3.4/fromWebToken.d.ts

@@ -1,10 +1,10 @@
 import { STSClientConfig } from "@aws-sdk/client-sts";
 import { FromWebTokenInit as _FromWebTokenInit } from "@aws-sdk/credential-provider-web-identity";
-import { CredentialProvider, Pluggable } from "@aws-sdk/types";
+import { AwsCredentialIdentityProvider, Pluggable } from "@aws-sdk/types";
 export interface FromWebTokenInit extends _FromWebTokenInit {
   clientConfig?: STSClientConfig;
   clientPlugins?: Pluggable<any, any>[];
 }
 export declare const fromWebToken: (
   init: FromWebTokenInit
-) => CredentialProvider;
+) => AwsCredentialIdentityProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/credential-providers",
-  "version": "3.213.0",
+  "version": "3.216.0",
   "description": "A collection of credential providers, without requiring service clients like STS, Cognito",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -27,20 +27,20 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/client-cognito-identity": "3.213.0",
-    "@aws-sdk/client-sso": "3.212.0",
-    "@aws-sdk/client-sts": "3.213.0",
-    "@aws-sdk/credential-provider-cognito-identity": "3.213.0",
-    "@aws-sdk/credential-provider-env": "3.212.0",
-    "@aws-sdk/credential-provider-imds": "3.212.0",
-    "@aws-sdk/credential-provider-ini": "3.212.0",
-    "@aws-sdk/credential-provider-node": "3.212.0",
-    "@aws-sdk/credential-provider-process": "3.212.0",
-    "@aws-sdk/credential-provider-sso": "3.212.0",
-    "@aws-sdk/credential-provider-web-identity": "3.212.0",
-    "@aws-sdk/property-provider": "3.212.0",
-    "@aws-sdk/shared-ini-file-loader": "3.212.0",
-    "@aws-sdk/types": "3.212.0",
+    "@aws-sdk/client-cognito-identity": "3.216.0",
+    "@aws-sdk/client-sso": "3.216.0",
+    "@aws-sdk/client-sts": "3.216.0",
+    "@aws-sdk/credential-provider-cognito-identity": "3.216.0",
+    "@aws-sdk/credential-provider-env": "3.215.0",
+    "@aws-sdk/credential-provider-imds": "3.215.0",
+    "@aws-sdk/credential-provider-ini": "3.216.0",
+    "@aws-sdk/credential-provider-node": "3.216.0",
+    "@aws-sdk/credential-provider-process": "3.215.0",
+    "@aws-sdk/credential-provider-sso": "3.216.0",
+    "@aws-sdk/credential-provider-web-identity": "3.215.0",
+    "@aws-sdk/property-provider": "3.215.0",
+    "@aws-sdk/shared-ini-file-loader": "3.215.0",
+    "@aws-sdk/types": "3.215.0",
     "tslib": "^2.3.1"
   },
   "devDependencies": {