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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a135a3c67fef18a2a5e5427d11fdfe0c2cfac56bb121eb74a80c219cde5624f7
4
- data.tar.gz: 26ad9244306b74d189e4933f3c3c8f021cf4ec40f2c96a3e413150942441266b
3
+ metadata.gz: 98f3a67056d5afe307f4d95073b8806a50c4420d8a2e1cdb6f9f1dc3a0fb318f
4
+ data.tar.gz: 0f518697784b5c6c43e96ca7c97d66ae655111300c881a8d0da33799f8e4c151
5
5
  SHA512:
6
- metadata.gz: 4655d97f55637f832eb2eb9561d45eee595e7dc2f987b25d5265b8ab5faffe5840f5b2dd385b22aae94eebe9dc32fe8501229cac36271fb2ce7ec45e70e27b23
7
- data.tar.gz: 2cd49239b576bf02c0b29730715037a2ac846808c3183b34fa13069cf3e9d208fa1be28a4d306dbc236985200c1a126b8733bef366b1a80a06719dc85997955f
6
+ metadata.gz: d6ce2b4eda9ffff7164b973f530db8437b8770f41bf93067a8feb47d562d766e4d7c76bd911568b0a680785b8c0b3746cbd6ffb231307929646e2bf6348c7fa7
7
+ data.tar.gz: 3e9698aa61b07e3c9e345a49505488728e0caf5f1e994d9ec4b57c5219306c8e5a28e31b4198ae53d699b594853e6ce9dde00a7d336450c0482f03e0dcd2223c
data/CHANGELOG.md CHANGED
@@ -1,6 +1,21 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.28.0 (2022-07-06)
5
+ ------------------
6
+
7
+ * Feature - This release introduces Group feature, which enables users to group cross-region canaries.
8
+
9
+ 1.27.0 (2022-05-02)
10
+ ------------------
11
+
12
+ * Feature - CloudWatch Synthetics has introduced a new feature to provide customers with an option to delete the underlying resources that Synthetics canary creates when the user chooses to delete the canary.
13
+
14
+ 1.26.0 (2022-03-04)
15
+ ------------------
16
+
17
+ * Feature - Allow custom handler function.
18
+
4
19
  1.25.0 (2022-02-24)
5
20
  ------------------
6
21
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.25.0
1
+ 1.28.0
@@ -351,6 +351,38 @@ module Aws::Synthetics
351
351
 
352
352
  # @!group API Operations
353
353
 
354
+ # Associates a canary with a group. Using groups can help you with
355
+ # managing and automating your canaries, and you can also view
356
+ # aggregated run results and statistics for all canaries in a group.
357
+ #
358
+ # You must run this operation in the Region where the canary exists.
359
+ #
360
+ # @option params [required, String] :group_identifier
361
+ # Specifies the group. You can specify the group name, the ARN, or the
362
+ # group ID as the `GroupIdentifier`.
363
+ #
364
+ # @option params [required, String] :resource_arn
365
+ # The ARN of the canary that you want to associate with the specified
366
+ # group.
367
+ #
368
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
369
+ #
370
+ # @example Request syntax with placeholder values
371
+ #
372
+ # resp = client.associate_resource({
373
+ # group_identifier: "GroupIdentifier", # required
374
+ # resource_arn: "CanaryArn", # required
375
+ # })
376
+ #
377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResource AWS API Documentation
378
+ #
379
+ # @overload associate_resource(params = {})
380
+ # @param [Hash] params ({})
381
+ def associate_resource(params = {}, options = {})
382
+ req = build_request(:associate_resource, params)
383
+ req.send_request(options)
384
+ end
385
+
354
386
  # Creates a canary. Canaries are scripts that monitor your endpoints and
355
387
  # APIs from the outside-in. Canaries help you check the availability and
356
388
  # latency of your web services and troubleshoot anomalies by
@@ -362,7 +394,7 @@ module Aws::Synthetics
362
394
  #
363
395
  # To create canaries, you must have the `CloudWatchSyntheticsFullAccess`
364
396
  # policy. If you are creating a new IAM role for the canary, you also
365
- # need the the `iam:CreateRole`, `iam:CreatePolicy` and
397
+ # need the `iam:CreateRole`, `iam:CreatePolicy` and
366
398
  # `iam:AttachRolePolicy` permissions. For more information, see
367
399
  # [Necessary Roles and Permissions][2].
368
400
  #
@@ -427,7 +459,10 @@ module Aws::Synthetics
427
459
  #
428
460
  # @option params [Types::CanaryRunConfigInput] :run_config
429
461
  # A structure that contains the configuration for individual canary
430
- # runs, such as timeout value.
462
+ # runs, such as timeout value and environment variables.
463
+ #
464
+ # The environment variables keys and values are not encrypted. Do not
465
+ # store sensitive information in this field.
431
466
  #
432
467
  # @option params [Integer] :success_retention_period_in_days
433
468
  # The number of days to retain data about successful runs of this
@@ -483,7 +518,7 @@ module Aws::Synthetics
483
518
  # s3_key: "String",
484
519
  # s3_version: "String",
485
520
  # zip_file: "data",
486
- # handler: "String", # required
521
+ # handler: "CodeHandler", # required
487
522
  # },
488
523
  # artifact_s3_location: "String", # required
489
524
  # execution_role_arn: "RoleArn", # required
@@ -533,7 +568,7 @@ module Aws::Synthetics
533
568
  # resp.canary.failure_retention_period_in_days #=> Integer
534
569
  # resp.canary.status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
535
570
  # resp.canary.status.state_reason #=> String
536
- # resp.canary.status.state_reason_code #=> String, one of "INVALID_PERMISSIONS"
571
+ # resp.canary.status.state_reason_code #=> String, one of "INVALID_PERMISSIONS", "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "UPDATE_PENDING", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "SYNC_DELETE_IN_PROGRESS"
537
572
  # resp.canary.timeline.created #=> Time
538
573
  # resp.canary.timeline.last_modified #=> Time
539
574
  # resp.canary.timeline.last_started #=> Time
@@ -565,14 +600,85 @@ module Aws::Synthetics
565
600
  req.send_request(options)
566
601
  end
567
602
 
603
+ # Creates a group which you can use to associate canaries with each
604
+ # other, including cross-Region canaries. Using groups can help you with
605
+ # managing and automating your canaries, and you can also view
606
+ # aggregated run results and statistics for all canaries in a group.
607
+ #
608
+ # Groups are global resources. When you create a group, it is replicated
609
+ # across Amazon Web Services Regions, and you can view it and add
610
+ # canaries to it from any Region. Although the group ARN format reflects
611
+ # the Region name where it was created, a group is not constrained to
612
+ # any Region. This means that you can put canaries from multiple Regions
613
+ # into the same group, and then use that group to view and manage all of
614
+ # those canaries in a single view.
615
+ #
616
+ # Groups are supported in all Regions except the Regions that are
617
+ # disabled by default. For more information about these Regions, see
618
+ # [Enabling a Region][1].
619
+ #
620
+ # Each group can contain as many as 10 canaries. You can have as many as
621
+ # 20 groups in your account. Any single canary can be a member of up to
622
+ # 10 groups.
623
+ #
624
+ #
625
+ #
626
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
627
+ #
628
+ # @option params [required, String] :name
629
+ # The name for the group. It can include any Unicode characters.
630
+ #
631
+ # The names for all groups in your account, across all Regions, must be
632
+ # unique.
633
+ #
634
+ # @option params [Hash<String,String>] :tags
635
+ # A list of key-value pairs to associate with the group. You can
636
+ # associate as many as 50 tags with a group.
637
+ #
638
+ # Tags can help you organize and categorize your resources. You can also
639
+ # use them to scope user permissions, by granting a user permission to
640
+ # access or change only the resources that have certain tag values.
641
+ #
642
+ # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
643
+ #
644
+ # * {Types::CreateGroupResponse#group #group} => Types::Group
645
+ #
646
+ # @example Request syntax with placeholder values
647
+ #
648
+ # resp = client.create_group({
649
+ # name: "GroupName", # required
650
+ # tags: {
651
+ # "TagKey" => "TagValue",
652
+ # },
653
+ # })
654
+ #
655
+ # @example Response structure
656
+ #
657
+ # resp.group.id #=> String
658
+ # resp.group.name #=> String
659
+ # resp.group.arn #=> String
660
+ # resp.group.tags #=> Hash
661
+ # resp.group.tags["TagKey"] #=> String
662
+ # resp.group.created_time #=> Time
663
+ # resp.group.last_modified_time #=> Time
664
+ #
665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroup AWS API Documentation
666
+ #
667
+ # @overload create_group(params = {})
668
+ # @param [Hash] params ({})
669
+ def create_group(params = {}, options = {})
670
+ req = build_request(:create_group, params)
671
+ req.send_request(options)
672
+ end
673
+
568
674
  # Permanently deletes the specified canary.
569
675
  #
570
- # When you delete a canary, resources used and created by the canary are
571
- # not automatically deleted. After you delete a canary that you do not
572
- # intend to use again, you should also delete the following:
676
+ # If you specify `DeleteLambda` to `true`, CloudWatch Synthetics also
677
+ # deletes the Lambda functions and layers that are used by the canary.
573
678
  #
574
- # * The Lambda functions and layers used by this canary. These have the
575
- # prefix `cwsyn-MyCanaryName `.
679
+ # Other resources used and created by the canary are not automatically
680
+ # deleted. After you delete a canary that you do not intend to use
681
+ # again, you should also delete the following:
576
682
  #
577
683
  # * The CloudWatch alarms created for this canary. These alarms have a
578
684
  # name of `Synthetics-SharpDrop-Alarm-MyCanaryName `.
@@ -600,12 +706,19 @@ module Aws::Synthetics
600
706
  #
601
707
  # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
602
708
  #
709
+ # @option params [Boolean] :delete_lambda
710
+ # Specifies whether to also delete the Lambda functions and layers used
711
+ # by this canary. The default is false.
712
+ #
713
+ # Type: Boolean
714
+ #
603
715
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
604
716
  #
605
717
  # @example Request syntax with placeholder values
606
718
  #
607
719
  # resp = client.delete_canary({
608
720
  # name: "CanaryName", # required
721
+ # delete_lambda: false,
609
722
  # })
610
723
  #
611
724
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteCanary AWS API Documentation
@@ -617,6 +730,35 @@ module Aws::Synthetics
617
730
  req.send_request(options)
618
731
  end
619
732
 
733
+ # Deletes a group. The group doesn't need to be empty to be deleted. If
734
+ # there are canaries in the group, they are not deleted when you delete
735
+ # the group.
736
+ #
737
+ # Groups are a global resource that appear in all Regions, but the
738
+ # request to delete a group must be made from its home Region. You can
739
+ # find the home Region of a group within its ARN.
740
+ #
741
+ # @option params [required, String] :group_identifier
742
+ # Specifies which group to delete. You can specify the group name, the
743
+ # ARN, or the group ID as the `GroupIdentifier`.
744
+ #
745
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
746
+ #
747
+ # @example Request syntax with placeholder values
748
+ #
749
+ # resp = client.delete_group({
750
+ # group_identifier: "GroupIdentifier", # required
751
+ # })
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroup AWS API Documentation
754
+ #
755
+ # @overload delete_group(params = {})
756
+ # @param [Hash] params ({})
757
+ def delete_group(params = {}, options = {})
758
+ req = build_request(:delete_group, params)
759
+ req.send_request(options)
760
+ end
761
+
620
762
  # This operation returns a list of the canaries in your account, along
621
763
  # with full details about each canary.
622
764
  #
@@ -696,7 +838,7 @@ module Aws::Synthetics
696
838
  # resp.canaries[0].failure_retention_period_in_days #=> Integer
697
839
  # resp.canaries[0].status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
698
840
  # resp.canaries[0].status.state_reason #=> String
699
- # resp.canaries[0].status.state_reason_code #=> String, one of "INVALID_PERMISSIONS"
841
+ # resp.canaries[0].status.state_reason_code #=> String, one of "INVALID_PERMISSIONS", "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "UPDATE_PENDING", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "SYNC_DELETE_IN_PROGRESS"
700
842
  # resp.canaries[0].timeline.created #=> Time
701
843
  # resp.canaries[0].timeline.last_modified #=> Time
702
844
  # resp.canaries[0].timeline.last_started #=> Time
@@ -750,8 +892,8 @@ module Aws::Synthetics
750
892
  #
751
893
  # @option params [String] :next_token
752
894
  # A token that indicates that there is more data available. You can use
753
- # this token in a subsequent `DescribeCanaries` operation to retrieve
754
- # the next set of results.
895
+ # this token in a subsequent `DescribeCanariesLastRun` operation to
896
+ # retrieve the next set of results.
755
897
  #
756
898
  # @option params [Integer] :max_results
757
899
  # Specify this parameter to limit how many runs are returned each time
@@ -863,6 +1005,35 @@ module Aws::Synthetics
863
1005
  req.send_request(options)
864
1006
  end
865
1007
 
1008
+ # Removes a canary from a group. You must run this operation in the
1009
+ # Region where the canary exists.
1010
+ #
1011
+ # @option params [required, String] :group_identifier
1012
+ # Specifies the group. You can specify the group name, the ARN, or the
1013
+ # group ID as the `GroupIdentifier`.
1014
+ #
1015
+ # @option params [required, String] :resource_arn
1016
+ # The ARN of the canary that you want to remove from the specified
1017
+ # group.
1018
+ #
1019
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1020
+ #
1021
+ # @example Request syntax with placeholder values
1022
+ #
1023
+ # resp = client.disassociate_resource({
1024
+ # group_identifier: "GroupIdentifier", # required
1025
+ # resource_arn: "CanaryArn", # required
1026
+ # })
1027
+ #
1028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResource AWS API Documentation
1029
+ #
1030
+ # @overload disassociate_resource(params = {})
1031
+ # @param [Hash] params ({})
1032
+ def disassociate_resource(params = {}, options = {})
1033
+ req = build_request(:disassociate_resource, params)
1034
+ req.send_request(options)
1035
+ end
1036
+
866
1037
  # Retrieves complete information about one canary. You must specify the
867
1038
  # name of the canary that you want. To get a list of canaries and their
868
1039
  # names, use [DescribeCanaries][1].
@@ -900,7 +1071,7 @@ module Aws::Synthetics
900
1071
  # resp.canary.failure_retention_period_in_days #=> Integer
901
1072
  # resp.canary.status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
902
1073
  # resp.canary.status.state_reason #=> String
903
- # resp.canary.status.state_reason_code #=> String, one of "INVALID_PERMISSIONS"
1074
+ # resp.canary.status.state_reason_code #=> String, one of "INVALID_PERMISSIONS", "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "UPDATE_PENDING", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "SYNC_DELETE_IN_PROGRESS"
904
1075
  # resp.canary.timeline.created #=> Time
905
1076
  # resp.canary.timeline.last_modified #=> Time
906
1077
  # resp.canary.timeline.last_started #=> Time
@@ -984,14 +1155,192 @@ module Aws::Synthetics
984
1155
  req.send_request(options)
985
1156
  end
986
1157
 
987
- # Displays the tags associated with a canary.
1158
+ # Returns information about one group. Groups are a global resource, so
1159
+ # you can use this operation from any Region.
1160
+ #
1161
+ # @option params [required, String] :group_identifier
1162
+ # Specifies the group to return information for. You can specify the
1163
+ # group name, the ARN, or the group ID as the `GroupIdentifier`.
1164
+ #
1165
+ # @return [Types::GetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1166
+ #
1167
+ # * {Types::GetGroupResponse#group #group} => Types::Group
1168
+ #
1169
+ # @example Request syntax with placeholder values
1170
+ #
1171
+ # resp = client.get_group({
1172
+ # group_identifier: "GroupIdentifier", # required
1173
+ # })
1174
+ #
1175
+ # @example Response structure
1176
+ #
1177
+ # resp.group.id #=> String
1178
+ # resp.group.name #=> String
1179
+ # resp.group.arn #=> String
1180
+ # resp.group.tags #=> Hash
1181
+ # resp.group.tags["TagKey"] #=> String
1182
+ # resp.group.created_time #=> Time
1183
+ # resp.group.last_modified_time #=> Time
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroup AWS API Documentation
1186
+ #
1187
+ # @overload get_group(params = {})
1188
+ # @param [Hash] params ({})
1189
+ def get_group(params = {}, options = {})
1190
+ req = build_request(:get_group, params)
1191
+ req.send_request(options)
1192
+ end
1193
+
1194
+ # Returns a list of the groups that the specified canary is associated
1195
+ # with. The canary that you specify must be in the current Region.
1196
+ #
1197
+ # @option params [String] :next_token
1198
+ # A token that indicates that there is more data available. You can use
1199
+ # this token in a subsequent operation to retrieve the next set of
1200
+ # results.
1201
+ #
1202
+ # @option params [Integer] :max_results
1203
+ # Specify this parameter to limit how many groups are returned each time
1204
+ # you use the `ListAssociatedGroups` operation. If you omit this
1205
+ # parameter, the default of 20 is used.
988
1206
  #
989
1207
  # @option params [required, String] :resource_arn
990
- # The ARN of the canary that you want to view tags for.
1208
+ # The ARN of the canary that you want to view groups for.
1209
+ #
1210
+ # @return [Types::ListAssociatedGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1211
+ #
1212
+ # * {Types::ListAssociatedGroupsResponse#groups #groups} => Array&lt;Types::GroupSummary&gt;
1213
+ # * {Types::ListAssociatedGroupsResponse#next_token #next_token} => String
1214
+ #
1215
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1216
+ #
1217
+ # @example Request syntax with placeholder values
1218
+ #
1219
+ # resp = client.list_associated_groups({
1220
+ # next_token: "PaginationToken",
1221
+ # max_results: 1,
1222
+ # resource_arn: "CanaryArn", # required
1223
+ # })
1224
+ #
1225
+ # @example Response structure
1226
+ #
1227
+ # resp.groups #=> Array
1228
+ # resp.groups[0].id #=> String
1229
+ # resp.groups[0].name #=> String
1230
+ # resp.groups[0].arn #=> String
1231
+ # resp.next_token #=> String
1232
+ #
1233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroups AWS API Documentation
1234
+ #
1235
+ # @overload list_associated_groups(params = {})
1236
+ # @param [Hash] params ({})
1237
+ def list_associated_groups(params = {}, options = {})
1238
+ req = build_request(:list_associated_groups, params)
1239
+ req.send_request(options)
1240
+ end
1241
+
1242
+ # This operation returns a list of the ARNs of the canaries that are
1243
+ # associated with the specified group.
1244
+ #
1245
+ # @option params [String] :next_token
1246
+ # A token that indicates that there is more data available. You can use
1247
+ # this token in a subsequent operation to retrieve the next set of
1248
+ # results.
1249
+ #
1250
+ # @option params [Integer] :max_results
1251
+ # Specify this parameter to limit how many canary ARNs are returned each
1252
+ # time you use the `ListGroupResources` operation. If you omit this
1253
+ # parameter, the default of 20 is used.
1254
+ #
1255
+ # @option params [required, String] :group_identifier
1256
+ # Specifies the group to return information for. You can specify the
1257
+ # group name, the ARN, or the group ID as the `GroupIdentifier`.
1258
+ #
1259
+ # @return [Types::ListGroupResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1260
+ #
1261
+ # * {Types::ListGroupResourcesResponse#resources #resources} => Array&lt;String&gt;
1262
+ # * {Types::ListGroupResourcesResponse#next_token #next_token} => String
1263
+ #
1264
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1265
+ #
1266
+ # @example Request syntax with placeholder values
1267
+ #
1268
+ # resp = client.list_group_resources({
1269
+ # next_token: "PaginationToken",
1270
+ # max_results: 1,
1271
+ # group_identifier: "GroupIdentifier", # required
1272
+ # })
1273
+ #
1274
+ # @example Response structure
1275
+ #
1276
+ # resp.resources #=> Array
1277
+ # resp.resources[0] #=> String
1278
+ # resp.next_token #=> String
1279
+ #
1280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResources AWS API Documentation
1281
+ #
1282
+ # @overload list_group_resources(params = {})
1283
+ # @param [Hash] params ({})
1284
+ def list_group_resources(params = {}, options = {})
1285
+ req = build_request(:list_group_resources, params)
1286
+ req.send_request(options)
1287
+ end
1288
+
1289
+ # Returns a list of all groups in the account, displaying their names,
1290
+ # unique IDs, and ARNs. The groups from all Regions are returned.
1291
+ #
1292
+ # @option params [String] :next_token
1293
+ # A token that indicates that there is more data available. You can use
1294
+ # this token in a subsequent operation to retrieve the next set of
1295
+ # results.
1296
+ #
1297
+ # @option params [Integer] :max_results
1298
+ # Specify this parameter to limit how many groups are returned each time
1299
+ # you use the `ListGroups` operation. If you omit this parameter, the
1300
+ # default of 20 is used.
1301
+ #
1302
+ # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1303
+ #
1304
+ # * {Types::ListGroupsResponse#groups #groups} => Array&lt;Types::GroupSummary&gt;
1305
+ # * {Types::ListGroupsResponse#next_token #next_token} => String
1306
+ #
1307
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1308
+ #
1309
+ # @example Request syntax with placeholder values
1310
+ #
1311
+ # resp = client.list_groups({
1312
+ # next_token: "PaginationToken",
1313
+ # max_results: 1,
1314
+ # })
1315
+ #
1316
+ # @example Response structure
1317
+ #
1318
+ # resp.groups #=> Array
1319
+ # resp.groups[0].id #=> String
1320
+ # resp.groups[0].name #=> String
1321
+ # resp.groups[0].arn #=> String
1322
+ # resp.next_token #=> String
1323
+ #
1324
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroups AWS API Documentation
1325
+ #
1326
+ # @overload list_groups(params = {})
1327
+ # @param [Hash] params ({})
1328
+ def list_groups(params = {}, options = {})
1329
+ req = build_request(:list_groups, params)
1330
+ req.send_request(options)
1331
+ end
1332
+
1333
+ # Displays the tags associated with a canary or group.
1334
+ #
1335
+ # @option params [required, String] :resource_arn
1336
+ # The ARN of the canary or group that you want to view tags for.
991
1337
  #
992
1338
  # The ARN format of a canary is
993
1339
  # `arn:aws:synthetics:Region:account-id:canary:canary-name `.
994
1340
  #
1341
+ # The ARN format of a group is
1342
+ # `arn:aws:synthetics:Region:account-id:group:group-name `
1343
+ #
995
1344
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
996
1345
  #
997
1346
  # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -999,7 +1348,7 @@ module Aws::Synthetics
999
1348
  # @example Request syntax with placeholder values
1000
1349
  #
1001
1350
  # resp = client.list_tags_for_resource({
1002
- # resource_arn: "CanaryArn", # required
1351
+ # resource_arn: "ResourceArn", # required
1003
1352
  # })
1004
1353
  #
1005
1354
  # @example Response structure
@@ -1050,17 +1399,16 @@ module Aws::Synthetics
1050
1399
  end
1051
1400
 
1052
1401
  # Stops the canary to prevent all future runs. If the canary is
1053
- # currently running, Synthetics stops waiting for the current run of the
1054
- # specified canary to complete. The run that is in progress completes on
1055
- # its own, publishes metrics, and uploads artifacts, but it is not
1056
- # recorded in Synthetics as a completed run.
1402
+ # currently running,the run that is in progress completes on its own,
1403
+ # publishes metrics, and uploads artifacts, but it is not recorded in
1404
+ # Synthetics as a completed run.
1057
1405
  #
1058
1406
  # You can use `StartCanary` to start it running again with the canary’s
1059
1407
  # current schedule at any point in the future.
1060
1408
  #
1061
1409
  # @option params [required, String] :name
1062
1410
  # The name of the canary that you want to stop. To find the names of
1063
- # your canaries, use [DescribeCanaries][1].
1411
+ # your canaries, use [ListCanaries][1].
1064
1412
  #
1065
1413
  #
1066
1414
  #
@@ -1083,7 +1431,8 @@ module Aws::Synthetics
1083
1431
  req.send_request(options)
1084
1432
  end
1085
1433
 
1086
- # Assigns one or more tags (key-value pairs) to the specified canary.
1434
+ # Assigns one or more tags (key-value pairs) to the specified canary or
1435
+ # group.
1087
1436
  #
1088
1437
  # Tags can help you organize and categorize your resources. You can also
1089
1438
  # use them to scope user permissions, by granting a user permission to
@@ -1092,29 +1441,33 @@ module Aws::Synthetics
1092
1441
  # Tags don't have any semantic meaning to Amazon Web Services and are
1093
1442
  # interpreted strictly as strings of characters.
1094
1443
  #
1095
- # You can use the `TagResource` action with a canary that already has
1096
- # tags. If you specify a new tag key for the alarm, this tag is appended
1097
- # to the list of tags associated with the alarm. If you specify a tag
1098
- # key that is already associated with the alarm, the new tag value that
1099
- # you specify replaces the previous value for that tag.
1444
+ # You can use the `TagResource` action with a resource that already has
1445
+ # tags. If you specify a new tag key for the resource, this tag is
1446
+ # appended to the list of tags associated with the resource. If you
1447
+ # specify a tag key that is already associated with the resource, the
1448
+ # new tag value that you specify replaces the previous value for that
1449
+ # tag.
1100
1450
  #
1101
- # You can associate as many as 50 tags with a canary.
1451
+ # You can associate as many as 50 tags with a canary or group.
1102
1452
  #
1103
1453
  # @option params [required, String] :resource_arn
1104
- # The ARN of the canary that you're adding tags to.
1454
+ # The ARN of the canary or group that you're adding tags to.
1105
1455
  #
1106
1456
  # The ARN format of a canary is
1107
1457
  # `arn:aws:synthetics:Region:account-id:canary:canary-name `.
1108
1458
  #
1459
+ # The ARN format of a group is
1460
+ # `arn:aws:synthetics:Region:account-id:group:group-name `
1461
+ #
1109
1462
  # @option params [required, Hash<String,String>] :tags
1110
- # The list of key-value pairs to associate with the canary.
1463
+ # The list of key-value pairs to associate with the resource.
1111
1464
  #
1112
1465
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1113
1466
  #
1114
1467
  # @example Request syntax with placeholder values
1115
1468
  #
1116
1469
  # resp = client.tag_resource({
1117
- # resource_arn: "CanaryArn", # required
1470
+ # resource_arn: "ResourceArn", # required
1118
1471
  # tags: { # required
1119
1472
  # "TagKey" => "TagValue",
1120
1473
  # },
@@ -1129,14 +1482,17 @@ module Aws::Synthetics
1129
1482
  req.send_request(options)
1130
1483
  end
1131
1484
 
1132
- # Removes one or more tags from the specified canary.
1485
+ # Removes one or more tags from the specified resource.
1133
1486
  #
1134
1487
  # @option params [required, String] :resource_arn
1135
- # The ARN of the canary that you're removing tags from.
1488
+ # The ARN of the canary or group that you're removing tags from.
1136
1489
  #
1137
1490
  # The ARN format of a canary is
1138
1491
  # `arn:aws:synthetics:Region:account-id:canary:canary-name `.
1139
1492
  #
1493
+ # The ARN format of a group is
1494
+ # `arn:aws:synthetics:Region:account-id:group:group-name `
1495
+ #
1140
1496
  # @option params [required, Array<String>] :tag_keys
1141
1497
  # The list of tag keys to remove from the resource.
1142
1498
  #
@@ -1145,7 +1501,7 @@ module Aws::Synthetics
1145
1501
  # @example Request syntax with placeholder values
1146
1502
  #
1147
1503
  # resp = client.untag_resource({
1148
- # resource_arn: "CanaryArn", # required
1504
+ # resource_arn: "ResourceArn", # required
1149
1505
  # tag_keys: ["TagKey"], # required
1150
1506
  # })
1151
1507
  #
@@ -1158,8 +1514,7 @@ module Aws::Synthetics
1158
1514
  req.send_request(options)
1159
1515
  end
1160
1516
 
1161
- # Use this operation to change the settings of a canary that has already
1162
- # been created.
1517
+ # Updates the configuration of a canary that has already been created.
1163
1518
  #
1164
1519
  # You can't use this operation to update the tags of an existing
1165
1520
  # canary. To change the tags of an existing canary, use
@@ -1221,6 +1576,9 @@ module Aws::Synthetics
1221
1576
  # A structure that contains the timeout value that is used for each
1222
1577
  # individual run of the canary.
1223
1578
  #
1579
+ # The environment variables keys and values are not encrypted. Do not
1580
+ # store sensitive information in this field.
1581
+ #
1224
1582
  # @option params [Integer] :success_retention_period_in_days
1225
1583
  # The number of days to retain data about successful runs of this
1226
1584
  # canary.
@@ -1273,7 +1631,7 @@ module Aws::Synthetics
1273
1631
  # s3_key: "String",
1274
1632
  # s3_version: "String",
1275
1633
  # zip_file: "data",
1276
- # handler: "String", # required
1634
+ # handler: "CodeHandler", # required
1277
1635
  # },
1278
1636
  # execution_role_arn: "RoleArn",
1279
1637
  # runtime_version: "String",
@@ -1335,7 +1693,7 @@ module Aws::Synthetics
1335
1693
  params: params,
1336
1694
  config: config)
1337
1695
  context[:gem_name] = 'aws-sdk-synthetics'
1338
- context[:gem_version] = '1.25.0'
1696
+ context[:gem_version] = '1.28.0'
1339
1697
  Seahorse::Client::Request.new(handlers, context)
1340
1698
  end
1341
1699