@aws-sdk/client-sso 3.36.0 → 3.39.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 (41) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/SSO.js +0 -18
  3. package/dist-cjs/SSOClient.js +0 -23
  4. package/dist-cjs/commands/GetRoleCredentialsCommand.js +0 -25
  5. package/dist-cjs/commands/ListAccountRolesCommand.js +0 -24
  6. package/dist-cjs/commands/ListAccountsCommand.js +0 -26
  7. package/dist-cjs/commands/LogoutCommand.js +0 -24
  8. package/dist-cjs/commands/index.js +7 -0
  9. package/dist-cjs/endpoints.js +6 -1
  10. package/dist-cjs/index.js +4 -9
  11. package/dist-cjs/models/models_0.js +0 -42
  12. package/dist-cjs/pagination/ListAccountRolesPaginator.js +0 -10
  13. package/dist-cjs/pagination/ListAccountsPaginator.js +0 -10
  14. package/dist-cjs/pagination/index.js +6 -0
  15. package/dist-cjs/protocols/Aws_restJson1.js +0 -5
  16. package/dist-cjs/runtimeConfig.browser.js +1 -5
  17. package/dist-cjs/runtimeConfig.js +1 -5
  18. package/dist-cjs/runtimeConfig.native.js +0 -3
  19. package/dist-cjs/runtimeConfig.shared.js +0 -3
  20. package/dist-es/commands/index.js +4 -0
  21. package/dist-es/endpoints.js +6 -1
  22. package/dist-es/index.js +4 -9
  23. package/dist-es/pagination/index.js +3 -0
  24. package/dist-types/commands/index.d.ts +4 -0
  25. package/dist-types/index.d.ts +4 -9
  26. package/dist-types/pagination/index.d.ts +3 -0
  27. package/dist-types/ts3.4/SSO.d.ts +5 -33
  28. package/dist-types/ts3.4/SSOClient.d.ts +23 -100
  29. package/dist-types/ts3.4/commands/GetRoleCredentialsCommand.d.ts +2 -21
  30. package/dist-types/ts3.4/commands/ListAccountRolesCommand.d.ts +2 -20
  31. package/dist-types/ts3.4/commands/ListAccountsCommand.d.ts +2 -22
  32. package/dist-types/ts3.4/commands/LogoutCommand.d.ts +2 -20
  33. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  34. package/dist-types/ts3.4/index.d.ts +4 -9
  35. package/dist-types/ts3.4/models/models_0.d.ts +46 -147
  36. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  37. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  38. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  39. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  40. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  41. package/package.json +29 -29
package/dist-es/index.js CHANGED
@@ -1,10 +1,5 @@
1
- export * from "./SSOClient";
2
1
  export * from "./SSO";
3
- export * from "./commands/GetRoleCredentialsCommand";
4
- export * from "./commands/ListAccountRolesCommand";
5
- export * from "./pagination/ListAccountRolesPaginator";
6
- export * from "./commands/ListAccountsCommand";
7
- export * from "./pagination/ListAccountsPaginator";
8
- export * from "./commands/LogoutCommand";
9
- export * from "./pagination/Interfaces";
10
- export * from "./models/index";
2
+ export * from "./SSOClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
@@ -0,0 +1,3 @@
1
+ export * from "./Interfaces";
2
+ export * from "./ListAccountRolesPaginator";
3
+ export * from "./ListAccountsPaginator";
@@ -0,0 +1,4 @@
1
+ export * from "./GetRoleCredentialsCommand";
2
+ export * from "./ListAccountRolesCommand";
3
+ export * from "./ListAccountsCommand";
4
+ export * from "./LogoutCommand";
@@ -1,10 +1,5 @@
1
- export * from "./SSOClient";
2
1
  export * from "./SSO";
3
- export * from "./commands/GetRoleCredentialsCommand";
4
- export * from "./commands/ListAccountRolesCommand";
5
- export * from "./pagination/ListAccountRolesPaginator";
6
- export * from "./commands/ListAccountsCommand";
7
- export * from "./pagination/ListAccountsPaginator";
8
- export * from "./commands/LogoutCommand";
9
- export * from "./pagination/Interfaces";
10
- export * from "./models/index";
2
+ export * from "./SSOClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
@@ -0,0 +1,3 @@
1
+ export * from "./Interfaces";
2
+ export * from "./ListAccountRolesPaginator";
3
+ export * from "./ListAccountsPaginator";
@@ -4,49 +4,21 @@ import { ListAccountRolesCommandInput, ListAccountRolesCommandOutput } from "./c
4
4
  import { ListAccountsCommandInput, ListAccountsCommandOutput } from "./commands/ListAccountsCommand";
5
5
  import { LogoutCommandInput, LogoutCommandOutput } from "./commands/LogoutCommand";
6
6
  import { SSOClient } from "./SSOClient";
7
- /**
8
- * <p>AWS Single Sign-On Portal is a web service that makes it easy for you to assign user
9
- * access to AWS SSO resources such as the user portal. Users can get AWS account applications
10
- * and roles assigned to them and get federated into the application.</p>
11
- *
12
- * <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
13
- * Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
14
- *
15
- * <p>This API reference guide describes the AWS SSO Portal operations that you can call
16
- * programatically and includes detailed information on data types and errors.</p>
17
- *
18
- * <note>
19
- * <p>AWS provides SDKs that consist of libraries and sample code for various programming
20
- * languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a
21
- * convenient way to create programmatic access to AWS SSO and other AWS services. For more
22
- * information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
23
- * </note>
24
- */
7
+
25
8
  export declare class SSO extends SSOClient {
26
- /**
27
- * <p>Returns the STS short-term credentials for a given role name that is assigned to the
28
- * user.</p>
29
- */
9
+
30
10
  getRoleCredentials(args: GetRoleCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<GetRoleCredentialsCommandOutput>;
31
11
  getRoleCredentials(args: GetRoleCredentialsCommandInput, cb: (err: any, data?: GetRoleCredentialsCommandOutput) => void): void;
32
12
  getRoleCredentials(args: GetRoleCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoleCredentialsCommandOutput) => void): void;
33
- /**
34
- * <p>Lists all roles that are assigned to the user for a given AWS account.</p>
35
- */
13
+
36
14
  listAccountRoles(args: ListAccountRolesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccountRolesCommandOutput>;
37
15
  listAccountRoles(args: ListAccountRolesCommandInput, cb: (err: any, data?: ListAccountRolesCommandOutput) => void): void;
38
16
  listAccountRoles(args: ListAccountRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountRolesCommandOutput) => void): void;
39
- /**
40
- * <p>Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the
41
- * administrator of the account. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers">Assign User Access</a> in the <i>AWS SSO User Guide</i>. This operation
42
- * returns a paginated response.</p>
43
- */
17
+
44
18
  listAccounts(args: ListAccountsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccountsCommandOutput>;
45
19
  listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void;
46
20
  listAccounts(args: ListAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountsCommandOutput) => void): void;
47
- /**
48
- * <p>Removes the client- and server-side session that is associated with the user.</p>
49
- */
21
+
50
22
  logout(args: LogoutCommandInput, options?: __HttpHandlerOptions): Promise<LogoutCommandOutput>;
51
23
  logout(args: LogoutCommandInput, cb: (err: any, data?: LogoutCommandOutput) => void): void;
52
24
  logout(args: LogoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LogoutCommandOutput) => void): void;
@@ -12,134 +12,57 @@ import { LogoutCommandInput, LogoutCommandOutput } from "./commands/LogoutComman
12
12
  export declare type ServiceInputTypes = GetRoleCredentialsCommandInput | ListAccountRolesCommandInput | ListAccountsCommandInput | LogoutCommandInput;
13
13
  export declare type ServiceOutputTypes = GetRoleCredentialsCommandOutput | ListAccountRolesCommandOutput | ListAccountsCommandOutput | LogoutCommandOutput;
14
14
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
15
- /**
16
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
17
- */
15
+
18
16
  requestHandler?: __HttpHandler;
19
- /**
20
- * A constructor for a class implementing the {@link __Hash} interface
21
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
22
- * @internal
23
- */
17
+
24
18
  sha256?: __HashConstructor;
25
- /**
26
- * The function that will be used to convert strings into HTTP endpoints.
27
- * @internal
28
- */
19
+
29
20
  urlParser?: __UrlParser;
30
- /**
31
- * A function that can calculate the length of a request body.
32
- * @internal
33
- */
21
+
34
22
  bodyLengthChecker?: (body: any) => number | undefined;
35
- /**
36
- * A function that converts a stream into an array of bytes.
37
- * @internal
38
- */
23
+
39
24
  streamCollector?: __StreamCollector;
40
- /**
41
- * The function that will be used to convert a base64-encoded string to a byte array.
42
- * @internal
43
- */
25
+
44
26
  base64Decoder?: __Decoder;
45
- /**
46
- * The function that will be used to convert binary data to a base64-encoded string.
47
- * @internal
48
- */
27
+
49
28
  base64Encoder?: __Encoder;
50
- /**
51
- * The function that will be used to convert a UTF8-encoded string to a byte array.
52
- * @internal
53
- */
29
+
54
30
  utf8Decoder?: __Decoder;
55
- /**
56
- * The function that will be used to convert binary data to a UTF-8 encoded string.
57
- * @internal
58
- */
31
+
59
32
  utf8Encoder?: __Encoder;
60
- /**
61
- * The runtime environment.
62
- * @internal
63
- */
33
+
64
34
  runtime?: string;
65
- /**
66
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
67
- * trait of an operation.
68
- */
35
+
69
36
  disableHostPrefix?: boolean;
70
- /**
71
- * Value for how many times a request will be made at most in case of retry.
72
- */
37
+
73
38
  maxAttempts?: number | __Provider<number>;
74
- /**
75
- * Specifies which retry algorithm to use.
76
- */
39
+
77
40
  retryMode?: string | __Provider<string>;
78
- /**
79
- * Optional logger for logging debug/info/warn/error.
80
- */
41
+
81
42
  logger?: __Logger;
82
- /**
83
- * Unique service identifier.
84
- * @internal
85
- */
43
+
86
44
  serviceId?: string;
87
- /**
88
- * The AWS region to which this client will send requests
89
- */
45
+
90
46
  region?: string | __Provider<string>;
91
- /**
92
- * Fetch related hostname, signing name or signing region with given region.
93
- * @internal
94
- */
47
+
95
48
  regionInfoProvider?: RegionInfoProvider;
96
- /**
97
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
98
- * @internal
99
- */
49
+
100
50
  defaultUserAgentProvider?: Provider<__UserAgent>;
101
51
  }
102
52
  declare type SSOClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig;
103
- /**
104
- * The configuration interface of SSOClient class constructor that set the region, credentials and other options.
105
- */
53
+
106
54
  export interface SSOClientConfig extends SSOClientConfigType {
107
55
  }
108
56
  declare type SSOClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig;
109
- /**
110
- * The resolved configuration interface of SSOClient class. This is resolved and normalized from the {@link SSOClientConfig | constructor configuration interface}.
111
- */
57
+
112
58
  export interface SSOClientResolvedConfig extends SSOClientResolvedConfigType {
113
59
  }
114
- /**
115
- * <p>AWS Single Sign-On Portal is a web service that makes it easy for you to assign user
116
- * access to AWS SSO resources such as the user portal. Users can get AWS account applications
117
- * and roles assigned to them and get federated into the application.</p>
118
- *
119
- * <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
120
- * Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
121
- *
122
- * <p>This API reference guide describes the AWS SSO Portal operations that you can call
123
- * programatically and includes detailed information on data types and errors.</p>
124
- *
125
- * <note>
126
- * <p>AWS provides SDKs that consist of libraries and sample code for various programming
127
- * languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a
128
- * convenient way to create programmatic access to AWS SSO and other AWS services. For more
129
- * information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
130
- * </note>
131
- */
60
+
132
61
  export declare class SSOClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SSOClientResolvedConfig> {
133
- /**
134
- * The resolved configuration of SSOClient class. This is resolved and normalized from the {@link SSOClientConfig | constructor configuration interface}.
135
- */
62
+
136
63
  readonly config: SSOClientResolvedConfig;
137
64
  constructor(configuration: SSOClientConfig);
138
- /**
139
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
140
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
141
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
142
- */
65
+
143
66
  destroy(): void;
144
67
  }
145
68
  export {};
@@ -6,30 +6,11 @@ export interface GetRoleCredentialsCommandInput extends GetRoleCredentialsReques
6
6
  }
7
7
  export interface GetRoleCredentialsCommandOutput extends GetRoleCredentialsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns the STS short-term credentials for a given role name that is assigned to the
11
- * user.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { SSOClient, GetRoleCredentialsCommand } from "@aws-sdk/client-sso"; // ES Modules import
16
- * // const { SSOClient, GetRoleCredentialsCommand } = require("@aws-sdk/client-sso"); // CommonJS import
17
- * const client = new SSOClient(config);
18
- * const command = new GetRoleCredentialsCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link GetRoleCredentialsCommandInput} for command's `input` shape.
23
- * @see {@link GetRoleCredentialsCommandOutput} for command's `response` shape.
24
- * @see {@link SSOClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class GetRoleCredentialsCommand extends $Command<GetRoleCredentialsCommandInput, GetRoleCredentialsCommandOutput, SSOClientResolvedConfig> {
28
11
  readonly input: GetRoleCredentialsCommandInput;
29
12
  constructor(input: GetRoleCredentialsCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSOClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRoleCredentialsCommandInput, GetRoleCredentialsCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface ListAccountRolesCommandInput extends ListAccountRolesRequest {
6
6
  }
7
7
  export interface ListAccountRolesCommandOutput extends ListAccountRolesResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists all roles that are assigned to the user for a given AWS account.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { SSOClient, ListAccountRolesCommand } from "@aws-sdk/client-sso"; // ES Modules import
15
- * // const { SSOClient, ListAccountRolesCommand } = require("@aws-sdk/client-sso"); // CommonJS import
16
- * const client = new SSOClient(config);
17
- * const command = new ListAccountRolesCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link ListAccountRolesCommandInput} for command's `input` shape.
22
- * @see {@link ListAccountRolesCommandOutput} for command's `response` shape.
23
- * @see {@link SSOClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class ListAccountRolesCommand extends $Command<ListAccountRolesCommandInput, ListAccountRolesCommandOutput, SSOClientResolvedConfig> {
27
11
  readonly input: ListAccountRolesCommandInput;
28
12
  constructor(input: ListAccountRolesCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSOClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAccountRolesCommandInput, ListAccountRolesCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,31 +6,11 @@ export interface ListAccountsCommandInput extends ListAccountsRequest {
6
6
  }
7
7
  export interface ListAccountsCommandOutput extends ListAccountsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the
11
- * administrator of the account. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers">Assign User Access</a> in the <i>AWS SSO User Guide</i>. This operation
12
- * returns a paginated response.</p>
13
- * @example
14
- * Use a bare-bones client and the command you need to make an API call.
15
- * ```javascript
16
- * import { SSOClient, ListAccountsCommand } from "@aws-sdk/client-sso"; // ES Modules import
17
- * // const { SSOClient, ListAccountsCommand } = require("@aws-sdk/client-sso"); // CommonJS import
18
- * const client = new SSOClient(config);
19
- * const command = new ListAccountsCommand(input);
20
- * const response = await client.send(command);
21
- * ```
22
- *
23
- * @see {@link ListAccountsCommandInput} for command's `input` shape.
24
- * @see {@link ListAccountsCommandOutput} for command's `response` shape.
25
- * @see {@link SSOClientResolvedConfig | config} for command's `input` shape.
26
- *
27
- */
9
+
28
10
  export declare class ListAccountsCommand extends $Command<ListAccountsCommandInput, ListAccountsCommandOutput, SSOClientResolvedConfig> {
29
11
  readonly input: ListAccountsCommandInput;
30
12
  constructor(input: ListAccountsCommandInput);
31
- /**
32
- * @internal
33
- */
13
+
34
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSOClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAccountsCommandInput, ListAccountsCommandOutput>;
35
15
  private serialize;
36
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface LogoutCommandInput extends LogoutRequest {
6
6
  }
7
7
  export interface LogoutCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Removes the client- and server-side session that is associated with the user.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { SSOClient, LogoutCommand } from "@aws-sdk/client-sso"; // ES Modules import
15
- * // const { SSOClient, LogoutCommand } = require("@aws-sdk/client-sso"); // CommonJS import
16
- * const client = new SSOClient(config);
17
- * const command = new LogoutCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link LogoutCommandInput} for command's `input` shape.
22
- * @see {@link LogoutCommandOutput} for command's `response` shape.
23
- * @see {@link SSOClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class LogoutCommand extends $Command<LogoutCommandInput, LogoutCommandOutput, SSOClientResolvedConfig> {
27
11
  readonly input: LogoutCommandInput;
28
12
  constructor(input: LogoutCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSOClientResolvedConfig, options?: __HttpHandlerOptions): Handler<LogoutCommandInput, LogoutCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -0,0 +1,4 @@
1
+ export * from "./GetRoleCredentialsCommand";
2
+ export * from "./ListAccountRolesCommand";
3
+ export * from "./ListAccountsCommand";
4
+ export * from "./LogoutCommand";
@@ -1,10 +1,5 @@
1
- export * from "./SSOClient";
2
1
  export * from "./SSO";
3
- export * from "./commands/GetRoleCredentialsCommand";
4
- export * from "./commands/ListAccountRolesCommand";
5
- export * from "./pagination/ListAccountRolesPaginator";
6
- export * from "./commands/ListAccountsCommand";
7
- export * from "./pagination/ListAccountsPaginator";
8
- export * from "./commands/LogoutCommand";
9
- export * from "./pagination/Interfaces";
10
- export * from "./models/index";
2
+ export * from "./SSOClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";