aws-sdk-servicediscovery 1.88.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-servicediscovery/client.rb +214 -53
- 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
@@ -826,9 +826,15 @@ module Aws::ServiceDiscovery
|
|
826
826
|
# [1]: http://www.haproxy.org/
|
827
827
|
#
|
828
828
|
# @option params [String] :namespace_id
|
829
|
-
# The ID of the namespace that you want to
|
830
|
-
#
|
831
|
-
#
|
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
|
832
838
|
#
|
833
839
|
# @option params [String] :creator_request_id
|
834
840
|
# A unique string that identifies the request and that allows failed
|
@@ -934,7 +940,7 @@ module Aws::ServiceDiscovery
|
|
934
940
|
#
|
935
941
|
# resp = client.create_service({
|
936
942
|
# name: "ServiceName", # required
|
937
|
-
# namespace_id: "
|
943
|
+
# namespace_id: "Arn",
|
938
944
|
# creator_request_id: "ResourceId",
|
939
945
|
# description: "ResourceDescription",
|
940
946
|
# dns_config: {
|
@@ -968,6 +974,7 @@ module Aws::ServiceDiscovery
|
|
968
974
|
#
|
969
975
|
# resp.service.id #=> String
|
970
976
|
# resp.service.arn #=> String
|
977
|
+
# resp.service.resource_owner #=> String
|
971
978
|
# resp.service.name #=> String
|
972
979
|
# resp.service.namespace_id #=> String
|
973
980
|
# resp.service.description #=> String
|
@@ -984,6 +991,7 @@ module Aws::ServiceDiscovery
|
|
984
991
|
# resp.service.health_check_custom_config.failure_threshold #=> Integer
|
985
992
|
# resp.service.create_date #=> Time
|
986
993
|
# resp.service.creator_request_id #=> String
|
994
|
+
# resp.service.created_by_account #=> String
|
987
995
|
#
|
988
996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateService AWS API Documentation
|
989
997
|
#
|
@@ -998,7 +1006,8 @@ module Aws::ServiceDiscovery
|
|
998
1006
|
# contains one or more services, the request fails.
|
999
1007
|
#
|
1000
1008
|
# @option params [required, String] :id
|
1001
|
-
# 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.
|
1002
1011
|
#
|
1003
1012
|
# @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1004
1013
|
#
|
@@ -1021,7 +1030,7 @@ module Aws::ServiceDiscovery
|
|
1021
1030
|
# @example Request syntax with placeholder values
|
1022
1031
|
#
|
1023
1032
|
# resp = client.delete_namespace({
|
1024
|
-
# id: "
|
1033
|
+
# id: "Arn", # required
|
1025
1034
|
# })
|
1026
1035
|
#
|
1027
1036
|
# @example Response structure
|
@@ -1042,7 +1051,15 @@ module Aws::ServiceDiscovery
|
|
1042
1051
|
# request fails.
|
1043
1052
|
#
|
1044
1053
|
# @option params [required, String] :id
|
1045
|
-
# 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
|
1046
1063
|
#
|
1047
1064
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1048
1065
|
#
|
@@ -1062,7 +1079,7 @@ module Aws::ServiceDiscovery
|
|
1062
1079
|
# @example Request syntax with placeholder values
|
1063
1080
|
#
|
1064
1081
|
# resp = client.delete_service({
|
1065
|
-
# id: "
|
1082
|
+
# id: "Arn", # required
|
1066
1083
|
# })
|
1067
1084
|
#
|
1068
1085
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteService AWS API Documentation
|
@@ -1077,7 +1094,15 @@ module Aws::ServiceDiscovery
|
|
1077
1094
|
# Deletes specific attributes associated with a service.
|
1078
1095
|
#
|
1079
1096
|
# @option params [required, String] :service_id
|
1080
|
-
# 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
|
1081
1106
|
#
|
1082
1107
|
# @option params [required, Array<String>] :attributes
|
1083
1108
|
# A list of keys corresponding to each attribute that you want to
|
@@ -1104,7 +1129,7 @@ module Aws::ServiceDiscovery
|
|
1104
1129
|
# @example Request syntax with placeholder values
|
1105
1130
|
#
|
1106
1131
|
# resp = client.delete_service_attributes({
|
1107
|
-
# service_id: "
|
1132
|
+
# service_id: "Arn", # required
|
1108
1133
|
# attributes: ["ServiceAttributeKey"], # required
|
1109
1134
|
# })
|
1110
1135
|
#
|
@@ -1121,7 +1146,15 @@ module Aws::ServiceDiscovery
|
|
1121
1146
|
# Cloud Map created for the specified instance.
|
1122
1147
|
#
|
1123
1148
|
# @option params [required, String] :service_id
|
1124
|
-
# 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
|
1125
1158
|
#
|
1126
1159
|
# @option params [required, String] :instance_id
|
1127
1160
|
# The value that you specified for `Id` in the [RegisterInstance][1]
|
@@ -1153,7 +1186,7 @@ module Aws::ServiceDiscovery
|
|
1153
1186
|
# @example Request syntax with placeholder values
|
1154
1187
|
#
|
1155
1188
|
# resp = client.deregister_instance({
|
1156
|
-
# service_id: "
|
1189
|
+
# service_id: "Arn", # required
|
1157
1190
|
# instance_id: "ResourceId", # required
|
1158
1191
|
# })
|
1159
1192
|
#
|
@@ -1178,7 +1211,7 @@ module Aws::ServiceDiscovery
|
|
1178
1211
|
# discover instances.
|
1179
1212
|
#
|
1180
1213
|
# @option params [required, String] :namespace_name
|
1181
|
-
# The `HttpName` name of the namespace.
|
1214
|
+
# The `HttpName` name of the namespace. The `HttpName` is found in the
|
1182
1215
|
# `HttpProperties` member of the `Properties` member of the namespace.
|
1183
1216
|
# In most cases, `Name` and `HttpName` match. However, if you reuse
|
1184
1217
|
# `Name` for namespace creation, a generated hash is added to `HttpName`
|
@@ -1229,6 +1262,12 @@ module Aws::ServiceDiscovery
|
|
1229
1262
|
# state. In that case, return all instances. This is also called
|
1230
1263
|
# failing open.
|
1231
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
|
+
#
|
1232
1271
|
# @return [Types::DiscoverInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1233
1272
|
#
|
1234
1273
|
# * {Types::DiscoverInstancesResponse#instances #instances} => Array<Types::HttpInstanceSummary>
|
@@ -1275,6 +1314,7 @@ module Aws::ServiceDiscovery
|
|
1275
1314
|
# "AttrKey" => "AttrValue",
|
1276
1315
|
# },
|
1277
1316
|
# health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL, HEALTHY_OR_ELSE_ALL
|
1317
|
+
# owner_account: "AWSAccountId",
|
1278
1318
|
# })
|
1279
1319
|
#
|
1280
1320
|
# @example Response structure
|
@@ -1300,13 +1340,25 @@ module Aws::ServiceDiscovery
|
|
1300
1340
|
# Discovers the increasing revision associated with an instance.
|
1301
1341
|
#
|
1302
1342
|
# @option params [required, String] :namespace_name
|
1303
|
-
# The `HttpName` name of the namespace.
|
1343
|
+
# The `HttpName` name of the namespace. The `HttpName` is found in the
|
1304
1344
|
# `HttpProperties` member of the `Properties` member of the namespace.
|
1305
1345
|
#
|
1306
1346
|
# @option params [required, String] :service_name
|
1307
1347
|
# The name of the service that you specified when you registered the
|
1308
1348
|
# instance.
|
1309
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
|
+
#
|
1310
1362
|
# @return [Types::DiscoverInstancesRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1311
1363
|
#
|
1312
1364
|
# * {Types::DiscoverInstancesRevisionResponse#instances_revision #instances_revision} => Integer
|
@@ -1331,6 +1383,7 @@ module Aws::ServiceDiscovery
|
|
1331
1383
|
# resp = client.discover_instances_revision({
|
1332
1384
|
# namespace_name: "NamespaceName", # required
|
1333
1385
|
# service_name: "ServiceName", # required
|
1386
|
+
# owner_account: "AWSAccountId",
|
1334
1387
|
# })
|
1335
1388
|
#
|
1336
1389
|
# @example Response structure
|
@@ -1349,13 +1402,22 @@ module Aws::ServiceDiscovery
|
|
1349
1402
|
# Gets information about a specified instance.
|
1350
1403
|
#
|
1351
1404
|
# @option params [required, String] :service_id
|
1352
|
-
# 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
|
1353
1414
|
#
|
1354
1415
|
# @option params [required, String] :instance_id
|
1355
1416
|
# The ID of the instance that you want to get information about.
|
1356
1417
|
#
|
1357
1418
|
# @return [Types::GetInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1358
1419
|
#
|
1420
|
+
# * {Types::GetInstanceResponse#resource_owner #resource_owner} => String
|
1359
1421
|
# * {Types::GetInstanceResponse#instance #instance} => Types::Instance
|
1360
1422
|
#
|
1361
1423
|
#
|
@@ -1385,16 +1447,18 @@ module Aws::ServiceDiscovery
|
|
1385
1447
|
# @example Request syntax with placeholder values
|
1386
1448
|
#
|
1387
1449
|
# resp = client.get_instance({
|
1388
|
-
# service_id: "
|
1450
|
+
# service_id: "Arn", # required
|
1389
1451
|
# instance_id: "ResourceId", # required
|
1390
1452
|
# })
|
1391
1453
|
#
|
1392
1454
|
# @example Response structure
|
1393
1455
|
#
|
1456
|
+
# resp.resource_owner #=> String
|
1394
1457
|
# resp.instance.id #=> String
|
1395
1458
|
# resp.instance.creator_request_id #=> String
|
1396
1459
|
# resp.instance.attributes #=> Hash
|
1397
1460
|
# resp.instance.attributes["AttrKey"] #=> String
|
1461
|
+
# resp.instance.created_by_account #=> String
|
1398
1462
|
#
|
1399
1463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstance AWS API Documentation
|
1400
1464
|
#
|
@@ -1414,7 +1478,15 @@ module Aws::ServiceDiscovery
|
|
1414
1478
|
# </note>
|
1415
1479
|
#
|
1416
1480
|
# @option params [required, String] :service_id
|
1417
|
-
# 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
|
1418
1490
|
#
|
1419
1491
|
# @option params [Array<String>] :instances
|
1420
1492
|
# An array that contains the IDs of all the instances that you want to
|
@@ -1473,7 +1545,7 @@ module Aws::ServiceDiscovery
|
|
1473
1545
|
# @example Request syntax with placeholder values
|
1474
1546
|
#
|
1475
1547
|
# resp = client.get_instances_health_status({
|
1476
|
-
# service_id: "
|
1548
|
+
# service_id: "Arn", # required
|
1477
1549
|
# instances: ["ResourceId"],
|
1478
1550
|
# max_results: 1,
|
1479
1551
|
# next_token: "NextToken",
|
@@ -1497,7 +1569,15 @@ module Aws::ServiceDiscovery
|
|
1497
1569
|
# Gets information about a namespace.
|
1498
1570
|
#
|
1499
1571
|
# @option params [required, String] :id
|
1500
|
-
# 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
|
1501
1581
|
#
|
1502
1582
|
# @return [Types::GetNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1503
1583
|
#
|
@@ -1535,13 +1615,14 @@ module Aws::ServiceDiscovery
|
|
1535
1615
|
# @example Request syntax with placeholder values
|
1536
1616
|
#
|
1537
1617
|
# resp = client.get_namespace({
|
1538
|
-
# id: "
|
1618
|
+
# id: "Arn", # required
|
1539
1619
|
# })
|
1540
1620
|
#
|
1541
1621
|
# @example Response structure
|
1542
1622
|
#
|
1543
1623
|
# resp.namespace.id #=> String
|
1544
1624
|
# resp.namespace.arn #=> String
|
1625
|
+
# resp.namespace.resource_owner #=> String
|
1545
1626
|
# resp.namespace.name #=> String
|
1546
1627
|
# resp.namespace.type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE", "HTTP"
|
1547
1628
|
# resp.namespace.description #=> String
|
@@ -1576,6 +1657,12 @@ module Aws::ServiceDiscovery
|
|
1576
1657
|
# @option params [required, String] :operation_id
|
1577
1658
|
# The ID of the operation that you want to get more information about.
|
1578
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
|
+
#
|
1579
1666
|
# @return [Types::GetOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1580
1667
|
#
|
1581
1668
|
# * {Types::GetOperationResponse#operation #operation} => Types::Operation
|
@@ -1606,12 +1693,14 @@ module Aws::ServiceDiscovery
|
|
1606
1693
|
# @example Request syntax with placeholder values
|
1607
1694
|
#
|
1608
1695
|
# resp = client.get_operation({
|
1609
|
-
# operation_id: "
|
1696
|
+
# operation_id: "OperationId", # required
|
1697
|
+
# owner_account: "AWSAccountId",
|
1610
1698
|
# })
|
1611
1699
|
#
|
1612
1700
|
# @example Response structure
|
1613
1701
|
#
|
1614
1702
|
# resp.operation.id #=> String
|
1703
|
+
# resp.operation.owner_account #=> String
|
1615
1704
|
# resp.operation.type #=> String, one of "CREATE_NAMESPACE", "DELETE_NAMESPACE", "UPDATE_NAMESPACE", "UPDATE_SERVICE", "REGISTER_INSTANCE", "DEREGISTER_INSTANCE"
|
1616
1705
|
# resp.operation.status #=> String, one of "SUBMITTED", "PENDING", "SUCCESS", "FAIL"
|
1617
1706
|
# resp.operation.error_message #=> String
|
@@ -1633,7 +1722,15 @@ module Aws::ServiceDiscovery
|
|
1633
1722
|
# Gets the settings for a specified service.
|
1634
1723
|
#
|
1635
1724
|
# @option params [required, String] :id
|
1636
|
-
# 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
|
1637
1734
|
#
|
1638
1735
|
# @return [Types::GetServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1639
1736
|
#
|
@@ -1669,13 +1766,14 @@ module Aws::ServiceDiscovery
|
|
1669
1766
|
# @example Request syntax with placeholder values
|
1670
1767
|
#
|
1671
1768
|
# resp = client.get_service({
|
1672
|
-
# id: "
|
1769
|
+
# id: "Arn", # required
|
1673
1770
|
# })
|
1674
1771
|
#
|
1675
1772
|
# @example Response structure
|
1676
1773
|
#
|
1677
1774
|
# resp.service.id #=> String
|
1678
1775
|
# resp.service.arn #=> String
|
1776
|
+
# resp.service.resource_owner #=> String
|
1679
1777
|
# resp.service.name #=> String
|
1680
1778
|
# resp.service.namespace_id #=> String
|
1681
1779
|
# resp.service.description #=> String
|
@@ -1692,6 +1790,7 @@ module Aws::ServiceDiscovery
|
|
1692
1790
|
# resp.service.health_check_custom_config.failure_threshold #=> Integer
|
1693
1791
|
# resp.service.create_date #=> Time
|
1694
1792
|
# resp.service.creator_request_id #=> String
|
1793
|
+
# resp.service.created_by_account #=> String
|
1695
1794
|
#
|
1696
1795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetService AWS API Documentation
|
1697
1796
|
#
|
@@ -1705,7 +1804,15 @@ module Aws::ServiceDiscovery
|
|
1705
1804
|
# Returns the attributes associated with a specified service.
|
1706
1805
|
#
|
1707
1806
|
# @option params [required, String] :service_id
|
1708
|
-
# 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
|
1709
1816
|
#
|
1710
1817
|
# @return [Types::GetServiceAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1711
1818
|
#
|
@@ -1733,12 +1840,13 @@ module Aws::ServiceDiscovery
|
|
1733
1840
|
# @example Request syntax with placeholder values
|
1734
1841
|
#
|
1735
1842
|
# resp = client.get_service_attributes({
|
1736
|
-
# service_id: "
|
1843
|
+
# service_id: "Arn", # required
|
1737
1844
|
# })
|
1738
1845
|
#
|
1739
1846
|
# @example Response structure
|
1740
1847
|
#
|
1741
1848
|
# resp.service_attributes.service_arn #=> String
|
1849
|
+
# resp.service_attributes.resource_owner #=> String
|
1742
1850
|
# resp.service_attributes.attributes #=> Hash
|
1743
1851
|
# resp.service_attributes.attributes["ServiceAttributeKey"] #=> String
|
1744
1852
|
#
|
@@ -1755,7 +1863,15 @@ module Aws::ServiceDiscovery
|
|
1755
1863
|
# using a specified service.
|
1756
1864
|
#
|
1757
1865
|
# @option params [required, String] :service_id
|
1758
|
-
# 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
|
1759
1875
|
#
|
1760
1876
|
# @option params [String] :next_token
|
1761
1877
|
# For the first `ListInstances` request, omit this value.
|
@@ -1772,6 +1888,7 @@ module Aws::ServiceDiscovery
|
|
1772
1888
|
#
|
1773
1889
|
# @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1774
1890
|
#
|
1891
|
+
# * {Types::ListInstancesResponse#resource_owner #resource_owner} => String
|
1775
1892
|
# * {Types::ListInstancesResponse#instances #instances} => Array<Types::InstanceSummary>
|
1776
1893
|
# * {Types::ListInstancesResponse#next_token #next_token} => String
|
1777
1894
|
#
|
@@ -1802,17 +1919,19 @@ module Aws::ServiceDiscovery
|
|
1802
1919
|
# @example Request syntax with placeholder values
|
1803
1920
|
#
|
1804
1921
|
# resp = client.list_instances({
|
1805
|
-
# service_id: "
|
1922
|
+
# service_id: "Arn", # required
|
1806
1923
|
# next_token: "NextToken",
|
1807
1924
|
# max_results: 1,
|
1808
1925
|
# })
|
1809
1926
|
#
|
1810
1927
|
# @example Response structure
|
1811
1928
|
#
|
1929
|
+
# resp.resource_owner #=> String
|
1812
1930
|
# resp.instances #=> Array
|
1813
1931
|
# resp.instances[0].id #=> String
|
1814
1932
|
# resp.instances[0].attributes #=> Hash
|
1815
1933
|
# resp.instances[0].attributes["AttrKey"] #=> String
|
1934
|
+
# resp.instances[0].created_by_account #=> String
|
1816
1935
|
# resp.next_token #=> String
|
1817
1936
|
#
|
1818
1937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstances AWS API Documentation
|
@@ -1825,7 +1944,8 @@ module Aws::ServiceDiscovery
|
|
1825
1944
|
end
|
1826
1945
|
|
1827
1946
|
# Lists summary information about the namespaces that were created by
|
1828
|
-
# the current Amazon Web Services account
|
1947
|
+
# the current Amazon Web Services account and shared with the current
|
1948
|
+
# Amazon Web Services account.
|
1829
1949
|
#
|
1830
1950
|
# @option params [String] :next_token
|
1831
1951
|
# For the first `ListNamespaces` request, omit this value.
|
@@ -1927,7 +2047,7 @@ module Aws::ServiceDiscovery
|
|
1927
2047
|
# max_results: 1,
|
1928
2048
|
# filters: [
|
1929
2049
|
# {
|
1930
|
-
# name: "TYPE", # required, accepts TYPE, NAME, HTTP_NAME
|
2050
|
+
# name: "TYPE", # required, accepts TYPE, NAME, HTTP_NAME, RESOURCE_OWNER
|
1931
2051
|
# values: ["FilterValue"], # required
|
1932
2052
|
# condition: "EQ", # accepts EQ, IN, BETWEEN, BEGINS_WITH
|
1933
2053
|
# },
|
@@ -1939,6 +2059,7 @@ module Aws::ServiceDiscovery
|
|
1939
2059
|
# resp.namespaces #=> Array
|
1940
2060
|
# resp.namespaces[0].id #=> String
|
1941
2061
|
# resp.namespaces[0].arn #=> String
|
2062
|
+
# resp.namespaces[0].resource_owner #=> String
|
1942
2063
|
# resp.namespaces[0].name #=> String
|
1943
2064
|
# resp.namespaces[0].type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE", "HTTP"
|
1944
2065
|
# resp.namespaces[0].description #=> String
|
@@ -2134,7 +2255,7 @@ module Aws::ServiceDiscovery
|
|
2134
2255
|
# max_results: 1,
|
2135
2256
|
# filters: [
|
2136
2257
|
# {
|
2137
|
-
# name: "NAMESPACE_ID", # required, accepts NAMESPACE_ID
|
2258
|
+
# name: "NAMESPACE_ID", # required, accepts NAMESPACE_ID, RESOURCE_OWNER
|
2138
2259
|
# values: ["FilterValue"], # required
|
2139
2260
|
# condition: "EQ", # accepts EQ, IN, BETWEEN, BEGINS_WITH
|
2140
2261
|
# },
|
@@ -2146,6 +2267,7 @@ module Aws::ServiceDiscovery
|
|
2146
2267
|
# resp.services #=> Array
|
2147
2268
|
# resp.services[0].id #=> String
|
2148
2269
|
# resp.services[0].arn #=> String
|
2270
|
+
# resp.services[0].resource_owner #=> String
|
2149
2271
|
# resp.services[0].name #=> String
|
2150
2272
|
# resp.services[0].type #=> String, one of "HTTP", "DNS_HTTP", "DNS"
|
2151
2273
|
# resp.services[0].description #=> String
|
@@ -2160,6 +2282,7 @@ module Aws::ServiceDiscovery
|
|
2160
2282
|
# resp.services[0].health_check_config.failure_threshold #=> Integer
|
2161
2283
|
# resp.services[0].health_check_custom_config.failure_threshold #=> Integer
|
2162
2284
|
# resp.services[0].create_date #=> Time
|
2285
|
+
# resp.services[0].created_by_account #=> String
|
2163
2286
|
# resp.next_token #=> String
|
2164
2287
|
#
|
2165
2288
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices AWS API Documentation
|
@@ -2265,8 +2388,15 @@ module Aws::ServiceDiscovery
|
|
2265
2388
|
# [2]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
2266
2389
|
#
|
2267
2390
|
# @option params [required, String] :service_id
|
2268
|
-
# The ID of the service that you want to
|
2269
|
-
# 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
|
2270
2400
|
#
|
2271
2401
|
# @option params [required, String] :instance_id
|
2272
2402
|
# An identifier that you want to associate with the instance. Note the
|
@@ -2459,7 +2589,7 @@ module Aws::ServiceDiscovery
|
|
2459
2589
|
# @example Request syntax with placeholder values
|
2460
2590
|
#
|
2461
2591
|
# resp = client.register_instance({
|
2462
|
-
# service_id: "
|
2592
|
+
# service_id: "Arn", # required
|
2463
2593
|
# instance_id: "InstanceId", # required
|
2464
2594
|
# creator_request_id: "ResourceId",
|
2465
2595
|
# attributes: { # required
|
@@ -2584,7 +2714,8 @@ module Aws::ServiceDiscovery
|
|
2584
2714
|
# Updates an HTTP namespace.
|
2585
2715
|
#
|
2586
2716
|
# @option params [required, String] :id
|
2587
|
-
# 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.
|
2588
2719
|
#
|
2589
2720
|
# @option params [String] :updater_request_id
|
2590
2721
|
# A unique string that identifies the request and that allows failed
|
@@ -2622,7 +2753,7 @@ module Aws::ServiceDiscovery
|
|
2622
2753
|
# @example Request syntax with placeholder values
|
2623
2754
|
#
|
2624
2755
|
# resp = client.update_http_namespace({
|
2625
|
-
# id: "
|
2756
|
+
# id: "Arn", # required
|
2626
2757
|
# updater_request_id: "ResourceId",
|
2627
2758
|
# namespace: { # required
|
2628
2759
|
# description: "ResourceDescription", # required
|
@@ -2658,8 +2789,16 @@ module Aws::ServiceDiscovery
|
|
2658
2789
|
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
|
2659
2790
|
#
|
2660
2791
|
# @option params [required, String] :service_id
|
2661
|
-
# The ID of the service that includes the
|
2662
|
-
# 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
|
2663
2802
|
#
|
2664
2803
|
# @option params [required, String] :instance_id
|
2665
2804
|
# The ID of the instance that you want to change the health status for.
|
@@ -2684,7 +2823,7 @@ module Aws::ServiceDiscovery
|
|
2684
2823
|
# @example Request syntax with placeholder values
|
2685
2824
|
#
|
2686
2825
|
# resp = client.update_instance_custom_health_status({
|
2687
|
-
# service_id: "
|
2826
|
+
# service_id: "Arn", # required
|
2688
2827
|
# instance_id: "ResourceId", # required
|
2689
2828
|
# status: "HEALTHY", # required, accepts HEALTHY, UNHEALTHY
|
2690
2829
|
# })
|
@@ -2701,7 +2840,8 @@ module Aws::ServiceDiscovery
|
|
2701
2840
|
# Updates a private DNS namespace.
|
2702
2841
|
#
|
2703
2842
|
# @option params [required, String] :id
|
2704
|
-
# 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.
|
2705
2845
|
#
|
2706
2846
|
# @option params [String] :updater_request_id
|
2707
2847
|
# A unique string that identifies the request and that allows failed
|
@@ -2720,9 +2860,9 @@ module Aws::ServiceDiscovery
|
|
2720
2860
|
# * {Types::UpdatePrivateDnsNamespaceResponse#operation_id #operation_id} => String
|
2721
2861
|
#
|
2722
2862
|
#
|
2723
|
-
# @example Example: To update a
|
2863
|
+
# @example Example: To update a private DNS namespace
|
2724
2864
|
#
|
2725
|
-
# # The following example updates the description of a
|
2865
|
+
# # The following example updates the description of a private DNS namespace.
|
2726
2866
|
#
|
2727
2867
|
# resp = client.update_private_dns_namespace({
|
2728
2868
|
# id: "ns-bk3aEXAMPLE",
|
@@ -2734,12 +2874,12 @@ module Aws::ServiceDiscovery
|
|
2734
2874
|
#
|
2735
2875
|
# resp.to_h outputs the following:
|
2736
2876
|
# {
|
2737
|
-
# operation_id: "
|
2877
|
+
# operation_id: "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE",
|
2738
2878
|
# }
|
2739
2879
|
#
|
2740
|
-
# @example Example: To update a
|
2880
|
+
# @example Example: To update a public DNS namespace
|
2741
2881
|
#
|
2742
|
-
# # The following example updates the description of a
|
2882
|
+
# # The following example updates the description of a public DNS namespace.
|
2743
2883
|
#
|
2744
2884
|
# resp = client.update_private_dns_namespace({
|
2745
2885
|
# id: "ns-bk3aEXAMPLE",
|
@@ -2751,13 +2891,13 @@ module Aws::ServiceDiscovery
|
|
2751
2891
|
#
|
2752
2892
|
# resp.to_h outputs the following:
|
2753
2893
|
# {
|
2754
|
-
# operation_id: "
|
2894
|
+
# operation_id: "ft52xe2koxhoeormaceymagglsdjEXAMPLE",
|
2755
2895
|
# }
|
2756
2896
|
#
|
2757
2897
|
# @example Request syntax with placeholder values
|
2758
2898
|
#
|
2759
2899
|
# resp = client.update_private_dns_namespace({
|
2760
|
-
# id: "
|
2900
|
+
# id: "Arn", # required
|
2761
2901
|
# updater_request_id: "ResourceId",
|
2762
2902
|
# namespace: { # required
|
2763
2903
|
# description: "ResourceDescription",
|
@@ -2787,7 +2927,7 @@ module Aws::ServiceDiscovery
|
|
2787
2927
|
# Updates a public DNS namespace.
|
2788
2928
|
#
|
2789
2929
|
# @option params [required, String] :id
|
2790
|
-
# The ID of the namespace being updated.
|
2930
|
+
# The ID or Amazon Resource Name (ARN) of the namespace being updated.
|
2791
2931
|
#
|
2792
2932
|
# @option params [String] :updater_request_id
|
2793
2933
|
# A unique string that identifies the request and that allows failed
|
@@ -2808,7 +2948,7 @@ module Aws::ServiceDiscovery
|
|
2808
2948
|
# @example Request syntax with placeholder values
|
2809
2949
|
#
|
2810
2950
|
# resp = client.update_public_dns_namespace({
|
2811
|
-
# id: "
|
2951
|
+
# id: "Arn", # required
|
2812
2952
|
# updater_request_id: "ResourceId",
|
2813
2953
|
# namespace: { # required
|
2814
2954
|
# description: "ResourceDescription",
|
@@ -2856,12 +2996,31 @@ module Aws::ServiceDiscovery
|
|
2856
2996
|
# an `UpdateService` request, the configuration isn't deleted from
|
2857
2997
|
# the service.
|
2858
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
|
+
#
|
2859
3010
|
# When you update settings for a service, Cloud Map also updates the
|
2860
3011
|
# corresponding settings in all the records and health checks that were
|
2861
3012
|
# created by using the specified service.
|
2862
3013
|
#
|
2863
3014
|
# @option params [required, String] :id
|
2864
|
-
# 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
|
2865
3024
|
#
|
2866
3025
|
# @option params [required, Types::ServiceChange] :service
|
2867
3026
|
# A complex type that contains the new settings for the service. You can
|
@@ -2903,7 +3062,7 @@ module Aws::ServiceDiscovery
|
|
2903
3062
|
# @example Request syntax with placeholder values
|
2904
3063
|
#
|
2905
3064
|
# resp = client.update_service({
|
2906
|
-
# id: "
|
3065
|
+
# id: "Arn", # required
|
2907
3066
|
# service: { # required
|
2908
3067
|
# description: "ResourceDescription",
|
2909
3068
|
# dns_config: {
|
@@ -2939,7 +3098,9 @@ module Aws::ServiceDiscovery
|
|
2939
3098
|
# attributes.
|
2940
3099
|
#
|
2941
3100
|
# @option params [required, String] :service_id
|
2942
|
-
# 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.
|
2943
3104
|
#
|
2944
3105
|
# @option params [required, Hash<String,String>] :attributes
|
2945
3106
|
# A string map that contains attribute key-value pairs.
|
@@ -2965,7 +3126,7 @@ module Aws::ServiceDiscovery
|
|
2965
3126
|
# @example Request syntax with placeholder values
|
2966
3127
|
#
|
2967
3128
|
# resp = client.update_service_attributes({
|
2968
|
-
# service_id: "
|
3129
|
+
# service_id: "Arn", # required
|
2969
3130
|
# attributes: { # required
|
2970
3131
|
# "ServiceAttributeKey" => "ServiceAttributeValue",
|
2971
3132
|
# },
|
@@ -2998,7 +3159,7 @@ module Aws::ServiceDiscovery
|
|
2998
3159
|
tracer: tracer
|
2999
3160
|
)
|
3000
3161
|
context[:gem_name] = 'aws-sdk-servicediscovery'
|
3001
|
-
context[:gem_version] = '1.
|
3162
|
+
context[:gem_version] = '1.89.0'
|
3002
3163
|
Seahorse::Client::Request.new(handlers, context)
|
3003
3164
|
end
|
3004
3165
|
|