@aws-sdk/client-sso-admin 3.154.0 → 3.156.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 (8) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +22 -1
  3. package/dist-types/SSOAdmin.d.ts +34 -1
  4. package/dist-types/SSOAdminClient.d.ts +22 -1
  5. package/dist-types/commands/CreateAccountAssignmentCommand.d.ts +5 -0
  6. package/dist-types/commands/CreateInstanceAccessControlAttributeConfigurationCommand.d.ts +4 -0
  7. package/dist-types/commands/DeleteAccountAssignmentCommand.d.ts +3 -0
  8. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.156.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.155.0...v3.156.0) (2022-08-23)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-sso-admin
9
+
10
+
11
+
12
+
13
+
6
14
  # [3.154.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.153.0...v3.154.0) (2022-08-19)
7
15
 
8
16
  **Note:** Version bump only for package @aws-sdk/client-sso-admin
package/README.md CHANGED
@@ -9,7 +9,28 @@
9
9
 
10
10
  AWS SDK for JavaScript SSOAdmin Client for Node.js, Browser and React Native.
11
11
 
12
- <p></p>
12
+ <p>Amazon Web Services Single Sign On helps you securely create, or connect, your workforce identities and manage their
13
+ access centrally across Amazon Web Services accounts and applications. Amazon Web Services SSO is the recommended
14
+ approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size
15
+ and type.</p>
16
+ <note>
17
+ <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
18
+ <code>identitystore</code> API namespaces will continue to retain their original name for
19
+ backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
20
+ </note>
21
+ <p>This reference guide provides information on single sign-on operations which could be used for
22
+ access management of Amazon Web Services accounts. For information about Amazon Web Services SSO features, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">Amazon Web Services SSO User
23
+ Guide</a>.</p>
24
+ <p>Many operations in the Amazon Web Services SSO APIs rely on identifiers for users and groups, known as
25
+ principals. For more information about how to work with principals and principal IDs in Amazon Web Services SSO,
26
+ see the <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html">Identity Store API
27
+ Reference</a>.</p>
28
+ <note>
29
+ <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
30
+ languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a
31
+ convenient way to create programmatic access to Amazon Web Services SSO and other Amazon Web Services services. For more
32
+ information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
33
+ </note>
13
34
 
14
35
  ## Installing
15
36
 
package/dist-types/SSOAdmin.d.ts CHANGED
@@ -38,7 +38,28 @@ import { UpdateInstanceAccessControlAttributeConfigurationCommandInput, UpdateIn
38
38
  import { UpdatePermissionSetCommandInput, UpdatePermissionSetCommandOutput } from "./commands/UpdatePermissionSetCommand";
39
39
  import { SSOAdminClient } from "./SSOAdminClient";
40
40
  /**
41
- * <p></p>
41
+ * <p>Amazon Web Services Single Sign On helps you securely create, or connect, your workforce identities and manage their
42
+ * access centrally across Amazon Web Services accounts and applications. Amazon Web Services SSO is the recommended
43
+ * approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size
44
+ * and type.</p>
45
+ * <note>
46
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
47
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
48
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
49
+ * </note>
50
+ * <p>This reference guide provides information on single sign-on operations which could be used for
51
+ * access management of Amazon Web Services accounts. For information about Amazon Web Services SSO features, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">Amazon Web Services SSO User
52
+ * Guide</a>.</p>
53
+ * <p>Many operations in the Amazon Web Services SSO APIs rely on identifiers for users and groups, known as
54
+ * principals. For more information about how to work with principals and principal IDs in Amazon Web Services SSO,
55
+ * see the <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html">Identity Store API
56
+ * Reference</a>.</p>
57
+ * <note>
58
+ * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
59
+ * languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a
60
+ * convenient way to create programmatic access to Amazon Web Services SSO and other Amazon Web Services services. For more
61
+ * information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
62
+ * </note>
42
63
  */
43
64
  export declare class SSOAdmin extends SSOAdminClient {
44
65
  /**
@@ -77,6 +98,11 @@ export declare class SSOAdmin extends SSOAdminClient {
77
98
  * <a>ProvisionPermissionSet</a>
78
99
  * </code> to make these updates.</p>
79
100
  * </note>
101
+ * <note>
102
+ * <p>
103
+ * After a successful response, call <code>DescribeAccountAssignmentCreationStatus</code> to describe the status of an assignment creation request.
104
+ * </p>
105
+ * </note>
80
106
  */
81
107
  createAccountAssignment(args: CreateAccountAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccountAssignmentCommandOutput>;
82
108
  createAccountAssignment(args: CreateAccountAssignmentCommandInput, cb: (err: any, data?: CreateAccountAssignmentCommandOutput) => void): void;
@@ -85,6 +111,10 @@ export declare class SSOAdmin extends SSOAdminClient {
85
111
  * <p>Enables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO
86
112
  * instance. You can also specify new attributes to add to your ABAC configuration during the
87
113
  * enabling process. For more information about ABAC, see <a href="/singlesignon/latest/userguide/abac.html">Attribute-Based Access Control</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
114
+ * <note>
115
+ * <p>After a successful response, call <code>DescribeInstanceAccessControlAttributeConfiguration</code> to validate that
116
+ * <code>InstanceAccessControlAttributeConfiguration</code> was created.</p>
117
+ * </note>
88
118
  */
89
119
  createInstanceAccessControlAttributeConfiguration(args: CreateInstanceAccessControlAttributeConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateInstanceAccessControlAttributeConfigurationCommandOutput>;
90
120
  createInstanceAccessControlAttributeConfiguration(args: CreateInstanceAccessControlAttributeConfigurationCommandInput, cb: (err: any, data?: CreateInstanceAccessControlAttributeConfigurationCommandOutput) => void): void;
@@ -103,6 +133,9 @@ export declare class SSOAdmin extends SSOAdminClient {
103
133
  /**
104
134
  * <p>Deletes a principal's access from a specified Amazon Web Services account using a specified permission
105
135
  * set.</p>
136
+ * <note>
137
+ * <p>After a successful response, call <code>DescribeAccountAssignmentCreationStatus</code> to describe the status of an assignment deletion request.</p>
138
+ * </note>
106
139
  */
107
140
  deleteAccountAssignment(args: DeleteAccountAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccountAssignmentCommandOutput>;
108
141
  deleteAccountAssignment(args: DeleteAccountAssignmentCommandInput, cb: (err: any, data?: DeleteAccountAssignmentCommandOutput) => void): void;
package/dist-types/SSOAdminClient.d.ts CHANGED
@@ -163,7 +163,28 @@ declare type SSOAdminClientResolvedConfigType = __SmithyResolvedConfiguration<__
163
163
  export interface SSOAdminClientResolvedConfig extends SSOAdminClientResolvedConfigType {
164
164
  }
165
165
  /**
166
- * <p></p>
166
+ * <p>Amazon Web Services Single Sign On helps you securely create, or connect, your workforce identities and manage their
167
+ * access centrally across Amazon Web Services accounts and applications. Amazon Web Services SSO is the recommended
168
+ * approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size
169
+ * and type.</p>
170
+ * <note>
171
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
172
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
173
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
174
+ * </note>
175
+ * <p>This reference guide provides information on single sign-on operations which could be used for
176
+ * access management of Amazon Web Services accounts. For information about Amazon Web Services SSO features, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">Amazon Web Services SSO User
177
+ * Guide</a>.</p>
178
+ * <p>Many operations in the Amazon Web Services SSO APIs rely on identifiers for users and groups, known as
179
+ * principals. For more information about how to work with principals and principal IDs in Amazon Web Services SSO,
180
+ * see the <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html">Identity Store API
181
+ * Reference</a>.</p>
182
+ * <note>
183
+ * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
184
+ * languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a
185
+ * convenient way to create programmatic access to Amazon Web Services SSO and other Amazon Web Services services. For more
186
+ * information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
187
+ * </note>
167
188
  */
168
189
  export declare class SSOAdminClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SSOAdminClientResolvedConfig> {
169
190
  /**
package/dist-types/commands/CreateAccountAssignmentCommand.d.ts CHANGED
@@ -22,6 +22,11 @@ export interface CreateAccountAssignmentCommandOutput extends CreateAccountAssig
22
22
  * <a>ProvisionPermissionSet</a>
23
23
  * </code> to make these updates.</p>
24
24
  * </note>
25
+ * <note>
26
+ * <p>
27
+ * After a successful response, call <code>DescribeAccountAssignmentCreationStatus</code> to describe the status of an assignment creation request.
28
+ * </p>
29
+ * </note>
25
30
  * @example
26
31
  * Use a bare-bones client and the command you need to make an API call.
27
32
  * ```javascript
package/dist-types/commands/CreateInstanceAccessControlAttributeConfigurationCommand.d.ts CHANGED
@@ -10,6 +10,10 @@ export interface CreateInstanceAccessControlAttributeConfigurationCommandOutput
10
10
  * <p>Enables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO
11
11
  * instance. You can also specify new attributes to add to your ABAC configuration during the
12
12
  * enabling process. For more information about ABAC, see <a href="/singlesignon/latest/userguide/abac.html">Attribute-Based Access Control</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
13
+ * <note>
14
+ * <p>After a successful response, call <code>DescribeInstanceAccessControlAttributeConfiguration</code> to validate that
15
+ * <code>InstanceAccessControlAttributeConfiguration</code> was created.</p>
16
+ * </note>
13
17
  * @example
14
18
  * Use a bare-bones client and the command you need to make an API call.
15
19
  * ```javascript
package/dist-types/commands/DeleteAccountAssignmentCommand.d.ts CHANGED
@@ -9,6 +9,9 @@ export interface DeleteAccountAssignmentCommandOutput extends DeleteAccountAssig
9
9
  /**
10
10
  * <p>Deletes a principal's access from a specified Amazon Web Services account using a specified permission
11
11
  * set.</p>
12
+ * <note>
13
+ * <p>After a successful response, call <code>DescribeAccountAssignmentCreationStatus</code> to describe the status of an assignment deletion request.</p>
14
+ * </note>
12
15
  * @example
13
16
  * Use a bare-bones client and the command you need to make an API call.
14
17
  * ```javascript
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sso-admin",
3
3
  "description": "AWS SDK for JavaScript Sso Admin Client for Node.js, Browser and React Native",
4
- "version": "3.154.0",
4
+ "version": "3.156.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",