codeguruprofiler.d.ts
20.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
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
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 CodeGuruProfiler extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CodeGuruProfiler.Types.ClientConfiguration)
config: Config & CodeGuruProfiler.Types.ClientConfiguration;
/**
*
*/
configureAgent(params: CodeGuruProfiler.Types.ConfigureAgentRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ConfigureAgentResponse) => void): Request<CodeGuruProfiler.Types.ConfigureAgentResponse, AWSError>;
/**
*
*/
configureAgent(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ConfigureAgentResponse) => void): Request<CodeGuruProfiler.Types.ConfigureAgentResponse, AWSError>;
/**
* Creates a profiling group.
*/
createProfilingGroup(params: CodeGuruProfiler.Types.CreateProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.CreateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.CreateProfilingGroupResponse, AWSError>;
/**
* Creates a profiling group.
*/
createProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.CreateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.CreateProfilingGroupResponse, AWSError>;
/**
* Deletes a profiling group.
*/
deleteProfilingGroup(params: CodeGuruProfiler.Types.DeleteProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.DeleteProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DeleteProfilingGroupResponse, AWSError>;
/**
* Deletes a profiling group.
*/
deleteProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.DeleteProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DeleteProfilingGroupResponse, AWSError>;
/**
* Describes a profiling group.
*/
describeProfilingGroup(params: CodeGuruProfiler.Types.DescribeProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.DescribeProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DescribeProfilingGroupResponse, AWSError>;
/**
* Describes a profiling group.
*/
describeProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.DescribeProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DescribeProfilingGroupResponse, AWSError>;
/**
* Gets the profiling group policy.
*/
getPolicy(params: CodeGuruProfiler.Types.GetPolicyRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetPolicyResponse) => void): Request<CodeGuruProfiler.Types.GetPolicyResponse, AWSError>;
/**
* Gets the profiling group policy.
*/
getPolicy(callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetPolicyResponse) => void): Request<CodeGuruProfiler.Types.GetPolicyResponse, AWSError>;
/**
* Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20. You must specify exactly two of the following parameters: startTime, period, and endTime.
*/
getProfile(params: CodeGuruProfiler.Types.GetProfileRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetProfileResponse) => void): Request<CodeGuruProfiler.Types.GetProfileResponse, AWSError>;
/**
* Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20. You must specify exactly two of the following parameters: startTime, period, and endTime.
*/
getProfile(callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetProfileResponse) => void): Request<CodeGuruProfiler.Types.GetProfileResponse, AWSError>;
/**
* List the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
*/
listProfileTimes(params: CodeGuruProfiler.Types.ListProfileTimesRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfileTimesResponse) => void): Request<CodeGuruProfiler.Types.ListProfileTimesResponse, AWSError>;
/**
* List the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
*/
listProfileTimes(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfileTimesResponse) => void): Request<CodeGuruProfiler.Types.ListProfileTimesResponse, AWSError>;
/**
* Lists profiling groups.
*/
listProfilingGroups(params: CodeGuruProfiler.Types.ListProfilingGroupsRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfilingGroupsResponse) => void): Request<CodeGuruProfiler.Types.ListProfilingGroupsResponse, AWSError>;
/**
* Lists profiling groups.
*/
listProfilingGroups(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfilingGroupsResponse) => void): Request<CodeGuruProfiler.Types.ListProfilingGroupsResponse, AWSError>;
/**
*
*/
postAgentProfile(params: CodeGuruProfiler.Types.PostAgentProfileRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.PostAgentProfileResponse) => void): Request<CodeGuruProfiler.Types.PostAgentProfileResponse, AWSError>;
/**
*
*/
postAgentProfile(callback?: (err: AWSError, data: CodeGuruProfiler.Types.PostAgentProfileResponse) => void): Request<CodeGuruProfiler.Types.PostAgentProfileResponse, AWSError>;
/**
* Provides permission to the principals. This overwrites the existing permissions, and is not additive.
*/
putPermission(params: CodeGuruProfiler.Types.PutPermissionRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.PutPermissionResponse) => void): Request<CodeGuruProfiler.Types.PutPermissionResponse, AWSError>;
/**
* Provides permission to the principals. This overwrites the existing permissions, and is not additive.
*/
putPermission(callback?: (err: AWSError, data: CodeGuruProfiler.Types.PutPermissionResponse) => void): Request<CodeGuruProfiler.Types.PutPermissionResponse, AWSError>;
/**
* Removes statement for the provided action group from the policy.
*/
removePermission(params: CodeGuruProfiler.Types.RemovePermissionRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.RemovePermissionResponse) => void): Request<CodeGuruProfiler.Types.RemovePermissionResponse, AWSError>;
/**
* Removes statement for the provided action group from the policy.
*/
removePermission(callback?: (err: AWSError, data: CodeGuruProfiler.Types.RemovePermissionResponse) => void): Request<CodeGuruProfiler.Types.RemovePermissionResponse, AWSError>;
/**
* Updates a profiling group.
*/
updateProfilingGroup(params: CodeGuruProfiler.Types.UpdateProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.UpdateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.UpdateProfilingGroupResponse, AWSError>;
/**
* Updates a profiling group.
*/
updateProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.UpdateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.UpdateProfilingGroupResponse, AWSError>;
}
declare namespace CodeGuruProfiler {
export type ActionGroup = "agentPermissions"|string;
export interface AgentConfiguration {
/**
*
*/
periodInSeconds: Integer;
/**
*
*/
shouldProfile: Boolean;
}
export interface AgentOrchestrationConfig {
/**
*
*/
profilingEnabled: Boolean;
}
export type AgentProfile = Buffer|Uint8Array|Blob|string;
export type AggregatedProfile = Buffer|Uint8Array|Blob|string;
export interface AggregatedProfileTime {
/**
* The time period.
*/
period?: AggregationPeriod;
/**
* The start time.
*/
start?: Timestamp;
}
export type AggregationPeriod = "P1D"|"PT1H"|"PT5M"|string;
export type Boolean = boolean;
export type ClientToken = string;
export interface ConfigureAgentRequest {
/**
*
*/
fleetInstanceId?: FleetInstanceId;
/**
*
*/
profilingGroupName: ProfilingGroupName;
}
export interface ConfigureAgentResponse {
/**
*
*/
configuration: AgentConfiguration;
}
export interface CreateProfilingGroupRequest {
/**
* The agent orchestration configuration.
*/
agentOrchestrationConfig?: AgentOrchestrationConfig;
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This parameter specifies a unique identifier for the new profiling group that helps ensure idempotency.
*/
clientToken: ClientToken;
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
}
export interface CreateProfilingGroupResponse {
/**
* Information about the new profiling group
*/
profilingGroup: ProfilingGroupDescription;
}
export interface DeleteProfilingGroupRequest {
/**
* The profiling group name to delete.
*/
profilingGroupName: ProfilingGroupName;
}
export interface DeleteProfilingGroupResponse {
}
export interface DescribeProfilingGroupRequest {
/**
* The profiling group name.
*/
profilingGroupName: ProfilingGroupName;
}
export interface DescribeProfilingGroupResponse {
/**
* Information about a profiling group.
*/
profilingGroup: ProfilingGroupDescription;
}
export type FleetInstanceId = string;
export interface GetPolicyRequest {
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
}
export interface GetPolicyResponse {
/**
* The resource-based policy attached to the ProfilingGroup.
*/
policy: String;
/**
* A unique identifier for the current revision of the policy.
*/
revisionId: RevisionId;
}
export interface GetProfileRequest {
/**
* The format of the profile to return. You can choose application/json or the default application/x-amzn-ion.
*/
accept?: String;
/**
* You must specify exactly two of the following parameters: startTime, period, and endTime.
*/
endTime?: Timestamp;
/**
* The maximum depth of the graph.
*/
maxDepth?: MaxDepth;
/**
* The period of the profile to get. The time range must be in the past and not longer than one week. You must specify exactly two of the following parameters: startTime, period, and endTime.
*/
period?: Period;
/**
* The name of the profiling group to get.
*/
profilingGroupName: ProfilingGroupName;
/**
* The start time of the profile to get. You must specify exactly two of the following parameters: startTime, period, and endTime.
*/
startTime?: Timestamp;
}
export interface GetProfileResponse {
/**
* The content encoding of the profile.
*/
contentEncoding?: String;
/**
* The content type of the profile in the payload. It is either application/json or the default application/x-amzn-ion.
*/
contentType: String;
/**
* Information about the profile.
*/
profile: AggregatedProfile;
}
export type Integer = number;
export interface ListProfileTimesRequest {
/**
* The end time of the time range from which to list the profiles.
*/
endTime: Timestamp;
/**
* The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.
*/
maxResults?: MaxResults;
/**
* The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.
*/
orderBy?: OrderBy;
/**
* The aggregation period.
*/
period: AggregationPeriod;
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
/**
* The start time of the time range from which to list the profiles.
*/
startTime: Timestamp;
}
export interface ListProfileTimesResponse {
/**
* The nextToken value to include in a future ListProfileTimes request. When the results of a ListProfileTimes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
/**
* The list of start times of the available profiles for the aggregation period in the specified time range.
*/
profileTimes: ProfileTimes;
}
export interface ListProfilingGroupsRequest {
/**
* A Boolean value indicating whether to include a description.
*/
includeDescription?: Boolean;
/**
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.
*/
maxResults?: MaxResults;
/**
* The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
}
export interface ListProfilingGroupsResponse {
/**
* The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
/**
* Information about profiling group names.
*/
profilingGroupNames: ProfilingGroupNames;
/**
* Information about profiling groups.
*/
profilingGroups?: ProfilingGroupDescriptions;
}
export type MaxDepth = number;
export type MaxResults = number;
export type OrderBy = "TimestampAscending"|"TimestampDescending"|string;
export type PaginationToken = string;
export type Period = string;
export interface PostAgentProfileRequest {
/**
*
*/
agentProfile: AgentProfile;
/**
*
*/
contentType: String;
/**
*
*/
profileToken?: ClientToken;
/**
*
*/
profilingGroupName: ProfilingGroupName;
}
export interface PostAgentProfileResponse {
}
export type Principal = string;
export type Principals = Principal[];
export interface ProfileTime {
/**
* The start time of the profile.
*/
start?: Timestamp;
}
export type ProfileTimes = ProfileTime[];
export type ProfilingGroupArn = string;
export interface ProfilingGroupDescription {
/**
*
*/
agentOrchestrationConfig?: AgentOrchestrationConfig;
/**
* The Amazon Resource Name (ARN) identifying the profiling group.
*/
arn?: ProfilingGroupArn;
/**
* The time, in milliseconds since the epoch, when the profiling group was created.
*/
createdAt?: Timestamp;
/**
* The name of the profiling group.
*/
name?: ProfilingGroupName;
/**
* The status of the profiling group.
*/
profilingStatus?: ProfilingStatus;
/**
* The time, in milliseconds since the epoch, when the profiling group was last updated.
*/
updatedAt?: Timestamp;
}
export type ProfilingGroupDescriptions = ProfilingGroupDescription[];
export type ProfilingGroupName = string;
export type ProfilingGroupNames = ProfilingGroupName[];
export interface ProfilingStatus {
/**
* The time, in milliseconds since the epoch, when the latest agent was orchestrated.
*/
latestAgentOrchestratedAt?: Timestamp;
/**
* The time, in milliseconds since the epoch, when the latest agent was reported..
*/
latestAgentProfileReportedAt?: Timestamp;
/**
* The latest aggregated profile
*/
latestAggregatedProfile?: AggregatedProfileTime;
}
export interface PutPermissionRequest {
/**
* The list of actions that the users and roles can perform on the profiling group.
*/
actionGroup: ActionGroup;
/**
* The list of role and user ARNs or the accountId that needs access (wildcards are not allowed).
*/
principals: Principals;
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
/**
* A unique identifier for the current revision of the policy. This is required, if a policy exists for the profiling group. This is not required when creating the policy for the first time.
*/
revisionId?: RevisionId;
}
export interface PutPermissionResponse {
/**
* The resource-based policy.
*/
policy: String;
/**
* A unique identifier for the current revision of the policy.
*/
revisionId: RevisionId;
}
export interface RemovePermissionRequest {
/**
* The list of actions that the users and roles can perform on the profiling group.
*/
actionGroup: ActionGroup;
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
/**
* A unique identifier for the current revision of the policy.
*/
revisionId: RevisionId;
}
export interface RemovePermissionResponse {
/**
* The resource-based policy.
*/
policy: String;
/**
* A unique identifier for the current revision of the policy.
*/
revisionId: RevisionId;
}
export type RevisionId = string;
export type String = string;
export type Timestamp = Date;
export interface UpdateProfilingGroupRequest {
/**
*
*/
agentOrchestrationConfig: AgentOrchestrationConfig;
/**
* The name of the profiling group to update.
*/
profilingGroupName: ProfilingGroupName;
}
export interface UpdateProfilingGroupResponse {
/**
* Updated information about the profiling group.
*/
profilingGroup: ProfilingGroupDescription;
}
/**
* 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 = "2019-07-18"|"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 CodeGuruProfiler client.
*/
export import Types = CodeGuruProfiler;
}
export = CodeGuruProfiler;