lib/aws-sdk-servicediscovery/client.rb in aws-sdk-servicediscovery-1.62.0 vs lib/aws-sdk-servicediscovery/client.rb in aws-sdk-servicediscovery-1.63.0
- old
+ new
@@ -20,10 +20,11 @@
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
require 'aws-sdk-core/plugins/response_paging.rb'
require 'aws-sdk-core/plugins/stub_responses.rb'
require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/invocation_id.rb'
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'
@@ -70,10 +71,11 @@
add_plugin(Aws::Plugins::EndpointDiscovery)
add_plugin(Aws::Plugins::EndpointPattern)
add_plugin(Aws::Plugins::ResponsePaging)
add_plugin(Aws::Plugins::StubResponses)
add_plugin(Aws::Plugins::IdempotencyToken)
+ add_plugin(Aws::Plugins::InvocationId)
add_plugin(Aws::Plugins::JsonvalueConverter)
add_plugin(Aws::Plugins::ClientMetricsPlugin)
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::HttpChecksum)
@@ -194,15 +196,22 @@
#
# @option options [Boolean] :disable_request_compression (false)
# When set to 'true' the request body will not be compressed
# for supported operations.
#
- # @option options [String] :endpoint
- # The client endpoint is normally constructed from the `:region`
- # option. You should only configure an `:endpoint` when connecting
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
+ # Normally you should not configure the `:endpoint` option
+ # directly. This is normally constructed from the `:region`
+ # option. Configuring `:endpoint` is normally reserved for
+ # connecting to test or custom endpoints. The endpoint should
+ # be a URI formatted like:
#
+ # 'http://example.com'
+ # 'https://example.com'
+ # 'http://example.com:123'
+ #
+ #
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
# for endpoint discovery enabled operations. Defaults to 1000.
#
# @option options [Integer] :endpoint_cache_max_threads (10)
@@ -345,55 +354,70 @@
# sending the request.
#
# @option options [Aws::ServiceDiscovery::EndpointProvider] :endpoint_provider
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ServiceDiscovery::EndpointParameters`
#
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
- # requests through. Formatted like 'http://proxy.com:123'.
+ # @option options [Float] :http_continue_timeout (1)
+ # The number of seconds to wait for a 100-continue response before sending the
+ # request body. This option has no effect unless the request has "Expect"
+ # header set to "100-continue". Defaults to `nil` which disables this
+ # behaviour. This value can safely be set per request on the session.
#
- # @option options [Float] :http_open_timeout (15) The number of
- # seconds to wait when opening a HTTP session before raising a
- # `Timeout::Error`.
+ # @option options [Float] :http_idle_timeout (5)
+ # The number of seconds a connection is allowed to sit idle before it
+ # is considered stale. Stale connections are closed and removed from the
+ # pool before making a request.
#
- # @option options [Float] :http_read_timeout (60) The default
- # number of seconds to wait for response data. This value can
- # safely be set per-request on the session.
+ # @option options [Float] :http_open_timeout (15)
+ # The default number of seconds to wait for response data.
+ # This value can safely be set per-request on the session.
#
- # @option options [Float] :http_idle_timeout (5) The number of
- # seconds a connection is allowed to sit idle before it is
- # considered stale. Stale connections are closed and removed
- # from the pool before making a request.
+ # @option options [URI::HTTP,String] :http_proxy
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
#
- # @option options [Float] :http_continue_timeout (1) The number of
- # seconds to wait for a 100-continue response before sending the
- # request body. This option has no effect unless the request has
- # "Expect" header set to "100-continue". Defaults to `nil` which
- # disables this behaviour. This value can safely be set per
- # request on the session.
+ # @option options [Float] :http_read_timeout (60)
+ # The default number of seconds to wait for response data.
+ # This value can safely be set per-request on the session.
#
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
- # in seconds.
+ # @option options [Boolean] :http_wire_trace (false)
+ # When `true`, HTTP debug output will be sent to the `:logger`.
#
- # @option options [Boolean] :http_wire_trace (false) When `true`,
- # HTTP debug output will be sent to the `:logger`.
+ # @option options [Proc] :on_chunk_received
+ # When a Proc object is provided, it will be used as callback when each chunk
+ # of the response body is received. It provides three arguments: the chunk,
+ # the number of bytes received, and the total number of
+ # bytes in the response (or nil if the server did not send a `content-length`).
#
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
- # SSL peer certificates are verified when establishing a
- # connection.
+ # @option options [Proc] :on_chunk_sent
+ # When a Proc object is provided, it will be used as callback when each chunk
+ # of the request body is sent. It provides three arguments: the chunk,
+ # the number of bytes read from the body, and the total number of
+ # bytes in the body.
#
- # @option options [String] :ssl_ca_bundle Full path to the SSL
- # certificate authority bundle file that should be used when
- # verifying peer certificates. If you do not pass
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
- # will be used if available.
+ # @option options [Boolean] :raise_response_errors (true)
+ # When `true`, response errors are raised.
#
- # @option options [String] :ssl_ca_directory Full path of the
- # directory that contains the unbundled SSL certificate
+ # @option options [String] :ssl_ca_bundle
+ # Full path to the SSL certificate authority bundle file that should be used when
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
+ # `:ssl_ca_directory` the the system default will be used if available.
+ #
+ # @option options [String] :ssl_ca_directory
+ # Full path of the directory that contains the unbundled SSL certificate
# authority files for verifying peer certificates. If you do
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
- # system default will be used if available.
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
+ # default will be used if available.
#
+ # @option options [String] :ssl_ca_store
+ # Sets the X509::Store to verify peer certificate.
+ #
+ # @option options [Float] :ssl_timeout
+ # Sets the SSL timeout in seconds
+ #
+ # @option options [Boolean] :ssl_verify_peer (true)
+ # When `true`, SSL peer certificates are verified when establishing a connection.
+ #
def initialize(*args)
super
end
# @!group API Operations
@@ -1050,10 +1074,13 @@
# discover instances.
#
# @option params [required, String] :namespace_name
# The `HttpName` name of the namespace. It's found in the
# `HttpProperties` member of the `Properties` member of the namespace.
+ # In most cases, `Name` and `HttpName` match. However, if you reuse
+ # `Name` for namespace creation, a generated hash is added to `HttpName`
+ # to distinguish the two.
#
# @option params [required, String] :service_name
# The name of the service that you specified when you registered the
# instance.
#
@@ -1178,10 +1205,25 @@
#
# @return [Types::DiscoverInstancesRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DiscoverInstancesRevisionResponse#instances_revision #instances_revision} => Integer
#
+ #
+ # @example Example: To discover the revision for a registered instance
+ #
+ # # The following example discovers the revision ID for a registered instance.
+ #
+ # resp = client.discover_instances_revision({
+ # namespace_name: "example-namespace",
+ # service_name: "example-service",
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # instances_revision: 123456,
+ # }
+ #
# @example Request syntax with placeholder values
#
# resp = client.discover_instances_revision({
# namespace_name: "NamespaceName", # required
# service_name: "ServiceName", # required
@@ -1865,11 +1907,11 @@
req = build_request(:list_operations, params)
req.send_request(options)
end
# Lists summary information for all the services that are associated
- # with one or more specified namespaces.
+ # with one or more namespaces.
#
# @option params [String] :next_token
# For the first `ListServices` request, omit this value.
#
# If the response contains `NextToken`, submit another `ListServices`
@@ -2127,17 +2169,15 @@
# * The attributes that apply to the records that are defined in the
# service.
#
# * For each attribute, the applicable value.
#
- # <note markdown="1"> Do not include sensitive information in the attributes if the
+ # Do not include sensitive information in the attributes if the
# namespace is discoverable by public DNS queries.
#
- # </note>
+ # The following are the supported attribute keys.
#
- # Supported attribute keys include the following:
- #
# AWS\_ALIAS\_DNS\_NAME
#
# : If you want Cloud Map to create an Amazon Route 53 alias record that
# routes traffic to an Elastic Load Balancing load balancer, specify
# the DNS name that's associated with the load balancer. For
@@ -2163,10 +2203,13 @@
# Load Balancing load balancers.
#
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
# values for any of the `AWS_INSTANCE` attributes.
#
+ # * The `AWS_ALIAS_DNS_NAME` is not supported in the GovCloud (US)
+ # Regions.
+ #
# AWS\_EC2\_INSTANCE\_ID
#
# : *HTTP namespaces only.* The Amazon EC2 instance ID for the instance.
# If the `AWS_EC2_INSTANCE_ID` attribute is specified, then the only
# other attribute that can be specified is `AWS_INIT_HEALTH_STATUS`.
@@ -2404,10 +2447,27 @@
#
# @return [Types::UpdateHttpNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateHttpNamespaceResponse#operation_id #operation_id} => String
#
+ #
+ # @example Example: To update a HTTP namespace
+ #
+ # # The following example updates the description of a HTTP namespace.
+ #
+ # resp = client.update_http_namespace({
+ # id: "ns-vh4nbmEXAMPLE",
+ # namespace: {
+ # description: "The updated namespace description.",
+ # },
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # operation_id: "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE",
+ # }
+ #
# @example Request syntax with placeholder values
#
# resp = client.update_http_namespace({
# id: "ResourceId", # required
# updater_request_id: "ResourceId",
@@ -2504,10 +2564,45 @@
#
# @return [Types::UpdatePrivateDnsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdatePrivateDnsNamespaceResponse#operation_id #operation_id} => String
#
+ #
+ # @example Example: To update a private DNS namespace
+ #
+ # # The following example updates the description of a private DNS namespace.
+ #
+ # resp = client.update_private_dns_namespace({
+ # id: "ns-bk3aEXAMPLE",
+ # namespace: {
+ # description: "The updated namespace description.",
+ # },
+ # updater_request_id: "",
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # operation_id: "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE",
+ # }
+ #
+ # @example Example: To update a public DNS namespace
+ #
+ # # The following example updates the description of a public DNS namespace.
+ #
+ # resp = client.update_private_dns_namespace({
+ # id: "ns-bk3aEXAMPLE",
+ # namespace: {
+ # description: "The updated namespace description.",
+ # },
+ # updater_request_id: "",
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # operation_id: "ft52xe2koxhoeormaceymagglsdjEXAMPLE",
+ # }
+ #
# @example Request syntax with placeholder values
#
# resp = client.update_private_dns_namespace({
# id: "ResourceId", # required
# updater_request_id: "ResourceId",
@@ -2697,10 +2792,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-servicediscovery'
- context[:gem_version] = '1.62.0'
+ context[:gem_version] = '1.63.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated