@aws-sdk/client-identitystore 3.1141.0 → 3.1143.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 (57) hide show
  1. package/README.md +22 -1
  2. package/dist-cjs/index.js +186 -76
  3. package/dist-es/Identitystore.js +8 -0
  4. package/dist-es/commands/DescribeIdentityStoreCommand.js +4 -0
  5. package/dist-es/commands/ListIdentityStoresCommand.js +4 -0
  6. package/dist-es/commands/UpdateIdentityStoreCommand.js +4 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/models/enums.js +4 -4
  9. package/dist-es/models/errors.js +34 -34
  10. package/dist-es/pagination/ListIdentityStoresPaginator.js +4 -0
  11. package/dist-es/pagination/index.js +1 -0
  12. package/dist-es/schemas/schemas_0.js +118 -37
  13. package/dist-types/Identitystore.d.ts +30 -1
  14. package/dist-types/IdentitystoreClient.d.ts +6 -3
  15. package/dist-types/commands/CreateGroupCommand.d.ts +3 -1
  16. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +2 -1
  17. package/dist-types/commands/CreateUserCommand.d.ts +2 -0
  18. package/dist-types/commands/DeleteGroupCommand.d.ts +1 -0
  19. package/dist-types/commands/DeleteUserCommand.d.ts +1 -0
  20. package/dist-types/commands/DescribeGroupCommand.d.ts +3 -1
  21. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +1 -0
  22. package/dist-types/commands/DescribeIdentityStoreCommand.d.ts +99 -0
  23. package/dist-types/commands/DescribeUserCommand.d.ts +2 -0
  24. package/dist-types/commands/GetGroupIdCommand.d.ts +2 -1
  25. package/dist-types/commands/GetGroupMembershipIdCommand.d.ts +2 -1
  26. package/dist-types/commands/GetUserIdCommand.d.ts +1 -0
  27. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListGroupMembershipsForMemberCommand.d.ts +2 -1
  29. package/dist-types/commands/ListGroupsCommand.d.ts +3 -1
  30. package/dist-types/commands/ListIdentityStoresCommand.d.ts +90 -0
  31. package/dist-types/commands/ListUsersCommand.d.ts +2 -0
  32. package/dist-types/commands/UpdateGroupCommand.d.ts +8 -2
  33. package/dist-types/commands/UpdateIdentityStoreCommand.d.ts +102 -0
  34. package/dist-types/commands/UpdateUserCommand.d.ts +8 -2
  35. package/dist-types/commands/index.d.ts +3 -0
  36. package/dist-types/index.d.ts +1 -1
  37. package/dist-types/models/enums.d.ts +12 -12
  38. package/dist-types/models/errors.d.ts +41 -41
  39. package/dist-types/models/models_0.d.ts +458 -150
  40. package/dist-types/pagination/ListIdentityStoresPaginator.d.ts +7 -0
  41. package/dist-types/pagination/index.d.ts +1 -0
  42. package/dist-types/schemas/schemas_0.d.ts +12 -0
  43. package/dist-types/ts3.4/Identitystore.d.ts +59 -0
  44. package/dist-types/ts3.4/IdentitystoreClient.d.ts +18 -0
  45. package/dist-types/ts3.4/commands/DescribeIdentityStoreCommand.d.ts +39 -0
  46. package/dist-types/ts3.4/commands/ListIdentityStoresCommand.d.ts +39 -0
  47. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/UpdateIdentityStoreCommand.d.ts +39 -0
  49. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  51. package/dist-types/ts3.4/models/enums.d.ts +6 -6
  52. package/dist-types/ts3.4/models/errors.d.ts +15 -15
  53. package/dist-types/ts3.4/models/models_0.d.ts +116 -44
  54. package/dist-types/ts3.4/pagination/ListIdentityStoresPaginator.d.ts +11 -0
  55. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  56. package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
  57. package/package.json +1 -1
@@ -0,0 +1,102 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { UpdateIdentityStoreRequest, UpdateIdentityStoreResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link UpdateIdentityStoreCommand}.
11
+ */
12
+ export interface UpdateIdentityStoreCommandInput extends UpdateIdentityStoreRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link UpdateIdentityStoreCommand}.
18
+ */
19
+ export interface UpdateIdentityStoreCommandOutput extends UpdateIdentityStoreResponse, __MetadataBearer {
20
+ }
21
+ declare const UpdateIdentityStoreCommand_base: {
22
+ new (input: UpdateIdentityStoreCommandInput): import("@smithy/core/client").CommandImpl<UpdateIdentityStoreCommandInput, UpdateIdentityStoreCommandOutput, import("..").IdentitystoreClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: UpdateIdentityStoreCommandInput): import("@smithy/core/client").CommandImpl<UpdateIdentityStoreCommandInput, UpdateIdentityStoreCommandOutput, import("..").IdentitystoreClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Updates the configuration of the specified identity store, including its network configuration.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IdentitystoreClient, UpdateIdentityStoreCommand } from "@aws-sdk/client-identitystore"; // ES Modules import
32
+ * // const { IdentitystoreClient, UpdateIdentityStoreCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import
33
+ * // import type { IdentitystoreClientConfig } from "@aws-sdk/client-identitystore";
34
+ * const config = {}; // type is IdentitystoreClientConfig
35
+ * const client = new IdentitystoreClient(config);
36
+ * const input = { // UpdateIdentityStoreRequest
37
+ * IdentityStoreId: "STRING_VALUE", // required
38
+ * NetworkConfiguration: { // NetworkConfiguration
39
+ * VpceAccessRequired: true || false, // required
40
+ * ApiRestrictSourceVpcs: [ // VpcIdList
41
+ * "STRING_VALUE",
42
+ * ],
43
+ * ApiAllowSourceIps: [ // IpCidrList
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * ScimAllowSourceIps: [
47
+ * "STRING_VALUE",
48
+ * ],
49
+ * },
50
+ * };
51
+ * const command = new UpdateIdentityStoreCommand(input);
52
+ * const response = await client.send(command);
53
+ * // { // UpdateIdentityStoreResponse
54
+ * // IdentityStoreId: "STRING_VALUE", // required
55
+ * // IdentityStoreArn: "STRING_VALUE", // required
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param UpdateIdentityStoreCommandInput - {@link UpdateIdentityStoreCommandInput}
61
+ * @returns {@link UpdateIdentityStoreCommandOutput}
62
+ * @see {@link UpdateIdentityStoreCommandInput} for command's `input` shape.
63
+ * @see {@link UpdateIdentityStoreCommandOutput} for command's `response` shape.
64
+ * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
65
+ *
66
+ * @throws {@link ConflictException} (client fault)
67
+ * <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
68
+ *
69
+ * @throws {@link ResourceNotFoundException} (client fault)
70
+ * <p>Indicates that a requested resource is not found.</p>
71
+ *
72
+ * @throws {@link ValidationException} (client fault)
73
+ * <p>The request failed because it contains a syntax error.</p>
74
+ *
75
+ * @throws {@link AccessDeniedException} (client fault)
76
+ * <p>You do not have sufficient access to perform this action.</p>
77
+ *
78
+ * @throws {@link InternalServerException} (server fault)
79
+ * <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
80
+ *
81
+ * @throws {@link ThrottlingException} (client fault)
82
+ * <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
83
+ *
84
+ * @throws {@link IdentitystoreServiceException}
85
+ * <p>Base exception class for all service exceptions from Identitystore service.</p>
86
+ *
87
+ *
88
+ * @public
89
+ */
90
+ export declare class UpdateIdentityStoreCommand extends UpdateIdentityStoreCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: UpdateIdentityStoreRequest;
95
+ output: UpdateIdentityStoreResponse;
96
+ };
97
+ sdk: {
98
+ input: UpdateIdentityStoreCommandInput;
99
+ output: UpdateIdentityStoreCommandOutput;
100
+ };
101
+ };
102
+ }
@@ -42,10 +42,16 @@ declare const UpdateUserCommand_base: {
42
42
  * AttributeValue: "DOCUMENT_VALUE",
43
43
  * },
44
44
  * ],
45
+ * Revision: "STRING_VALUE",
45
46
  * };
46
47
  * const command = new UpdateUserCommand(input);
47
48
  * const response = await client.send(command);
48
- * // {};
49
+ * // { // UpdateUserResponse
50
+ * // IdentityStoreId: "STRING_VALUE", // required
51
+ * // UserId: "STRING_VALUE", // required
52
+ * // UserArn: "STRING_VALUE", // required
53
+ * // Revision: "STRING_VALUE", // required
54
+ * // };
49
55
  *
50
56
  * ```
51
57
  *
@@ -87,7 +93,7 @@ export declare class UpdateUserCommand extends UpdateUserCommand_base {
87
93
  protected static __types: {
88
94
  api: {
89
95
  input: UpdateUserRequest;
90
- output: {};
96
+ output: UpdateUserResponse;
91
97
  };
92
98
  sdk: {
93
99
  input: UpdateUserCommandInput;
@@ -6,6 +6,7 @@ export * from "./DeleteGroupMembershipCommand";
6
6
  export * from "./DeleteUserCommand";
7
7
  export * from "./DescribeGroupCommand";
8
8
  export * from "./DescribeGroupMembershipCommand";
9
+ export * from "./DescribeIdentityStoreCommand";
9
10
  export * from "./DescribeUserCommand";
10
11
  export * from "./GetGroupIdCommand";
11
12
  export * from "./GetGroupMembershipIdCommand";
@@ -14,6 +15,8 @@ export * from "./IsMemberInGroupsCommand";
14
15
  export * from "./ListGroupMembershipsCommand";
15
16
  export * from "./ListGroupMembershipsForMemberCommand";
16
17
  export * from "./ListGroupsCommand";
18
+ export * from "./ListIdentityStoresCommand";
17
19
  export * from "./ListUsersCommand";
18
20
  export * from "./UpdateGroupCommand";
21
+ export * from "./UpdateIdentityStoreCommand";
19
22
  export * from "./UpdateUserCommand";
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html"> IAM Identity Center User Guide</a>.</p> <p>This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.</p> <note> <p> IAM Identity Center uses the <code>sso</code>, <code>sso-directory</code>, and <code>identitystore</code> API namespaces. The <code>sso-directory</code> and <code>identitystore</code> namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.</p> </note>
2
+ * <note> <p> IAM Identity Center uses the <code>sso</code>, <code>sso-directory</code>, and <code>identitystore</code> API namespaces. The <code>sso-directory</code> and <code>identitystore</code> namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.</p> </note> <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). You can use the identity store API operations in this guide to manage your identity data programmatically. The scope of these APIs allows you to create, read, update, delete, and list users, groups, and memberships.</p> <p>This guide also describes identity store operations that you can call and includes detailed information about data types and errors.</p> <important> <p>If you use an external identity provider or Active Directory as your identity source, we recommend that you use the <code>Create</code>, <code>Update</code>, and <code>Delete</code> APIs with caution. Because IAM Identity Center doesn't support outbound synchronization, your identity source won't automatically update with the changes that you make to users or groups using these APIs.</p> </important> <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to programmatically access the identity store and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Amazon Web Services Builder Center Toolbox</a>.</p>
3
3
  *
4
4
  * @packageDocumentation
5
5
  */
@@ -9,6 +9,18 @@ export declare const AccessDeniedExceptionReason: {
9
9
  * @public
10
10
  */
11
11
  export type AccessDeniedExceptionReason = (typeof AccessDeniedExceptionReason)[keyof typeof AccessDeniedExceptionReason];
12
+ /**
13
+ * @public
14
+ * @enum
15
+ */
16
+ export declare const ConflictExceptionReason: {
17
+ readonly CONCURRENT_MODIFICATION: "CONCURRENT_MODIFICATION";
18
+ readonly UNIQUENESS_CONSTRAINT_VIOLATION: "UNIQUENESS_CONSTRAINT_VIOLATION";
19
+ };
20
+ /**
21
+ * @public
22
+ */
23
+ export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
12
24
  /**
13
25
  * @public
14
26
  * @enum
@@ -60,18 +72,6 @@ export declare const ValidationExceptionReason: {
60
72
  * @public
61
73
  */
62
74
  export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
63
- /**
64
- * @public
65
- * @enum
66
- */
67
- export declare const ConflictExceptionReason: {
68
- readonly CONCURRENT_MODIFICATION: "CONCURRENT_MODIFICATION";
69
- readonly UNIQUENESS_CONSTRAINT_VIOLATION: "UNIQUENESS_CONSTRAINT_VIOLATION";
70
- };
71
- /**
72
- * @public
73
- */
74
- export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
75
75
  /**
76
76
  * @public
77
77
  * @enum
@@ -24,6 +24,29 @@ export declare class AccessDeniedException extends __BaseException {
24
24
  */
25
25
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
26
26
  }
27
+ /**
28
+ * <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
29
+ * @public
30
+ */
31
+ export declare class ConflictException extends __BaseException {
32
+ readonly name: "ConflictException";
33
+ readonly $fault: "client";
34
+ Message?: string | undefined;
35
+ /**
36
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
37
+ * @public
38
+ */
39
+ RequestId?: string | undefined;
40
+ /**
41
+ * <p>Indicates the reason for a conflict error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.</p>
42
+ * @public
43
+ */
44
+ Reason?: ConflictExceptionReason | undefined;
45
+ /**
46
+ * @internal
47
+ */
48
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
49
+ }
27
50
  /**
28
51
  * <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
29
52
  * @public
@@ -81,6 +104,24 @@ export declare class ResourceNotFoundException extends __BaseException {
81
104
  */
82
105
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
83
106
  }
107
+ /**
108
+ * <p>The request would cause the number of users or groups in the identity store to exceed the maximum allowed.</p>
109
+ * @public
110
+ */
111
+ export declare class ServiceQuotaExceededException extends __BaseException {
112
+ readonly name: "ServiceQuotaExceededException";
113
+ readonly $fault: "client";
114
+ Message?: string | undefined;
115
+ /**
116
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
117
+ * @public
118
+ */
119
+ RequestId?: string | undefined;
120
+ /**
121
+ * @internal
122
+ */
123
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
124
+ }
84
125
  /**
85
126
  * <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
86
127
  * @public
@@ -135,44 +176,3 @@ export declare class ValidationException extends __BaseException {
135
176
  */
136
177
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
137
178
  }
138
- /**
139
- * <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
140
- * @public
141
- */
142
- export declare class ConflictException extends __BaseException {
143
- readonly name: "ConflictException";
144
- readonly $fault: "client";
145
- Message?: string | undefined;
146
- /**
147
- * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
148
- * @public
149
- */
150
- RequestId?: string | undefined;
151
- /**
152
- * <p>Indicates the reason for a conflict error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.</p>
153
- * @public
154
- */
155
- Reason?: ConflictExceptionReason | undefined;
156
- /**
157
- * @internal
158
- */
159
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
160
- }
161
- /**
162
- * <p>The request would cause the number of users or groups in the identity store to exceed the maximum allowed.</p>
163
- * @public
164
- */
165
- export declare class ServiceQuotaExceededException extends __BaseException {
166
- readonly name: "ServiceQuotaExceededException";
167
- readonly $fault: "client";
168
- Message?: string | undefined;
169
- /**
170
- * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
171
- * @public
172
- */
173
- RequestId?: string | undefined;
174
- /**
175
- * @internal
176
- */
177
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
178
- }