macie.d.ts
14.4 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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
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';
interface Blob {}
declare class Macie extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Macie.Types.ClientConfiguration)
config: Config & Macie.Types.ClientConfiguration;
/**
* Associates a specified AWS account with Amazon Macie as a member account.
*/
associateMemberAccount(params: Macie.Types.AssociateMemberAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates a specified AWS account with Amazon Macie as a member account.
*/
associateMemberAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account.
*/
associateS3Resources(params: Macie.Types.AssociateS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.AssociateS3ResourcesResult) => void): Request<Macie.Types.AssociateS3ResourcesResult, AWSError>;
/**
* Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account.
*/
associateS3Resources(callback?: (err: AWSError, data: Macie.Types.AssociateS3ResourcesResult) => void): Request<Macie.Types.AssociateS3ResourcesResult, AWSError>;
/**
* Removes the specified member account from Amazon Macie.
*/
disassociateMemberAccount(params: Macie.Types.DisassociateMemberAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified member account from Amazon Macie.
*/
disassociateMemberAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account.
*/
disassociateS3Resources(params: Macie.Types.DisassociateS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.DisassociateS3ResourcesResult) => void): Request<Macie.Types.DisassociateS3ResourcesResult, AWSError>;
/**
* Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account.
*/
disassociateS3Resources(callback?: (err: AWSError, data: Macie.Types.DisassociateS3ResourcesResult) => void): Request<Macie.Types.DisassociateS3ResourcesResult, AWSError>;
/**
* Lists all Amazon Macie member accounts for the current Amazon Macie master account.
*/
listMemberAccounts(params: Macie.Types.ListMemberAccountsRequest, callback?: (err: AWSError, data: Macie.Types.ListMemberAccountsResult) => void): Request<Macie.Types.ListMemberAccountsResult, AWSError>;
/**
* Lists all Amazon Macie member accounts for the current Amazon Macie master account.
*/
listMemberAccounts(callback?: (err: AWSError, data: Macie.Types.ListMemberAccountsResult) => void): Request<Macie.Types.ListMemberAccountsResult, AWSError>;
/**
* Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account.
*/
listS3Resources(params: Macie.Types.ListS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.ListS3ResourcesResult) => void): Request<Macie.Types.ListS3ResourcesResult, AWSError>;
/**
* Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account.
*/
listS3Resources(callback?: (err: AWSError, data: Macie.Types.ListS3ResourcesResult) => void): Request<Macie.Types.ListS3ResourcesResult, AWSError>;
/**
* Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account.
*/
updateS3Resources(params: Macie.Types.UpdateS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.UpdateS3ResourcesResult) => void): Request<Macie.Types.UpdateS3ResourcesResult, AWSError>;
/**
* Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account.
*/
updateS3Resources(callback?: (err: AWSError, data: Macie.Types.UpdateS3ResourcesResult) => void): Request<Macie.Types.UpdateS3ResourcesResult, AWSError>;
}
declare namespace Macie {
export type AWSAccountId = string;
export interface AssociateMemberAccountRequest {
/**
* The ID of the AWS account that you want to associate with Amazon Macie as a member account.
*/
memberAccountId: AWSAccountId;
}
export interface AssociateS3ResourcesRequest {
/**
* The ID of the Amazon Macie member account whose resources you want to associate with Macie.
*/
memberAccountId?: AWSAccountId;
/**
* The S3 resources that you want to associate with Amazon Macie for monitoring and data classification.
*/
s3Resources: S3ResourcesClassification;
}
export interface AssociateS3ResourcesResult {
/**
* S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for each failed item.
*/
failedS3Resources?: FailedS3Resources;
}
export type BucketName = string;
export interface ClassificationType {
/**
* A one-time classification of all of the existing objects in a specified S3 bucket.
*/
oneTime: S3OneTimeClassificationType;
/**
* A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.
*/
continuous: S3ContinuousClassificationType;
}
export interface ClassificationTypeUpdate {
/**
* A one-time classification of all of the existing objects in a specified S3 bucket.
*/
oneTime?: S3OneTimeClassificationType;
/**
* A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.
*/
continuous?: S3ContinuousClassificationType;
}
export interface DisassociateMemberAccountRequest {
/**
* The ID of the member account that you want to remove from Amazon Macie.
*/
memberAccountId: AWSAccountId;
}
export interface DisassociateS3ResourcesRequest {
/**
* The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon Macie.
*/
memberAccountId?: AWSAccountId;
/**
* The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie.
*/
associatedS3Resources: S3Resources;
}
export interface DisassociateS3ResourcesResult {
/**
* S3 resources that couldn't be removed from being monitored and classified by Amazon Macie. An error code and an error message are provided for each failed item.
*/
failedS3Resources?: FailedS3Resources;
}
export type ErrorCode = string;
export type ExceptionMessage = string;
export interface FailedS3Resource {
/**
* The failed S3 resources.
*/
failedItem?: S3Resource;
/**
* The status code of a failed item.
*/
errorCode?: ErrorCode;
/**
* The error message of a failed item.
*/
errorMessage?: ExceptionMessage;
}
export type FailedS3Resources = FailedS3Resource[];
export interface ListMemberAccountsRequest {
/**
* Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
*/
nextToken?: NextToken;
/**
* Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.
*/
maxResults?: MaxResults;
}
export interface ListMemberAccountsResult {
/**
* A list of the Amazon Macie member accounts returned by the action. The current master account is also included in this list.
*/
memberAccounts?: MemberAccounts;
/**
* When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
*/
nextToken?: NextToken;
}
export interface ListS3ResourcesRequest {
/**
* The Amazon Macie member account ID whose associated S3 resources you want to list.
*/
memberAccountId?: AWSAccountId;
/**
* Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
*/
nextToken?: NextToken;
/**
* Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.
*/
maxResults?: MaxResults;
}
export interface ListS3ResourcesResult {
/**
* A list of the associated S3 resources returned by the action.
*/
s3Resources?: S3ResourcesClassification;
/**
* When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
*/
nextToken?: NextToken;
}
export type MaxResults = number;
export interface MemberAccount {
/**
* The AWS account ID of the Amazon Macie member account.
*/
accountId?: AWSAccountId;
}
export type MemberAccounts = MemberAccount[];
export type NextToken = string;
export type Prefix = string;
export type S3ContinuousClassificationType = "FULL"|string;
export type S3OneTimeClassificationType = "FULL"|"NONE"|string;
export interface S3Resource {
/**
* The name of the S3 bucket.
*/
bucketName: BucketName;
/**
* The prefix of the S3 bucket.
*/
prefix?: Prefix;
}
export interface S3ResourceClassification {
/**
* The name of the S3 bucket that you want to associate with Amazon Macie.
*/
bucketName: BucketName;
/**
* The prefix of the S3 bucket that you want to associate with Amazon Macie.
*/
prefix?: Prefix;
/**
* The classification type that you want to specify for the resource associated with Amazon Macie.
*/
classificationType: ClassificationType;
}
export interface S3ResourceClassificationUpdate {
/**
* The name of the S3 bucket whose classification types you want to update.
*/
bucketName: BucketName;
/**
* The prefix of the S3 bucket whose classification types you want to update.
*/
prefix?: Prefix;
/**
* The classification type that you want to update for the resource associated with Amazon Macie.
*/
classificationTypeUpdate: ClassificationTypeUpdate;
}
export type S3Resources = S3Resource[];
export type S3ResourcesClassification = S3ResourceClassification[];
export type S3ResourcesClassificationUpdate = S3ResourceClassificationUpdate[];
export interface UpdateS3ResourcesRequest {
/**
* The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update.
*/
memberAccountId?: AWSAccountId;
/**
* The S3 resources whose classification types you want to update.
*/
s3ResourcesUpdate: S3ResourcesClassificationUpdate;
}
export interface UpdateS3ResourcesResult {
/**
* The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item.
*/
failedS3Resources?: FailedS3Resources;
}
/**
* 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 = "2017-12-19"|"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 Macie client.
*/
export import Types = Macie;
}
export = Macie;