aws-sdk-synthetics 1.25.0 → 1.28.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.
@@ -62,6 +62,50 @@ module Aws::Synthetics
62
62
  include Aws::Structure
63
63
  end
64
64
 
65
+ # @note When making an API call, you may pass AssociateResourceRequest
66
+ # data as a hash:
67
+ #
68
+ # {
69
+ # group_identifier: "GroupIdentifier", # required
70
+ # resource_arn: "CanaryArn", # required
71
+ # }
72
+ #
73
+ # @!attribute [rw] group_identifier
74
+ # Specifies the group. You can specify the group name, the ARN, or the
75
+ # group ID as the `GroupIdentifier`.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] resource_arn
79
+ # The ARN of the canary that you want to associate with the specified
80
+ # group.
81
+ # @return [String]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResourceRequest AWS API Documentation
84
+ #
85
+ class AssociateResourceRequest < Struct.new(
86
+ :group_identifier,
87
+ :resource_arn)
88
+ SENSITIVE = []
89
+ include Aws::Structure
90
+ end
91
+
92
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResourceResponse AWS API Documentation
93
+ #
94
+ class AssociateResourceResponse < Aws::EmptyStructure; end
95
+
96
+ # The request was not valid.
97
+ #
98
+ # @!attribute [rw] message
99
+ # @return [String]
100
+ #
101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/BadRequestException AWS API Documentation
102
+ #
103
+ class BadRequestException < Struct.new(
104
+ :message)
105
+ SENSITIVE = []
106
+ include Aws::Structure
107
+ end
108
+
65
109
  # A structure representing a screenshot that is used as a baseline
66
110
  # during visual monitoring comparisons made by the canary.
67
111
  #
@@ -82,8 +126,12 @@ module Aws::Synthetics
82
126
  # @!attribute [rw] ignore_coordinates
83
127
  # Coordinates that define the part of a screen to ignore during
84
128
  # screenshot comparisons. To obtain the coordinates to use here, use
85
- # the CloudWatch Logs console to draw the boundaries on the screen.
86
- # For more information, see \\\{LINK\\}
129
+ # the CloudWatch console to draw the boundaries on the screen. For
130
+ # more information, see [ Editing or deleting a canary][1]
131
+ #
132
+ #
133
+ #
134
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html
87
135
  # @return [Array<String>]
88
136
  #
89
137
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/BaseScreenshot AWS API Documentation
@@ -236,7 +284,7 @@ module Aws::Synthetics
236
284
  # s3_key: "String",
237
285
  # s3_version: "String",
238
286
  # zip_file: "data",
239
- # handler: "String", # required
287
+ # handler: "CodeHandler", # required
240
288
  # }
241
289
  #
242
290
  # @!attribute [rw] s3_bucket
@@ -269,8 +317,13 @@ module Aws::Synthetics
269
317
  #
270
318
  # @!attribute [rw] handler
271
319
  # The entry point to use for the source code when running the canary.
272
- # This value must end with the string `.handler`. The string is
273
- # limited to 29 characters or fewer.
320
+ # For canaries that use the `syn-python-selenium-1.0` runtime or a
321
+ # `syn-nodejs.puppeteer` runtime earlier than
322
+ # `syn-nodejs.puppeteer-3.4`, the handler must be specified as `
323
+ # fileName.handler`. For `syn-python-selenium-1.1`,
324
+ # `syn-nodejs.puppeteer-3.4`, and later runtimes, the handler can be
325
+ # specified as ` fileName.functionName `, or you can specify a folder
326
+ # where canary scripts reside as ` folder/fileName.functionName `.
274
327
  # @return [String]
275
328
  #
276
329
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryCodeInput AWS API Documentation
@@ -417,6 +470,9 @@ module Aws::Synthetics
417
470
  # for your environment variables. For more information about reserved
418
471
  # keys, see [ Runtime environment variables][1].
419
472
  #
473
+ # The environment variables keys and values are not encrypted. Do not
474
+ # store sensitive information in this field.
475
+ #
420
476
  #
421
477
  #
422
478
  # [1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
@@ -678,7 +734,7 @@ module Aws::Synthetics
678
734
  # s3_key: "String",
679
735
  # s3_version: "String",
680
736
  # zip_file: "data",
681
- # handler: "String", # required
737
+ # handler: "CodeHandler", # required
682
738
  # },
683
739
  # artifact_s3_location: "String", # required
684
740
  # execution_role_arn: "RoleArn", # required
@@ -768,7 +824,10 @@ module Aws::Synthetics
768
824
  #
769
825
  # @!attribute [rw] run_config
770
826
  # A structure that contains the configuration for individual canary
771
- # runs, such as timeout value.
827
+ # runs, such as timeout value and environment variables.
828
+ #
829
+ # The environment variables keys and values are not encrypted. Do not
830
+ # store sensitive information in this field.
772
831
  # @return [Types::CanaryRunConfigInput]
773
832
  #
774
833
  # @!attribute [rw] success_retention_period_in_days
@@ -850,11 +909,61 @@ module Aws::Synthetics
850
909
  include Aws::Structure
851
910
  end
852
911
 
912
+ # @note When making an API call, you may pass CreateGroupRequest
913
+ # data as a hash:
914
+ #
915
+ # {
916
+ # name: "GroupName", # required
917
+ # tags: {
918
+ # "TagKey" => "TagValue",
919
+ # },
920
+ # }
921
+ #
922
+ # @!attribute [rw] name
923
+ # The name for the group. It can include any Unicode characters.
924
+ #
925
+ # The names for all groups in your account, across all Regions, must
926
+ # be unique.
927
+ # @return [String]
928
+ #
929
+ # @!attribute [rw] tags
930
+ # A list of key-value pairs to associate with the group. You can
931
+ # associate as many as 50 tags with a group.
932
+ #
933
+ # Tags can help you organize and categorize your resources. You can
934
+ # also use them to scope user permissions, by granting a user
935
+ # permission to access or change only the resources that have certain
936
+ # tag values.
937
+ # @return [Hash<String,String>]
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroupRequest AWS API Documentation
940
+ #
941
+ class CreateGroupRequest < Struct.new(
942
+ :name,
943
+ :tags)
944
+ SENSITIVE = []
945
+ include Aws::Structure
946
+ end
947
+
948
+ # @!attribute [rw] group
949
+ # A structure that contains information about the group that was just
950
+ # created.
951
+ # @return [Types::Group]
952
+ #
953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroupResponse AWS API Documentation
954
+ #
955
+ class CreateGroupResponse < Struct.new(
956
+ :group)
957
+ SENSITIVE = []
958
+ include Aws::Structure
959
+ end
960
+
853
961
  # @note When making an API call, you may pass DeleteCanaryRequest
854
962
  # data as a hash:
855
963
  #
856
964
  # {
857
965
  # name: "CanaryName", # required
966
+ # delete_lambda: false,
858
967
  # }
859
968
  #
860
969
  # @!attribute [rw] name
@@ -866,10 +975,18 @@ module Aws::Synthetics
866
975
  # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
867
976
  # @return [String]
868
977
  #
978
+ # @!attribute [rw] delete_lambda
979
+ # Specifies whether to also delete the Lambda functions and layers
980
+ # used by this canary. The default is false.
981
+ #
982
+ # Type: Boolean
983
+ # @return [Boolean]
984
+ #
869
985
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteCanaryRequest AWS API Documentation
870
986
  #
871
987
  class DeleteCanaryRequest < Struct.new(
872
- :name)
988
+ :name,
989
+ :delete_lambda)
873
990
  SENSITIVE = []
874
991
  include Aws::Structure
875
992
  end
@@ -878,6 +995,30 @@ module Aws::Synthetics
878
995
  #
879
996
  class DeleteCanaryResponse < Aws::EmptyStructure; end
880
997
 
998
+ # @note When making an API call, you may pass DeleteGroupRequest
999
+ # data as a hash:
1000
+ #
1001
+ # {
1002
+ # group_identifier: "GroupIdentifier", # required
1003
+ # }
1004
+ #
1005
+ # @!attribute [rw] group_identifier
1006
+ # Specifies which group to delete. You can specify the group name, the
1007
+ # ARN, or the group ID as the `GroupIdentifier`.
1008
+ # @return [String]
1009
+ #
1010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroupRequest AWS API Documentation
1011
+ #
1012
+ class DeleteGroupRequest < Struct.new(
1013
+ :group_identifier)
1014
+ SENSITIVE = []
1015
+ include Aws::Structure
1016
+ end
1017
+
1018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroupResponse AWS API Documentation
1019
+ #
1020
+ class DeleteGroupResponse < Aws::EmptyStructure; end
1021
+
881
1022
  # @note When making an API call, you may pass DescribeCanariesLastRunRequest
882
1023
  # data as a hash:
883
1024
  #
@@ -889,8 +1030,8 @@ module Aws::Synthetics
889
1030
  #
890
1031
  # @!attribute [rw] next_token
891
1032
  # A token that indicates that there is more data available. You can
892
- # use this token in a subsequent `DescribeCanaries` operation to
893
- # retrieve the next set of results.
1033
+ # use this token in a subsequent `DescribeCanariesLastRun` operation
1034
+ # to retrieve the next set of results.
894
1035
  # @return [String]
895
1036
  #
896
1037
  # @!attribute [rw] max_results
@@ -1067,6 +1208,37 @@ module Aws::Synthetics
1067
1208
  include Aws::Structure
1068
1209
  end
1069
1210
 
1211
+ # @note When making an API call, you may pass DisassociateResourceRequest
1212
+ # data as a hash:
1213
+ #
1214
+ # {
1215
+ # group_identifier: "GroupIdentifier", # required
1216
+ # resource_arn: "CanaryArn", # required
1217
+ # }
1218
+ #
1219
+ # @!attribute [rw] group_identifier
1220
+ # Specifies the group. You can specify the group name, the ARN, or the
1221
+ # group ID as the `GroupIdentifier`.
1222
+ # @return [String]
1223
+ #
1224
+ # @!attribute [rw] resource_arn
1225
+ # The ARN of the canary that you want to remove from the specified
1226
+ # group.
1227
+ # @return [String]
1228
+ #
1229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResourceRequest AWS API Documentation
1230
+ #
1231
+ class DisassociateResourceRequest < Struct.new(
1232
+ :group_identifier,
1233
+ :resource_arn)
1234
+ SENSITIVE = []
1235
+ include Aws::Structure
1236
+ end
1237
+
1238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResourceResponse AWS API Documentation
1239
+ #
1240
+ class DisassociateResourceResponse < Aws::EmptyStructure; end
1241
+
1070
1242
  # @note When making an API call, you may pass GetCanaryRequest
1071
1243
  # data as a hash:
1072
1244
  #
@@ -1087,7 +1259,7 @@ module Aws::Synthetics
1087
1259
  end
1088
1260
 
1089
1261
  # @!attribute [rw] canary
1090
- # A strucure that contains the full information about the canary.
1262
+ # A structure that contains the full information about the canary.
1091
1263
  # @return [Types::Canary]
1092
1264
  #
1093
1265
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryResponse AWS API Documentation
@@ -1153,6 +1325,114 @@ module Aws::Synthetics
1153
1325
  include Aws::Structure
1154
1326
  end
1155
1327
 
1328
+ # @note When making an API call, you may pass GetGroupRequest
1329
+ # data as a hash:
1330
+ #
1331
+ # {
1332
+ # group_identifier: "GroupIdentifier", # required
1333
+ # }
1334
+ #
1335
+ # @!attribute [rw] group_identifier
1336
+ # Specifies the group to return information for. You can specify the
1337
+ # group name, the ARN, or the group ID as the `GroupIdentifier`.
1338
+ # @return [String]
1339
+ #
1340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroupRequest AWS API Documentation
1341
+ #
1342
+ class GetGroupRequest < Struct.new(
1343
+ :group_identifier)
1344
+ SENSITIVE = []
1345
+ include Aws::Structure
1346
+ end
1347
+
1348
+ # @!attribute [rw] group
1349
+ # A structure that contains information about the group.
1350
+ # @return [Types::Group]
1351
+ #
1352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroupResponse AWS API Documentation
1353
+ #
1354
+ class GetGroupResponse < Struct.new(
1355
+ :group)
1356
+ SENSITIVE = []
1357
+ include Aws::Structure
1358
+ end
1359
+
1360
+ # This structure contains information about one group.
1361
+ #
1362
+ # @!attribute [rw] id
1363
+ # The unique ID of the group.
1364
+ # @return [String]
1365
+ #
1366
+ # @!attribute [rw] name
1367
+ # The name of the group.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] arn
1371
+ # The ARN of the group.
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] tags
1375
+ # The list of key-value pairs that are associated with the canary.
1376
+ # @return [Hash<String,String>]
1377
+ #
1378
+ # @!attribute [rw] created_time
1379
+ # The date and time that the group was created.
1380
+ # @return [Time]
1381
+ #
1382
+ # @!attribute [rw] last_modified_time
1383
+ # The date and time that the group was most recently updated.
1384
+ # @return [Time]
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/Group AWS API Documentation
1387
+ #
1388
+ class Group < Struct.new(
1389
+ :id,
1390
+ :name,
1391
+ :arn,
1392
+ :tags,
1393
+ :created_time,
1394
+ :last_modified_time)
1395
+ SENSITIVE = []
1396
+ include Aws::Structure
1397
+ end
1398
+
1399
+ # A structure containing some information about a group.
1400
+ #
1401
+ # @!attribute [rw] id
1402
+ # The unique ID of the group.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] name
1406
+ # The name of the group.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] arn
1410
+ # The ARN of the group.
1411
+ # @return [String]
1412
+ #
1413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GroupSummary AWS API Documentation
1414
+ #
1415
+ class GroupSummary < Struct.new(
1416
+ :id,
1417
+ :name,
1418
+ :arn)
1419
+ SENSITIVE = []
1420
+ include Aws::Structure
1421
+ end
1422
+
1423
+ # An internal failure occurred. Try the operation again.
1424
+ #
1425
+ # @!attribute [rw] message
1426
+ # @return [String]
1427
+ #
1428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/InternalFailureException AWS API Documentation
1429
+ #
1430
+ class InternalFailureException < Struct.new(
1431
+ :message)
1432
+ SENSITIVE = []
1433
+ include Aws::Structure
1434
+ end
1435
+
1156
1436
  # An unknown internal error occurred.
1157
1437
  #
1158
1438
  # @!attribute [rw] message
@@ -1166,18 +1446,181 @@ module Aws::Synthetics
1166
1446
  include Aws::Structure
1167
1447
  end
1168
1448
 
1169
- # @note When making an API call, you may pass ListTagsForResourceRequest
1449
+ # @note When making an API call, you may pass ListAssociatedGroupsRequest
1170
1450
  # data as a hash:
1171
1451
  #
1172
1452
  # {
1453
+ # next_token: "PaginationToken",
1454
+ # max_results: 1,
1173
1455
  # resource_arn: "CanaryArn", # required
1174
1456
  # }
1175
1457
  #
1458
+ # @!attribute [rw] next_token
1459
+ # A token that indicates that there is more data available. You can
1460
+ # use this token in a subsequent operation to retrieve the next set of
1461
+ # results.
1462
+ # @return [String]
1463
+ #
1464
+ # @!attribute [rw] max_results
1465
+ # Specify this parameter to limit how many groups are returned each
1466
+ # time you use the `ListAssociatedGroups` operation. If you omit this
1467
+ # parameter, the default of 20 is used.
1468
+ # @return [Integer]
1469
+ #
1176
1470
  # @!attribute [rw] resource_arn
1177
- # The ARN of the canary that you want to view tags for.
1471
+ # The ARN of the canary that you want to view groups for.
1472
+ # @return [String]
1473
+ #
1474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroupsRequest AWS API Documentation
1475
+ #
1476
+ class ListAssociatedGroupsRequest < Struct.new(
1477
+ :next_token,
1478
+ :max_results,
1479
+ :resource_arn)
1480
+ SENSITIVE = []
1481
+ include Aws::Structure
1482
+ end
1483
+
1484
+ # @!attribute [rw] groups
1485
+ # An array of structures that contain information about the groups
1486
+ # that this canary is associated with.
1487
+ # @return [Array<Types::GroupSummary>]
1488
+ #
1489
+ # @!attribute [rw] next_token
1490
+ # A token that indicates that there is more data available. You can
1491
+ # use this token in a subsequent `ListAssociatedGroups` operation to
1492
+ # retrieve the next set of results.
1493
+ # @return [String]
1494
+ #
1495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroupsResponse AWS API Documentation
1496
+ #
1497
+ class ListAssociatedGroupsResponse < Struct.new(
1498
+ :groups,
1499
+ :next_token)
1500
+ SENSITIVE = []
1501
+ include Aws::Structure
1502
+ end
1503
+
1504
+ # @note When making an API call, you may pass ListGroupResourcesRequest
1505
+ # data as a hash:
1506
+ #
1507
+ # {
1508
+ # next_token: "PaginationToken",
1509
+ # max_results: 1,
1510
+ # group_identifier: "GroupIdentifier", # required
1511
+ # }
1512
+ #
1513
+ # @!attribute [rw] next_token
1514
+ # A token that indicates that there is more data available. You can
1515
+ # use this token in a subsequent operation to retrieve the next set of
1516
+ # results.
1517
+ # @return [String]
1518
+ #
1519
+ # @!attribute [rw] max_results
1520
+ # Specify this parameter to limit how many canary ARNs are returned
1521
+ # each time you use the `ListGroupResources` operation. If you omit
1522
+ # this parameter, the default of 20 is used.
1523
+ # @return [Integer]
1524
+ #
1525
+ # @!attribute [rw] group_identifier
1526
+ # Specifies the group to return information for. You can specify the
1527
+ # group name, the ARN, or the group ID as the `GroupIdentifier`.
1528
+ # @return [String]
1529
+ #
1530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResourcesRequest AWS API Documentation
1531
+ #
1532
+ class ListGroupResourcesRequest < Struct.new(
1533
+ :next_token,
1534
+ :max_results,
1535
+ :group_identifier)
1536
+ SENSITIVE = []
1537
+ include Aws::Structure
1538
+ end
1539
+
1540
+ # @!attribute [rw] resources
1541
+ # An array of ARNs. These ARNs are for the canaries that are
1542
+ # associated with the group.
1543
+ # @return [Array<String>]
1544
+ #
1545
+ # @!attribute [rw] next_token
1546
+ # A token that indicates that there is more data available. You can
1547
+ # use this token in a subsequent `ListGroupResources` operation to
1548
+ # retrieve the next set of results.
1549
+ # @return [String]
1550
+ #
1551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResourcesResponse AWS API Documentation
1552
+ #
1553
+ class ListGroupResourcesResponse < Struct.new(
1554
+ :resources,
1555
+ :next_token)
1556
+ SENSITIVE = []
1557
+ include Aws::Structure
1558
+ end
1559
+
1560
+ # @note When making an API call, you may pass ListGroupsRequest
1561
+ # data as a hash:
1562
+ #
1563
+ # {
1564
+ # next_token: "PaginationToken",
1565
+ # max_results: 1,
1566
+ # }
1567
+ #
1568
+ # @!attribute [rw] next_token
1569
+ # A token that indicates that there is more data available. You can
1570
+ # use this token in a subsequent operation to retrieve the next set of
1571
+ # results.
1572
+ # @return [String]
1573
+ #
1574
+ # @!attribute [rw] max_results
1575
+ # Specify this parameter to limit how many groups are returned each
1576
+ # time you use the `ListGroups` operation. If you omit this parameter,
1577
+ # the default of 20 is used.
1578
+ # @return [Integer]
1579
+ #
1580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupsRequest AWS API Documentation
1581
+ #
1582
+ class ListGroupsRequest < Struct.new(
1583
+ :next_token,
1584
+ :max_results)
1585
+ SENSITIVE = []
1586
+ include Aws::Structure
1587
+ end
1588
+
1589
+ # @!attribute [rw] groups
1590
+ # An array of structures that each contain information about one
1591
+ # group.
1592
+ # @return [Array<Types::GroupSummary>]
1593
+ #
1594
+ # @!attribute [rw] next_token
1595
+ # A token that indicates that there is more data available. You can
1596
+ # use this token in a subsequent `ListGroups` operation to retrieve
1597
+ # the next set of results.
1598
+ # @return [String]
1599
+ #
1600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupsResponse AWS API Documentation
1601
+ #
1602
+ class ListGroupsResponse < Struct.new(
1603
+ :groups,
1604
+ :next_token)
1605
+ SENSITIVE = []
1606
+ include Aws::Structure
1607
+ end
1608
+
1609
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1610
+ # data as a hash:
1611
+ #
1612
+ # {
1613
+ # resource_arn: "ResourceArn", # required
1614
+ # }
1615
+ #
1616
+ # @!attribute [rw] resource_arn
1617
+ # The ARN of the canary or group that you want to view tags for.
1178
1618
  #
1179
1619
  # The ARN format of a canary is
1180
1620
  # `arn:aws:synthetics:Region:account-id:canary:canary-name `.
1621
+ #
1622
+ # The ARN format of a group is
1623
+ # `arn:aws:synthetics:Region:account-id:group:group-name `
1181
1624
  # @return [String]
1182
1625
  #
1183
1626
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListTagsForResourceRequest AWS API Documentation
@@ -1189,8 +1632,8 @@ module Aws::Synthetics
1189
1632
  end
1190
1633
 
1191
1634
  # @!attribute [rw] tags
1192
- # The list of tag keys and values associated with the canary that you
1193
- # specified.
1635
+ # The list of tag keys and values associated with the resource that
1636
+ # you specified.
1194
1637
  # @return [Hash<String,String>]
1195
1638
  #
1196
1639
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListTagsForResourceResponse AWS API Documentation
@@ -1201,6 +1644,19 @@ module Aws::Synthetics
1201
1644
  include Aws::Structure
1202
1645
  end
1203
1646
 
1647
+ # The specified resource was not found.
1648
+ #
1649
+ # @!attribute [rw] message
1650
+ # @return [String]
1651
+ #
1652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/NotFoundException AWS API Documentation
1653
+ #
1654
+ class NotFoundException < Struct.new(
1655
+ :message)
1656
+ SENSITIVE = []
1657
+ include Aws::Structure
1658
+ end
1659
+
1204
1660
  # One of the input resources is larger than is allowed.
1205
1661
  #
1206
1662
  # @!attribute [rw] message
@@ -1309,6 +1765,19 @@ module Aws::Synthetics
1309
1765
  include Aws::Structure
1310
1766
  end
1311
1767
 
1768
+ # The request exceeded a service quota value.
1769
+ #
1770
+ # @!attribute [rw] message
1771
+ # @return [String]
1772
+ #
1773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ServiceQuotaExceededException AWS API Documentation
1774
+ #
1775
+ class ServiceQuotaExceededException < Struct.new(
1776
+ :message)
1777
+ SENSITIVE = []
1778
+ include Aws::Structure
1779
+ end
1780
+
1312
1781
  # @note When making an API call, you may pass StartCanaryRequest
1313
1782
  # data as a hash:
1314
1783
  #
@@ -1346,7 +1815,7 @@ module Aws::Synthetics
1346
1815
  #
1347
1816
  # @!attribute [rw] name
1348
1817
  # The name of the canary that you want to stop. To find the names of
1349
- # your canaries, use [DescribeCanaries][1].
1818
+ # your canaries, use [ListCanaries][1].
1350
1819
  #
1351
1820
  #
1352
1821
  #
@@ -1369,21 +1838,24 @@ module Aws::Synthetics
1369
1838
  # data as a hash:
1370
1839
  #
1371
1840
  # {
1372
- # resource_arn: "CanaryArn", # required
1841
+ # resource_arn: "ResourceArn", # required
1373
1842
  # tags: { # required
1374
1843
  # "TagKey" => "TagValue",
1375
1844
  # },
1376
1845
  # }
1377
1846
  #
1378
1847
  # @!attribute [rw] resource_arn
1379
- # The ARN of the canary that you're adding tags to.
1848
+ # The ARN of the canary or group that you're adding tags to.
1380
1849
  #
1381
1850
  # The ARN format of a canary is
1382
1851
  # `arn:aws:synthetics:Region:account-id:canary:canary-name `.
1852
+ #
1853
+ # The ARN format of a group is
1854
+ # `arn:aws:synthetics:Region:account-id:group:group-name `
1383
1855
  # @return [String]
1384
1856
  #
1385
1857
  # @!attribute [rw] tags
1386
- # The list of key-value pairs to associate with the canary.
1858
+ # The list of key-value pairs to associate with the resource.
1387
1859
  # @return [Hash<String,String>]
1388
1860
  #
1389
1861
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/TagResourceRequest AWS API Documentation
@@ -1399,19 +1871,35 @@ module Aws::Synthetics
1399
1871
  #
1400
1872
  class TagResourceResponse < Aws::EmptyStructure; end
1401
1873
 
1874
+ # There were too many simultaneous requests. Try the operation again.
1875
+ #
1876
+ # @!attribute [rw] message
1877
+ # @return [String]
1878
+ #
1879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/TooManyRequestsException AWS API Documentation
1880
+ #
1881
+ class TooManyRequestsException < Struct.new(
1882
+ :message)
1883
+ SENSITIVE = []
1884
+ include Aws::Structure
1885
+ end
1886
+
1402
1887
  # @note When making an API call, you may pass UntagResourceRequest
1403
1888
  # data as a hash:
1404
1889
  #
1405
1890
  # {
1406
- # resource_arn: "CanaryArn", # required
1891
+ # resource_arn: "ResourceArn", # required
1407
1892
  # tag_keys: ["TagKey"], # required
1408
1893
  # }
1409
1894
  #
1410
1895
  # @!attribute [rw] resource_arn
1411
- # The ARN of the canary that you're removing tags from.
1896
+ # The ARN of the canary or group that you're removing tags from.
1412
1897
  #
1413
1898
  # The ARN format of a canary is
1414
1899
  # `arn:aws:synthetics:Region:account-id:canary:canary-name `.
1900
+ #
1901
+ # The ARN format of a group is
1902
+ # `arn:aws:synthetics:Region:account-id:group:group-name `
1415
1903
  # @return [String]
1416
1904
  #
1417
1905
  # @!attribute [rw] tag_keys
@@ -1441,7 +1929,7 @@ module Aws::Synthetics
1441
1929
  # s3_key: "String",
1442
1930
  # s3_version: "String",
1443
1931
  # zip_file: "data",
1444
- # handler: "String", # required
1932
+ # handler: "CodeHandler", # required
1445
1933
  # },
1446
1934
  # execution_role_arn: "RoleArn",
1447
1935
  # runtime_version: "String",
@@ -1538,6 +2026,9 @@ module Aws::Synthetics
1538
2026
  # @!attribute [rw] run_config
1539
2027
  # A structure that contains the timeout value that is used for each
1540
2028
  # individual run of the canary.
2029
+ #
2030
+ # The environment variables keys and values are not encrypted. Do not
2031
+ # store sensitive information in this field.
1541
2032
  # @return [Types::CanaryRunConfigInput]
1542
2033
  #
1543
2034
  # @!attribute [rw] success_retention_period_in_days
@@ -1625,8 +2116,8 @@ module Aws::Synthetics
1625
2116
  end
1626
2117
 
1627
2118
  # An object that specifies what screenshots to use as a baseline for
1628
- # visual monitoring by this canary, and optionally the parts of the
1629
- # screenshots to ignore during the visual monitoring comparison.
2119
+ # visual monitoring by this canary. It can optionally also specify parts
2120
+ # of the screenshots to ignore during the visual monitoring comparison.
1630
2121
  #
1631
2122
  # Visual monitoring is supported only on canaries running the
1632
2123
  # **syn-puppeteer-node-3.2** runtime or later. For more information, see
@@ -1693,9 +2184,8 @@ module Aws::Synthetics
1693
2184
  # @return [Array<Types::BaseScreenshot>]
1694
2185
  #
1695
2186
  # @!attribute [rw] base_canary_run_id
1696
- # The ID of the canary run that produced the screenshots that are used
1697
- # as the baseline for visual monitoring comparisons during future runs
1698
- # of this canary.
2187
+ # The ID of the canary run that produced the baseline screenshots that
2188
+ # are used for visual monitoring comparisons by this canary.
1699
2189
  # @return [String]
1700
2190
  #
1701
2191
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceOutput AWS API Documentation