identitystore.d.ts
11.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class IdentityStore extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: IdentityStore.Types.ClientConfiguration)
config: Config & IdentityStore.Types.ClientConfiguration;
/**
* Retrieves the group metadata and attributes from GroupId in an identity store.
*/
describeGroup(params: IdentityStore.Types.DescribeGroupRequest, callback?: (err: AWSError, data: IdentityStore.Types.DescribeGroupResponse) => void): Request<IdentityStore.Types.DescribeGroupResponse, AWSError>;
/**
* Retrieves the group metadata and attributes from GroupId in an identity store.
*/
describeGroup(callback?: (err: AWSError, data: IdentityStore.Types.DescribeGroupResponse) => void): Request<IdentityStore.Types.DescribeGroupResponse, AWSError>;
/**
* Retrieves the user metadata and attributes from UserId in an identity store.
*/
describeUser(params: IdentityStore.Types.DescribeUserRequest, callback?: (err: AWSError, data: IdentityStore.Types.DescribeUserResponse) => void): Request<IdentityStore.Types.DescribeUserResponse, AWSError>;
/**
* Retrieves the user metadata and attributes from UserId in an identity store.
*/
describeUser(callback?: (err: AWSError, data: IdentityStore.Types.DescribeUserResponse) => void): Request<IdentityStore.Types.DescribeUserResponse, AWSError>;
/**
* Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.
*/
listGroups(params: IdentityStore.Types.ListGroupsRequest, callback?: (err: AWSError, data: IdentityStore.Types.ListGroupsResponse) => void): Request<IdentityStore.Types.ListGroupsResponse, AWSError>;
/**
* Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.
*/
listGroups(callback?: (err: AWSError, data: IdentityStore.Types.ListGroupsResponse) => void): Request<IdentityStore.Types.ListGroupsResponse, AWSError>;
/**
* Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.
*/
listUsers(params: IdentityStore.Types.ListUsersRequest, callback?: (err: AWSError, data: IdentityStore.Types.ListUsersResponse) => void): Request<IdentityStore.Types.ListUsersResponse, AWSError>;
/**
* Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.
*/
listUsers(callback?: (err: AWSError, data: IdentityStore.Types.ListUsersResponse) => void): Request<IdentityStore.Types.ListUsersResponse, AWSError>;
}
declare namespace IdentityStore {
export type AttributePath = string;
export interface DescribeGroupRequest {
/**
* The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
*/
IdentityStoreId: IdentityStoreId;
/**
* The identifier for a group in the identity store.
*/
GroupId: ResourceId;
}
export interface DescribeGroupResponse {
/**
* The identifier for a group in the identity store.
*/
GroupId: ResourceId;
/**
* Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “<>;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
*/
DisplayName: GroupDisplayName;
}
export interface DescribeUserRequest {
/**
* The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
*/
IdentityStoreId: IdentityStoreId;
/**
* The identifier for a user in the identity store.
*/
UserId: ResourceId;
}
export interface DescribeUserResponse {
/**
* Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “<>;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
*/
UserName: UserName;
/**
* The identifier for a user in the identity store.
*/
UserId: ResourceId;
}
export interface Filter {
/**
* The attribute path used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
*/
AttributePath: AttributePath;
/**
* Represents the data for an attribute. Each attribute value is described as a name-value pair.
*/
AttributeValue: SensitiveStringType;
}
export type Filters = Filter[];
export interface Group {
/**
* The identifier for a group in the identity store.
*/
GroupId: ResourceId;
/**
* Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “<>;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
*/
DisplayName: GroupDisplayName;
}
export type GroupDisplayName = string;
export type Groups = Group[];
export type IdentityStoreId = string;
export interface ListGroupsRequest {
/**
* The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
*/
IdentityStoreId: IdentityStoreId;
/**
* The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
*/
MaxResults?: MaxResults;
/**
* The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
*/
NextToken?: NextToken;
/**
* A list of Filter objects, which is used in the ListUsers and ListGroups request.
*/
Filters?: Filters;
}
export interface ListGroupsResponse {
/**
* A list of Group objects in the identity store.
*/
Groups: Groups;
/**
* The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
*/
NextToken?: NextToken;
}
export interface ListUsersRequest {
/**
* The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
*/
IdentityStoreId: IdentityStoreId;
/**
* The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
*/
MaxResults?: MaxResults;
/**
* The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
*/
NextToken?: NextToken;
/**
* A list of Filter objects, which is used in the ListUsers and ListGroups request.
*/
Filters?: Filters;
}
export interface ListUsersResponse {
/**
* A list of User objects in the identity store.
*/
Users: Users;
/**
* The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
*/
NextToken?: NextToken;
}
export type MaxResults = number;
export type NextToken = string;
export type ResourceId = string;
export type SensitiveStringType = string;
export interface User {
/**
* Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “<>;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
*/
UserName: UserName;
/**
* The identifier for a user in the identity store.
*/
UserId: ResourceId;
}
export type UserName = string;
export type Users = User[];
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2020-06-15"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the IdentityStore client.
*/
export import Types = IdentityStore;
}
export = IdentityStore;