aws-sdk-servicediscovery 1.21.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e64ff7ce50ce56d23b15d666811fc167ea242e18c89c9a74514d1405f9d746e
-  data.tar.gz: 5cf8488e8935bc78f98ed8ddf44e0247bfa70bb7d35d881514bbc3a4cb19d8e2
+  metadata.gz: ba0f0c9d82125cb5267c5ca9c248a901f64ba2c1dac13be0631b3dbd9de9a827
+  data.tar.gz: e859879cb185def6b8c189f742deb8a929e97764670f85f23a8625aef6239b9b
 SHA512:
-  metadata.gz: b4450d7cb912a3a16406c392052bff114878644d998a6145ccf30b0699e611c461a114136f31c03268a796b3f2d3d8eab47ef8d9bc4f9057d625ac9a7c1704db
-  data.tar.gz: dfd907bed860d514c492732e031d6a2cafb930bee0aed93891d78c567d4aac5301795b7065b2173a2954ab9b3962f2bad90281ddeea58767cd52210e525286a3
+  metadata.gz: 3489c4c9a017239c54626b5d7073c505b5315fb510dd82385c904e18b136b823889cca72efcc16a2afad7f35a86b9af4c2b2fe5022b30a66b1df2080e4d052b5
+  data.tar.gz: 0ee1513d2c9ad5b2117b2a77f666c4c6d0d40bad541f67376b39a58e1e8c980699132b9bf8585d679a17d233302d94a08d4fe6b6a866cfd00cbd542116bb0442

data/lib/aws-sdk-servicediscovery.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-servicediscovery/customizations'
 # @service
 module Aws::ServiceDiscovery
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.26.0'
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
@@ -69,6 +72,7 @@ module Aws::ServiceDiscovery
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
 
@@ -105,7 +109,7 @@ module Aws::ServiceDiscovery
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -161,7 +165,7 @@ module Aws::ServiceDiscovery
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +180,7 @@ module Aws::ServiceDiscovery
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -345,16 +349,44 @@ module Aws::ServiceDiscovery
     # @option params [String] :description
     #   A description for the namespace.
     #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags to add to the namespace. Each tag consists of a key and an
+    #   optional value, both of which you define. Tag keys can have a maximum
+    #   character length of 128 characters, and tag values can have a maximum
+    #   length of 256 characters.
+    #
     # @return [Types::CreateHttpNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateHttpNamespaceResponse#operation_id #operation_id} => String
     #
+    #
+    # @example Example: CreateHttpNamespace example
+    #
+    #   # This example creates an HTTP namespace.
+    #
+    #   resp = client.create_http_namespace({
+    #     creator_request_id: "example-creator-request-id-0001", 
+    #     description: "Example.com AWS Cloud Map HTTP Namespace", 
+    #     name: "example-http.com", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     operation_id: "httpvoqozuhfet5kzxoxg-a-response-example", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_http_namespace({
     #     name: "NamespaceName", # required
     #     creator_request_id: "ResourceId",
     #     description: "ResourceDescription",
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -403,6 +435,12 @@ module Aws::ServiceDiscovery
     #   The ID of the Amazon VPC that you want to associate the namespace
     #   with.
     #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags to add to the namespace. Each tag consists of a key and an
+    #   optional value, both of which you define. Tag keys can have a maximum
+    #   character length of 128 characters, and tag values can have a maximum
+    #   length of 256 characters.
+    #
     # @return [Types::CreatePrivateDnsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreatePrivateDnsNamespaceResponse#operation_id #operation_id} => String
@@ -430,6 +468,12 @@ module Aws::ServiceDiscovery
     #     creator_request_id: "ResourceId",
     #     description: "ResourceDescription",
     #     vpc: "ResourceId", # required
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -472,16 +516,44 @@ module Aws::ServiceDiscovery
     # @option params [String] :description
     #   A description for the namespace.
     #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags to add to the namespace. Each tag consists of a key and an
+    #   optional value, both of which you define. Tag keys can have a maximum
+    #   character length of 128 characters, and tag values can have a maximum
+    #   length of 256 characters.
+    #
     # @return [Types::CreatePublicDnsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreatePublicDnsNamespaceResponse#operation_id #operation_id} => String
     #
+    #
+    # @example Example: CreatePublicDnsNamespace example
+    #
+    #   # This example creates a public namespace based on DNS.
+    #
+    #   resp = client.create_public_dns_namespace({
+    #     creator_request_id: "example-creator-request-id-0003", 
+    #     description: "Example.com AWS Cloud Map Public DNS Namespace", 
+    #     name: "example-public-dns.com", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     operation_id: "dns2voqozuhfet5kzxoxg-a-response-example", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_public_dns_namespace({
     #     name: "NamespaceName", # required
     #     creator_request_id: "ResourceId",
     #     description: "ResourceDescription",
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -595,6 +667,12 @@ module Aws::ServiceDiscovery
     #   You can't add, update, or delete a `HealthCheckCustomConfig`
     #   configuration from an existing service.
     #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags to add to the service. Each tag consists of a key and an
+    #   optional value, both of which you define. Tag keys can have a maximum
+    #   character length of 128 characters, and tag values can have a maximum
+    #   length of 256 characters.
+    #
     # @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateServiceResponse#service #service} => Types::Service
@@ -667,6 +745,12 @@ module Aws::ServiceDiscovery
     #     health_check_custom_config: {
     #       failure_threshold: 1,
     #     },
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -933,6 +1017,30 @@ module Aws::ServiceDiscovery
     #
     #   * {Types::GetInstanceResponse#instance #instance} => Types::Instance
     #
+    #
+    # @example Example: GetInstance example
+    #
+    #   # This example gets information about a specified instance.
+    #
+    #   resp = client.get_instance({
+    #     instance_id: "i-abcd1234", 
+    #     service_id: "srv-e4anhexample0004", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     instance: {
+    #       attributes: {
+    #         "AWS_INSTANCE_IPV4" => "192.0.2.44", 
+    #         "AWS_INSTANCE_PORT" => "80", 
+    #         "color" => "green", 
+    #         "region" => "us-west-2", 
+    #         "stage" => "beta", 
+    #       }, 
+    #       id: "i-abcd1234", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_instance({
@@ -1004,6 +1112,23 @@ module Aws::ServiceDiscovery
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: GetInstancesHealthStatus example
+    #
+    #   # This example gets the current health status of one or more instances that are associate with a specified service.
+    #
+    #   resp = client.get_instances_health_status({
+    #     service_id: "srv-e4anhexample0004", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     status: {
+    #       "i-abcd1234" => "HEALTHY", 
+    #       "i-abcd1235" => "UNHEALTHY", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_instances_health_status({
@@ -1037,6 +1162,35 @@ module Aws::ServiceDiscovery
     #
     #   * {Types::GetNamespaceResponse#namespace #namespace} => Types::Namespace
     #
+    #
+    # @example Example: GetNamespace example
+    #
+    #   # This example gets information about a specified namespace.
+    #
+    #   resp = client.get_namespace({
+    #     id: "ns-e4anhexample0004", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     namespace: {
+    #       arn: "arn:aws:servicediscovery:us-west-2: 123456789120:namespace/ns-e1tpmexample0001", 
+    #       create_date: Time.parse("20181118T211712Z"), 
+    #       creator_request_id: "example-creator-request-id-0001", 
+    #       description: "Example.com AWS Cloud Map HTTP Namespace", 
+    #       id: "ns-e1tpmexample0001", 
+    #       name: "example-http.com", 
+    #       properties: {
+    #         dns_properties: {
+    #         }, 
+    #         http_properties: {
+    #           http_name: "example-http.com", 
+    #         }, 
+    #       }, 
+    #       type: "HTTP", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_namespace({
@@ -1143,6 +1297,33 @@ module Aws::ServiceDiscovery
     #
     #   * {Types::GetServiceResponse#service #service} => Types::Service
     #
+    #
+    # @example Example: GetService Example
+    #
+    #   # This example gets the settings for a specified service.
+    #
+    #   resp = client.get_service({
+    #     id: "srv-e4anhexample0004", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     service: {
+    #       arn: "arn:aws:servicediscovery:us-west-2:123456789120:service/srv-e4anhexample0004", 
+    #       create_date: Time.parse("20181118T211707Z"), 
+    #       creator_request_id: "example-creator-request-id-0004", 
+    #       description: "Example.com AWS Cloud Map HTTP Service", 
+    #       health_check_config: {
+    #         failure_threshold: 3, 
+    #         resource_path: "/", 
+    #         type: "HTTPS", 
+    #       }, 
+    #       id: "srv-e4anhexample0004", 
+    #       name: "example-http-service", 
+    #       namespace_id: "ns-e4anhexample0004", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_service({
@@ -1421,6 +1602,42 @@ module Aws::ServiceDiscovery
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: ListOperations Example
+    #
+    #   # This example gets the operations that have a STATUS of either PENDING or SUCCESS.
+    #
+    #   resp = client.list_operations({
+    #     filters: [
+    #       {
+    #         condition: "IN", 
+    #         name: "STATUS", 
+    #         values: [
+    #           "PENDING", 
+    #           "SUCCESS", 
+    #         ], 
+    #       }, 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     operations: [
+    #       {
+    #         id: "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample", 
+    #         status: "SUCCESS", 
+    #       }, 
+    #       {
+    #         id: "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample", 
+    #         status: "SUCCESS", 
+    #       }, 
+    #       {
+    #         id: "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example", 
+    #         status: "PENDING", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_operations({
@@ -1560,6 +1777,60 @@ module Aws::ServiceDiscovery
       req.send_request(options)
     end
 
+    # Lists tags for the specified resource.
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Name (ARN) of the resource that you want to
+    #   retrieve tags for.
+    #
+    # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
+    #
+    #
+    # @example Example: ListTagsForResource example
+    #
+    #   # This example lists the tags of a resource.
+    #
+    #   resp = client.list_tags_for_resource({
+    #     resource_arn: "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     tags: [
+    #       {
+    #         key: "Project", 
+    #         value: "Zeta", 
+    #       }, 
+    #       {
+    #         key: "Department", 
+    #         value: "Engineering", 
+    #       }, 
+    #     ], 
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_tags_for_resource({
+    #     resource_arn: "AmazonResourceName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.tags #=> Array
+    #   resp.tags[0].key #=> String
+    #   resp.tags[0].value #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListTagsForResource AWS API Documentation
+    #
+    # @overload list_tags_for_resource(params = {})
+    # @param [Hash] params ({})
+    def list_tags_for_resource(params = {}, options = {})
+      req = build_request(:list_tags_for_resource, params)
+      req.send_request(options)
+    end
+
     # Creates or updates one or more records and, optionally, creates a
     # health check based on the settings in a specified service. When you
     # submit a `RegisterInstance` request, the following occurs:
@@ -1737,7 +2008,9 @@ module Aws::ServiceDiscovery
     #
     #   You can add up to 30 custom attributes. For each key-value pair, the
     #   maximum length of the attribute name is 255 characters, and the
-    #   maximum length of the attribute value is 1,024 characters.
+    #   maximum length of the attribute value is 1,024 characters. Total size
+    #   of all provided attributes (sum of all keys and values) must not
+    #   exceed 5,000 characters.
     #
     #
     #
@@ -1791,6 +2064,107 @@ module Aws::ServiceDiscovery
       req.send_request(options)
     end
 
+    # Adds one or more tags to the specified resource.
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Name (ARN) of the resource that you want to
+    #   retrieve tags for.
+    #
+    # @option params [required, Array<Types::Tag>] :tags
+    #   The tags to add to the specified resource. Specifying the tag key is
+    #   required. You can set the value of a tag to an empty string, but you
+    #   can't set the value of a tag to null.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    #
+    # @example Example: TagResource example
+    #
+    #   # This example adds "Department" and "Project" tags to a resource.
+    #
+    #   resp = client.tag_resource({
+    #     resource_arn: "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm", 
+    #     tags: [
+    #       {
+    #         key: "Department", 
+    #         value: "Engineering", 
+    #       }, 
+    #       {
+    #         key: "Project", 
+    #         value: "Zeta", 
+    #       }, 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.tag_resource({
+    #     resource_arn: "AmazonResourceName", # required
+    #     tags: [ # required
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/TagResource AWS API Documentation
+    #
+    # @overload tag_resource(params = {})
+    # @param [Hash] params ({})
+    def tag_resource(params = {}, options = {})
+      req = build_request(:tag_resource, params)
+      req.send_request(options)
+    end
+
+    # Removes one or more tags from the specified resource.
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Name (ARN) of the resource that you want to
+    #   retrieve tags for.
+    #
+    # @option params [required, Array<String>] :tag_keys
+    #   The tag keys to remove from the specified resource.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    #
+    # @example Example: UntagResource example
+    #
+    #   # This example removes the "Department" and "Project" tags from a resource.
+    #
+    #   resp = client.untag_resource({
+    #     resource_arn: "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm", 
+    #     tag_keys: [
+    #       "Project", 
+    #       "Department", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.untag_resource({
+    #     resource_arn: "AmazonResourceName", # required
+    #     tag_keys: ["TagKey"], # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UntagResource AWS API Documentation
+    #
+    # @overload untag_resource(params = {})
+    # @param [Hash] params ({})
+    def untag_resource(params = {}, options = {})
+      req = build_request(:untag_resource, params)
+      req.send_request(options)
+    end
+
     # Submits a request to change the health status of a custom health check
     # to healthy or unhealthy.
     #
@@ -1818,6 +2192,18 @@ module Aws::ServiceDiscovery
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: UpdateInstanceCustomHealthStatus Example
+    #
+    #   # This example submits a request to change the health status of an instance associated with a service with a custom health
+    #   # check to HEALTHY.
+    #
+    #   resp = client.update_instance_custom_health_status({
+    #     instance_id: "i-abcd1234", 
+    #     service_id: "srv-e4anhexample0004", 
+    #     status: "HEALTHY", 
+    #   })
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_instance_custom_health_status({
@@ -1870,13 +2256,42 @@ module Aws::ServiceDiscovery
     #
     #   * {Types::UpdateServiceResponse#operation_id #operation_id} => String
     #
+    #
+    # @example Example: UpdateService Example
+    #
+    #   # This example submits a request to replace the DnsConfig and HealthCheckConfig settings of a specified service.
+    #
+    #   resp = client.update_service({
+    #     id: "srv-e4anhexample0004", 
+    #     service: {
+    #       dns_config: {
+    #         dns_records: [
+    #           {
+    #             ttl: 60, 
+    #             type: "A", 
+    #           }, 
+    #         ], 
+    #       }, 
+    #       health_check_config: {
+    #         failure_threshold: 2, 
+    #         resource_path: "/", 
+    #         type: "HTTP", 
+    #       }, 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     operation_id: "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_service({
     #     id: "ResourceId", # required
     #     service: { # required
     #       description: "ResourceDescription",
-    #       dns_config: { # required
+    #       dns_config: {
     #         dns_records: [ # required
     #           {
     #             type: "SRV", # required, accepts SRV, A, AAAA, CNAME
@@ -1918,7 +2333,7 @@ module Aws::ServiceDiscovery
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-servicediscovery'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.26.0'
       Seahorse::Client::Request.new(handlers, context)
     end