aws-sdk-servicediscovery 1.18.0 → 1.23.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 555a483b012a3dd7ec71f1b8553335da656224c6
4
- data.tar.gz: 481dd0530b53490e0e5398f80dea5d7a705fd905
2
+ SHA256:
3
+ metadata.gz: 288018fa5ba020f7b997ec7874dba2796ff45d4cff74a7c865ff09e95a3ceeb9
4
+ data.tar.gz: 4b0b9045aa90813bbf97499dbac3eba9e6017c61d5ab9dd4bdbb67a8d4924fa9
5
5
  SHA512:
6
- metadata.gz: 7a92f158309d0bc4cfa8f2cfccce0534ef47a05a7d861cbae2bd8db24e352c64b60ff810ca9da876cb98dd9f9d91442edcc31474effdaaa3c680b832f463dbf1
7
- data.tar.gz: f7add6814bd3a8fdde3b9fae56d9785261b73aa5d6421ca6ba95542d55f1ef02a1dc5938d865b60d85937de34bf84ef10030ca5a5c8c15184793b364dbe686e5
6
+ metadata.gz: 60d6fc999006b89a816f9d0ffb14050bb45ff61ed4e4e5cf789e89f9a08ccf4a7d59cfdbc209984bee63cc38db7c647e3c65c4c2aa367c838f3d6b2571831608
7
+ data.tar.gz: d55ed05fe7daa5bc11c97cab0cf269ae2f72810689cebb9a94e5a746940e6112ca754bc77faef95a9c8129cab6d7b0a770d3990a962c809790932b52c60e23de
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-servicediscovery/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # service_discovery = Aws::ServiceDiscovery::Client.new
28
+ # resp = service_discovery.create_http_namespace(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Cloud Map all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Cloud Map are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::ServiceDiscovery::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Cloud Map API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-servicediscovery/customizations'
42
45
  # @service
43
46
  module Aws::ServiceDiscovery
44
47
 
45
- GEM_VERSION = '1.18.0'
48
+ GEM_VERSION = '1.23.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:servicediscovery)
31
31
 
32
32
  module Aws::ServiceDiscovery
33
+ # An API client for ServiceDiscovery. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::ServiceDiscovery::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::ServiceDiscovery
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::ServiceDiscovery
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::ServiceDiscovery
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::ServiceDiscovery
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::ServiceDiscovery
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::ServiceDiscovery
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::ServiceDiscovery
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::ServiceDiscovery
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::ServiceDiscovery
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -274,7 +328,7 @@ module Aws::ServiceDiscovery
274
328
  #
275
329
  #
276
330
  #
277
- # [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
331
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
278
332
  #
279
333
  # @option params [required, String] :name
280
334
  # The name that you want to assign to this namespace.
@@ -326,7 +380,7 @@ module Aws::ServiceDiscovery
326
380
  #
327
381
  #
328
382
  #
329
- # [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
383
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
330
384
  #
331
385
  # @option params [required, String] :name
332
386
  # The name that you want to assign to this namespace. When you create a
@@ -353,6 +407,22 @@ module Aws::ServiceDiscovery
353
407
  #
354
408
  # * {Types::CreatePrivateDnsNamespaceResponse#operation_id #operation_id} => String
355
409
  #
410
+ #
411
+ # @example Example: Example: Create private DNS namespace
412
+ #
413
+ # # Example: Create private DNS namespace
414
+ #
415
+ # resp = client.create_private_dns_namespace({
416
+ # creator_request_id: "eedd6892-50f3-41b2-8af9-611d6e1d1a8c",
417
+ # name: "example.com",
418
+ # vpc: "vpc-1c56417b",
419
+ # })
420
+ #
421
+ # resp.to_h outputs the following:
422
+ # {
423
+ # operation_id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
424
+ # }
425
+ #
356
426
  # @example Request syntax with placeholder values
357
427
  #
358
428
  # resp = client.create_private_dns_namespace({
@@ -385,7 +455,7 @@ module Aws::ServiceDiscovery
385
455
  #
386
456
  #
387
457
  #
388
- # [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
458
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
389
459
  #
390
460
  # @option params [required, String] :name
391
461
  # The name that you want to assign to this namespace.
@@ -445,21 +515,40 @@ module Aws::ServiceDiscovery
445
515
  #
446
516
  # * Optionally, a health check
447
517
  #
448
- # After you create the service, you can submit a RegisterInstance
518
+ # After you create the service, you can submit a [RegisterInstance][1]
449
519
  # request, and AWS Cloud Map uses the values in the configuration to
450
520
  # create the specified entities.
451
521
  #
452
522
  # For the current limit on the number of instances that you can register
453
523
  # using the same namespace and using the same service, see [AWS Cloud
454
- # Map Limits][1] in the *AWS Cloud Map Developer Guide*.
524
+ # Map Limits][2] in the *AWS Cloud Map Developer Guide*.
455
525
  #
456
526
  #
457
527
  #
458
- # [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
528
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
529
+ # [2]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
459
530
  #
460
531
  # @option params [required, String] :name
461
532
  # The name that you want to assign to the service.
462
533
  #
534
+ # If you want AWS Cloud Map to create an SRV record when you register an
535
+ # instance, and if you're using a system that requires a specific SRV
536
+ # format, such as [HAProxy][1], specify the following for `Name`\:
537
+ #
538
+ # * Start the name with an underscore (\_), such as `_exampleservice`
539
+ #
540
+ # * End the name with *.\_protocol*, such as `._tcp`
541
+ #
542
+ # When you register an instance, AWS Cloud Map creates an SRV record and
543
+ # assigns a name to the record by concatenating the service name and the
544
+ # namespace name, for example:
545
+ #
546
+ # `_exampleservice._tcp.example.com`
547
+ #
548
+ #
549
+ #
550
+ # [1]: http://www.haproxy.org/
551
+ #
463
552
  # @option params [String] :namespace_id
464
553
  # The ID of the namespace that you want to use to create the service.
465
554
  #
@@ -481,10 +570,10 @@ module Aws::ServiceDiscovery
481
570
  # instance.
482
571
  #
483
572
  # @option params [Types::HealthCheckConfig] :health_check_config
484
- # *Public DNS namespaces only.* A complex type that contains settings
485
- # for an optional Route 53 health check. If you specify settings for a
486
- # health check, AWS Cloud Map associates the health check with all the
487
- # Route 53 DNS records that you specify in `DnsConfig`.
573
+ # *Public DNS and HTTP namespaces only.* A complex type that contains
574
+ # settings for an optional Route 53 health check. If you specify
575
+ # settings for a health check, AWS Cloud Map associates the health check
576
+ # with all the Route 53 DNS records that you specify in `DnsConfig`.
488
577
  #
489
578
  # If you specify a health check configuration, you can specify either
490
579
  # `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
@@ -503,10 +592,56 @@ module Aws::ServiceDiscovery
503
592
  # If you specify a health check configuration, you can specify either
504
593
  # `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
505
594
  #
595
+ # You can't add, update, or delete a `HealthCheckCustomConfig`
596
+ # configuration from an existing service.
597
+ #
506
598
  # @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
507
599
  #
508
600
  # * {Types::CreateServiceResponse#service #service} => Types::Service
509
601
  #
602
+ #
603
+ # @example Example: Example: Create service
604
+ #
605
+ # # Example: Create service
606
+ #
607
+ # resp = client.create_service({
608
+ # creator_request_id: "567c1193-6b00-4308-bd57-ad38a8822d25",
609
+ # dns_config: {
610
+ # dns_records: [
611
+ # {
612
+ # ttl: 60,
613
+ # type: "A",
614
+ # },
615
+ # ],
616
+ # namespace_id: "ns-ylexjili4cdxy3xm",
617
+ # routing_policy: "MULTIVALUE",
618
+ # },
619
+ # name: "myservice",
620
+ # namespace_id: "ns-ylexjili4cdxy3xm",
621
+ # })
622
+ #
623
+ # resp.to_h outputs the following:
624
+ # {
625
+ # service: {
626
+ # arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
627
+ # create_date: Time.parse(1587081768.334),
628
+ # creator_request_id: "567c1193-6b00-4308-bd57-ad38a8822d25",
629
+ # dns_config: {
630
+ # dns_records: [
631
+ # {
632
+ # ttl: 60,
633
+ # type: "A",
634
+ # },
635
+ # ],
636
+ # namespace_id: "ns-ylexjili4cdxy3xm",
637
+ # routing_policy: "MULTIVALUE",
638
+ # },
639
+ # id: "srv-p5zdwlg5uvvzjita",
640
+ # name: "myservice",
641
+ # namespace_id: "ns-ylexjili4cdxy3xm",
642
+ # },
643
+ # }
644
+ #
510
645
  # @example Request syntax with placeholder values
511
646
  #
512
647
  # resp = client.create_service({
@@ -573,6 +708,20 @@ module Aws::ServiceDiscovery
573
708
  #
574
709
  # * {Types::DeleteNamespaceResponse#operation_id #operation_id} => String
575
710
  #
711
+ #
712
+ # @example Example: Example: Delete namespace
713
+ #
714
+ # # Example: Delete namespace
715
+ #
716
+ # resp = client.delete_namespace({
717
+ # id: "ns-ylexjili4cdxy3xm",
718
+ # })
719
+ #
720
+ # resp.to_h outputs the following:
721
+ # {
722
+ # operation_id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk",
723
+ # }
724
+ #
576
725
  # @example Request syntax with placeholder values
577
726
  #
578
727
  # resp = client.delete_namespace({
@@ -600,6 +749,19 @@ module Aws::ServiceDiscovery
600
749
  #
601
750
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
602
751
  #
752
+ #
753
+ # @example Example: Example: Delete service
754
+ #
755
+ # # Example: Delete service
756
+ #
757
+ # resp = client.delete_service({
758
+ # id: "srv-p5zdwlg5uvvzjita",
759
+ # })
760
+ #
761
+ # resp.to_h outputs the following:
762
+ # {
763
+ # }
764
+ #
603
765
  # @example Request syntax with placeholder values
604
766
  #
605
767
  # resp = client.delete_service({
@@ -622,12 +784,32 @@ module Aws::ServiceDiscovery
622
784
  # The ID of the service that the instance is associated with.
623
785
  #
624
786
  # @option params [required, String] :instance_id
625
- # The value that you specified for `Id` in the RegisterInstance request.
787
+ # The value that you specified for `Id` in the [RegisterInstance][1]
788
+ # request.
789
+ #
790
+ #
791
+ #
792
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
626
793
  #
627
794
  # @return [Types::DeregisterInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
628
795
  #
629
796
  # * {Types::DeregisterInstanceResponse#operation_id #operation_id} => String
630
797
  #
798
+ #
799
+ # @example Example: Example: Deregister a service instance
800
+ #
801
+ # # Example: Deregister a service instance
802
+ #
803
+ # resp = client.deregister_instance({
804
+ # instance_id: "myservice-53",
805
+ # service_id: "srv-p5zdwlg5uvvzjita",
806
+ # })
807
+ #
808
+ # resp.to_h outputs the following:
809
+ # {
810
+ # operation_id: "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq",
811
+ # }
812
+ #
631
813
  # @example Request syntax with placeholder values
632
814
  #
633
815
  # resp = client.deregister_instance({
@@ -649,6 +831,9 @@ module Aws::ServiceDiscovery
649
831
  end
650
832
 
651
833
  # Discovers registered instances for a specified namespace and service.
834
+ # You can use `DiscoverInstances` to discover instances for any type of
835
+ # namespace. For public and private DNS namespaces, you can also use DNS
836
+ # queries to discover instances.
652
837
  #
653
838
  # @option params [required, String] :namespace_name
654
839
  # The name of the namespace that you specified when you registered the
@@ -659,9 +844,10 @@ module Aws::ServiceDiscovery
659
844
  # instance.
660
845
  #
661
846
  # @option params [Integer] :max_results
662
- # The maximum number of instances that you want Cloud Map to return in
663
- # the response to a `DiscoverInstances` request. If you don't specify a
664
- # value for `MaxResults`, Cloud Map returns up to 100 instances.
847
+ # The maximum number of instances that you want AWS Cloud Map to return
848
+ # in the response to a `DiscoverInstances` request. If you don't
849
+ # specify a value for `MaxResults`, AWS Cloud Map returns up to 100
850
+ # instances.
665
851
  #
666
852
  # @option params [Hash<String,String>] :query_parameters
667
853
  # A string map that contains attributes with values that you can use to
@@ -676,6 +862,34 @@ module Aws::ServiceDiscovery
676
862
  #
677
863
  # * {Types::DiscoverInstancesResponse#instances #instances} => Array&lt;Types::HttpInstanceSummary&gt;
678
864
  #
865
+ #
866
+ # @example Example: Example: Discover registered instances
867
+ #
868
+ # # Example: Discover registered instances
869
+ #
870
+ # resp = client.discover_instances({
871
+ # health_status: "ALL",
872
+ # max_results: 10,
873
+ # namespace_name: "example.com",
874
+ # service_name: "myservice",
875
+ # })
876
+ #
877
+ # resp.to_h outputs the following:
878
+ # {
879
+ # instances: [
880
+ # {
881
+ # attributes: {
882
+ # "AWS_INSTANCE_IPV4" => "172.2.1.3",
883
+ # "AWS_INSTANCE_PORT" => "808",
884
+ # },
885
+ # health_status: "UNKNOWN",
886
+ # instance_id: "myservice-53",
887
+ # namespace_name: "example.com",
888
+ # service_name: "myservice",
889
+ # },
890
+ # ],
891
+ # }
892
+ #
679
893
  # @example Request syntax with placeholder values
680
894
  #
681
895
  # resp = client.discover_instances({
@@ -761,10 +975,14 @@ module Aws::ServiceDiscovery
761
975
  # all the instances that are associated with the specified service.
762
976
  #
763
977
  # <note markdown="1"> To get the IDs for the instances that you've registered by using a
764
- # specified service, submit a ListInstances request.
978
+ # specified service, submit a [ListInstances][1] request.
765
979
  #
766
980
  # </note>
767
981
  #
982
+ #
983
+ #
984
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html
985
+ #
768
986
  # @option params [Integer] :max_results
769
987
  # The maximum number of instances that you want AWS Cloud Map to return
770
988
  # in the response to a `GetInstancesHealthStatus` request. If you don't
@@ -784,6 +1002,8 @@ module Aws::ServiceDiscovery
784
1002
  # * {Types::GetInstancesHealthStatusResponse#status #status} => Hash&lt;String,String&gt;
785
1003
  # * {Types::GetInstancesHealthStatusResponse#next_token #next_token} => String
786
1004
  #
1005
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1006
+ #
787
1007
  # @example Request syntax with placeholder values
788
1008
  #
789
1009
  # resp = client.get_instances_health_status({
@@ -849,10 +1069,14 @@ module Aws::ServiceDiscovery
849
1069
  # the response, such as a `CreateService` request.
850
1070
  #
851
1071
  # <note markdown="1"> To get a list of operations that match specified criteria, see
852
- # ListOperations.
1072
+ # [ListOperations][1].
853
1073
  #
854
1074
  # </note>
855
1075
  #
1076
+ #
1077
+ #
1078
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html
1079
+ #
856
1080
  # @option params [required, String] :operation_id
857
1081
  # The ID of the operation that you want to get more information about.
858
1082
  #
@@ -860,6 +1084,29 @@ module Aws::ServiceDiscovery
860
1084
  #
861
1085
  # * {Types::GetOperationResponse#operation #operation} => Types::Operation
862
1086
  #
1087
+ #
1088
+ # @example Example: Example: Get operation result
1089
+ #
1090
+ # # Example: Get operation result
1091
+ #
1092
+ # resp = client.get_operation({
1093
+ # operation_id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
1094
+ # })
1095
+ #
1096
+ # resp.to_h outputs the following:
1097
+ # {
1098
+ # operation: {
1099
+ # create_date: Time.parse(1587055860.121),
1100
+ # id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
1101
+ # status: "SUCCESS",
1102
+ # targets: {
1103
+ # "NAMESPACE" => "ns-ylexjili4cdxy3xm",
1104
+ # },
1105
+ # type: "CREATE_NAMESPACE",
1106
+ # update_date: Time.parse(1587055900.469),
1107
+ # },
1108
+ # }
1109
+ #
863
1110
  # @example Request syntax with placeholder values
864
1111
  #
865
1112
  # resp = client.get_operation({
@@ -955,6 +1202,30 @@ module Aws::ServiceDiscovery
955
1202
  # * {Types::ListInstancesResponse#instances #instances} => Array&lt;Types::InstanceSummary&gt;
956
1203
  # * {Types::ListInstancesResponse#next_token #next_token} => String
957
1204
  #
1205
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1206
+ #
1207
+ #
1208
+ # @example Example: Example: List service instances
1209
+ #
1210
+ # # Example: List service instances
1211
+ #
1212
+ # resp = client.list_instances({
1213
+ # service_id: "srv-qzpwvt2tfqcegapy",
1214
+ # })
1215
+ #
1216
+ # resp.to_h outputs the following:
1217
+ # {
1218
+ # instances: [
1219
+ # {
1220
+ # attributes: {
1221
+ # "AWS_INSTANCE_IPV4" => "172.2.1.3",
1222
+ # "AWS_INSTANCE_PORT" => "808",
1223
+ # },
1224
+ # id: "i-06bdabbae60f65a4e",
1225
+ # },
1226
+ # ],
1227
+ # }
1228
+ #
958
1229
  # @example Request syntax with placeholder values
959
1230
  #
960
1231
  # resp = client.list_instances({
@@ -1015,6 +1286,67 @@ module Aws::ServiceDiscovery
1015
1286
  # * {Types::ListNamespacesResponse#namespaces #namespaces} => Array&lt;Types::NamespaceSummary&gt;
1016
1287
  # * {Types::ListNamespacesResponse#next_token #next_token} => String
1017
1288
  #
1289
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1290
+ #
1291
+ #
1292
+ # @example Example: Example: List namespaces
1293
+ #
1294
+ # # Example: List namespaces
1295
+ #
1296
+ # resp = client.list_namespaces({
1297
+ # })
1298
+ #
1299
+ # resp.to_h outputs the following:
1300
+ # {
1301
+ # namespaces: [
1302
+ # {
1303
+ # arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile",
1304
+ # create_date: Time.parse(1585354387.357),
1305
+ # id: "ns-a3ccy2e7e3a7rile",
1306
+ # name: "local",
1307
+ # properties: {
1308
+ # dns_properties: {
1309
+ # hosted_zone_id: "Z06752353VBUDTC32S84S",
1310
+ # },
1311
+ # http_properties: {
1312
+ # http_name: "local",
1313
+ # },
1314
+ # },
1315
+ # type: "DNS_PRIVATE",
1316
+ # },
1317
+ # {
1318
+ # arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx",
1319
+ # create_date: Time.parse(1586468974.698),
1320
+ # description: "My second namespace",
1321
+ # id: "ns-pocfyjtrsmwtvcxx",
1322
+ # name: "My-second-namespace",
1323
+ # properties: {
1324
+ # dns_properties: {
1325
+ # },
1326
+ # http_properties: {
1327
+ # http_name: "My-second-namespace",
1328
+ # },
1329
+ # },
1330
+ # type: "HTTP",
1331
+ # },
1332
+ # {
1333
+ # arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm",
1334
+ # create_date: Time.parse(1587055896.798),
1335
+ # id: "ns-ylexjili4cdxy3xm",
1336
+ # name: "example.com",
1337
+ # properties: {
1338
+ # dns_properties: {
1339
+ # hosted_zone_id: "Z09983722P0QME1B3KC8I",
1340
+ # },
1341
+ # http_properties: {
1342
+ # http_name: "example.com",
1343
+ # },
1344
+ # },
1345
+ # type: "DNS_PRIVATE",
1346
+ # },
1347
+ # ],
1348
+ # }
1349
+ #
1018
1350
  # @example Request syntax with placeholder values
1019
1351
  #
1020
1352
  # resp = client.list_namespaces({
@@ -1087,6 +1419,8 @@ module Aws::ServiceDiscovery
1087
1419
  # * {Types::ListOperationsResponse#operations #operations} => Array&lt;Types::OperationSummary&gt;
1088
1420
  # * {Types::ListOperationsResponse#next_token #next_token} => String
1089
1421
  #
1422
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1423
+ #
1090
1424
  # @example Request syntax with placeholder values
1091
1425
  #
1092
1426
  # resp = client.list_operations({
@@ -1152,6 +1486,37 @@ module Aws::ServiceDiscovery
1152
1486
  # * {Types::ListServicesResponse#services #services} => Array&lt;Types::ServiceSummary&gt;
1153
1487
  # * {Types::ListServicesResponse#next_token #next_token} => String
1154
1488
  #
1489
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1490
+ #
1491
+ #
1492
+ # @example Example: Example: List services
1493
+ #
1494
+ # # Example: List services
1495
+ #
1496
+ # resp = client.list_services({
1497
+ # })
1498
+ #
1499
+ # resp.to_h outputs the following:
1500
+ # {
1501
+ # services: [
1502
+ # {
1503
+ # arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
1504
+ # create_date: Time.parse(1587081768.334),
1505
+ # dns_config: {
1506
+ # dns_records: [
1507
+ # {
1508
+ # ttl: 60,
1509
+ # type: "A",
1510
+ # },
1511
+ # ],
1512
+ # routing_policy: "MULTIVALUE",
1513
+ # },
1514
+ # id: "srv-p5zdwlg5uvvzjita",
1515
+ # name: "myservice",
1516
+ # },
1517
+ # ],
1518
+ # }
1519
+ #
1155
1520
  # @example Request syntax with placeholder values
1156
1521
  #
1157
1522
  # resp = client.list_services({
@@ -1212,7 +1577,7 @@ module Aws::ServiceDiscovery
1212
1577
  # One `RegisterInstance` request must complete before you can submit
1213
1578
  # another request and specify the same service ID and instance ID.
1214
1579
  #
1215
- # For more information, see CreateService.
1580
+ # For more information, see [CreateService][1].
1216
1581
  #
1217
1582
  # When AWS Cloud Map receives a DNS query for the specified DNS name, it
1218
1583
  # returns the applicable value:
@@ -1227,11 +1592,12 @@ module Aws::ServiceDiscovery
1227
1592
  #
1228
1593
  # For the current limit on the number of instances that you can register
1229
1594
  # using the same namespace and using the same service, see [AWS Cloud
1230
- # Map Limits][1] in the *AWS Cloud Map Developer Guide*.
1595
+ # Map Limits][2] in the *AWS Cloud Map Developer Guide*.
1231
1596
  #
1232
1597
  #
1233
1598
  #
1234
- # [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
1599
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html
1600
+ # [2]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
1235
1601
  #
1236
1602
  # @option params [required, String] :service_id
1237
1603
  # The ID of the service that you want to use for settings for the
@@ -1244,7 +1610,7 @@ module Aws::ServiceDiscovery
1244
1610
  # * If the service that is specified by `ServiceId` includes settings
1245
1611
  # for an SRV record, the value of `InstanceId` is automatically
1246
1612
  # included as part of the value for the SRV record. For more
1247
- # information, see DnsRecord$Type.
1613
+ # information, see [DnsRecord &gt; Type][1].
1248
1614
  #
1249
1615
  # * You can use this value to update an existing instance.
1250
1616
  #
@@ -1261,6 +1627,10 @@ module Aws::ServiceDiscovery
1261
1627
  #
1262
1628
  # </note>
1263
1629
  #
1630
+ #
1631
+ #
1632
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type
1633
+ #
1264
1634
  # @option params [String] :creator_request_id
1265
1635
  # A unique string that identifies the request and that allows failed
1266
1636
  # `RegisterInstance` requests to be retried without the risk of
@@ -1360,8 +1730,8 @@ module Aws::ServiceDiscovery
1360
1730
  # If the service includes `HealthCheckConfig`, the port on the endpoint
1361
1731
  # that you want Route 53 to send requests to.
1362
1732
  #
1363
- # This value is required if you specified settings for an SRV record
1364
- # when you created the service.
1733
+ # This value is required if you specified settings for an SRV record or
1734
+ # a Route 53 health check when you created the service.
1365
1735
  #
1366
1736
  # **Custom attributes**
1367
1737
  #
@@ -1371,12 +1741,32 @@ module Aws::ServiceDiscovery
1371
1741
  #
1372
1742
  #
1373
1743
  #
1374
- # [1]: http://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html
1744
+ # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html
1375
1745
  #
1376
1746
  # @return [Types::RegisterInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1377
1747
  #
1378
1748
  # * {Types::RegisterInstanceResponse#operation_id #operation_id} => String
1379
1749
  #
1750
+ #
1751
+ # @example Example: Example: Register Instance
1752
+ #
1753
+ # # Example: Register Instance
1754
+ #
1755
+ # resp = client.register_instance({
1756
+ # attributes: {
1757
+ # "AWS_INSTANCE_IPV4" => "172.2.1.3",
1758
+ # "AWS_INSTANCE_PORT" => "808",
1759
+ # },
1760
+ # creator_request_id: "7a48a98a-72e6-4849-bfa7-1a458e030d7b",
1761
+ # instance_id: "myservice-53",
1762
+ # service_id: "srv-p5zdwlg5uvvzjita",
1763
+ # })
1764
+ #
1765
+ # resp.to_h outputs the following:
1766
+ # {
1767
+ # operation_id: "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7",
1768
+ # }
1769
+ #
1380
1770
  # @example Request syntax with placeholder values
1381
1771
  #
1382
1772
  # resp = client.register_instance({
@@ -1410,7 +1800,11 @@ module Aws::ServiceDiscovery
1410
1800
  # to change the status for Route 53 health checks, which you define
1411
1801
  # using `HealthCheckConfig`.
1412
1802
  #
1413
- # For more information, see HealthCheckCustomConfig.
1803
+ # For more information, see [HealthCheckCustomConfig][1].
1804
+ #
1805
+ #
1806
+ #
1807
+ # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
1414
1808
  #
1415
1809
  # @option params [required, String] :service_id
1416
1810
  # The ID of the service that includes the configuration for the custom
@@ -1443,21 +1837,28 @@ module Aws::ServiceDiscovery
1443
1837
 
1444
1838
  # Submits a request to perform the following operations:
1445
1839
  #
1446
- # * Add or delete `DnsRecords` configurations
1447
- #
1448
1840
  # * Update the TTL setting for existing `DnsRecords` configurations
1449
1841
  #
1450
1842
  # * Add, update, or delete `HealthCheckConfig` for a specified service
1451
1843
  #
1452
- # For public and private DNS namespaces, you must specify all
1453
- # `DnsRecords` configurations (and, optionally, `HealthCheckConfig`)
1454
- # that you want to appear in the updated service. Any current
1455
- # configurations that don't appear in an `UpdateService` request are
1456
- # deleted.
1844
+ # <note markdown="1"> You can't add, update, or delete a `HealthCheckCustomConfig`
1845
+ # configuration.
1846
+ #
1847
+ # </note>
1848
+ #
1849
+ # For public and private DNS namespaces, note the following:
1850
+ #
1851
+ # * If you omit any existing `DnsRecords` or `HealthCheckConfig`
1852
+ # configurations from an `UpdateService` request, the configurations
1853
+ # are deleted from the service.
1854
+ #
1855
+ # * If you omit an existing `HealthCheckCustomConfig` configuration from
1856
+ # an `UpdateService` request, the configuration is not deleted from
1857
+ # the service.
1457
1858
  #
1458
- # When you update the TTL setting for a service, AWS Cloud Map also
1459
- # updates the corresponding settings in all the records and health
1460
- # checks that were created by using the specified service.
1859
+ # When you update settings for a service, AWS Cloud Map also updates the
1860
+ # corresponding settings in all the records and health checks that were
1861
+ # created by using the specified service.
1461
1862
  #
1462
1863
  # @option params [required, String] :id
1463
1864
  # The ID of the service that you want to update.
@@ -1517,7 +1918,7 @@ module Aws::ServiceDiscovery
1517
1918
  params: params,
1518
1919
  config: config)
1519
1920
  context[:gem_name] = 'aws-sdk-servicediscovery'
1520
- context[:gem_version] = '1.18.0'
1921
+ context[:gem_version] = '1.23.0'
1521
1922
  Seahorse::Client::Request.new(handlers, context)
1522
1923
  end
1523
1924