@aws-sdk/nested-clients 3.775.0 → 3.777.0

package/dist-types/submodules/sso-oidc/commands/CreateTokenCommand.d.ts

@@ -111,6 +111,52 @@ declare const CreateTokenCommand_base: {
  * @throws {@link SSOOIDCServiceException}
  * <p>Base exception class for all service exceptions from SSOOIDC service.</p>
  *
+ *
+ * @example Call OAuth/OIDC /token endpoint for Device Code grant with Secret authentication
+ * ```javascript
+ * //
+ * const input = {
+ *   clientId: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID",
+ *   clientSecret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0",
+ *   deviceCode: "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE",
+ *   grantType: "urn:ietf:params:oauth:grant-type:device-code"
+ * };
+ * const command = new CreateTokenCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   accessToken: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
+ *   expiresIn: 1579729529,
+ *   refreshToken: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
+ *   tokenType: "Bearer"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Call OAuth/OIDC /token endpoint for Refresh Token grant with Secret authentication
+ * ```javascript
+ * //
+ * const input = {
+ *   clientId: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID",
+ *   clientSecret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0",
+ *   grantType: "refresh_token",
+ *   refreshToken: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
+ *   scope: [
+ *     "codewhisperer:completions"
+ *   ]
+ * };
+ * const command = new CreateTokenCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   accessToken: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
+ *   expiresIn: 1579729529,
+ *   refreshToken: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
+ *   tokenType: "Bearer"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class CreateTokenCommand extends CreateTokenCommand_base {

package/dist-types/submodules/sts/commands/AssumeRoleCommand.d.ts

@@ -205,6 +205,53 @@ declare const AssumeRoleCommand_base: {
  * @throws {@link STSServiceException}
  * <p>Base exception class for all service exceptions from STS service.</p>
  *
+ *
+ * @example To assume a role
+ * ```javascript
+ * //
+ * const input = {
+ *   ExternalId: "123ABC",
+ *   Policy: `{"Version":"2012-10-17","Statement":[{"Sid":"Stmt1","Effect":"Allow","Action":"s3:ListAllMyBuckets","Resource":"*"}]}`,
+ *   RoleArn: "arn:aws:iam::123456789012:role/demo",
+ *   RoleSessionName: "testAssumeRoleSession",
+ *   Tags: [
+ *     {
+ *       Key: "Project",
+ *       Value: "Unicorn"
+ *     },
+ *     {
+ *       Key: "Team",
+ *       Value: "Automation"
+ *     },
+ *     {
+ *       Key: "Cost-Center",
+ *       Value: "12345"
+ *     }
+ *   ],
+ *   TransitiveTagKeys: [
+ *     "Project",
+ *     "Cost-Center"
+ *   ]
+ * };
+ * const command = new AssumeRoleCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   AssumedRoleUser: {
+ *     Arn: "arn:aws:sts::123456789012:assumed-role/demo/Bob",
+ *     AssumedRoleId: "ARO123EXAMPLE123:Bob"
+ *   },
+ *   Credentials: {
+ *     AccessKeyId: "AKIAIOSFODNN7EXAMPLE",
+ *     Expiration: "2011-07-15T23:28:33.359Z",
+ *     SecretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY",
+ *     SessionToken: "AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA=="
+ *   },
+ *   PackedPolicySize: 8
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class AssumeRoleCommand extends AssumeRoleCommand_base {

package/dist-types/submodules/sts/commands/AssumeRoleWithWebIdentityCommand.d.ts

@@ -237,6 +237,40 @@ declare const AssumeRoleWithWebIdentityCommand_base: {
  * @throws {@link STSServiceException}
  * <p>Base exception class for all service exceptions from STS service.</p>
  *
+ *
+ * @example To assume a role as an OpenID Connect-federated user
+ * ```javascript
+ * //
+ * const input = {
+ *   DurationSeconds: 3600,
+ *   Policy: `{"Version":"2012-10-17","Statement":[{"Sid":"Stmt1","Effect":"Allow","Action":"s3:ListAllMyBuckets","Resource":"*"}]}`,
+ *   ProviderId: "www.amazon.com",
+ *   RoleArn: "arn:aws:iam::123456789012:role/FederatedWebIdentityRole",
+ *   RoleSessionName: "app1",
+ *   WebIdentityToken: "Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXXXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFBmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNIL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAGpsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ"
+ * };
+ * const command = new AssumeRoleWithWebIdentityCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   AssumedRoleUser: {
+ *     Arn: "arn:aws:sts::123456789012:assumed-role/FederatedWebIdentityRole/app1",
+ *     AssumedRoleId: "AROACLKWSDQRAOEXAMPLE:app1"
+ *   },
+ *   Audience: "client.5498841531868486423.1548@apps.example.com",
+ *   Credentials: {
+ *     AccessKeyId: "AKIAIOSFODNN7EXAMPLE",
+ *     Expiration: "2014-10-24T23:00:23Z",
+ *     SecretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY",
+ *     SessionToken: "AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IEXAMPLE"
+ *   },
+ *   PackedPolicySize: 123,
+ *   Provider: "www.amazon.com",
+ *   SubjectFromWebIdentityToken: "amzn1.account.AF6RHO7KZU5XRVQJGXK6HEXAMPLE"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class AssumeRoleWithWebIdentityCommand extends AssumeRoleWithWebIdentityCommand_base {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/nested-clients",
-  "version": "3.775.0",
+  "version": "3.777.0",
   "description": "Nested clients for AWS SDK packages.",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",