aws-sdk-servicediscovery 1.87.0 → 1.89.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-servicediscovery/client.rb +223 -65
- data/lib/aws-sdk-servicediscovery/client_api.rb +37 -20
- data/lib/aws-sdk-servicediscovery/errors.rb +5 -0
- data/lib/aws-sdk-servicediscovery/types.rb +367 -40
- data/lib/aws-sdk-servicediscovery.rb +1 -1
- data/sig/client.rbs +10 -5
- data/sig/errors.rbs +1 -0
- data/sig/types.rbs +18 -2
- metadata +1 -1
@@ -95,8 +95,8 @@ module Aws::ServiceDiscovery
|
|
95
95
|
# class name or an instance of a plugin class.
|
96
96
|
#
|
97
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
98
|
-
# Your AWS credentials used for authentication. This can be
|
99
|
-
# following classes:
|
98
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
100
100
|
#
|
101
101
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
102
102
|
# credentials.
|
@@ -124,8 +124,7 @@ module Aws::ServiceDiscovery
|
|
124
124
|
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
125
125
|
# from the Cognito Identity service.
|
126
126
|
#
|
127
|
-
# When `:credentials` are not configured directly, the following
|
128
|
-
# locations will be searched for credentials:
|
127
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
129
128
|
#
|
130
129
|
# * `Aws.config[:credentials]`
|
131
130
|
#
|
@@ -139,12 +138,10 @@ module Aws::ServiceDiscovery
|
|
139
138
|
#
|
140
139
|
# * `~/.aws/config`
|
141
140
|
#
|
142
|
-
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
147
|
-
# to `true`.
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
148
145
|
#
|
149
146
|
# @option options [required, String] :region
|
150
147
|
# The AWS region to connect to. The configured `:region` is
|
@@ -384,8 +381,8 @@ module Aws::ServiceDiscovery
|
|
384
381
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
385
382
|
#
|
386
383
|
# @option options [Aws::TokenProvider] :token_provider
|
387
|
-
# Your Bearer token used for authentication. This can be
|
388
|
-
# following classes:
|
384
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
385
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
389
386
|
#
|
390
387
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
391
388
|
# tokens.
|
@@ -829,9 +826,15 @@ module Aws::ServiceDiscovery
|
|
829
826
|
# [1]: http://www.haproxy.org/
|
830
827
|
#
|
831
828
|
# @option params [String] :namespace_id
|
832
|
-
# The ID of the namespace that you want to
|
833
|
-
#
|
834
|
-
#
|
829
|
+
# The ID or Amazon Resource Name (ARN) of the namespace that you want to
|
830
|
+
# use to create the service. For namespaces shared with your Amazon Web
|
831
|
+
# Services account, specify the namespace ARN. For more information
|
832
|
+
# about shared namespaces, see [Cross-account Cloud Map namespace
|
833
|
+
# sharing][1] in the *Cloud Map Developer Guide*.
|
834
|
+
#
|
835
|
+
#
|
836
|
+
#
|
837
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
835
838
|
#
|
836
839
|
# @option params [String] :creator_request_id
|
837
840
|
# A unique string that identifies the request and that allows failed
|
@@ -937,7 +940,7 @@ module Aws::ServiceDiscovery
|
|
937
940
|
#
|
938
941
|
# resp = client.create_service({
|
939
942
|
# name: "ServiceName", # required
|
940
|
-
# namespace_id: "
|
943
|
+
# namespace_id: "Arn",
|
941
944
|
# creator_request_id: "ResourceId",
|
942
945
|
# description: "ResourceDescription",
|
943
946
|
# dns_config: {
|
@@ -971,6 +974,7 @@ module Aws::ServiceDiscovery
|
|
971
974
|
#
|
972
975
|
# resp.service.id #=> String
|
973
976
|
# resp.service.arn #=> String
|
977
|
+
# resp.service.resource_owner #=> String
|
974
978
|
# resp.service.name #=> String
|
975
979
|
# resp.service.namespace_id #=> String
|
976
980
|
# resp.service.description #=> String
|
@@ -987,6 +991,7 @@ module Aws::ServiceDiscovery
|
|
987
991
|
# resp.service.health_check_custom_config.failure_threshold #=> Integer
|
988
992
|
# resp.service.create_date #=> Time
|
989
993
|
# resp.service.creator_request_id #=> String
|
994
|
+
# resp.service.created_by_account #=> String
|
990
995
|
#
|
991
996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateService AWS API Documentation
|
992
997
|
#
|
@@ -1001,7 +1006,8 @@ module Aws::ServiceDiscovery
|
|
1001
1006
|
# contains one or more services, the request fails.
|
1002
1007
|
#
|
1003
1008
|
# @option params [required, String] :id
|
1004
|
-
# The ID of the namespace that you want to
|
1009
|
+
# The ID or Amazon Resource Name (ARN) of the namespace that you want to
|
1010
|
+
# delete.
|
1005
1011
|
#
|
1006
1012
|
# @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1007
1013
|
#
|
@@ -1024,7 +1030,7 @@ module Aws::ServiceDiscovery
|
|
1024
1030
|
# @example Request syntax with placeholder values
|
1025
1031
|
#
|
1026
1032
|
# resp = client.delete_namespace({
|
1027
|
-
# id: "
|
1033
|
+
# id: "Arn", # required
|
1028
1034
|
# })
|
1029
1035
|
#
|
1030
1036
|
# @example Response structure
|
@@ -1045,7 +1051,15 @@ module Aws::ServiceDiscovery
|
|
1045
1051
|
# request fails.
|
1046
1052
|
#
|
1047
1053
|
# @option params [required, String] :id
|
1048
|
-
# The ID of the service that you want to
|
1054
|
+
# The ID or Amazon Resource Name (ARN) of the service that you want to
|
1055
|
+
# delete. If the namespace associated with the service is shared with
|
1056
|
+
# your Amazon Web Services account, specify the service ARN. For more
|
1057
|
+
# information about shared namespaces, see [Cross-account Cloud Map
|
1058
|
+
# namespace sharing][1].
|
1059
|
+
#
|
1060
|
+
#
|
1061
|
+
#
|
1062
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1049
1063
|
#
|
1050
1064
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1051
1065
|
#
|
@@ -1065,7 +1079,7 @@ module Aws::ServiceDiscovery
|
|
1065
1079
|
# @example Request syntax with placeholder values
|
1066
1080
|
#
|
1067
1081
|
# resp = client.delete_service({
|
1068
|
-
# id: "
|
1082
|
+
# id: "Arn", # required
|
1069
1083
|
# })
|
1070
1084
|
#
|
1071
1085
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteService AWS API Documentation
|
@@ -1080,7 +1094,15 @@ module Aws::ServiceDiscovery
|
|
1080
1094
|
# Deletes specific attributes associated with a service.
|
1081
1095
|
#
|
1082
1096
|
# @option params [required, String] :service_id
|
1083
|
-
# The ID of the service from which the
|
1097
|
+
# The ID or Amazon Resource Name (ARN) of the service from which the
|
1098
|
+
# attributes will be deleted. For services created in a namespace shared
|
1099
|
+
# with your Amazon Web Services account, specify the service ARN. For
|
1100
|
+
# more information about shared namespaces, see [Cross-account Cloud Map
|
1101
|
+
# namespace sharing][1] in the *Cloud Map Developer Guide*.
|
1102
|
+
#
|
1103
|
+
#
|
1104
|
+
#
|
1105
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1084
1106
|
#
|
1085
1107
|
# @option params [required, Array<String>] :attributes
|
1086
1108
|
# A list of keys corresponding to each attribute that you want to
|
@@ -1107,7 +1129,7 @@ module Aws::ServiceDiscovery
|
|
1107
1129
|
# @example Request syntax with placeholder values
|
1108
1130
|
#
|
1109
1131
|
# resp = client.delete_service_attributes({
|
1110
|
-
# service_id: "
|
1132
|
+
# service_id: "Arn", # required
|
1111
1133
|
# attributes: ["ServiceAttributeKey"], # required
|
1112
1134
|
# })
|
1113
1135
|
#
|
@@ -1124,7 +1146,15 @@ module Aws::ServiceDiscovery
|
|
1124
1146
|
# Cloud Map created for the specified instance.
|
1125
1147
|
#
|
1126
1148
|
# @option params [required, String] :service_id
|
1127
|
-
# The ID of the service that the instance
|
1149
|
+
# The ID or Amazon Resource Name (ARN) of the service that the instance
|
1150
|
+
# is associated with. If the namespace associated with the service is
|
1151
|
+
# shared with your account, specify the service ARN. For more
|
1152
|
+
# information about shared namespaces, see [Cross-account Cloud Map
|
1153
|
+
# namespace sharing][1] in the *Cloud Map Developer Guide*.
|
1154
|
+
#
|
1155
|
+
#
|
1156
|
+
#
|
1157
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1128
1158
|
#
|
1129
1159
|
# @option params [required, String] :instance_id
|
1130
1160
|
# The value that you specified for `Id` in the [RegisterInstance][1]
|
@@ -1156,7 +1186,7 @@ module Aws::ServiceDiscovery
|
|
1156
1186
|
# @example Request syntax with placeholder values
|
1157
1187
|
#
|
1158
1188
|
# resp = client.deregister_instance({
|
1159
|
-
# service_id: "
|
1189
|
+
# service_id: "Arn", # required
|
1160
1190
|
# instance_id: "ResourceId", # required
|
1161
1191
|
# })
|
1162
1192
|
#
|
@@ -1181,7 +1211,7 @@ module Aws::ServiceDiscovery
|
|
1181
1211
|
# discover instances.
|
1182
1212
|
#
|
1183
1213
|
# @option params [required, String] :namespace_name
|
1184
|
-
# The `HttpName` name of the namespace.
|
1214
|
+
# The `HttpName` name of the namespace. The `HttpName` is found in the
|
1185
1215
|
# `HttpProperties` member of the `Properties` member of the namespace.
|
1186
1216
|
# In most cases, `Name` and `HttpName` match. However, if you reuse
|
1187
1217
|
# `Name` for namespace creation, a generated hash is added to `HttpName`
|
@@ -1232,6 +1262,12 @@ module Aws::ServiceDiscovery
|
|
1232
1262
|
# state. In that case, return all instances. This is also called
|
1233
1263
|
# failing open.
|
1234
1264
|
#
|
1265
|
+
# @option params [String] :owner_account
|
1266
|
+
# The ID of the Amazon Web Services account that owns the namespace
|
1267
|
+
# associated with the instance, as specified in the namespace
|
1268
|
+
# `ResourceOwner` field. For instances associated with namespaces that
|
1269
|
+
# are shared with your account, you must specify an `OwnerAccount`.
|
1270
|
+
#
|
1235
1271
|
# @return [Types::DiscoverInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1236
1272
|
#
|
1237
1273
|
# * {Types::DiscoverInstancesResponse#instances #instances} => Array<Types::HttpInstanceSummary>
|
@@ -1278,6 +1314,7 @@ module Aws::ServiceDiscovery
|
|
1278
1314
|
# "AttrKey" => "AttrValue",
|
1279
1315
|
# },
|
1280
1316
|
# health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL, HEALTHY_OR_ELSE_ALL
|
1317
|
+
# owner_account: "AWSAccountId",
|
1281
1318
|
# })
|
1282
1319
|
#
|
1283
1320
|
# @example Response structure
|
@@ -1303,13 +1340,25 @@ module Aws::ServiceDiscovery
|
|
1303
1340
|
# Discovers the increasing revision associated with an instance.
|
1304
1341
|
#
|
1305
1342
|
# @option params [required, String] :namespace_name
|
1306
|
-
# The `HttpName` name of the namespace.
|
1343
|
+
# The `HttpName` name of the namespace. The `HttpName` is found in the
|
1307
1344
|
# `HttpProperties` member of the `Properties` member of the namespace.
|
1308
1345
|
#
|
1309
1346
|
# @option params [required, String] :service_name
|
1310
1347
|
# The name of the service that you specified when you registered the
|
1311
1348
|
# instance.
|
1312
1349
|
#
|
1350
|
+
# @option params [String] :owner_account
|
1351
|
+
# The ID of the Amazon Web Services account that owns the namespace
|
1352
|
+
# associated with the instance, as specified in the namespace
|
1353
|
+
# `ResourceOwner` field. For instances associated with namespaces that
|
1354
|
+
# are shared with your account, you must specify an `OwnerAccount`. For
|
1355
|
+
# more information about shared namespaces, see [Cross-account Cloud Map
|
1356
|
+
# namespace sharing][1] in the *Cloud Map Developer Guide*.
|
1357
|
+
#
|
1358
|
+
#
|
1359
|
+
#
|
1360
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1361
|
+
#
|
1313
1362
|
# @return [Types::DiscoverInstancesRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1314
1363
|
#
|
1315
1364
|
# * {Types::DiscoverInstancesRevisionResponse#instances_revision #instances_revision} => Integer
|
@@ -1334,6 +1383,7 @@ module Aws::ServiceDiscovery
|
|
1334
1383
|
# resp = client.discover_instances_revision({
|
1335
1384
|
# namespace_name: "NamespaceName", # required
|
1336
1385
|
# service_name: "ServiceName", # required
|
1386
|
+
# owner_account: "AWSAccountId",
|
1337
1387
|
# })
|
1338
1388
|
#
|
1339
1389
|
# @example Response structure
|
@@ -1352,13 +1402,22 @@ module Aws::ServiceDiscovery
|
|
1352
1402
|
# Gets information about a specified instance.
|
1353
1403
|
#
|
1354
1404
|
# @option params [required, String] :service_id
|
1355
|
-
# The ID of the service that the instance
|
1405
|
+
# The ID or Amazon Resource Name (ARN) of the service that the instance
|
1406
|
+
# is associated with. For services created in a shared namespace,
|
1407
|
+
# specify the service ARN. For more information about shared namespaces,
|
1408
|
+
# see [Cross-account Cloud Map namespace sharing][1] in the *Cloud Map
|
1409
|
+
# Developer Guide*.
|
1410
|
+
#
|
1411
|
+
#
|
1412
|
+
#
|
1413
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1356
1414
|
#
|
1357
1415
|
# @option params [required, String] :instance_id
|
1358
1416
|
# The ID of the instance that you want to get information about.
|
1359
1417
|
#
|
1360
1418
|
# @return [Types::GetInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1361
1419
|
#
|
1420
|
+
# * {Types::GetInstanceResponse#resource_owner #resource_owner} => String
|
1362
1421
|
# * {Types::GetInstanceResponse#instance #instance} => Types::Instance
|
1363
1422
|
#
|
1364
1423
|
#
|
@@ -1388,16 +1447,18 @@ module Aws::ServiceDiscovery
|
|
1388
1447
|
# @example Request syntax with placeholder values
|
1389
1448
|
#
|
1390
1449
|
# resp = client.get_instance({
|
1391
|
-
# service_id: "
|
1450
|
+
# service_id: "Arn", # required
|
1392
1451
|
# instance_id: "ResourceId", # required
|
1393
1452
|
# })
|
1394
1453
|
#
|
1395
1454
|
# @example Response structure
|
1396
1455
|
#
|
1456
|
+
# resp.resource_owner #=> String
|
1397
1457
|
# resp.instance.id #=> String
|
1398
1458
|
# resp.instance.creator_request_id #=> String
|
1399
1459
|
# resp.instance.attributes #=> Hash
|
1400
1460
|
# resp.instance.attributes["AttrKey"] #=> String
|
1461
|
+
# resp.instance.created_by_account #=> String
|
1401
1462
|
#
|
1402
1463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstance AWS API Documentation
|
1403
1464
|
#
|
@@ -1417,7 +1478,15 @@ module Aws::ServiceDiscovery
|
|
1417
1478
|
# </note>
|
1418
1479
|
#
|
1419
1480
|
# @option params [required, String] :service_id
|
1420
|
-
# The ID of the service that the instance
|
1481
|
+
# The ID or Amazon Resource Name (ARN) of the service that the instance
|
1482
|
+
# is associated with. For services created in a shared namespace,
|
1483
|
+
# specify the service ARN. For more information about shared namespaces,
|
1484
|
+
# see [Cross-account Cloud Map namespace sharing][1] in the *Cloud Map
|
1485
|
+
# Developer Guide*.
|
1486
|
+
#
|
1487
|
+
#
|
1488
|
+
#
|
1489
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1421
1490
|
#
|
1422
1491
|
# @option params [Array<String>] :instances
|
1423
1492
|
# An array that contains the IDs of all the instances that you want to
|
@@ -1476,7 +1545,7 @@ module Aws::ServiceDiscovery
|
|
1476
1545
|
# @example Request syntax with placeholder values
|
1477
1546
|
#
|
1478
1547
|
# resp = client.get_instances_health_status({
|
1479
|
-
# service_id: "
|
1548
|
+
# service_id: "Arn", # required
|
1480
1549
|
# instances: ["ResourceId"],
|
1481
1550
|
# max_results: 1,
|
1482
1551
|
# next_token: "NextToken",
|
@@ -1500,7 +1569,15 @@ module Aws::ServiceDiscovery
|
|
1500
1569
|
# Gets information about a namespace.
|
1501
1570
|
#
|
1502
1571
|
# @option params [required, String] :id
|
1503
|
-
# The ID of the namespace that you want to
|
1572
|
+
# The ID or Amazon Resource Name (ARN) of the namespace that you want to
|
1573
|
+
# get information about. For namespaces shared with your Amazon Web
|
1574
|
+
# Services account, specify the namespace ARN. For more information
|
1575
|
+
# about shared namespaces, see [Cross-account Cloud Map namespace
|
1576
|
+
# sharing][1] in the *Cloud Map Developer Guide*
|
1577
|
+
#
|
1578
|
+
#
|
1579
|
+
#
|
1580
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1504
1581
|
#
|
1505
1582
|
# @return [Types::GetNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1506
1583
|
#
|
@@ -1538,13 +1615,14 @@ module Aws::ServiceDiscovery
|
|
1538
1615
|
# @example Request syntax with placeholder values
|
1539
1616
|
#
|
1540
1617
|
# resp = client.get_namespace({
|
1541
|
-
# id: "
|
1618
|
+
# id: "Arn", # required
|
1542
1619
|
# })
|
1543
1620
|
#
|
1544
1621
|
# @example Response structure
|
1545
1622
|
#
|
1546
1623
|
# resp.namespace.id #=> String
|
1547
1624
|
# resp.namespace.arn #=> String
|
1625
|
+
# resp.namespace.resource_owner #=> String
|
1548
1626
|
# resp.namespace.name #=> String
|
1549
1627
|
# resp.namespace.type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE", "HTTP"
|
1550
1628
|
# resp.namespace.description #=> String
|
@@ -1579,6 +1657,12 @@ module Aws::ServiceDiscovery
|
|
1579
1657
|
# @option params [required, String] :operation_id
|
1580
1658
|
# The ID of the operation that you want to get more information about.
|
1581
1659
|
#
|
1660
|
+
# @option params [String] :owner_account
|
1661
|
+
# The ID of the Amazon Web Services account that owns the namespace
|
1662
|
+
# associated with the operation, as specified in the namespace
|
1663
|
+
# `ResourceOwner` field. For operations associated with namespaces that
|
1664
|
+
# are shared with your account, you must specify an `OwnerAccount`.
|
1665
|
+
#
|
1582
1666
|
# @return [Types::GetOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1583
1667
|
#
|
1584
1668
|
# * {Types::GetOperationResponse#operation #operation} => Types::Operation
|
@@ -1609,12 +1693,14 @@ module Aws::ServiceDiscovery
|
|
1609
1693
|
# @example Request syntax with placeholder values
|
1610
1694
|
#
|
1611
1695
|
# resp = client.get_operation({
|
1612
|
-
# operation_id: "
|
1696
|
+
# operation_id: "OperationId", # required
|
1697
|
+
# owner_account: "AWSAccountId",
|
1613
1698
|
# })
|
1614
1699
|
#
|
1615
1700
|
# @example Response structure
|
1616
1701
|
#
|
1617
1702
|
# resp.operation.id #=> String
|
1703
|
+
# resp.operation.owner_account #=> String
|
1618
1704
|
# resp.operation.type #=> String, one of "CREATE_NAMESPACE", "DELETE_NAMESPACE", "UPDATE_NAMESPACE", "UPDATE_SERVICE", "REGISTER_INSTANCE", "DEREGISTER_INSTANCE"
|
1619
1705
|
# resp.operation.status #=> String, one of "SUBMITTED", "PENDING", "SUCCESS", "FAIL"
|
1620
1706
|
# resp.operation.error_message #=> String
|
@@ -1636,7 +1722,15 @@ module Aws::ServiceDiscovery
|
|
1636
1722
|
# Gets the settings for a specified service.
|
1637
1723
|
#
|
1638
1724
|
# @option params [required, String] :id
|
1639
|
-
# The ID of the service that you want to
|
1725
|
+
# The ID or Amazon Resource Name (ARN) of the service that you want to
|
1726
|
+
# get settings for. For services created by consumers in a shared
|
1727
|
+
# namespace, specify the service ARN. For more information about shared
|
1728
|
+
# namespaces, see [Cross-account Cloud Map namespace sharing][1] in the
|
1729
|
+
# *Cloud Map Developer Guide*.
|
1730
|
+
#
|
1731
|
+
#
|
1732
|
+
#
|
1733
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1640
1734
|
#
|
1641
1735
|
# @return [Types::GetServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1642
1736
|
#
|
@@ -1672,13 +1766,14 @@ module Aws::ServiceDiscovery
|
|
1672
1766
|
# @example Request syntax with placeholder values
|
1673
1767
|
#
|
1674
1768
|
# resp = client.get_service({
|
1675
|
-
# id: "
|
1769
|
+
# id: "Arn", # required
|
1676
1770
|
# })
|
1677
1771
|
#
|
1678
1772
|
# @example Response structure
|
1679
1773
|
#
|
1680
1774
|
# resp.service.id #=> String
|
1681
1775
|
# resp.service.arn #=> String
|
1776
|
+
# resp.service.resource_owner #=> String
|
1682
1777
|
# resp.service.name #=> String
|
1683
1778
|
# resp.service.namespace_id #=> String
|
1684
1779
|
# resp.service.description #=> String
|
@@ -1695,6 +1790,7 @@ module Aws::ServiceDiscovery
|
|
1695
1790
|
# resp.service.health_check_custom_config.failure_threshold #=> Integer
|
1696
1791
|
# resp.service.create_date #=> Time
|
1697
1792
|
# resp.service.creator_request_id #=> String
|
1793
|
+
# resp.service.created_by_account #=> String
|
1698
1794
|
#
|
1699
1795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetService AWS API Documentation
|
1700
1796
|
#
|
@@ -1708,7 +1804,15 @@ module Aws::ServiceDiscovery
|
|
1708
1804
|
# Returns the attributes associated with a specified service.
|
1709
1805
|
#
|
1710
1806
|
# @option params [required, String] :service_id
|
1711
|
-
# The ID of the service that you want to
|
1807
|
+
# The ID or Amazon Resource Name (ARN) of the service that you want to
|
1808
|
+
# get attributes for. For services created in a namespace shared with
|
1809
|
+
# your Amazon Web Services account, specify the service ARN. For more
|
1810
|
+
# information about shared namespaces, see [Cross-account Cloud Map
|
1811
|
+
# namespace sharing][1] in the *Cloud Map Developer Guide*.
|
1812
|
+
#
|
1813
|
+
#
|
1814
|
+
#
|
1815
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1712
1816
|
#
|
1713
1817
|
# @return [Types::GetServiceAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1714
1818
|
#
|
@@ -1736,12 +1840,13 @@ module Aws::ServiceDiscovery
|
|
1736
1840
|
# @example Request syntax with placeholder values
|
1737
1841
|
#
|
1738
1842
|
# resp = client.get_service_attributes({
|
1739
|
-
# service_id: "
|
1843
|
+
# service_id: "Arn", # required
|
1740
1844
|
# })
|
1741
1845
|
#
|
1742
1846
|
# @example Response structure
|
1743
1847
|
#
|
1744
1848
|
# resp.service_attributes.service_arn #=> String
|
1849
|
+
# resp.service_attributes.resource_owner #=> String
|
1745
1850
|
# resp.service_attributes.attributes #=> Hash
|
1746
1851
|
# resp.service_attributes.attributes["ServiceAttributeKey"] #=> String
|
1747
1852
|
#
|
@@ -1758,7 +1863,15 @@ module Aws::ServiceDiscovery
|
|
1758
1863
|
# using a specified service.
|
1759
1864
|
#
|
1760
1865
|
# @option params [required, String] :service_id
|
1761
|
-
# The ID of the service that you want to
|
1866
|
+
# The ID or Amazon Resource Name (ARN) of the service that you want to
|
1867
|
+
# list instances for. For services created in a shared namespace,
|
1868
|
+
# specify the service ARN. For more information about shared namespaces,
|
1869
|
+
# see [Cross-account Cloud Map namespace sharing][1] in the *Cloud Map
|
1870
|
+
# Developer Guide*.
|
1871
|
+
#
|
1872
|
+
#
|
1873
|
+
#
|
1874
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
1762
1875
|
#
|
1763
1876
|
# @option params [String] :next_token
|
1764
1877
|
# For the first `ListInstances` request, omit this value.
|
@@ -1775,6 +1888,7 @@ module Aws::ServiceDiscovery
|
|
1775
1888
|
#
|
1776
1889
|
# @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1777
1890
|
#
|
1891
|
+
# * {Types::ListInstancesResponse#resource_owner #resource_owner} => String
|
1778
1892
|
# * {Types::ListInstancesResponse#instances #instances} => Array<Types::InstanceSummary>
|
1779
1893
|
# * {Types::ListInstancesResponse#next_token #next_token} => String
|
1780
1894
|
#
|
@@ -1805,17 +1919,19 @@ module Aws::ServiceDiscovery
|
|
1805
1919
|
# @example Request syntax with placeholder values
|
1806
1920
|
#
|
1807
1921
|
# resp = client.list_instances({
|
1808
|
-
# service_id: "
|
1922
|
+
# service_id: "Arn", # required
|
1809
1923
|
# next_token: "NextToken",
|
1810
1924
|
# max_results: 1,
|
1811
1925
|
# })
|
1812
1926
|
#
|
1813
1927
|
# @example Response structure
|
1814
1928
|
#
|
1929
|
+
# resp.resource_owner #=> String
|
1815
1930
|
# resp.instances #=> Array
|
1816
1931
|
# resp.instances[0].id #=> String
|
1817
1932
|
# resp.instances[0].attributes #=> Hash
|
1818
1933
|
# resp.instances[0].attributes["AttrKey"] #=> String
|
1934
|
+
# resp.instances[0].created_by_account #=> String
|
1819
1935
|
# resp.next_token #=> String
|
1820
1936
|
#
|
1821
1937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstances AWS API Documentation
|
@@ -1828,7 +1944,8 @@ module Aws::ServiceDiscovery
|
|
1828
1944
|
end
|
1829
1945
|
|
1830
1946
|
# Lists summary information about the namespaces that were created by
|
1831
|
-
# the current Amazon Web Services account
|
1947
|
+
# the current Amazon Web Services account and shared with the current
|
1948
|
+
# Amazon Web Services account.
|
1832
1949
|
#
|
1833
1950
|
# @option params [String] :next_token
|
1834
1951
|
# For the first `ListNamespaces` request, omit this value.
|
@@ -1930,7 +2047,7 @@ module Aws::ServiceDiscovery
|
|
1930
2047
|
# max_results: 1,
|
1931
2048
|
# filters: [
|
1932
2049
|
# {
|
1933
|
-
# name: "TYPE", # required, accepts TYPE, NAME, HTTP_NAME
|
2050
|
+
# name: "TYPE", # required, accepts TYPE, NAME, HTTP_NAME, RESOURCE_OWNER
|
1934
2051
|
# values: ["FilterValue"], # required
|
1935
2052
|
# condition: "EQ", # accepts EQ, IN, BETWEEN, BEGINS_WITH
|
1936
2053
|
# },
|
@@ -1942,6 +2059,7 @@ module Aws::ServiceDiscovery
|
|
1942
2059
|
# resp.namespaces #=> Array
|
1943
2060
|
# resp.namespaces[0].id #=> String
|
1944
2061
|
# resp.namespaces[0].arn #=> String
|
2062
|
+
# resp.namespaces[0].resource_owner #=> String
|
1945
2063
|
# resp.namespaces[0].name #=> String
|
1946
2064
|
# resp.namespaces[0].type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE", "HTTP"
|
1947
2065
|
# resp.namespaces[0].description #=> String
|
@@ -2137,7 +2255,7 @@ module Aws::ServiceDiscovery
|
|
2137
2255
|
# max_results: 1,
|
2138
2256
|
# filters: [
|
2139
2257
|
# {
|
2140
|
-
# name: "NAMESPACE_ID", # required, accepts NAMESPACE_ID
|
2258
|
+
# name: "NAMESPACE_ID", # required, accepts NAMESPACE_ID, RESOURCE_OWNER
|
2141
2259
|
# values: ["FilterValue"], # required
|
2142
2260
|
# condition: "EQ", # accepts EQ, IN, BETWEEN, BEGINS_WITH
|
2143
2261
|
# },
|
@@ -2149,6 +2267,7 @@ module Aws::ServiceDiscovery
|
|
2149
2267
|
# resp.services #=> Array
|
2150
2268
|
# resp.services[0].id #=> String
|
2151
2269
|
# resp.services[0].arn #=> String
|
2270
|
+
# resp.services[0].resource_owner #=> String
|
2152
2271
|
# resp.services[0].name #=> String
|
2153
2272
|
# resp.services[0].type #=> String, one of "HTTP", "DNS_HTTP", "DNS"
|
2154
2273
|
# resp.services[0].description #=> String
|
@@ -2163,6 +2282,7 @@ module Aws::ServiceDiscovery
|
|
2163
2282
|
# resp.services[0].health_check_config.failure_threshold #=> Integer
|
2164
2283
|
# resp.services[0].health_check_custom_config.failure_threshold #=> Integer
|
2165
2284
|
# resp.services[0].create_date #=> Time
|
2285
|
+
# resp.services[0].created_by_account #=> String
|
2166
2286
|
# resp.next_token #=> String
|
2167
2287
|
#
|
2168
2288
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices AWS API Documentation
|
@@ -2268,8 +2388,15 @@ module Aws::ServiceDiscovery
|
|
2268
2388
|
# [2]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
2269
2389
|
#
|
2270
2390
|
# @option params [required, String] :service_id
|
2271
|
-
# The ID of the service that you want to
|
2272
|
-
# instance.
|
2391
|
+
# The ID or Amazon Resource Name (ARN) of the service that you want to
|
2392
|
+
# use for settings for the instance. For services created in a shared
|
2393
|
+
# namespace, specify the service ARN. For more information about shared
|
2394
|
+
# namespaces, see [Cross-account Cloud Map namespace sharing][1] in the
|
2395
|
+
# *Cloud Map Developer Guide*.
|
2396
|
+
#
|
2397
|
+
#
|
2398
|
+
#
|
2399
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
2273
2400
|
#
|
2274
2401
|
# @option params [required, String] :instance_id
|
2275
2402
|
# An identifier that you want to associate with the instance. Note the
|
@@ -2462,7 +2589,7 @@ module Aws::ServiceDiscovery
|
|
2462
2589
|
# @example Request syntax with placeholder values
|
2463
2590
|
#
|
2464
2591
|
# resp = client.register_instance({
|
2465
|
-
# service_id: "
|
2592
|
+
# service_id: "Arn", # required
|
2466
2593
|
# instance_id: "InstanceId", # required
|
2467
2594
|
# creator_request_id: "ResourceId",
|
2468
2595
|
# attributes: { # required
|
@@ -2587,7 +2714,8 @@ module Aws::ServiceDiscovery
|
|
2587
2714
|
# Updates an HTTP namespace.
|
2588
2715
|
#
|
2589
2716
|
# @option params [required, String] :id
|
2590
|
-
# The ID of the namespace that you want to
|
2717
|
+
# The ID or Amazon Resource Name (ARN) of the namespace that you want to
|
2718
|
+
# update.
|
2591
2719
|
#
|
2592
2720
|
# @option params [String] :updater_request_id
|
2593
2721
|
# A unique string that identifies the request and that allows failed
|
@@ -2625,7 +2753,7 @@ module Aws::ServiceDiscovery
|
|
2625
2753
|
# @example Request syntax with placeholder values
|
2626
2754
|
#
|
2627
2755
|
# resp = client.update_http_namespace({
|
2628
|
-
# id: "
|
2756
|
+
# id: "Arn", # required
|
2629
2757
|
# updater_request_id: "ResourceId",
|
2630
2758
|
# namespace: { # required
|
2631
2759
|
# description: "ResourceDescription", # required
|
@@ -2661,8 +2789,16 @@ module Aws::ServiceDiscovery
|
|
2661
2789
|
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
|
2662
2790
|
#
|
2663
2791
|
# @option params [required, String] :service_id
|
2664
|
-
# The ID of the service that includes the
|
2665
|
-
# health check that you want to change the
|
2792
|
+
# The ID or Amazon Resource Name (ARN) of the service that includes the
|
2793
|
+
# configuration for the custom health check that you want to change the
|
2794
|
+
# status for. For services created in a shared namespace, specify the
|
2795
|
+
# service ARN. For more information about shared namespaces, see
|
2796
|
+
# [Cross-account Cloud Map namespace sharing][1] in the *Cloud Map
|
2797
|
+
# Developer Guide*.
|
2798
|
+
#
|
2799
|
+
#
|
2800
|
+
#
|
2801
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
2666
2802
|
#
|
2667
2803
|
# @option params [required, String] :instance_id
|
2668
2804
|
# The ID of the instance that you want to change the health status for.
|
@@ -2687,7 +2823,7 @@ module Aws::ServiceDiscovery
|
|
2687
2823
|
# @example Request syntax with placeholder values
|
2688
2824
|
#
|
2689
2825
|
# resp = client.update_instance_custom_health_status({
|
2690
|
-
# service_id: "
|
2826
|
+
# service_id: "Arn", # required
|
2691
2827
|
# instance_id: "ResourceId", # required
|
2692
2828
|
# status: "HEALTHY", # required, accepts HEALTHY, UNHEALTHY
|
2693
2829
|
# })
|
@@ -2704,7 +2840,8 @@ module Aws::ServiceDiscovery
|
|
2704
2840
|
# Updates a private DNS namespace.
|
2705
2841
|
#
|
2706
2842
|
# @option params [required, String] :id
|
2707
|
-
# The ID of the namespace that you want to
|
2843
|
+
# The ID or Amazon Resource Name (ARN) of the namespace that you want to
|
2844
|
+
# update.
|
2708
2845
|
#
|
2709
2846
|
# @option params [String] :updater_request_id
|
2710
2847
|
# A unique string that identifies the request and that allows failed
|
@@ -2723,9 +2860,9 @@ module Aws::ServiceDiscovery
|
|
2723
2860
|
# * {Types::UpdatePrivateDnsNamespaceResponse#operation_id #operation_id} => String
|
2724
2861
|
#
|
2725
2862
|
#
|
2726
|
-
# @example Example: To update a
|
2863
|
+
# @example Example: To update a private DNS namespace
|
2727
2864
|
#
|
2728
|
-
# # The following example updates the description of a
|
2865
|
+
# # The following example updates the description of a private DNS namespace.
|
2729
2866
|
#
|
2730
2867
|
# resp = client.update_private_dns_namespace({
|
2731
2868
|
# id: "ns-bk3aEXAMPLE",
|
@@ -2737,12 +2874,12 @@ module Aws::ServiceDiscovery
|
|
2737
2874
|
#
|
2738
2875
|
# resp.to_h outputs the following:
|
2739
2876
|
# {
|
2740
|
-
# operation_id: "
|
2877
|
+
# operation_id: "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE",
|
2741
2878
|
# }
|
2742
2879
|
#
|
2743
|
-
# @example Example: To update a
|
2880
|
+
# @example Example: To update a public DNS namespace
|
2744
2881
|
#
|
2745
|
-
# # The following example updates the description of a
|
2882
|
+
# # The following example updates the description of a public DNS namespace.
|
2746
2883
|
#
|
2747
2884
|
# resp = client.update_private_dns_namespace({
|
2748
2885
|
# id: "ns-bk3aEXAMPLE",
|
@@ -2754,13 +2891,13 @@ module Aws::ServiceDiscovery
|
|
2754
2891
|
#
|
2755
2892
|
# resp.to_h outputs the following:
|
2756
2893
|
# {
|
2757
|
-
# operation_id: "
|
2894
|
+
# operation_id: "ft52xe2koxhoeormaceymagglsdjEXAMPLE",
|
2758
2895
|
# }
|
2759
2896
|
#
|
2760
2897
|
# @example Request syntax with placeholder values
|
2761
2898
|
#
|
2762
2899
|
# resp = client.update_private_dns_namespace({
|
2763
|
-
# id: "
|
2900
|
+
# id: "Arn", # required
|
2764
2901
|
# updater_request_id: "ResourceId",
|
2765
2902
|
# namespace: { # required
|
2766
2903
|
# description: "ResourceDescription",
|
@@ -2790,7 +2927,7 @@ module Aws::ServiceDiscovery
|
|
2790
2927
|
# Updates a public DNS namespace.
|
2791
2928
|
#
|
2792
2929
|
# @option params [required, String] :id
|
2793
|
-
# The ID of the namespace being updated.
|
2930
|
+
# The ID or Amazon Resource Name (ARN) of the namespace being updated.
|
2794
2931
|
#
|
2795
2932
|
# @option params [String] :updater_request_id
|
2796
2933
|
# A unique string that identifies the request and that allows failed
|
@@ -2811,7 +2948,7 @@ module Aws::ServiceDiscovery
|
|
2811
2948
|
# @example Request syntax with placeholder values
|
2812
2949
|
#
|
2813
2950
|
# resp = client.update_public_dns_namespace({
|
2814
|
-
# id: "
|
2951
|
+
# id: "Arn", # required
|
2815
2952
|
# updater_request_id: "ResourceId",
|
2816
2953
|
# namespace: { # required
|
2817
2954
|
# description: "ResourceDescription",
|
@@ -2859,12 +2996,31 @@ module Aws::ServiceDiscovery
|
|
2859
2996
|
# an `UpdateService` request, the configuration isn't deleted from
|
2860
2997
|
# the service.
|
2861
2998
|
#
|
2999
|
+
# <note markdown="1"> You can't call `UpdateService` and update settings in the following
|
3000
|
+
# scenarios:
|
3001
|
+
#
|
3002
|
+
# * When the service is associated with an HTTP namespace
|
3003
|
+
#
|
3004
|
+
# * When the service is associated with a shared namespace and contains
|
3005
|
+
# instances that were registered by Amazon Web Services accounts other
|
3006
|
+
# than the account making the `UpdateService` call
|
3007
|
+
#
|
3008
|
+
# </note>
|
3009
|
+
#
|
2862
3010
|
# When you update settings for a service, Cloud Map also updates the
|
2863
3011
|
# corresponding settings in all the records and health checks that were
|
2864
3012
|
# created by using the specified service.
|
2865
3013
|
#
|
2866
3014
|
# @option params [required, String] :id
|
2867
|
-
# The ID of the service that you want to
|
3015
|
+
# The ID or Amazon Resource Name (ARN) of the service that you want to
|
3016
|
+
# update. If the namespace associated with the service is shared with
|
3017
|
+
# your Amazon Web Services account, specify the service ARN. For more
|
3018
|
+
# information about shared namespaces, see [Cross-account Cloud Map
|
3019
|
+
# namespace sharing][1] in the *Cloud Map Developer Guide*
|
3020
|
+
#
|
3021
|
+
#
|
3022
|
+
#
|
3023
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html
|
2868
3024
|
#
|
2869
3025
|
# @option params [required, Types::ServiceChange] :service
|
2870
3026
|
# A complex type that contains the new settings for the service. You can
|
@@ -2906,7 +3062,7 @@ module Aws::ServiceDiscovery
|
|
2906
3062
|
# @example Request syntax with placeholder values
|
2907
3063
|
#
|
2908
3064
|
# resp = client.update_service({
|
2909
|
-
# id: "
|
3065
|
+
# id: "Arn", # required
|
2910
3066
|
# service: { # required
|
2911
3067
|
# description: "ResourceDescription",
|
2912
3068
|
# dns_config: {
|
@@ -2942,7 +3098,9 @@ module Aws::ServiceDiscovery
|
|
2942
3098
|
# attributes.
|
2943
3099
|
#
|
2944
3100
|
# @option params [required, String] :service_id
|
2945
|
-
# The ID of the service that you want to
|
3101
|
+
# The ID or Amazon Resource Name (ARN) of the service that you want to
|
3102
|
+
# update. For services created in a namespace shared with your Amazon
|
3103
|
+
# Web Services account, specify the service ARN.
|
2946
3104
|
#
|
2947
3105
|
# @option params [required, Hash<String,String>] :attributes
|
2948
3106
|
# A string map that contains attribute key-value pairs.
|
@@ -2968,7 +3126,7 @@ module Aws::ServiceDiscovery
|
|
2968
3126
|
# @example Request syntax with placeholder values
|
2969
3127
|
#
|
2970
3128
|
# resp = client.update_service_attributes({
|
2971
|
-
# service_id: "
|
3129
|
+
# service_id: "Arn", # required
|
2972
3130
|
# attributes: { # required
|
2973
3131
|
# "ServiceAttributeKey" => "ServiceAttributeValue",
|
2974
3132
|
# },
|
@@ -3001,7 +3159,7 @@ module Aws::ServiceDiscovery
|
|
3001
3159
|
tracer: tracer
|
3002
3160
|
)
|
3003
3161
|
context[:gem_name] = 'aws-sdk-servicediscovery'
|
3004
|
-
context[:gem_version] = '1.
|
3162
|
+
context[:gem_version] = '1.89.0'
|
3005
3163
|
Seahorse::Client::Request.new(handlers, context)
|
3006
3164
|
end
|
3007
3165
|
|