@aws-sdk/client-identitystore 3.295.0 → 3.297.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 (29) hide show
  1. package/dist-types/Identitystore.d.ts +20 -0
  2. package/dist-types/IdentitystoreClient.d.ts +24 -4
  3. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeGroupCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeUserCommand.d.ts +16 -0
  12. package/dist-types/commands/GetGroupIdCommand.d.ts +16 -0
  13. package/dist-types/commands/GetGroupMembershipIdCommand.d.ts +16 -0
  14. package/dist-types/commands/GetUserIdCommand.d.ts +16 -0
  15. package/dist-types/commands/IsMemberInGroupsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListGroupMembershipsForMemberCommand.d.ts +16 -0
  18. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  20. package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
  21. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  22. package/dist-types/models/IdentitystoreServiceException.d.ts +2 -0
  23. package/dist-types/models/models_0.d.ts +147 -0
  24. package/dist-types/pagination/Interfaces.d.ts +3 -0
  25. package/dist-types/pagination/ListGroupMembershipsForMemberPaginator.d.ts +3 -0
  26. package/dist-types/pagination/ListGroupMembershipsPaginator.d.ts +3 -0
  27. package/dist-types/pagination/ListGroupsPaginator.d.ts +3 -0
  28. package/dist-types/pagination/ListUsersPaginator.d.ts +3 -0
  29. package/package.json +29 -29
@@ -20,6 +20,7 @@ import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/Up
20
20
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
21
21
  import { IdentitystoreClient } from "./IdentitystoreClient";
22
22
  /**
23
+ * @public
23
24
  * <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
24
25
  * 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
25
26
  * Guide</a>.</p>
@@ -35,42 +36,49 @@ import { IdentitystoreClient } from "./IdentitystoreClient";
35
36
  */
36
37
  export declare class Identitystore extends IdentitystoreClient {
37
38
  /**
39
+ * @public
38
40
  * <p>Creates a group within the specified identity store.</p>
39
41
  */
40
42
  createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>;
41
43
  createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
42
44
  createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
43
45
  /**
46
+ * @public
44
47
  * <p>Creates a relationship between a member and a group. The following identifiers must be specified: <code>GroupId</code>, <code>IdentityStoreId</code>, and <code>MemberId</code>.</p>
45
48
  */
46
49
  createGroupMembership(args: CreateGroupMembershipCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupMembershipCommandOutput>;
47
50
  createGroupMembership(args: CreateGroupMembershipCommandInput, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
48
51
  createGroupMembership(args: CreateGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
49
52
  /**
53
+ * @public
50
54
  * <p>Creates a new user within the specified identity store.</p>
51
55
  */
52
56
  createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserCommandOutput>;
53
57
  createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
54
58
  createUser(args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
55
59
  /**
60
+ * @public
56
61
  * <p>Delete a group within an identity store given <code>GroupId</code>.</p>
57
62
  */
58
63
  deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupCommandOutput>;
59
64
  deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
60
65
  deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
61
66
  /**
67
+ * @public
62
68
  * <p>Delete a membership within a group given <code>MembershipId</code>.</p>
63
69
  */
64
70
  deleteGroupMembership(args: DeleteGroupMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupMembershipCommandOutput>;
65
71
  deleteGroupMembership(args: DeleteGroupMembershipCommandInput, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
66
72
  deleteGroupMembership(args: DeleteGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
67
73
  /**
74
+ * @public
68
75
  * <p>Deletes a user within an identity store given <code>UserId</code>.</p>
69
76
  */
70
77
  deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserCommandOutput>;
71
78
  deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
72
79
  deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
73
80
  /**
81
+ * @public
74
82
  * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
75
83
  * store.</p>
76
84
  */
@@ -78,54 +86,63 @@ export declare class Identitystore extends IdentitystoreClient {
78
86
  describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
79
87
  describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
80
88
  /**
89
+ * @public
81
90
  * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store.</p>
82
91
  */
83
92
  describeGroupMembership(args: DescribeGroupMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupMembershipCommandOutput>;
84
93
  describeGroupMembership(args: DescribeGroupMembershipCommandInput, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void): void;
85
94
  describeGroupMembership(args: DescribeGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void): void;
86
95
  /**
96
+ * @public
87
97
  * <p>Retrieves the user metadata and attributes from the <code>UserId</code> in an identity store.</p>
88
98
  */
89
99
  describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserCommandOutput>;
90
100
  describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
91
101
  describeUser(args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
92
102
  /**
103
+ * @public
93
104
  * <p>Retrieves <code>GroupId</code> in an identity store.</p>
94
105
  */
95
106
  getGroupId(args: GetGroupIdCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupIdCommandOutput>;
96
107
  getGroupId(args: GetGroupIdCommandInput, cb: (err: any, data?: GetGroupIdCommandOutput) => void): void;
97
108
  getGroupId(args: GetGroupIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupIdCommandOutput) => void): void;
98
109
  /**
110
+ * @public
99
111
  * <p>Retrieves the <code>MembershipId</code> in an identity store.</p>
100
112
  */
101
113
  getGroupMembershipId(args: GetGroupMembershipIdCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupMembershipIdCommandOutput>;
102
114
  getGroupMembershipId(args: GetGroupMembershipIdCommandInput, cb: (err: any, data?: GetGroupMembershipIdCommandOutput) => void): void;
103
115
  getGroupMembershipId(args: GetGroupMembershipIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupMembershipIdCommandOutput) => void): void;
104
116
  /**
117
+ * @public
105
118
  * <p>Retrieves the <code>UserId</code> in an identity store.</p>
106
119
  */
107
120
  getUserId(args: GetUserIdCommandInput, options?: __HttpHandlerOptions): Promise<GetUserIdCommandOutput>;
108
121
  getUserId(args: GetUserIdCommandInput, cb: (err: any, data?: GetUserIdCommandOutput) => void): void;
109
122
  getUserId(args: GetUserIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserIdCommandOutput) => void): void;
110
123
  /**
124
+ * @public
111
125
  * <p>Checks the user's membership in all requested groups and returns if the member exists in all queried groups.</p>
112
126
  */
113
127
  isMemberInGroups(args: IsMemberInGroupsCommandInput, options?: __HttpHandlerOptions): Promise<IsMemberInGroupsCommandOutput>;
114
128
  isMemberInGroups(args: IsMemberInGroupsCommandInput, cb: (err: any, data?: IsMemberInGroupsCommandOutput) => void): void;
115
129
  isMemberInGroups(args: IsMemberInGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IsMemberInGroupsCommandOutput) => void): void;
116
130
  /**
131
+ * @public
117
132
  * <p>For the specified group in the specified identity store, returns the list of all <code>GroupMembership</code> objects and returns results in paginated form.</p>
118
133
  */
119
134
  listGroupMemberships(args: ListGroupMembershipsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupMembershipsCommandOutput>;
120
135
  listGroupMemberships(args: ListGroupMembershipsCommandInput, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void): void;
121
136
  listGroupMemberships(args: ListGroupMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void): void;
122
137
  /**
138
+ * @public
123
139
  * <p>For the specified member in the specified identity store, returns the list of all <code>GroupMembership</code> objects and returns results in paginated form.</p>
124
140
  */
125
141
  listGroupMembershipsForMember(args: ListGroupMembershipsForMemberCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupMembershipsForMemberCommandOutput>;
126
142
  listGroupMembershipsForMember(args: ListGroupMembershipsForMemberCommandInput, cb: (err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void): void;
127
143
  listGroupMembershipsForMember(args: ListGroupMembershipsForMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void): void;
128
144
  /**
145
+ * @public
129
146
  * <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.
130
147
  * Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</p>
131
148
  */
@@ -133,6 +150,7 @@ export declare class Identitystore extends IdentitystoreClient {
133
150
  listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
134
151
  listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
135
152
  /**
153
+ * @public
136
154
  * <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.
137
155
  * Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</p>
138
156
  */
@@ -140,12 +158,14 @@ export declare class Identitystore extends IdentitystoreClient {
140
158
  listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
141
159
  listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
142
160
  /**
161
+ * @public
143
162
  * <p>For the specified group in the specified identity store, updates the group metadata and attributes.</p>
144
163
  */
145
164
  updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupCommandOutput>;
146
165
  updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
147
166
  updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
148
167
  /**
168
+ * @public
149
169
  * <p>For the specified user in the specified identity store, updates the user metadata and attributes.</p>
150
170
  */
151
171
  updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserCommandOutput>;
@@ -27,15 +27,24 @@ import { ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUs
27
27
  import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand";
28
28
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
29
29
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
30
+ /**
31
+ * @public
32
+ */
30
33
  export type ServiceInputTypes = CreateGroupCommandInput | CreateGroupMembershipCommandInput | CreateUserCommandInput | DeleteGroupCommandInput | DeleteGroupMembershipCommandInput | DeleteUserCommandInput | DescribeGroupCommandInput | DescribeGroupMembershipCommandInput | DescribeUserCommandInput | GetGroupIdCommandInput | GetGroupMembershipIdCommandInput | GetUserIdCommandInput | IsMemberInGroupsCommandInput | ListGroupMembershipsCommandInput | ListGroupMembershipsForMemberCommandInput | ListGroupsCommandInput | ListUsersCommandInput | UpdateGroupCommandInput | UpdateUserCommandInput;
34
+ /**
35
+ * @public
36
+ */
31
37
  export type ServiceOutputTypes = CreateGroupCommandOutput | CreateGroupMembershipCommandOutput | CreateUserCommandOutput | DeleteGroupCommandOutput | DeleteGroupMembershipCommandOutput | DeleteUserCommandOutput | DescribeGroupCommandOutput | DescribeGroupMembershipCommandOutput | DescribeUserCommandOutput | GetGroupIdCommandOutput | GetGroupMembershipIdCommandOutput | GetUserIdCommandOutput | IsMemberInGroupsCommandOutput | ListGroupMembershipsCommandOutput | ListGroupMembershipsForMemberCommandOutput | ListGroupsCommandOutput | ListUsersCommandOutput | UpdateGroupCommandOutput | UpdateUserCommandOutput;
38
+ /**
39
+ * @public
40
+ */
32
41
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
33
42
  /**
34
43
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
35
44
  */
36
45
  requestHandler?: __HttpHandler;
37
46
  /**
38
- * A constructor for a class implementing the {@link __Checksum} interface
47
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
39
48
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
40
49
  * @internal
41
50
  */
@@ -125,23 +134,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
125
134
  */
126
135
  logger?: __Logger;
127
136
  /**
128
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
137
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
129
138
  */
130
139
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
131
140
  }
141
+ /**
142
+ * @public
143
+ */
132
144
  type IdentitystoreClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
133
145
  /**
134
- * The configuration interface of IdentitystoreClient class constructor that set the region, credentials and other options.
146
+ * @public
147
+ *
148
+ * The configuration interface of IdentitystoreClient class constructor that set the region, credentials and other options.
135
149
  */
136
150
  export interface IdentitystoreClientConfig extends IdentitystoreClientConfigType {
137
151
  }
152
+ /**
153
+ * @public
154
+ */
138
155
  type IdentitystoreClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
139
156
  /**
140
- * The resolved configuration interface of IdentitystoreClient class. This is resolved and normalized from the {@link IdentitystoreClientConfig | constructor configuration interface}.
157
+ * @public
158
+ *
159
+ * The resolved configuration interface of IdentitystoreClient class. This is resolved and normalized from the {@link IdentitystoreClientConfig | constructor configuration interface}.
141
160
  */
142
161
  export interface IdentitystoreClientResolvedConfig extends IdentitystoreClientResolvedConfigType {
143
162
  }
144
163
  /**
164
+ * @public
145
165
  * <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
146
166
  * 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
147
167
  * Guide</a>.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { CreateGroupRequest, CreateGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateGroupCommand}.
8
10
  */
9
11
  export interface CreateGroupCommandInput extends CreateGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateGroupCommand}.
13
17
  */
14
18
  export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a group within the specified identity store.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
34
+ * @returns {@link CreateGroupCommandOutput}
28
35
  * @see {@link CreateGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -63,11 +70,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
63
70
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, IdentitystoreClientResolvedConfig> {
64
71
  readonly input: CreateGroupCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: CreateGroupCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGroupCommandInput, CreateGroupCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { CreateGroupMembershipRequest, CreateGroupMembershipResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateGroupMembershipCommand}.
8
10
  */
9
11
  export interface CreateGroupMembershipCommandInput extends CreateGroupMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateGroupMembershipCommand}.
13
17
  */
14
18
  export interface CreateGroupMembershipCommandOutput extends CreateGroupMembershipResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a relationship between a member and a group. The following identifiers must be specified: <code>GroupId</code>, <code>IdentityStoreId</code>, and <code>MemberId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateGroupMembershipCommandOutput extends CreateGroupMembershi
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateGroupMembershipCommandInput - {@link CreateGroupMembershipCommandInput}
34
+ * @returns {@link CreateGroupMembershipCommandOutput}
28
35
  * @see {@link CreateGroupMembershipCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateGroupMembershipCommandOutput} for command's `response` shape.
30
37
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -63,11 +70,20 @@ export interface CreateGroupMembershipCommandOutput extends CreateGroupMembershi
63
70
  export declare class CreateGroupMembershipCommand extends $Command<CreateGroupMembershipCommandInput, CreateGroupMembershipCommandOutput, IdentitystoreClientResolvedConfig> {
64
71
  readonly input: CreateGroupMembershipCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: CreateGroupMembershipCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGroupMembershipCommandInput, CreateGroupMembershipCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { CreateUserRequest, CreateUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateUserCommand}.
8
10
  */
9
11
  export interface CreateUserCommandInput extends CreateUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateUserCommand}.
13
17
  */
14
18
  export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new user within the specified identity store.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateUserCommandInput - {@link CreateUserCommandInput}
34
+ * @returns {@link CreateUserCommandOutput}
28
35
  * @see {@link CreateUserCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -63,11 +70,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
63
70
  export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, IdentitystoreClientResolvedConfig> {
64
71
  readonly input: CreateUserCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: CreateUserCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateUserCommandInput, CreateUserCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { DeleteGroupRequest, DeleteGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteGroupCommand}.
8
10
  */
9
11
  export interface DeleteGroupCommandInput extends DeleteGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteGroupCommand}.
13
17
  */
14
18
  export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete a group within an identity store given <code>GroupId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
34
+ * @returns {@link DeleteGroupCommandOutput}
28
35
  * @see {@link DeleteGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
60
67
  export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, IdentitystoreClientResolvedConfig> {
61
68
  readonly input: DeleteGroupCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteGroupCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGroupCommandInput, DeleteGroupCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { DeleteGroupMembershipRequest, DeleteGroupMembershipResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteGroupMembershipCommand}.
8
10
  */
9
11
  export interface DeleteGroupMembershipCommandInput extends DeleteGroupMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteGroupMembershipCommand}.
13
17
  */
14
18
  export interface DeleteGroupMembershipCommandOutput extends DeleteGroupMembershipResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete a membership within a group given <code>MembershipId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteGroupMembershipCommandOutput extends DeleteGroupMembershi
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteGroupMembershipCommandInput - {@link DeleteGroupMembershipCommandInput}
34
+ * @returns {@link DeleteGroupMembershipCommandOutput}
28
35
  * @see {@link DeleteGroupMembershipCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteGroupMembershipCommandOutput} for command's `response` shape.
30
37
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteGroupMembershipCommandOutput extends DeleteGroupMembershi
60
67
  export declare class DeleteGroupMembershipCommand extends $Command<DeleteGroupMembershipCommandInput, DeleteGroupMembershipCommandOutput, IdentitystoreClientResolvedConfig> {
61
68
  readonly input: DeleteGroupMembershipCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteGroupMembershipCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGroupMembershipCommandInput, DeleteGroupMembershipCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { DeleteUserRequest, DeleteUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteUserCommand}.
8
10
  */
9
11
  export interface DeleteUserCommandInput extends DeleteUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteUserCommand}.
13
17
  */
14
18
  export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a user within an identity store given <code>UserId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
34
+ * @returns {@link DeleteUserCommandOutput}
28
35
  * @see {@link DeleteUserCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
60
67
  export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, IdentitystoreClientResolvedConfig> {
61
68
  readonly input: DeleteUserCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteUserCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteUserCommandInput, DeleteUserCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { DescribeGroupRequest, DescribeGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeGroupCommand}.
8
10
  */
9
11
  export interface DescribeGroupCommandInput extends DescribeGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeGroupCommand}.
13
17
  */
14
18
  export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
18
23
  * store.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeGroupCommandInput - {@link DescribeGroupCommandInput}
35
+ * @returns {@link DescribeGroupCommandOutput}
29
36
  * @see {@link DescribeGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
50
57
  export declare class DescribeGroupCommand extends $Command<DescribeGroupCommandInput, DescribeGroupCommandOutput, IdentitystoreClientResolvedConfig> {
51
58
  readonly input: DescribeGroupCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeGroupCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeGroupCommandInput, DescribeGroupCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IdentitystoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IdentitystoreClient";
5
5
  import { DescribeGroupMembershipRequest, DescribeGroupMembershipResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeGroupMembershipCommand}.
8
10
  */
9
11
  export interface DescribeGroupMembershipCommandInput extends DescribeGroupMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeGroupMembershipCommand}.
13
17
  */
14
18
  export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembershipResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeGroupMembershipCommandInput - {@link DescribeGroupMembershipCommandInput}
34
+ * @returns {@link DescribeGroupMembershipCommandOutput}
28
35
  * @see {@link DescribeGroupMembershipCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeGroupMembershipCommandOutput} for command's `response` shape.
30
37
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembe
49
56
  export declare class DescribeGroupMembershipCommand extends $Command<DescribeGroupMembershipCommandInput, DescribeGroupMembershipCommandOutput, IdentitystoreClientResolvedConfig> {
50
57
  readonly input: DescribeGroupMembershipCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DescribeGroupMembershipCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IdentitystoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeGroupMembershipCommandInput, DescribeGroupMembershipCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }