@aws-lite/sts-types 0.0.0 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +56 -0
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1,15 +1,64 @@
1
1
  import {
2
2
  /* ! Do not remove IMPORTS_START / IMPORTS_END ! */
3
3
  // $IMPORTS_START
4
+ AssumeRoleCommandOutput as AssumeRoleResponse,
5
+ AssumeRoleWithSAMLCommandOutput as AssumeRoleWithSAMLResponse,
6
+ AssumeRoleWithWebIdentityCommandOutput as AssumeRoleWithWebIdentityResponse,
7
+ DecodeAuthorizationMessageCommandOutput as DecodeAuthorizationMessageResponse,
8
+ GetAccessKeyInfoCommandOutput as GetAccessKeyInfoResponse,
4
9
  GetCallerIdentityCommandOutput as GetCallerIdentityResponse,
10
+ GetFederationTokenCommandOutput as GetFederationTokenResponse,
11
+ GetSessionTokenCommandOutput as GetSessionTokenResponse,
5
12
  // $IMPORTS_END
6
13
  } from "@aws-sdk/client-sts";
7
14
 
8
15
  declare interface AwsLiteSTS {
9
16
  /* ! Do not remove METHODS_START / METHODS_END ! */
10
17
  // $METHODS_START
18
+ /**
19
+ * @description
20
+ * - AWS docs: {@link https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html STS: AssumeRole}
21
+ * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#AssumeRole STS: AssumeRole}
22
+ */
23
+ AssumeRole: (input: { RoleArn: string, RoleSessionName: string, DurationSeconds?: number, ExternalId?: string, Policy?: string, PolicyArns?: any[], ProvidedContexts?: any[], SerialNumber?: string, SourceIdentity?: string, Tags?: any[], TokenCode?: string, TransitiveTagKeys?: any[] }) => Promise<AssumeRoleResponse>
24
+ /**
25
+ * @description
26
+ * - AWS docs: {@link https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html STS: AssumeRoleWithSAML}
27
+ * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#AssumeRoleWithSAML STS: AssumeRoleWithSAML}
28
+ */
29
+ AssumeRoleWithSAML: (input: { RoleArn: string, PrincipalArn: string, SAMLAssertion: string, DurationSeconds?: number, Policy?: string, PolicyArns?: any[] }) => Promise<AssumeRoleWithSAMLResponse>
30
+ /**
31
+ * @description
32
+ * - AWS docs: {@link https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html STS: AssumeRoleWithWebIdentity}
33
+ * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#AssumeRoleWithWebIdentity STS: AssumeRoleWithWebIdentity}
34
+ */
35
+ AssumeRoleWithWebIdentity: (input: { RoleArn: string, RoleSessionName: string, WebIdentityToken: string, DurationSeconds?: number, ProviderId?: string, Policy?: string, PolicyArns?: any[] }) => Promise<AssumeRoleWithWebIdentityResponse>
36
+ /**
37
+ * @description
38
+ * - AWS docs: {@link https://docs.aws.amazon.com/STS/latest/APIReference/API_DecodeAuthorizationMessage.html STS: DecodeAuthorizationMessage}
39
+ * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#DecodeAuthorizationMessage STS: DecodeAuthorizationMessage}
40
+ */
41
+ DecodeAuthorizationMessage: (input: { EncodedMessage: string }) => Promise<DecodeAuthorizationMessageResponse>
42
+ /**
43
+ * @description
44
+ * - AWS docs: {@link https://docs.aws.amazon.com/STS/latest/APIReference/API_GetAccessKeyInfo.html STS: GetAccessKeyInfo}
45
+ * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#GetAccessKeyInfo STS: GetAccessKeyInfo}
46
+ */
47
+ GetAccessKeyInfo: (input: { AccessKeyId: string }) => Promise<GetAccessKeyInfoResponse>
11
48
  /** @description aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#GetCallerIdentity STS: GetCallerIdentity} */
12
49
  GetCallerIdentity: () => Promise<GetCallerIdentityResponse>
50
+ /**
51
+ * @description
52
+ * - AWS docs: {@link https://docs.aws.amazon.com/STS/latest/APIReference/API_GetFederationToken.html STS: GetFederationToken}
53
+ * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#GetFederationToken STS: GetFederationToken}
54
+ */
55
+ GetFederationToken: (input: { Name: string, DurationSeconds?: number, Policy?: string, PolicyArns?: any[], Tags?: any[] }) => Promise<GetFederationTokenResponse>
56
+ /**
57
+ * @description
58
+ * - AWS docs: {@link https://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html STS: GetSessionToken}
59
+ * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#GetSessionToken STS: GetSessionToken}
60
+ */
61
+ GetSessionToken: (input: { DurationSeconds?: number, SerialNumber?: string, TokenCode?: string }) => Promise<GetSessionTokenResponse>
13
62
  // $METHODS_END
14
63
  }
15
64
 
@@ -23,6 +72,13 @@ export type {
23
72
  AwsLiteSTS,
24
73
  /* ! Do not remove EXPORT_START / EXPORT_END ! */
25
74
  // $EXPORT_START
75
+ AssumeRoleResponse,
76
+ AssumeRoleWithSAMLResponse,
77
+ AssumeRoleWithWebIdentityResponse,
78
+ DecodeAuthorizationMessageResponse,
79
+ GetAccessKeyInfoResponse,
26
80
  GetCallerIdentityResponse,
81
+ GetFederationTokenResponse,
82
+ GetSessionTokenResponse,
27
83
  // $EXPORT_END
28
84
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-lite/sts-types",
3
- "version": "0.0.0",
3
+ "version": "0.1.0",
4
4
  "description": "Type definitions for the `@aws-lite/sts` plugin",
5
5
  "homepage": "https://aws-lite.org/services/sts",
6
6
  "repository": {