aws-sdk-synthetics 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e90ede807013d574614f641816461a58854c876226b6cd13d404edf5a33485e8
-  data.tar.gz: 665b4ff535fa7a6280e982c0a740eacb888872c85995e153a5943b2652b2708c
+  metadata.gz: 98f3a67056d5afe307f4d95073b8806a50c4420d8a2e1cdb6f9f1dc3a0fb318f
+  data.tar.gz: 0f518697784b5c6c43e96ca7c97d66ae655111300c881a8d0da33799f8e4c151
 SHA512:
-  metadata.gz: 670516f66f038cb78944cb853aebb162d63c1ce1e91b3127baa8f169d4cde3fb55a96d89a82fea4bbc34ef3eb5974cec9b6941d93ce63d5e5145d9421d294c57
-  data.tar.gz: 50819f10eb45d54a35b37a1d24da703c7e5b483d6d3a31d8bb7103cbdc0c080b80680700aed79dd45ea10f370ba2135b3a61e09403e8beecc1046b855a604fc6
+  metadata.gz: d6ce2b4eda9ffff7164b973f530db8437b8770f41bf93067a8feb47d562d766e4d7c76bd911568b0a680785b8c0b3746cbd6ffb231307929646e2bf6348c7fa7
+  data.tar.gz: 3e9698aa61b07e3c9e345a49505488728e0caf5f1e994d9ec4b57c5219306c8e5a28e31b4198ae53d699b594853e6ce9dde00a7d336450c0482f03e0dcd2223c

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.28.0 (2022-07-06)
+------------------
+
+* Feature - This release introduces Group feature, which enables users to group cross-region canaries.
+
 1.27.0 (2022-05-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.27.0
+1.28.0

data/lib/aws-sdk-synthetics/client.rb

@@ -351,6 +351,38 @@ module Aws::Synthetics
 
     # @!group API Operations
 
+    # Associates a canary with a group. Using groups can help you with
+    # managing and automating your canaries, and you can also view
+    # aggregated run results and statistics for all canaries in a group.
+    #
+    # You must run this operation in the Region where the canary exists.
+    #
+    # @option params [required, String] :group_identifier
+    #   Specifies the group. You can specify the group name, the ARN, or the
+    #   group ID as the `GroupIdentifier`.
+    #
+    # @option params [required, String] :resource_arn
+    #   The ARN of the canary that you want to associate with the specified
+    #   group.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.associate_resource({
+    #     group_identifier: "GroupIdentifier", # required
+    #     resource_arn: "CanaryArn", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResource AWS API Documentation
+    #
+    # @overload associate_resource(params = {})
+    # @param [Hash] params ({})
+    def associate_resource(params = {}, options = {})
+      req = build_request(:associate_resource, params)
+      req.send_request(options)
+    end
+
     # 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
@@ -362,7 +394,7 @@ module Aws::Synthetics
     #
     # 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
+    # need the `iam:CreateRole`, `iam:CreatePolicy` and
     # `iam:AttachRolePolicy` permissions. For more information, see
     # [Necessary Roles and Permissions][2].
     #
@@ -427,7 +459,10 @@ module Aws::Synthetics
     #
     # @option params [Types::CanaryRunConfigInput] :run_config
     #   A structure that contains the configuration for individual canary
-    #   runs, such as timeout value.
+    #   runs, such as timeout value and environment variables.
+    #
+    #   The environment variables keys and values are not encrypted. Do not
+    #   store sensitive information in this field.
     #
     # @option params [Integer] :success_retention_period_in_days
     #   The number of days to retain data about successful runs of this
@@ -565,12 +600,83 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
+    # Creates a group which you can use to associate canaries with each
+    # other, including cross-Region canaries. Using groups can help you with
+    # managing and automating your canaries, and you can also view
+    # aggregated run results and statistics for all canaries in a group.
+    #
+    # Groups are global resources. When you create a group, it is replicated
+    # across Amazon Web Services Regions, and you can view it and add
+    # canaries to it from any Region. Although the group ARN format reflects
+    # the Region name where it was created, a group is not constrained to
+    # any Region. This means that you can put canaries from multiple Regions
+    # into the same group, and then use that group to view and manage all of
+    # those canaries in a single view.
+    #
+    # Groups are supported in all Regions except the Regions that are
+    # disabled by default. For more information about these Regions, see
+    # [Enabling a Region][1].
+    #
+    # Each group can contain as many as 10 canaries. You can have as many as
+    # 20 groups in your account. Any single canary can be a member of up to
+    # 10 groups.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
+    #
+    # @option params [required, String] :name
+    #   The name for the group. It can include any Unicode characters.
+    #
+    #   The names for all groups in your account, across all Regions, must be
+    #   unique.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   A list of key-value pairs to associate with the group. You can
+    #   associate as many as 50 tags with a group.
+    #
+    #   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.
+    #
+    # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateGroupResponse#group #group} => Types::Group
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_group({
+    #     name: "GroupName", # required
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.group.id #=> String
+    #   resp.group.name #=> String
+    #   resp.group.arn #=> String
+    #   resp.group.tags #=> Hash
+    #   resp.group.tags["TagKey"] #=> String
+    #   resp.group.created_time #=> Time
+    #   resp.group.last_modified_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroup AWS API Documentation
+    #
+    # @overload create_group(params = {})
+    # @param [Hash] params ({})
+    def create_group(params = {}, options = {})
+      req = build_request(:create_group, params)
+      req.send_request(options)
+    end
+
     # Permanently deletes the specified canary.
     #
     # If you specify `DeleteLambda` to `true`, CloudWatch Synthetics also
     # deletes the Lambda functions and layers that are used by the canary.
     #
-    # Other esources used and created by the canary are not automatically
+    # Other 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:
     #
@@ -624,6 +730,35 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
+    # Deletes a group. The group doesn't need to be empty to be deleted. If
+    # there are canaries in the group, they are not deleted when you delete
+    # the group.
+    #
+    # Groups are a global resource that appear in all Regions, but the
+    # request to delete a group must be made from its home Region. You can
+    # find the home Region of a group within its ARN.
+    #
+    # @option params [required, String] :group_identifier
+    #   Specifies which group to delete. You can specify the group name, the
+    #   ARN, or the group ID as the `GroupIdentifier`.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_group({
+    #     group_identifier: "GroupIdentifier", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroup AWS API Documentation
+    #
+    # @overload delete_group(params = {})
+    # @param [Hash] params ({})
+    def delete_group(params = {}, options = {})
+      req = build_request(:delete_group, params)
+      req.send_request(options)
+    end
+
     # This operation returns a list of the canaries in your account, along
     # with full details about each canary.
     #
@@ -757,8 +892,8 @@ module Aws::Synthetics
     #
     # @option params [String] :next_token
     #   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.
+    #   this token in a subsequent `DescribeCanariesLastRun` operation to
+    #   retrieve the next set of results.
     #
     # @option params [Integer] :max_results
     #   Specify this parameter to limit how many runs are returned each time
@@ -870,6 +1005,35 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
+    # Removes a canary from a group. You must run this operation in the
+    # Region where the canary exists.
+    #
+    # @option params [required, String] :group_identifier
+    #   Specifies the group. You can specify the group name, the ARN, or the
+    #   group ID as the `GroupIdentifier`.
+    #
+    # @option params [required, String] :resource_arn
+    #   The ARN of the canary that you want to remove from the specified
+    #   group.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.disassociate_resource({
+    #     group_identifier: "GroupIdentifier", # required
+    #     resource_arn: "CanaryArn", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResource AWS API Documentation
+    #
+    # @overload disassociate_resource(params = {})
+    # @param [Hash] params ({})
+    def disassociate_resource(params = {}, options = {})
+      req = build_request(:disassociate_resource, params)
+      req.send_request(options)
+    end
+
     # 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][1].
@@ -991,14 +1155,192 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
-    # Displays the tags associated with a canary.
+    # Returns information about one group. Groups are a global resource, so
+    # you can use this operation from any Region.
+    #
+    # @option params [required, String] :group_identifier
+    #   Specifies the group to return information for. You can specify the
+    #   group name, the ARN, or the group ID as the `GroupIdentifier`.
+    #
+    # @return [Types::GetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetGroupResponse#group #group} => Types::Group
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_group({
+    #     group_identifier: "GroupIdentifier", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.group.id #=> String
+    #   resp.group.name #=> String
+    #   resp.group.arn #=> String
+    #   resp.group.tags #=> Hash
+    #   resp.group.tags["TagKey"] #=> String
+    #   resp.group.created_time #=> Time
+    #   resp.group.last_modified_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroup AWS API Documentation
+    #
+    # @overload get_group(params = {})
+    # @param [Hash] params ({})
+    def get_group(params = {}, options = {})
+      req = build_request(:get_group, params)
+      req.send_request(options)
+    end
+
+    # Returns a list of the groups that the specified canary is associated
+    # with. The canary that you specify must be in the current Region.
+    #
+    # @option params [String] :next_token
+    #   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.
+    #
+    # @option params [Integer] :max_results
+    #   Specify this parameter to limit how many groups are returned each time
+    #   you use the `ListAssociatedGroups` operation. If you omit this
+    #   parameter, the default of 20 is used.
+    #
+    # @option params [required, String] :resource_arn
+    #   The ARN of the canary that you want to view groups for.
+    #
+    # @return [Types::ListAssociatedGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListAssociatedGroupsResponse#groups #groups} => Array&lt;Types::GroupSummary&gt;
+    #   * {Types::ListAssociatedGroupsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_associated_groups({
+    #     next_token: "PaginationToken",
+    #     max_results: 1,
+    #     resource_arn: "CanaryArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.groups #=> Array
+    #   resp.groups[0].id #=> String
+    #   resp.groups[0].name #=> String
+    #   resp.groups[0].arn #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroups AWS API Documentation
+    #
+    # @overload list_associated_groups(params = {})
+    # @param [Hash] params ({})
+    def list_associated_groups(params = {}, options = {})
+      req = build_request(:list_associated_groups, params)
+      req.send_request(options)
+    end
+
+    # This operation returns a list of the ARNs of the canaries that are
+    # associated with the specified group.
+    #
+    # @option params [String] :next_token
+    #   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.
+    #
+    # @option params [Integer] :max_results
+    #   Specify this parameter to limit how many canary ARNs are returned each
+    #   time you use the `ListGroupResources` operation. If you omit this
+    #   parameter, the default of 20 is used.
+    #
+    # @option params [required, String] :group_identifier
+    #   Specifies the group to return information for. You can specify the
+    #   group name, the ARN, or the group ID as the `GroupIdentifier`.
+    #
+    # @return [Types::ListGroupResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListGroupResourcesResponse#resources #resources} => Array&lt;String&gt;
+    #   * {Types::ListGroupResourcesResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_group_resources({
+    #     next_token: "PaginationToken",
+    #     max_results: 1,
+    #     group_identifier: "GroupIdentifier", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.resources #=> Array
+    #   resp.resources[0] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResources AWS API Documentation
+    #
+    # @overload list_group_resources(params = {})
+    # @param [Hash] params ({})
+    def list_group_resources(params = {}, options = {})
+      req = build_request(:list_group_resources, params)
+      req.send_request(options)
+    end
+
+    # Returns a list of all groups in the account, displaying their names,
+    # unique IDs, and ARNs. The groups from all Regions are returned.
+    #
+    # @option params [String] :next_token
+    #   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.
+    #
+    # @option params [Integer] :max_results
+    #   Specify this parameter to limit how many groups are returned each time
+    #   you use the `ListGroups` operation. If you omit this parameter, the
+    #   default of 20 is used.
+    #
+    # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListGroupsResponse#groups #groups} => Array&lt;Types::GroupSummary&gt;
+    #   * {Types::ListGroupsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_groups({
+    #     next_token: "PaginationToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.groups #=> Array
+    #   resp.groups[0].id #=> String
+    #   resp.groups[0].name #=> String
+    #   resp.groups[0].arn #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroups AWS API Documentation
+    #
+    # @overload list_groups(params = {})
+    # @param [Hash] params ({})
+    def list_groups(params = {}, options = {})
+      req = build_request(:list_groups, params)
+      req.send_request(options)
+    end
+
+    # Displays the tags associated with a canary or group.
     #
     # @option params [required, String] :resource_arn
-    #   The ARN of the canary that you want to view tags for.
+    #   The ARN of the canary or group that you want to view tags for.
     #
     #   The ARN format of a canary is
     #   `arn:aws:synthetics:Region:account-id:canary:canary-name `.
     #
+    #   The ARN format of a group is
+    #   `arn:aws:synthetics:Region:account-id:group:group-name `
+    #
     # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -1006,7 +1348,7 @@ module Aws::Synthetics
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_tags_for_resource({
-    #     resource_arn: "CanaryArn", # required
+    #     resource_arn: "ResourceArn", # required
     #   })
     #
     # @example Response structure
@@ -1057,17 +1399,16 @@ module Aws::Synthetics
     end
 
     # 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.
+    # currently running,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.
     #
     # @option params [required, String] :name
     #   The name of the canary that you want to stop. To find the names of
-    #   your canaries, use [DescribeCanaries][1].
+    #   your canaries, use [ListCanaries][1].
     #
     #
     #
@@ -1090,7 +1431,8 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
-    # Assigns one or more tags (key-value pairs) to the specified canary.
+    # Assigns one or more tags (key-value pairs) to the specified canary or
+    # group.
     #
     # Tags can help you organize and categorize your resources. You can also
     # use them to scope user permissions, by granting a user permission to
@@ -1099,29 +1441,33 @@ module Aws::Synthetics
     # Tags don't have any semantic meaning to Amazon Web Services 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 use the `TagResource` action with a resource that already has
+    # tags. If you specify a new tag key for the resource, this tag is
+    # appended to the list of tags associated with the resource. If you
+    # specify a tag key that is already associated with the resource, 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.
+    # You can associate as many as 50 tags with a canary or group.
     #
     # @option params [required, String] :resource_arn
-    #   The ARN of the canary that you're adding tags to.
+    #   The ARN of the canary or group that you're adding tags to.
     #
     #   The ARN format of a canary is
     #   `arn:aws:synthetics:Region:account-id:canary:canary-name `.
     #
+    #   The ARN format of a group is
+    #   `arn:aws:synthetics:Region:account-id:group:group-name `
+    #
     # @option params [required, Hash<String,String>] :tags
-    #   The list of key-value pairs to associate with the canary.
+    #   The list of key-value pairs to associate with the resource.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.tag_resource({
-    #     resource_arn: "CanaryArn", # required
+    #     resource_arn: "ResourceArn", # required
     #     tags: { # required
     #       "TagKey" => "TagValue",
     #     },
@@ -1136,14 +1482,17 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
-    # Removes one or more tags from the specified canary.
+    # Removes one or more tags from the specified resource.
     #
     # @option params [required, String] :resource_arn
-    #   The ARN of the canary that you're removing tags from.
+    #   The ARN of the canary or group that you're removing tags from.
     #
     #   The ARN format of a canary is
     #   `arn:aws:synthetics:Region:account-id:canary:canary-name `.
     #
+    #   The ARN format of a group is
+    #   `arn:aws:synthetics:Region:account-id:group:group-name `
+    #
     # @option params [required, Array<String>] :tag_keys
     #   The list of tag keys to remove from the resource.
     #
@@ -1152,7 +1501,7 @@ module Aws::Synthetics
     # @example Request syntax with placeholder values
     #
     #   resp = client.untag_resource({
-    #     resource_arn: "CanaryArn", # required
+    #     resource_arn: "ResourceArn", # required
     #     tag_keys: ["TagKey"], # required
     #   })
     #
@@ -1165,8 +1514,7 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
-    # Use this operation to change the settings of a canary that has already
-    # been created.
+    # Updates the configuration 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
@@ -1228,6 +1576,9 @@ module Aws::Synthetics
     #   A structure that contains the timeout value that is used for each
     #   individual run of the canary.
     #
+    #   The environment variables keys and values are not encrypted. Do not
+    #   store sensitive information in this field.
+    #
     # @option params [Integer] :success_retention_period_in_days
     #   The number of days to retain data about successful runs of this
     #   canary.
@@ -1342,7 +1693,7 @@ module Aws::Synthetics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.27.0'
+      context[:gem_version] = '1.28.0'
       Seahorse::Client::Request.new(handlers, context)
     end