aws-sdk-synthetics 1.27.0 → 1.29.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-synthetics/client.rb +399 -31
- data/lib/aws-sdk-synthetics/client_api.rb +249 -12
- data/lib/aws-sdk-synthetics/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-synthetics/endpoint_provider.rb +112 -0
- data/lib/aws-sdk-synthetics/endpoints.rb +309 -0
- data/lib/aws-sdk-synthetics/errors.rb +80 -0
- data/lib/aws-sdk-synthetics/plugins/endpoints.rb +110 -0
- data/lib/aws-sdk-synthetics/types.rb +497 -21
- data/lib/aws-sdk-synthetics.rb +6 -2
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f62625d3b98f340891246ab7fd163e536f92d6da62e0eebc2230455bade9f606
|
4
|
+
data.tar.gz: a91e66e33614afe2d736eae7fc10eff38cd57a1c714745b1b8f238b5f250767c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5152430936bf0f7604e83f755e3f826670cd58a610aaf6d4db21f4e1f1774e40c388dc2bfab11becbe28b2e5ebd8a9f205b50272f8ff2d8f2d8eeaeee5439c4c
|
7
|
+
data.tar.gz: 29eb2011917eac10fdde20f7dcb1aac9c1b2cdd95ed42d09ccb2846c67d3396624d4277a3223ba72360733e35a9ba4cb6257c3b23ab599a6cc062e916f98467b
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.29.0 (2022-10-25)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.28.0 (2022-07-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release introduces Group feature, which enables users to group cross-region canaries.
|
13
|
+
|
4
14
|
1.27.0 (2022-05-02)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.29.0
|
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:synthetics)
|
@@ -79,8 +79,9 @@ module Aws::Synthetics
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::Synthetics::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -287,6 +288,19 @@ module Aws::Synthetics
|
|
287
288
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
289
|
# requests are made, and retries are disabled.
|
289
290
|
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
290
304
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
305
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
306
|
# will be used if available.
|
@@ -300,6 +314,9 @@ module Aws::Synthetics
|
|
300
314
|
# When `true`, request parameters are validated before
|
301
315
|
# sending the request.
|
302
316
|
#
|
317
|
+
# @option options [Aws::Synthetics::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Synthetics::EndpointParameters`
|
319
|
+
#
|
303
320
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
321
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
322
|
#
|
@@ -351,6 +368,38 @@ module Aws::Synthetics
|
|
351
368
|
|
352
369
|
# @!group API Operations
|
353
370
|
|
371
|
+
# Associates a canary with a group. Using groups can help you with
|
372
|
+
# managing and automating your canaries, and you can also view
|
373
|
+
# aggregated run results and statistics for all canaries in a group.
|
374
|
+
#
|
375
|
+
# You must run this operation in the Region where the canary exists.
|
376
|
+
#
|
377
|
+
# @option params [required, String] :group_identifier
|
378
|
+
# Specifies the group. You can specify the group name, the ARN, or the
|
379
|
+
# group ID as the `GroupIdentifier`.
|
380
|
+
#
|
381
|
+
# @option params [required, String] :resource_arn
|
382
|
+
# The ARN of the canary that you want to associate with the specified
|
383
|
+
# group.
|
384
|
+
#
|
385
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
386
|
+
#
|
387
|
+
# @example Request syntax with placeholder values
|
388
|
+
#
|
389
|
+
# resp = client.associate_resource({
|
390
|
+
# group_identifier: "GroupIdentifier", # required
|
391
|
+
# resource_arn: "CanaryArn", # required
|
392
|
+
# })
|
393
|
+
#
|
394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResource AWS API Documentation
|
395
|
+
#
|
396
|
+
# @overload associate_resource(params = {})
|
397
|
+
# @param [Hash] params ({})
|
398
|
+
def associate_resource(params = {}, options = {})
|
399
|
+
req = build_request(:associate_resource, params)
|
400
|
+
req.send_request(options)
|
401
|
+
end
|
402
|
+
|
354
403
|
# Creates a canary. Canaries are scripts that monitor your endpoints and
|
355
404
|
# APIs from the outside-in. Canaries help you check the availability and
|
356
405
|
# latency of your web services and troubleshoot anomalies by
|
@@ -362,7 +411,7 @@ module Aws::Synthetics
|
|
362
411
|
#
|
363
412
|
# To create canaries, you must have the `CloudWatchSyntheticsFullAccess`
|
364
413
|
# policy. If you are creating a new IAM role for the canary, you also
|
365
|
-
# need the
|
414
|
+
# need the `iam:CreateRole`, `iam:CreatePolicy` and
|
366
415
|
# `iam:AttachRolePolicy` permissions. For more information, see
|
367
416
|
# [Necessary Roles and Permissions][2].
|
368
417
|
#
|
@@ -427,7 +476,10 @@ module Aws::Synthetics
|
|
427
476
|
#
|
428
477
|
# @option params [Types::CanaryRunConfigInput] :run_config
|
429
478
|
# A structure that contains the configuration for individual canary
|
430
|
-
# runs, such as timeout value.
|
479
|
+
# runs, such as timeout value and environment variables.
|
480
|
+
#
|
481
|
+
# The environment variables keys and values are not encrypted. Do not
|
482
|
+
# store sensitive information in this field.
|
431
483
|
#
|
432
484
|
# @option params [Integer] :success_retention_period_in_days
|
433
485
|
# The number of days to retain data about successful runs of this
|
@@ -565,12 +617,83 @@ module Aws::Synthetics
|
|
565
617
|
req.send_request(options)
|
566
618
|
end
|
567
619
|
|
620
|
+
# Creates a group which you can use to associate canaries with each
|
621
|
+
# other, including cross-Region canaries. Using groups can help you with
|
622
|
+
# managing and automating your canaries, and you can also view
|
623
|
+
# aggregated run results and statistics for all canaries in a group.
|
624
|
+
#
|
625
|
+
# Groups are global resources. When you create a group, it is replicated
|
626
|
+
# across Amazon Web Services Regions, and you can view it and add
|
627
|
+
# canaries to it from any Region. Although the group ARN format reflects
|
628
|
+
# the Region name where it was created, a group is not constrained to
|
629
|
+
# any Region. This means that you can put canaries from multiple Regions
|
630
|
+
# into the same group, and then use that group to view and manage all of
|
631
|
+
# those canaries in a single view.
|
632
|
+
#
|
633
|
+
# Groups are supported in all Regions except the Regions that are
|
634
|
+
# disabled by default. For more information about these Regions, see
|
635
|
+
# [Enabling a Region][1].
|
636
|
+
#
|
637
|
+
# Each group can contain as many as 10 canaries. You can have as many as
|
638
|
+
# 20 groups in your account. Any single canary can be a member of up to
|
639
|
+
# 10 groups.
|
640
|
+
#
|
641
|
+
#
|
642
|
+
#
|
643
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
|
644
|
+
#
|
645
|
+
# @option params [required, String] :name
|
646
|
+
# The name for the group. It can include any Unicode characters.
|
647
|
+
#
|
648
|
+
# The names for all groups in your account, across all Regions, must be
|
649
|
+
# unique.
|
650
|
+
#
|
651
|
+
# @option params [Hash<String,String>] :tags
|
652
|
+
# A list of key-value pairs to associate with the group. You can
|
653
|
+
# associate as many as 50 tags with a group.
|
654
|
+
#
|
655
|
+
# Tags can help you organize and categorize your resources. You can also
|
656
|
+
# use them to scope user permissions, by granting a user permission to
|
657
|
+
# access or change only the resources that have certain tag values.
|
658
|
+
#
|
659
|
+
# @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
660
|
+
#
|
661
|
+
# * {Types::CreateGroupResponse#group #group} => Types::Group
|
662
|
+
#
|
663
|
+
# @example Request syntax with placeholder values
|
664
|
+
#
|
665
|
+
# resp = client.create_group({
|
666
|
+
# name: "GroupName", # required
|
667
|
+
# tags: {
|
668
|
+
# "TagKey" => "TagValue",
|
669
|
+
# },
|
670
|
+
# })
|
671
|
+
#
|
672
|
+
# @example Response structure
|
673
|
+
#
|
674
|
+
# resp.group.id #=> String
|
675
|
+
# resp.group.name #=> String
|
676
|
+
# resp.group.arn #=> String
|
677
|
+
# resp.group.tags #=> Hash
|
678
|
+
# resp.group.tags["TagKey"] #=> String
|
679
|
+
# resp.group.created_time #=> Time
|
680
|
+
# resp.group.last_modified_time #=> Time
|
681
|
+
#
|
682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroup AWS API Documentation
|
683
|
+
#
|
684
|
+
# @overload create_group(params = {})
|
685
|
+
# @param [Hash] params ({})
|
686
|
+
def create_group(params = {}, options = {})
|
687
|
+
req = build_request(:create_group, params)
|
688
|
+
req.send_request(options)
|
689
|
+
end
|
690
|
+
|
568
691
|
# Permanently deletes the specified canary.
|
569
692
|
#
|
570
693
|
# If you specify `DeleteLambda` to `true`, CloudWatch Synthetics also
|
571
694
|
# deletes the Lambda functions and layers that are used by the canary.
|
572
695
|
#
|
573
|
-
# Other
|
696
|
+
# Other resources used and created by the canary are not automatically
|
574
697
|
# deleted. After you delete a canary that you do not intend to use
|
575
698
|
# again, you should also delete the following:
|
576
699
|
#
|
@@ -624,6 +747,35 @@ module Aws::Synthetics
|
|
624
747
|
req.send_request(options)
|
625
748
|
end
|
626
749
|
|
750
|
+
# Deletes a group. The group doesn't need to be empty to be deleted. If
|
751
|
+
# there are canaries in the group, they are not deleted when you delete
|
752
|
+
# the group.
|
753
|
+
#
|
754
|
+
# Groups are a global resource that appear in all Regions, but the
|
755
|
+
# request to delete a group must be made from its home Region. You can
|
756
|
+
# find the home Region of a group within its ARN.
|
757
|
+
#
|
758
|
+
# @option params [required, String] :group_identifier
|
759
|
+
# Specifies which group to delete. You can specify the group name, the
|
760
|
+
# ARN, or the group ID as the `GroupIdentifier`.
|
761
|
+
#
|
762
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
763
|
+
#
|
764
|
+
# @example Request syntax with placeholder values
|
765
|
+
#
|
766
|
+
# resp = client.delete_group({
|
767
|
+
# group_identifier: "GroupIdentifier", # required
|
768
|
+
# })
|
769
|
+
#
|
770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroup AWS API Documentation
|
771
|
+
#
|
772
|
+
# @overload delete_group(params = {})
|
773
|
+
# @param [Hash] params ({})
|
774
|
+
def delete_group(params = {}, options = {})
|
775
|
+
req = build_request(:delete_group, params)
|
776
|
+
req.send_request(options)
|
777
|
+
end
|
778
|
+
|
627
779
|
# This operation returns a list of the canaries in your account, along
|
628
780
|
# with full details about each canary.
|
629
781
|
#
|
@@ -757,8 +909,8 @@ module Aws::Synthetics
|
|
757
909
|
#
|
758
910
|
# @option params [String] :next_token
|
759
911
|
# A token that indicates that there is more data available. You can use
|
760
|
-
# this token in a subsequent `
|
761
|
-
# the next set of results.
|
912
|
+
# this token in a subsequent `DescribeCanariesLastRun` operation to
|
913
|
+
# retrieve the next set of results.
|
762
914
|
#
|
763
915
|
# @option params [Integer] :max_results
|
764
916
|
# Specify this parameter to limit how many runs are returned each time
|
@@ -870,6 +1022,35 @@ module Aws::Synthetics
|
|
870
1022
|
req.send_request(options)
|
871
1023
|
end
|
872
1024
|
|
1025
|
+
# Removes a canary from a group. You must run this operation in the
|
1026
|
+
# Region where the canary exists.
|
1027
|
+
#
|
1028
|
+
# @option params [required, String] :group_identifier
|
1029
|
+
# Specifies the group. You can specify the group name, the ARN, or the
|
1030
|
+
# group ID as the `GroupIdentifier`.
|
1031
|
+
#
|
1032
|
+
# @option params [required, String] :resource_arn
|
1033
|
+
# The ARN of the canary that you want to remove from the specified
|
1034
|
+
# group.
|
1035
|
+
#
|
1036
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1037
|
+
#
|
1038
|
+
# @example Request syntax with placeholder values
|
1039
|
+
#
|
1040
|
+
# resp = client.disassociate_resource({
|
1041
|
+
# group_identifier: "GroupIdentifier", # required
|
1042
|
+
# resource_arn: "CanaryArn", # required
|
1043
|
+
# })
|
1044
|
+
#
|
1045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResource AWS API Documentation
|
1046
|
+
#
|
1047
|
+
# @overload disassociate_resource(params = {})
|
1048
|
+
# @param [Hash] params ({})
|
1049
|
+
def disassociate_resource(params = {}, options = {})
|
1050
|
+
req = build_request(:disassociate_resource, params)
|
1051
|
+
req.send_request(options)
|
1052
|
+
end
|
1053
|
+
|
873
1054
|
# Retrieves complete information about one canary. You must specify the
|
874
1055
|
# name of the canary that you want. To get a list of canaries and their
|
875
1056
|
# names, use [DescribeCanaries][1].
|
@@ -991,14 +1172,192 @@ module Aws::Synthetics
|
|
991
1172
|
req.send_request(options)
|
992
1173
|
end
|
993
1174
|
|
994
|
-
#
|
1175
|
+
# Returns information about one group. Groups are a global resource, so
|
1176
|
+
# you can use this operation from any Region.
|
1177
|
+
#
|
1178
|
+
# @option params [required, String] :group_identifier
|
1179
|
+
# Specifies the group to return information for. You can specify the
|
1180
|
+
# group name, the ARN, or the group ID as the `GroupIdentifier`.
|
1181
|
+
#
|
1182
|
+
# @return [Types::GetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1183
|
+
#
|
1184
|
+
# * {Types::GetGroupResponse#group #group} => Types::Group
|
1185
|
+
#
|
1186
|
+
# @example Request syntax with placeholder values
|
1187
|
+
#
|
1188
|
+
# resp = client.get_group({
|
1189
|
+
# group_identifier: "GroupIdentifier", # required
|
1190
|
+
# })
|
1191
|
+
#
|
1192
|
+
# @example Response structure
|
1193
|
+
#
|
1194
|
+
# resp.group.id #=> String
|
1195
|
+
# resp.group.name #=> String
|
1196
|
+
# resp.group.arn #=> String
|
1197
|
+
# resp.group.tags #=> Hash
|
1198
|
+
# resp.group.tags["TagKey"] #=> String
|
1199
|
+
# resp.group.created_time #=> Time
|
1200
|
+
# resp.group.last_modified_time #=> Time
|
1201
|
+
#
|
1202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroup AWS API Documentation
|
1203
|
+
#
|
1204
|
+
# @overload get_group(params = {})
|
1205
|
+
# @param [Hash] params ({})
|
1206
|
+
def get_group(params = {}, options = {})
|
1207
|
+
req = build_request(:get_group, params)
|
1208
|
+
req.send_request(options)
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
# Returns a list of the groups that the specified canary is associated
|
1212
|
+
# with. The canary that you specify must be in the current Region.
|
1213
|
+
#
|
1214
|
+
# @option params [String] :next_token
|
1215
|
+
# A token that indicates that there is more data available. You can use
|
1216
|
+
# this token in a subsequent operation to retrieve the next set of
|
1217
|
+
# results.
|
1218
|
+
#
|
1219
|
+
# @option params [Integer] :max_results
|
1220
|
+
# Specify this parameter to limit how many groups are returned each time
|
1221
|
+
# you use the `ListAssociatedGroups` operation. If you omit this
|
1222
|
+
# parameter, the default of 20 is used.
|
995
1223
|
#
|
996
1224
|
# @option params [required, String] :resource_arn
|
997
|
-
# The ARN of the canary that you want to view
|
1225
|
+
# The ARN of the canary that you want to view groups for.
|
1226
|
+
#
|
1227
|
+
# @return [Types::ListAssociatedGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1228
|
+
#
|
1229
|
+
# * {Types::ListAssociatedGroupsResponse#groups #groups} => Array<Types::GroupSummary>
|
1230
|
+
# * {Types::ListAssociatedGroupsResponse#next_token #next_token} => String
|
1231
|
+
#
|
1232
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1233
|
+
#
|
1234
|
+
# @example Request syntax with placeholder values
|
1235
|
+
#
|
1236
|
+
# resp = client.list_associated_groups({
|
1237
|
+
# next_token: "PaginationToken",
|
1238
|
+
# max_results: 1,
|
1239
|
+
# resource_arn: "CanaryArn", # required
|
1240
|
+
# })
|
1241
|
+
#
|
1242
|
+
# @example Response structure
|
1243
|
+
#
|
1244
|
+
# resp.groups #=> Array
|
1245
|
+
# resp.groups[0].id #=> String
|
1246
|
+
# resp.groups[0].name #=> String
|
1247
|
+
# resp.groups[0].arn #=> String
|
1248
|
+
# resp.next_token #=> String
|
1249
|
+
#
|
1250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroups AWS API Documentation
|
1251
|
+
#
|
1252
|
+
# @overload list_associated_groups(params = {})
|
1253
|
+
# @param [Hash] params ({})
|
1254
|
+
def list_associated_groups(params = {}, options = {})
|
1255
|
+
req = build_request(:list_associated_groups, params)
|
1256
|
+
req.send_request(options)
|
1257
|
+
end
|
1258
|
+
|
1259
|
+
# This operation returns a list of the ARNs of the canaries that are
|
1260
|
+
# associated with the specified group.
|
1261
|
+
#
|
1262
|
+
# @option params [String] :next_token
|
1263
|
+
# A token that indicates that there is more data available. You can use
|
1264
|
+
# this token in a subsequent operation to retrieve the next set of
|
1265
|
+
# results.
|
1266
|
+
#
|
1267
|
+
# @option params [Integer] :max_results
|
1268
|
+
# Specify this parameter to limit how many canary ARNs are returned each
|
1269
|
+
# time you use the `ListGroupResources` operation. If you omit this
|
1270
|
+
# parameter, the default of 20 is used.
|
1271
|
+
#
|
1272
|
+
# @option params [required, String] :group_identifier
|
1273
|
+
# Specifies the group to return information for. You can specify the
|
1274
|
+
# group name, the ARN, or the group ID as the `GroupIdentifier`.
|
1275
|
+
#
|
1276
|
+
# @return [Types::ListGroupResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1277
|
+
#
|
1278
|
+
# * {Types::ListGroupResourcesResponse#resources #resources} => Array<String>
|
1279
|
+
# * {Types::ListGroupResourcesResponse#next_token #next_token} => String
|
1280
|
+
#
|
1281
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1282
|
+
#
|
1283
|
+
# @example Request syntax with placeholder values
|
1284
|
+
#
|
1285
|
+
# resp = client.list_group_resources({
|
1286
|
+
# next_token: "PaginationToken",
|
1287
|
+
# max_results: 1,
|
1288
|
+
# group_identifier: "GroupIdentifier", # required
|
1289
|
+
# })
|
1290
|
+
#
|
1291
|
+
# @example Response structure
|
1292
|
+
#
|
1293
|
+
# resp.resources #=> Array
|
1294
|
+
# resp.resources[0] #=> String
|
1295
|
+
# resp.next_token #=> String
|
1296
|
+
#
|
1297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResources AWS API Documentation
|
1298
|
+
#
|
1299
|
+
# @overload list_group_resources(params = {})
|
1300
|
+
# @param [Hash] params ({})
|
1301
|
+
def list_group_resources(params = {}, options = {})
|
1302
|
+
req = build_request(:list_group_resources, params)
|
1303
|
+
req.send_request(options)
|
1304
|
+
end
|
1305
|
+
|
1306
|
+
# Returns a list of all groups in the account, displaying their names,
|
1307
|
+
# unique IDs, and ARNs. The groups from all Regions are returned.
|
1308
|
+
#
|
1309
|
+
# @option params [String] :next_token
|
1310
|
+
# A token that indicates that there is more data available. You can use
|
1311
|
+
# this token in a subsequent operation to retrieve the next set of
|
1312
|
+
# results.
|
1313
|
+
#
|
1314
|
+
# @option params [Integer] :max_results
|
1315
|
+
# Specify this parameter to limit how many groups are returned each time
|
1316
|
+
# you use the `ListGroups` operation. If you omit this parameter, the
|
1317
|
+
# default of 20 is used.
|
1318
|
+
#
|
1319
|
+
# @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1320
|
+
#
|
1321
|
+
# * {Types::ListGroupsResponse#groups #groups} => Array<Types::GroupSummary>
|
1322
|
+
# * {Types::ListGroupsResponse#next_token #next_token} => String
|
1323
|
+
#
|
1324
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1325
|
+
#
|
1326
|
+
# @example Request syntax with placeholder values
|
1327
|
+
#
|
1328
|
+
# resp = client.list_groups({
|
1329
|
+
# next_token: "PaginationToken",
|
1330
|
+
# max_results: 1,
|
1331
|
+
# })
|
1332
|
+
#
|
1333
|
+
# @example Response structure
|
1334
|
+
#
|
1335
|
+
# resp.groups #=> Array
|
1336
|
+
# resp.groups[0].id #=> String
|
1337
|
+
# resp.groups[0].name #=> String
|
1338
|
+
# resp.groups[0].arn #=> String
|
1339
|
+
# resp.next_token #=> String
|
1340
|
+
#
|
1341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroups AWS API Documentation
|
1342
|
+
#
|
1343
|
+
# @overload list_groups(params = {})
|
1344
|
+
# @param [Hash] params ({})
|
1345
|
+
def list_groups(params = {}, options = {})
|
1346
|
+
req = build_request(:list_groups, params)
|
1347
|
+
req.send_request(options)
|
1348
|
+
end
|
1349
|
+
|
1350
|
+
# Displays the tags associated with a canary or group.
|
1351
|
+
#
|
1352
|
+
# @option params [required, String] :resource_arn
|
1353
|
+
# The ARN of the canary or group that you want to view tags for.
|
998
1354
|
#
|
999
1355
|
# The ARN format of a canary is
|
1000
1356
|
# `arn:aws:synthetics:Region:account-id:canary:canary-name `.
|
1001
1357
|
#
|
1358
|
+
# The ARN format of a group is
|
1359
|
+
# `arn:aws:synthetics:Region:account-id:group:group-name `
|
1360
|
+
#
|
1002
1361
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1003
1362
|
#
|
1004
1363
|
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
@@ -1006,7 +1365,7 @@ module Aws::Synthetics
|
|
1006
1365
|
# @example Request syntax with placeholder values
|
1007
1366
|
#
|
1008
1367
|
# resp = client.list_tags_for_resource({
|
1009
|
-
# resource_arn: "
|
1368
|
+
# resource_arn: "ResourceArn", # required
|
1010
1369
|
# })
|
1011
1370
|
#
|
1012
1371
|
# @example Response structure
|
@@ -1057,17 +1416,16 @@ module Aws::Synthetics
|
|
1057
1416
|
end
|
1058
1417
|
|
1059
1418
|
# Stops the canary to prevent all future runs. If the canary is
|
1060
|
-
# currently running,
|
1061
|
-
#
|
1062
|
-
#
|
1063
|
-
# recorded in Synthetics as a completed run.
|
1419
|
+
# currently running,the run that is in progress completes on its own,
|
1420
|
+
# publishes metrics, and uploads artifacts, but it is not recorded in
|
1421
|
+
# Synthetics as a completed run.
|
1064
1422
|
#
|
1065
1423
|
# You can use `StartCanary` to start it running again with the canary’s
|
1066
1424
|
# current schedule at any point in the future.
|
1067
1425
|
#
|
1068
1426
|
# @option params [required, String] :name
|
1069
1427
|
# The name of the canary that you want to stop. To find the names of
|
1070
|
-
# your canaries, use [
|
1428
|
+
# your canaries, use [ListCanaries][1].
|
1071
1429
|
#
|
1072
1430
|
#
|
1073
1431
|
#
|
@@ -1090,7 +1448,8 @@ module Aws::Synthetics
|
|
1090
1448
|
req.send_request(options)
|
1091
1449
|
end
|
1092
1450
|
|
1093
|
-
# Assigns one or more tags (key-value pairs) to the specified canary
|
1451
|
+
# Assigns one or more tags (key-value pairs) to the specified canary or
|
1452
|
+
# group.
|
1094
1453
|
#
|
1095
1454
|
# Tags can help you organize and categorize your resources. You can also
|
1096
1455
|
# use them to scope user permissions, by granting a user permission to
|
@@ -1099,29 +1458,33 @@ module Aws::Synthetics
|
|
1099
1458
|
# Tags don't have any semantic meaning to Amazon Web Services and are
|
1100
1459
|
# interpreted strictly as strings of characters.
|
1101
1460
|
#
|
1102
|
-
# You can use the `TagResource` action with a
|
1103
|
-
# tags. If you specify a new tag key for the
|
1104
|
-
# to the list of tags associated with the
|
1105
|
-
# key that is already associated with the
|
1106
|
-
# you specify replaces the previous value for that
|
1461
|
+
# You can use the `TagResource` action with a resource that already has
|
1462
|
+
# tags. If you specify a new tag key for the resource, this tag is
|
1463
|
+
# appended to the list of tags associated with the resource. If you
|
1464
|
+
# specify a tag key that is already associated with the resource, the
|
1465
|
+
# new tag value that you specify replaces the previous value for that
|
1466
|
+
# tag.
|
1107
1467
|
#
|
1108
|
-
# You can associate as many as 50 tags with a canary.
|
1468
|
+
# You can associate as many as 50 tags with a canary or group.
|
1109
1469
|
#
|
1110
1470
|
# @option params [required, String] :resource_arn
|
1111
|
-
# The ARN of the canary that you're adding tags to.
|
1471
|
+
# The ARN of the canary or group that you're adding tags to.
|
1112
1472
|
#
|
1113
1473
|
# The ARN format of a canary is
|
1114
1474
|
# `arn:aws:synthetics:Region:account-id:canary:canary-name `.
|
1115
1475
|
#
|
1476
|
+
# The ARN format of a group is
|
1477
|
+
# `arn:aws:synthetics:Region:account-id:group:group-name `
|
1478
|
+
#
|
1116
1479
|
# @option params [required, Hash<String,String>] :tags
|
1117
|
-
# The list of key-value pairs to associate with the
|
1480
|
+
# The list of key-value pairs to associate with the resource.
|
1118
1481
|
#
|
1119
1482
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1120
1483
|
#
|
1121
1484
|
# @example Request syntax with placeholder values
|
1122
1485
|
#
|
1123
1486
|
# resp = client.tag_resource({
|
1124
|
-
# resource_arn: "
|
1487
|
+
# resource_arn: "ResourceArn", # required
|
1125
1488
|
# tags: { # required
|
1126
1489
|
# "TagKey" => "TagValue",
|
1127
1490
|
# },
|
@@ -1136,14 +1499,17 @@ module Aws::Synthetics
|
|
1136
1499
|
req.send_request(options)
|
1137
1500
|
end
|
1138
1501
|
|
1139
|
-
# Removes one or more tags from the specified
|
1502
|
+
# Removes one or more tags from the specified resource.
|
1140
1503
|
#
|
1141
1504
|
# @option params [required, String] :resource_arn
|
1142
|
-
# The ARN of the canary that you're removing tags from.
|
1505
|
+
# The ARN of the canary or group that you're removing tags from.
|
1143
1506
|
#
|
1144
1507
|
# The ARN format of a canary is
|
1145
1508
|
# `arn:aws:synthetics:Region:account-id:canary:canary-name `.
|
1146
1509
|
#
|
1510
|
+
# The ARN format of a group is
|
1511
|
+
# `arn:aws:synthetics:Region:account-id:group:group-name `
|
1512
|
+
#
|
1147
1513
|
# @option params [required, Array<String>] :tag_keys
|
1148
1514
|
# The list of tag keys to remove from the resource.
|
1149
1515
|
#
|
@@ -1152,7 +1518,7 @@ module Aws::Synthetics
|
|
1152
1518
|
# @example Request syntax with placeholder values
|
1153
1519
|
#
|
1154
1520
|
# resp = client.untag_resource({
|
1155
|
-
# resource_arn: "
|
1521
|
+
# resource_arn: "ResourceArn", # required
|
1156
1522
|
# tag_keys: ["TagKey"], # required
|
1157
1523
|
# })
|
1158
1524
|
#
|
@@ -1165,8 +1531,7 @@ module Aws::Synthetics
|
|
1165
1531
|
req.send_request(options)
|
1166
1532
|
end
|
1167
1533
|
|
1168
|
-
#
|
1169
|
-
# been created.
|
1534
|
+
# Updates the configuration of a canary that has already been created.
|
1170
1535
|
#
|
1171
1536
|
# You can't use this operation to update the tags of an existing
|
1172
1537
|
# canary. To change the tags of an existing canary, use
|
@@ -1228,6 +1593,9 @@ module Aws::Synthetics
|
|
1228
1593
|
# A structure that contains the timeout value that is used for each
|
1229
1594
|
# individual run of the canary.
|
1230
1595
|
#
|
1596
|
+
# The environment variables keys and values are not encrypted. Do not
|
1597
|
+
# store sensitive information in this field.
|
1598
|
+
#
|
1231
1599
|
# @option params [Integer] :success_retention_period_in_days
|
1232
1600
|
# The number of days to retain data about successful runs of this
|
1233
1601
|
# canary.
|
@@ -1342,7 +1710,7 @@ module Aws::Synthetics
|
|
1342
1710
|
params: params,
|
1343
1711
|
config: config)
|
1344
1712
|
context[:gem_name] = 'aws-sdk-synthetics'
|
1345
|
-
context[:gem_version] = '1.
|
1713
|
+
context[:gem_version] = '1.29.0'
|
1346
1714
|
Seahorse::Client::Request.new(handlers, context)
|
1347
1715
|
end
|
1348
1716
|
|