@aws-sdk/client-servicediscovery 3.288.0 → 3.290.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.
Files changed (27) hide show
  1. package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +43 -0
  2. package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +43 -0
  3. package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +43 -0
  4. package/dist-types/commands/CreateServiceCommand.d.ts +70 -0
  5. package/dist-types/commands/DeleteNamespaceCommand.d.ts +37 -0
  6. package/dist-types/commands/DeleteServiceCommand.d.ts +29 -0
  7. package/dist-types/commands/DeregisterInstanceCommand.d.ts +42 -0
  8. package/dist-types/commands/DiscoverInstancesCommand.d.ts +47 -0
  9. package/dist-types/commands/GetInstanceCommand.d.ts +44 -0
  10. package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +37 -0
  11. package/dist-types/commands/GetNamespaceCommand.d.ts +39 -0
  12. package/dist-types/commands/GetOperationCommand.d.ts +39 -0
  13. package/dist-types/commands/GetServiceCommand.d.ts +43 -0
  14. package/dist-types/commands/ListInstancesCommand.d.ts +38 -0
  15. package/dist-types/commands/ListNamespacesCommand.d.ts +70 -0
  16. package/dist-types/commands/ListOperationsCommand.d.ts +49 -0
  17. package/dist-types/commands/ListServicesCommand.d.ts +41 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +39 -0
  19. package/dist-types/commands/RegisterInstanceCommand.d.ts +47 -0
  20. package/dist-types/commands/TagResourceCommand.d.ts +39 -0
  21. package/dist-types/commands/UntagResourceCommand.d.ts +29 -0
  22. package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts +21 -0
  23. package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +35 -0
  24. package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts +21 -0
  25. package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts +21 -0
  26. package/dist-types/commands/UpdateServiceCommand.d.ts +48 -0
  27. package/package.json +29 -29
@@ -30,6 +30,44 @@ export interface ListInstancesCommandOutput extends ListInstancesResponse, __Met
30
30
  * @see {@link ListInstancesCommandOutput} for command's `response` shape.
31
31
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
32
32
  *
33
+ * @throws {@link InvalidInput} (client fault)
34
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
35
+ * numeric value might be outside the allowed range, or a string value might exceed length
36
+ * constraints.</p>
37
+ *
38
+ * @throws {@link RequestLimitExceeded} (client fault)
39
+ * <p>The operation can't be completed because you've reached the quota for the number of
40
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
41
+ * <i>Cloud Map Developer Guide</i>.</p>
42
+ *
43
+ * @throws {@link ServiceNotFound} (client fault)
44
+ * <p>No service exists with the specified ID.</p>
45
+ *
46
+ *
47
+ * @example Example: List service instances
48
+ * ```javascript
49
+ * // Example: List service instances
50
+ * const input = {
51
+ * "ServiceId": "srv-qzpwvt2tfqcegapy"
52
+ * };
53
+ * const command = new ListInstancesCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "Instances": [
58
+ * {
59
+ * "Attributes": {
60
+ * "AWS_INSTANCE_IPV4": "172.2.1.3",
61
+ * "AWS_INSTANCE_PORT": "808"
62
+ * },
63
+ * "Id": "i-06bdabbae60f65a4e"
64
+ * }
65
+ * ]
66
+ * }
67
+ * *\/
68
+ * // example id: example-list-service-instances-1587236237008
69
+ * ```
70
+ *
33
71
  */
34
72
  export declare class ListInstancesCommand extends $Command<ListInstancesCommandInput, ListInstancesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
73
  readonly input: ListInstancesCommandInput;
@@ -29,6 +29,76 @@ export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __M
29
29
  * @see {@link ListNamespacesCommandOutput} for command's `response` shape.
30
30
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidInput} (client fault)
33
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
34
+ * numeric value might be outside the allowed range, or a string value might exceed length
35
+ * constraints.</p>
36
+ *
37
+ * @throws {@link RequestLimitExceeded} (client fault)
38
+ * <p>The operation can't be completed because you've reached the quota for the number of
39
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
40
+ * <i>Cloud Map Developer Guide</i>.</p>
41
+ *
42
+ *
43
+ * @example Example: List namespaces
44
+ * ```javascript
45
+ * // Example: List namespaces
46
+ * const input = {};
47
+ * const command = new ListNamespacesCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "Namespaces": [
52
+ * {
53
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile",
54
+ * "CreateDate": 1585354387.357,
55
+ * "Id": "ns-a3ccy2e7e3a7rile",
56
+ * "Name": "local",
57
+ * "Properties": {
58
+ * "DnsProperties": {
59
+ * "HostedZoneId": "Z06752353VBUDTC32S84S"
60
+ * },
61
+ * "HttpProperties": {
62
+ * "HttpName": "local"
63
+ * }
64
+ * },
65
+ * "Type": "DNS_PRIVATE"
66
+ * },
67
+ * {
68
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx",
69
+ * "CreateDate": 1586468974.698,
70
+ * "Description": "My second namespace",
71
+ * "Id": "ns-pocfyjtrsmwtvcxx",
72
+ * "Name": "My-second-namespace",
73
+ * "Properties": {
74
+ * "DnsProperties": {},
75
+ * "HttpProperties": {
76
+ * "HttpName": "My-second-namespace"
77
+ * }
78
+ * },
79
+ * "Type": "HTTP"
80
+ * },
81
+ * {
82
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm",
83
+ * "CreateDate": 1587055896.798,
84
+ * "Id": "ns-ylexjili4cdxy3xm",
85
+ * "Name": "example.com",
86
+ * "Properties": {
87
+ * "DnsProperties": {
88
+ * "HostedZoneId": "Z09983722P0QME1B3KC8I"
89
+ * },
90
+ * "HttpProperties": {
91
+ * "HttpName": "example.com"
92
+ * }
93
+ * },
94
+ * "Type": "DNS_PRIVATE"
95
+ * }
96
+ * ]
97
+ * }
98
+ * *\/
99
+ * // example id: example-list-namespaces-1587401553154
100
+ * ```
101
+ *
32
102
  */
33
103
  export declare class ListNamespacesCommand extends $Command<ListNamespacesCommandInput, ListNamespacesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
104
  readonly input: ListNamespacesCommandInput;
@@ -29,6 +29,55 @@ export interface ListOperationsCommandOutput extends ListOperationsResponse, __M
29
29
  * @see {@link ListOperationsCommandOutput} for command's `response` shape.
30
30
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidInput} (client fault)
33
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
34
+ * numeric value might be outside the allowed range, or a string value might exceed length
35
+ * constraints.</p>
36
+ *
37
+ * @throws {@link RequestLimitExceeded} (client fault)
38
+ * <p>The operation can't be completed because you've reached the quota for the number of
39
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
40
+ * <i>Cloud Map Developer Guide</i>.</p>
41
+ *
42
+ *
43
+ * @example ListOperations Example
44
+ * ```javascript
45
+ * // This example gets the operations that have a STATUS of either PENDING or SUCCESS.
46
+ * const input = {
47
+ * "Filters": [
48
+ * {
49
+ * "Condition": "IN",
50
+ * "Name": "STATUS",
51
+ * "Values": [
52
+ * "PENDING",
53
+ * "SUCCESS"
54
+ * ]
55
+ * }
56
+ * ]
57
+ * };
58
+ * const command = new ListOperationsCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "Operations": [
63
+ * {
64
+ * "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample",
65
+ * "Status": "SUCCESS"
66
+ * },
67
+ * {
68
+ * "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample",
69
+ * "Status": "SUCCESS"
70
+ * },
71
+ * {
72
+ * "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example",
73
+ * "Status": "PENDING"
74
+ * }
75
+ * ]
76
+ * }
77
+ * *\/
78
+ * // example id: listoperations-example-1590117354396
79
+ * ```
80
+ *
32
81
  */
33
82
  export declare class ListOperationsCommand extends $Command<ListOperationsCommandInput, ListOperationsCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
83
  readonly input: ListOperationsCommandInput;
@@ -30,6 +30,47 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad
30
30
  * @see {@link ListServicesCommandOutput} for command's `response` shape.
31
31
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
32
32
  *
33
+ * @throws {@link InvalidInput} (client fault)
34
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
35
+ * numeric value might be outside the allowed range, or a string value might exceed length
36
+ * constraints.</p>
37
+ *
38
+ * @throws {@link RequestLimitExceeded} (client fault)
39
+ * <p>The operation can't be completed because you've reached the quota for the number of
40
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
41
+ * <i>Cloud Map Developer Guide</i>.</p>
42
+ *
43
+ *
44
+ * @example Example: List services
45
+ * ```javascript
46
+ * // Example: List services
47
+ * const input = {};
48
+ * const command = new ListServicesCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Services": [
53
+ * {
54
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
55
+ * "CreateDate": 1587081768.334,
56
+ * "DnsConfig": {
57
+ * "DnsRecords": [
58
+ * {
59
+ * "TTL": 60,
60
+ * "Type": "A"
61
+ * }
62
+ * ],
63
+ * "RoutingPolicy": "MULTIVALUE"
64
+ * },
65
+ * "Id": "srv-p5zdwlg5uvvzjita",
66
+ * "Name": "myservice"
67
+ * }
68
+ * ]
69
+ * }
70
+ * *\/
71
+ * // example id: example-list-services-1587236889840
72
+ * ```
73
+ *
33
74
  */
34
75
  export declare class ListServicesCommand extends $Command<ListServicesCommandInput, ListServicesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
76
  readonly input: ListServicesCommandInput;
@@ -29,6 +29,45 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
29
29
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
30
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidInput} (client fault)
33
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
34
+ * numeric value might be outside the allowed range, or a string value might exceed length
35
+ * constraints.</p>
36
+ *
37
+ * @throws {@link RequestLimitExceeded} (client fault)
38
+ * <p>The operation can't be completed because you've reached the quota for the number of
39
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
40
+ * <i>Cloud Map Developer Guide</i>.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>The operation can't be completed because the resource was not found.</p>
44
+ *
45
+ *
46
+ * @example ListTagsForResource example
47
+ * ```javascript
48
+ * // This example lists the tags of a resource.
49
+ * const input = {
50
+ * "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm"
51
+ * };
52
+ * const command = new ListTagsForResourceCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "Tags": [
57
+ * {
58
+ * "Key": "Project",
59
+ * "Value": "Zeta"
60
+ * },
61
+ * {
62
+ * "Key": "Department",
63
+ * "Value": "Engineering"
64
+ * }
65
+ * ]
66
+ * }
67
+ * *\/
68
+ * // example id: listtagsforresource-example-1590093928416
69
+ * ```
70
+ *
32
71
  */
33
72
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
73
  readonly input: ListTagsForResourceCommandInput;
@@ -72,6 +72,53 @@ export interface RegisterInstanceCommandOutput extends RegisterInstanceResponse,
72
72
  * @see {@link RegisterInstanceCommandOutput} for command's `response` shape.
73
73
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
74
74
  *
75
+ * @throws {@link DuplicateRequest} (client fault)
76
+ * <p>The operation is already in progress.</p>
77
+ *
78
+ * @throws {@link InvalidInput} (client fault)
79
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
80
+ * numeric value might be outside the allowed range, or a string value might exceed length
81
+ * constraints.</p>
82
+ *
83
+ * @throws {@link RequestLimitExceeded} (client fault)
84
+ * <p>The operation can't be completed because you've reached the quota for the number of
85
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
86
+ * <i>Cloud Map Developer Guide</i>.</p>
87
+ *
88
+ * @throws {@link ResourceInUse} (client fault)
89
+ * <p>The specified resource can't be deleted because it contains other resources. For example,
90
+ * you can't delete a service that contains any instances.</p>
91
+ *
92
+ * @throws {@link ResourceLimitExceeded} (client fault)
93
+ * <p>The resource can't be created because you've reached the quota on the number of
94
+ * resources.</p>
95
+ *
96
+ * @throws {@link ServiceNotFound} (client fault)
97
+ * <p>No service exists with the specified ID.</p>
98
+ *
99
+ *
100
+ * @example Example: Register Instance
101
+ * ```javascript
102
+ * // Example: Register Instance
103
+ * const input = {
104
+ * "Attributes": {
105
+ * "AWS_INSTANCE_IPV4": "172.2.1.3",
106
+ * "AWS_INSTANCE_PORT": "808"
107
+ * },
108
+ * "CreatorRequestId": "7a48a98a-72e6-4849-bfa7-1a458e030d7b",
109
+ * "InstanceId": "myservice-53",
110
+ * "ServiceId": "srv-p5zdwlg5uvvzjita"
111
+ * };
112
+ * const command = new RegisterInstanceCommand(input);
113
+ * const response = await client.send(command);
114
+ * /* response ==
115
+ * {
116
+ * "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7"
117
+ * }
118
+ * *\/
119
+ * // example id: example-register-instance-1587236116314
120
+ * ```
121
+ *
75
122
  */
76
123
  export declare class RegisterInstanceCommand extends $Command<RegisterInstanceCommandInput, RegisterInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
77
124
  readonly input: RegisterInstanceCommandInput;
@@ -29,6 +29,45 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
29
29
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
30
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidInput} (client fault)
33
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
34
+ * numeric value might be outside the allowed range, or a string value might exceed length
35
+ * constraints.</p>
36
+ *
37
+ * @throws {@link RequestLimitExceeded} (client fault)
38
+ * <p>The operation can't be completed because you've reached the quota for the number of
39
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
40
+ * <i>Cloud Map Developer Guide</i>.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>The operation can't be completed because the resource was not found.</p>
44
+ *
45
+ * @throws {@link TooManyTagsException} (client fault)
46
+ * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
47
+ * applied to a resource is 50.</p>
48
+ *
49
+ *
50
+ * @example TagResource example
51
+ * ```javascript
52
+ * // This example adds "Department" and "Project" tags to a resource.
53
+ * const input = {
54
+ * "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm",
55
+ * "Tags": [
56
+ * {
57
+ * "Key": "Department",
58
+ * "Value": "Engineering"
59
+ * },
60
+ * {
61
+ * "Key": "Project",
62
+ * "Value": "Zeta"
63
+ * }
64
+ * ]
65
+ * };
66
+ * const command = new TagResourceCommand(input);
67
+ * await client.send(command);
68
+ * // example id: tagresource-example-1590093532240
69
+ * ```
70
+ *
32
71
  */
33
72
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
73
  readonly input: TagResourceCommandInput;
@@ -29,6 +29,35 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
29
29
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
30
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidInput} (client fault)
33
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
34
+ * numeric value might be outside the allowed range, or a string value might exceed length
35
+ * constraints.</p>
36
+ *
37
+ * @throws {@link RequestLimitExceeded} (client fault)
38
+ * <p>The operation can't be completed because you've reached the quota for the number of
39
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
40
+ * <i>Cloud Map Developer Guide</i>.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>The operation can't be completed because the resource was not found.</p>
44
+ *
45
+ *
46
+ * @example UntagResource example
47
+ * ```javascript
48
+ * // This example removes the "Department" and "Project" tags from a resource.
49
+ * const input = {
50
+ * "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm",
51
+ * "TagKeys": [
52
+ * "Project",
53
+ * "Department"
54
+ * ]
55
+ * };
56
+ * const command = new UntagResourceCommand(input);
57
+ * await client.send(command);
58
+ * // example id: untagresource-example-1590094024672
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
63
  readonly input: UntagResourceCommandInput;
@@ -30,6 +30,27 @@ export interface UpdateHttpNamespaceCommandOutput extends UpdateHttpNamespaceRes
30
30
  * @see {@link UpdateHttpNamespaceCommandOutput} for command's `response` shape.
31
31
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
32
32
  *
33
+ * @throws {@link DuplicateRequest} (client fault)
34
+ * <p>The operation is already in progress.</p>
35
+ *
36
+ * @throws {@link InvalidInput} (client fault)
37
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
38
+ * numeric value might be outside the allowed range, or a string value might exceed length
39
+ * constraints.</p>
40
+ *
41
+ * @throws {@link NamespaceNotFound} (client fault)
42
+ * <p>No namespace exists with the specified ID.</p>
43
+ *
44
+ * @throws {@link RequestLimitExceeded} (client fault)
45
+ * <p>The operation can't be completed because you've reached the quota for the number of
46
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
47
+ * <i>Cloud Map Developer Guide</i>.</p>
48
+ *
49
+ * @throws {@link ResourceInUse} (client fault)
50
+ * <p>The specified resource can't be deleted because it contains other resources. For example,
51
+ * you can't delete a service that contains any instances.</p>
52
+ *
53
+ *
33
54
  */
34
55
  export declare class UpdateHttpNamespaceCommand extends $Command<UpdateHttpNamespaceCommandInput, UpdateHttpNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
56
  readonly input: UpdateHttpNamespaceCommandInput;
@@ -35,6 +35,41 @@ export interface UpdateInstanceCustomHealthStatusCommandOutput extends __Metadat
35
35
  * @see {@link UpdateInstanceCustomHealthStatusCommandOutput} for command's `response` shape.
36
36
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
37
37
  *
38
+ * @throws {@link CustomHealthNotFound} (client fault)
39
+ * <p>The health check for the instance that's specified by <code>ServiceId</code> and
40
+ * <code>InstanceId</code> isn't a custom health check. </p>
41
+ *
42
+ * @throws {@link InstanceNotFound} (client fault)
43
+ * <p>No instance exists with the specified ID, or the instance was recently registered, and
44
+ * information about the instance hasn't propagated yet.</p>
45
+ *
46
+ * @throws {@link InvalidInput} (client fault)
47
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
48
+ * numeric value might be outside the allowed range, or a string value might exceed length
49
+ * constraints.</p>
50
+ *
51
+ * @throws {@link RequestLimitExceeded} (client fault)
52
+ * <p>The operation can't be completed because you've reached the quota for the number of
53
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
54
+ * <i>Cloud Map Developer Guide</i>.</p>
55
+ *
56
+ * @throws {@link ServiceNotFound} (client fault)
57
+ * <p>No service exists with the specified ID.</p>
58
+ *
59
+ *
60
+ * @example UpdateInstanceCustomHealthStatus Example
61
+ * ```javascript
62
+ * // This example submits a request to change the health status of an instance associated with a service with a custom health check to HEALTHY.
63
+ * const input = {
64
+ * "InstanceId": "i-abcd1234",
65
+ * "ServiceId": "srv-e4anhexample0004",
66
+ * "Status": "HEALTHY"
67
+ * };
68
+ * const command = new UpdateInstanceCustomHealthStatusCommand(input);
69
+ * await client.send(command);
70
+ * // example id: updateinstancecustomhealthstatus-example-1590118408574
71
+ * ```
72
+ *
38
73
  */
39
74
  export declare class UpdateInstanceCustomHealthStatusCommand extends $Command<UpdateInstanceCustomHealthStatusCommandInput, UpdateInstanceCustomHealthStatusCommandOutput, ServiceDiscoveryClientResolvedConfig> {
40
75
  readonly input: UpdateInstanceCustomHealthStatusCommandInput;
@@ -30,6 +30,27 @@ export interface UpdatePrivateDnsNamespaceCommandOutput extends UpdatePrivateDns
30
30
  * @see {@link UpdatePrivateDnsNamespaceCommandOutput} for command's `response` shape.
31
31
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
32
32
  *
33
+ * @throws {@link DuplicateRequest} (client fault)
34
+ * <p>The operation is already in progress.</p>
35
+ *
36
+ * @throws {@link InvalidInput} (client fault)
37
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
38
+ * numeric value might be outside the allowed range, or a string value might exceed length
39
+ * constraints.</p>
40
+ *
41
+ * @throws {@link NamespaceNotFound} (client fault)
42
+ * <p>No namespace exists with the specified ID.</p>
43
+ *
44
+ * @throws {@link RequestLimitExceeded} (client fault)
45
+ * <p>The operation can't be completed because you've reached the quota for the number of
46
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
47
+ * <i>Cloud Map Developer Guide</i>.</p>
48
+ *
49
+ * @throws {@link ResourceInUse} (client fault)
50
+ * <p>The specified resource can't be deleted because it contains other resources. For example,
51
+ * you can't delete a service that contains any instances.</p>
52
+ *
53
+ *
33
54
  */
34
55
  export declare class UpdatePrivateDnsNamespaceCommand extends $Command<UpdatePrivateDnsNamespaceCommandInput, UpdatePrivateDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
56
  readonly input: UpdatePrivateDnsNamespaceCommandInput;
@@ -30,6 +30,27 @@ export interface UpdatePublicDnsNamespaceCommandOutput extends UpdatePublicDnsNa
30
30
  * @see {@link UpdatePublicDnsNamespaceCommandOutput} for command's `response` shape.
31
31
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
32
32
  *
33
+ * @throws {@link DuplicateRequest} (client fault)
34
+ * <p>The operation is already in progress.</p>
35
+ *
36
+ * @throws {@link InvalidInput} (client fault)
37
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
38
+ * numeric value might be outside the allowed range, or a string value might exceed length
39
+ * constraints.</p>
40
+ *
41
+ * @throws {@link NamespaceNotFound} (client fault)
42
+ * <p>No namespace exists with the specified ID.</p>
43
+ *
44
+ * @throws {@link RequestLimitExceeded} (client fault)
45
+ * <p>The operation can't be completed because you've reached the quota for the number of
46
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
47
+ * <i>Cloud Map Developer Guide</i>.</p>
48
+ *
49
+ * @throws {@link ResourceInUse} (client fault)
50
+ * <p>The specified resource can't be deleted because it contains other resources. For example,
51
+ * you can't delete a service that contains any instances.</p>
52
+ *
53
+ *
33
54
  */
34
55
  export declare class UpdatePublicDnsNamespaceCommand extends $Command<UpdatePublicDnsNamespaceCommandInput, UpdatePublicDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
56
  readonly input: UpdatePublicDnsNamespaceCommandInput;
@@ -55,6 +55,54 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
55
55
  * @see {@link UpdateServiceCommandOutput} for command's `response` shape.
56
56
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
57
57
  *
58
+ * @throws {@link DuplicateRequest} (client fault)
59
+ * <p>The operation is already in progress.</p>
60
+ *
61
+ * @throws {@link InvalidInput} (client fault)
62
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
63
+ * numeric value might be outside the allowed range, or a string value might exceed length
64
+ * constraints.</p>
65
+ *
66
+ * @throws {@link RequestLimitExceeded} (client fault)
67
+ * <p>The operation can't be completed because you've reached the quota for the number of
68
+ * requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
69
+ * <i>Cloud Map Developer Guide</i>.</p>
70
+ *
71
+ * @throws {@link ServiceNotFound} (client fault)
72
+ * <p>No service exists with the specified ID.</p>
73
+ *
74
+ *
75
+ * @example UpdateService Example
76
+ * ```javascript
77
+ * // This example submits a request to replace the DnsConfig and HealthCheckConfig settings of a specified service.
78
+ * const input = {
79
+ * "Id": "srv-e4anhexample0004",
80
+ * "Service": {
81
+ * "DnsConfig": {
82
+ * "DnsRecords": [
83
+ * {
84
+ * "TTL": 60,
85
+ * "Type": "A"
86
+ * }
87
+ * ]
88
+ * },
89
+ * "HealthCheckConfig": {
90
+ * "FailureThreshold": 2,
91
+ * "ResourcePath": "/",
92
+ * "Type": "HTTP"
93
+ * }
94
+ * }
95
+ * };
96
+ * const command = new UpdateServiceCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "OperationId": "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5"
101
+ * }
102
+ * *\/
103
+ * // example id: updateservice-example-1590117830880
104
+ * ```
105
+ *
58
106
  */
59
107
  export declare class UpdateServiceCommand extends $Command<UpdateServiceCommandInput, UpdateServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
60
108
  readonly input: UpdateServiceCommandInput;