synthetics.d.ts
35.6 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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
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 Synthetics extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Synthetics.Types.ClientConfiguration)
config: Config & Synthetics.Types.ClientConfiguration;
/**
* Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once. Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
*/
createCanary(params: Synthetics.Types.CreateCanaryRequest, callback?: (err: AWSError, data: Synthetics.Types.CreateCanaryResponse) => void): Request<Synthetics.Types.CreateCanaryResponse, AWSError>;
/**
* Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once. Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
*/
createCanary(callback?: (err: AWSError, data: Synthetics.Types.CreateCanaryResponse) => void): Request<Synthetics.Types.CreateCanaryResponse, AWSError>;
/**
* Permanently deletes the specified canary. When you delete a canary, resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following: The Lambda functions and layers used by this canary. These have the prefix cwsyn-MyCanaryName . The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName . Amazon S3 objects and buckets, such as the canary's artifact location. IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName . CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName . Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.
*/
deleteCanary(params: Synthetics.Types.DeleteCanaryRequest, callback?: (err: AWSError, data: Synthetics.Types.DeleteCanaryResponse) => void): Request<Synthetics.Types.DeleteCanaryResponse, AWSError>;
/**
* Permanently deletes the specified canary. When you delete a canary, resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following: The Lambda functions and layers used by this canary. These have the prefix cwsyn-MyCanaryName . The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName . Amazon S3 objects and buckets, such as the canary's artifact location. IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName . CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName . Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.
*/
deleteCanary(callback?: (err: AWSError, data: Synthetics.Types.DeleteCanaryResponse) => void): Request<Synthetics.Types.DeleteCanaryResponse, AWSError>;
/**
* This operation returns a list of the canaries in your account, along with full details about each canary. This operation does not have resource-level authorization, so if a user is able to use DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be used to restrict access to all canaries. It cannot be used on specific resources.
*/
describeCanaries(params: Synthetics.Types.DescribeCanariesRequest, callback?: (err: AWSError, data: Synthetics.Types.DescribeCanariesResponse) => void): Request<Synthetics.Types.DescribeCanariesResponse, AWSError>;
/**
* This operation returns a list of the canaries in your account, along with full details about each canary. This operation does not have resource-level authorization, so if a user is able to use DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be used to restrict access to all canaries. It cannot be used on specific resources.
*/
describeCanaries(callback?: (err: AWSError, data: Synthetics.Types.DescribeCanariesResponse) => void): Request<Synthetics.Types.DescribeCanariesResponse, AWSError>;
/**
* Use this operation to see information from the most recent run of each canary that you have created.
*/
describeCanariesLastRun(params: Synthetics.Types.DescribeCanariesLastRunRequest, callback?: (err: AWSError, data: Synthetics.Types.DescribeCanariesLastRunResponse) => void): Request<Synthetics.Types.DescribeCanariesLastRunResponse, AWSError>;
/**
* Use this operation to see information from the most recent run of each canary that you have created.
*/
describeCanariesLastRun(callback?: (err: AWSError, data: Synthetics.Types.DescribeCanariesLastRunResponse) => void): Request<Synthetics.Types.DescribeCanariesLastRunResponse, AWSError>;
/**
* Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
*/
describeRuntimeVersions(params: Synthetics.Types.DescribeRuntimeVersionsRequest, callback?: (err: AWSError, data: Synthetics.Types.DescribeRuntimeVersionsResponse) => void): Request<Synthetics.Types.DescribeRuntimeVersionsResponse, AWSError>;
/**
* Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
*/
describeRuntimeVersions(callback?: (err: AWSError, data: Synthetics.Types.DescribeRuntimeVersionsResponse) => void): Request<Synthetics.Types.DescribeRuntimeVersionsResponse, AWSError>;
/**
* Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.
*/
getCanary(params: Synthetics.Types.GetCanaryRequest, callback?: (err: AWSError, data: Synthetics.Types.GetCanaryResponse) => void): Request<Synthetics.Types.GetCanaryResponse, AWSError>;
/**
* Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.
*/
getCanary(callback?: (err: AWSError, data: Synthetics.Types.GetCanaryResponse) => void): Request<Synthetics.Types.GetCanaryResponse, AWSError>;
/**
* Retrieves a list of runs for a specified canary.
*/
getCanaryRuns(params: Synthetics.Types.GetCanaryRunsRequest, callback?: (err: AWSError, data: Synthetics.Types.GetCanaryRunsResponse) => void): Request<Synthetics.Types.GetCanaryRunsResponse, AWSError>;
/**
* Retrieves a list of runs for a specified canary.
*/
getCanaryRuns(callback?: (err: AWSError, data: Synthetics.Types.GetCanaryRunsResponse) => void): Request<Synthetics.Types.GetCanaryRunsResponse, AWSError>;
/**
* Displays the tags associated with a canary.
*/
listTagsForResource(params: Synthetics.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Synthetics.Types.ListTagsForResourceResponse) => void): Request<Synthetics.Types.ListTagsForResourceResponse, AWSError>;
/**
* Displays the tags associated with a canary.
*/
listTagsForResource(callback?: (err: AWSError, data: Synthetics.Types.ListTagsForResourceResponse) => void): Request<Synthetics.Types.ListTagsForResourceResponse, AWSError>;
/**
* Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.
*/
startCanary(params: Synthetics.Types.StartCanaryRequest, callback?: (err: AWSError, data: Synthetics.Types.StartCanaryResponse) => void): Request<Synthetics.Types.StartCanaryResponse, AWSError>;
/**
* Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.
*/
startCanary(callback?: (err: AWSError, data: Synthetics.Types.StartCanaryResponse) => void): Request<Synthetics.Types.StartCanaryResponse, AWSError>;
/**
* Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. The run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run. You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.
*/
stopCanary(params: Synthetics.Types.StopCanaryRequest, callback?: (err: AWSError, data: Synthetics.Types.StopCanaryResponse) => void): Request<Synthetics.Types.StopCanaryResponse, AWSError>;
/**
* Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. The run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run. You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.
*/
stopCanary(callback?: (err: AWSError, data: Synthetics.Types.StopCanaryResponse) => void): Request<Synthetics.Types.StopCanaryResponse, AWSError>;
/**
* Assigns one or more tags (key-value pairs) to the specified canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary.
*/
tagResource(params: Synthetics.Types.TagResourceRequest, callback?: (err: AWSError, data: Synthetics.Types.TagResourceResponse) => void): Request<Synthetics.Types.TagResourceResponse, AWSError>;
/**
* Assigns one or more tags (key-value pairs) to the specified canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary.
*/
tagResource(callback?: (err: AWSError, data: Synthetics.Types.TagResourceResponse) => void): Request<Synthetics.Types.TagResourceResponse, AWSError>;
/**
* Removes one or more tags from the specified canary.
*/
untagResource(params: Synthetics.Types.UntagResourceRequest, callback?: (err: AWSError, data: Synthetics.Types.UntagResourceResponse) => void): Request<Synthetics.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from the specified canary.
*/
untagResource(callback?: (err: AWSError, data: Synthetics.Types.UntagResourceResponse) => void): Request<Synthetics.Types.UntagResourceResponse, AWSError>;
/**
* Use this operation to change the settings of a canary that has already been created. You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
*/
updateCanary(params: Synthetics.Types.UpdateCanaryRequest, callback?: (err: AWSError, data: Synthetics.Types.UpdateCanaryResponse) => void): Request<Synthetics.Types.UpdateCanaryResponse, AWSError>;
/**
* Use this operation to change the settings of a canary that has already been created. You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
*/
updateCanary(callback?: (err: AWSError, data: Synthetics.Types.UpdateCanaryResponse) => void): Request<Synthetics.Types.UpdateCanaryResponse, AWSError>;
}
declare namespace Synthetics {
export type Arn = string;
export type _Blob = Buffer|Uint8Array|Blob|string;
export type Canaries = Canary[];
export type CanariesLastRun = CanaryLastRun[];
export interface Canary {
/**
* The unique ID of this canary.
*/
Id?: UUID;
/**
* The name of the canary.
*/
Name?: CanaryName;
Code?: CanaryCodeOutput;
/**
* The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.
*/
ExecutionRoleArn?: Arn;
/**
* A structure that contains information about how often the canary is to run, and when these runs are to stop.
*/
Schedule?: CanaryScheduleOutput;
RunConfig?: CanaryRunConfigOutput;
/**
* The number of days to retain data about successful runs of this canary.
*/
SuccessRetentionPeriodInDays?: MaxSize1024;
/**
* The number of days to retain data about failed runs of this canary.
*/
FailureRetentionPeriodInDays?: MaxSize1024;
/**
* A structure that contains information about the canary's status.
*/
Status?: CanaryStatus;
/**
* A structure that contains information about when the canary was created, modified, and most recently run.
*/
Timeline?: CanaryTimeline;
/**
* The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
*/
ArtifactS3Location?: String;
/**
* The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
*/
EngineArn?: Arn;
/**
* Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
*/
RuntimeVersion?: String;
VpcConfig?: VpcConfigOutput;
/**
* The list of key-value pairs that are associated with the canary.
*/
Tags?: TagMap;
}
export interface CanaryCodeInput {
/**
* If your canary script is located in S3, specify the full bucket name here. The bucket must already exist. Specify the full bucket name, including s3:// as the start of the bucket name.
*/
S3Bucket?: String;
/**
* The S3 key of your script. For more information, see Working with Amazon S3 Objects.
*/
S3Key?: String;
/**
* The S3 version ID of your script.
*/
S3Version?: String;
/**
* If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the .zip file that contains the script. It can be up to 5 MB.
*/
ZipFile?: _Blob;
/**
* The entry point to use for the source code when running the canary. This value must end with the string .handler.
*/
Handler: String;
}
export interface CanaryCodeOutput {
/**
* The ARN of the Lambda layer where Synthetics stores the canary script code.
*/
SourceLocationArn?: String;
/**
* The entry point to use for the source code when running the canary.
*/
Handler?: String;
}
export interface CanaryLastRun {
/**
* The name of the canary.
*/
CanaryName?: CanaryName;
/**
* The results from this canary's most recent run.
*/
LastRun?: CanaryRun;
}
export type CanaryName = string;
export interface CanaryRun {
/**
* The name of the canary.
*/
Name?: CanaryName;
/**
* The status of this run.
*/
Status?: CanaryRunStatus;
/**
* A structure that contains the start and end times of this run.
*/
Timeline?: CanaryRunTimeline;
/**
* The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.
*/
ArtifactS3Location?: String;
}
export interface CanaryRunConfigInput {
/**
* How long the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
*/
TimeoutInSeconds: MaxFifteenMinutesInSeconds;
}
export interface CanaryRunConfigOutput {
/**
* How long the canary is allowed to run before it must stop.
*/
TimeoutInSeconds?: MaxFifteenMinutesInSeconds;
}
export type CanaryRunState = "RUNNING"|"PASSED"|"FAILED"|string;
export type CanaryRunStateReasonCode = "CANARY_FAILURE"|"EXECUTION_FAILURE"|string;
export interface CanaryRunStatus {
/**
* The current state of the run.
*/
State?: CanaryRunState;
/**
* If run of the canary failed, this field contains the reason for the error.
*/
StateReason?: String;
/**
* If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.
*/
StateReasonCode?: CanaryRunStateReasonCode;
}
export interface CanaryRunTimeline {
/**
* The start time of the run.
*/
Started?: Timestamp;
/**
* The end time of the run.
*/
Completed?: Timestamp;
}
export type CanaryRuns = CanaryRun[];
export interface CanaryScheduleInput {
/**
* A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
*/
Expression: String;
/**
* How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
*/
DurationInSeconds?: MaxOneYearInSeconds;
}
export interface CanaryScheduleOutput {
/**
* A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
*/
Expression?: String;
/**
* How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
*/
DurationInSeconds?: MaxOneYearInSeconds;
}
export type CanaryState = "CREATING"|"READY"|"STARTING"|"RUNNING"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR"|"DELETING"|string;
export type CanaryStateReasonCode = "INVALID_PERMISSIONS"|string;
export interface CanaryStatus {
/**
* The current state of the canary.
*/
State?: CanaryState;
/**
* If the canary has insufficient permissions to run, this field provides more details.
*/
StateReason?: String;
/**
* If the canary cannot run or has failed, this field displays the reason.
*/
StateReasonCode?: CanaryStateReasonCode;
}
export interface CanaryTimeline {
/**
* The date and time the canary was created.
*/
Created?: Timestamp;
/**
* The date and time the canary was most recently modified.
*/
LastModified?: Timestamp;
/**
* The date and time that the canary's most recent run started.
*/
LastStarted?: Timestamp;
/**
* The date and time that the canary's most recent run ended.
*/
LastStopped?: Timestamp;
}
export interface CreateCanaryRequest {
/**
* The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
*/
Name: CanaryName;
/**
* A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
*/
Code: CanaryCodeInput;
/**
* The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files.
*/
ArtifactS3Location: String;
/**
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions: s3:PutObject s3:GetBucketLocation s3:ListAllMyBuckets cloudwatch:PutMetricData logs:CreateLogGroup logs:CreateLogStream logs:CreateLogStream
*/
ExecutionRoleArn: Arn;
/**
* A structure that contains information about how often the canary is to run and when these test runs are to stop.
*/
Schedule: CanaryScheduleInput;
/**
* A structure that contains the configuration for individual canary runs, such as timeout value.
*/
RunConfig?: CanaryRunConfigInput;
/**
* The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
*/
SuccessRetentionPeriodInDays?: MaxSize1024;
/**
* The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
*/
FailureRetentionPeriodInDays?: MaxSize1024;
/**
* Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
*/
RuntimeVersion: String;
/**
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
*/
VpcConfig?: VpcConfigInput;
/**
* A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
*/
Tags?: TagMap;
}
export interface CreateCanaryResponse {
/**
* The full details about the canary you have created.
*/
Canary?: Canary;
}
export interface DeleteCanaryRequest {
/**
* The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.
*/
Name: CanaryName;
}
export interface DeleteCanaryResponse {
}
export interface DescribeCanariesLastRunRequest {
/**
* A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
*/
NextToken?: Token;
/**
* Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.
*/
MaxResults?: MaxSize100;
}
export interface DescribeCanariesLastRunResponse {
/**
* An array that contains the information from the most recent run of each canary.
*/
CanariesLastRun?: CanariesLastRun;
/**
* A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.
*/
NextToken?: Token;
}
export interface DescribeCanariesRequest {
/**
* A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
*/
NextToken?: Token;
/**
* Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.
*/
MaxResults?: MaxCanaryResults;
}
export interface DescribeCanariesResponse {
/**
* Returns an array. Each item in the array contains the full information about one canary.
*/
Canaries?: Canaries;
/**
* A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
*/
NextToken?: Token;
}
export interface DescribeRuntimeVersionsRequest {
/**
* A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
*/
NextToken?: Token;
/**
* Specify this parameter to limit how many runs are returned each time you use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used.
*/
MaxResults?: MaxSize100;
}
export interface DescribeRuntimeVersionsResponse {
/**
* An array of objects that display the details about each Synthetics canary runtime version.
*/
RuntimeVersions?: RuntimeVersionList;
/**
* A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
*/
NextToken?: Token;
}
export interface GetCanaryRequest {
/**
* The name of the canary that you want details for.
*/
Name: CanaryName;
}
export interface GetCanaryResponse {
/**
* A strucure that contains the full information about the canary.
*/
Canary?: Canary;
}
export interface GetCanaryRunsRequest {
/**
* The name of the canary that you want to see runs for.
*/
Name: CanaryName;
/**
* A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
*/
NextToken?: Token;
/**
* Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
*/
MaxResults?: MaxSize100;
}
export interface GetCanaryRunsResponse {
/**
* An array of structures. Each structure contains the details of one of the retrieved canary runs.
*/
CanaryRuns?: CanaryRuns;
/**
* A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
*/
NextToken?: Token;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the canary that you want to view tags for. The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
*/
ResourceArn: Arn;
}
export interface ListTagsForResourceResponse {
/**
* The list of tag keys and values associated with the canary that you specified.
*/
Tags?: TagMap;
}
export type MaxCanaryResults = number;
export type MaxFifteenMinutesInSeconds = number;
export type MaxOneYearInSeconds = number;
export type MaxSize100 = number;
export type MaxSize1024 = number;
export interface RuntimeVersion {
/**
* The name of the runtime version. Currently, the only valid value is syn-1.0. Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0.
*/
VersionName?: String;
/**
* A description of the runtime version, created by Amazon.
*/
Description?: String;
/**
* The date that the runtime version was released.
*/
ReleaseDate?: Timestamp;
/**
* If this runtime version is deprecated, this value is the date of deprecation.
*/
DeprecationDate?: Timestamp;
}
export type RuntimeVersionList = RuntimeVersion[];
export type SecurityGroupId = string;
export type SecurityGroupIds = SecurityGroupId[];
export interface StartCanaryRequest {
/**
* The name of the canary that you want to run. To find canary names, use DescribeCanaries.
*/
Name: CanaryName;
}
export interface StartCanaryResponse {
}
export interface StopCanaryRequest {
/**
* The name of the canary that you want to stop. To find the names of your canaries, use DescribeCanaries.
*/
Name: CanaryName;
}
export interface StopCanaryResponse {
}
export type String = string;
export type SubnetId = string;
export type SubnetIds = SubnetId[];
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The ARN of the canary that you're adding tags to. The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
*/
ResourceArn: Arn;
/**
* The list of key-value pairs to associate with the canary.
*/
Tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Timestamp = Date;
export type Token = string;
export type UUID = string;
export interface UntagResourceRequest {
/**
* The ARN of the canary that you're removing tags from. The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
*/
ResourceArn: Arn;
/**
* The list of tag keys to remove from the resource.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateCanaryRequest {
/**
* The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries. You cannot change the name of a canary that has already been created.
*/
Name: CanaryName;
/**
* A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
*/
Code?: CanaryCodeInput;
/**
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions: s3:PutObject s3:GetBucketLocation s3:ListAllMyBuckets cloudwatch:PutMetricData logs:CreateLogGroup logs:CreateLogStream logs:CreateLogStream
*/
ExecutionRoleArn?: Arn;
/**
* Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
*/
RuntimeVersion?: String;
/**
* A structure that contains information about how often the canary is to run, and when these runs are to stop.
*/
Schedule?: CanaryScheduleInput;
/**
* A structure that contains the timeout value that is used for each individual run of the canary.
*/
RunConfig?: CanaryRunConfigInput;
/**
* The number of days to retain data about successful runs of this canary.
*/
SuccessRetentionPeriodInDays?: MaxSize1024;
/**
* The number of days to retain data about failed runs of this canary.
*/
FailureRetentionPeriodInDays?: MaxSize1024;
/**
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
*/
VpcConfig?: VpcConfigInput;
}
export interface UpdateCanaryResponse {
}
export interface VpcConfigInput {
/**
* The IDs of the subnets where this canary is to run.
*/
SubnetIds?: SubnetIds;
/**
* The IDs of the security groups for this canary.
*/
SecurityGroupIds?: SecurityGroupIds;
}
export interface VpcConfigOutput {
/**
* The IDs of the VPC where this canary is to run.
*/
VpcId?: VpcId;
/**
* The IDs of the subnets where this canary is to run.
*/
SubnetIds?: SubnetIds;
/**
* The IDs of the security groups for this canary.
*/
SecurityGroupIds?: SecurityGroupIds;
}
export type VpcId = string;
/**
* 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-10-11"|"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 Synthetics client.
*/
export import Types = Synthetics;
}
export = Synthetics;