@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
@@ -33,6 +33,49 @@ export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceRes
33
33
  * @see {@link CreateHttpNamespaceCommandOutput} for command's `response` shape.
34
34
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
35
35
  *
36
+ * @throws {@link DuplicateRequest} (client fault)
37
+ * <p>The operation is already in progress.</p>
38
+ *
39
+ * @throws {@link InvalidInput} (client fault)
40
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
41
+ * numeric value might be outside the allowed range, or a string value might exceed length
42
+ * constraints.</p>
43
+ *
44
+ * @throws {@link NamespaceAlreadyExists} (client fault)
45
+ * <p>The namespace that you're trying to create already exists.</p>
46
+ *
47
+ * @throws {@link RequestLimitExceeded} (client fault)
48
+ * <p>The operation can't be completed because you've reached the quota for the number of
49
+ * 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
50
+ * <i>Cloud Map Developer Guide</i>.</p>
51
+ *
52
+ * @throws {@link ResourceLimitExceeded} (client fault)
53
+ * <p>The resource can't be created because you've reached the quota on the number of
54
+ * resources.</p>
55
+ *
56
+ * @throws {@link TooManyTagsException} (client fault)
57
+ * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
58
+ * applied to a resource is 50.</p>
59
+ *
60
+ *
61
+ * @example CreateHttpNamespace example
62
+ * ```javascript
63
+ * // This example creates an HTTP namespace.
64
+ * const input = {
65
+ * "CreatorRequestId": "example-creator-request-id-0001",
66
+ * "Description": "Example.com AWS Cloud Map HTTP Namespace",
67
+ * "Name": "example-http.com"
68
+ * };
69
+ * const command = new CreateHttpNamespaceCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "OperationId": "httpvoqozuhfet5kzxoxg-a-response-example"
74
+ * }
75
+ * *\/
76
+ * // example id: createhttpnamespace-example-1590114811304
77
+ * ```
78
+ *
36
79
  */
37
80
  export declare class CreateHttpNamespaceCommand extends $Command<CreateHttpNamespaceCommandInput, CreateHttpNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
38
81
  readonly input: CreateHttpNamespaceCommandInput;
@@ -36,6 +36,49 @@ export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDns
36
36
  * @see {@link CreatePrivateDnsNamespaceCommandOutput} for command's `response` shape.
37
37
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
38
38
  *
39
+ * @throws {@link DuplicateRequest} (client fault)
40
+ * <p>The operation is already in progress.</p>
41
+ *
42
+ * @throws {@link InvalidInput} (client fault)
43
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
44
+ * numeric value might be outside the allowed range, or a string value might exceed length
45
+ * constraints.</p>
46
+ *
47
+ * @throws {@link NamespaceAlreadyExists} (client fault)
48
+ * <p>The namespace that you're trying to create already exists.</p>
49
+ *
50
+ * @throws {@link RequestLimitExceeded} (client fault)
51
+ * <p>The operation can't be completed because you've reached the quota for the number of
52
+ * 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
53
+ * <i>Cloud Map Developer Guide</i>.</p>
54
+ *
55
+ * @throws {@link ResourceLimitExceeded} (client fault)
56
+ * <p>The resource can't be created because you've reached the quota on the number of
57
+ * resources.</p>
58
+ *
59
+ * @throws {@link TooManyTagsException} (client fault)
60
+ * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
61
+ * applied to a resource is 50.</p>
62
+ *
63
+ *
64
+ * @example Example: Create private DNS namespace
65
+ * ```javascript
66
+ * // Example: Create private DNS namespace
67
+ * const input = {
68
+ * "CreatorRequestId": "eedd6892-50f3-41b2-8af9-611d6e1d1a8c",
69
+ * "Name": "example.com",
70
+ * "Vpc": "vpc-1c56417b"
71
+ * };
72
+ * const command = new CreatePrivateDnsNamespaceCommand(input);
73
+ * const response = await client.send(command);
74
+ * /* response ==
75
+ * {
76
+ * "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
77
+ * }
78
+ * *\/
79
+ * // example id: example-create-private-dns-namespace-1587058592930
80
+ * ```
81
+ *
39
82
  */
40
83
  export declare class CreatePrivateDnsNamespaceCommand extends $Command<CreatePrivateDnsNamespaceCommandInput, CreatePrivateDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
41
84
  readonly input: CreatePrivateDnsNamespaceCommandInput;
@@ -38,6 +38,49 @@ export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNa
38
38
  * @see {@link CreatePublicDnsNamespaceCommandOutput} for command's `response` shape.
39
39
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
40
40
  *
41
+ * @throws {@link DuplicateRequest} (client fault)
42
+ * <p>The operation is already in progress.</p>
43
+ *
44
+ * @throws {@link InvalidInput} (client fault)
45
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
46
+ * numeric value might be outside the allowed range, or a string value might exceed length
47
+ * constraints.</p>
48
+ *
49
+ * @throws {@link NamespaceAlreadyExists} (client fault)
50
+ * <p>The namespace that you're trying to create already exists.</p>
51
+ *
52
+ * @throws {@link RequestLimitExceeded} (client fault)
53
+ * <p>The operation can't be completed because you've reached the quota for the number of
54
+ * 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
55
+ * <i>Cloud Map Developer Guide</i>.</p>
56
+ *
57
+ * @throws {@link ResourceLimitExceeded} (client fault)
58
+ * <p>The resource can't be created because you've reached the quota on the number of
59
+ * resources.</p>
60
+ *
61
+ * @throws {@link TooManyTagsException} (client fault)
62
+ * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
63
+ * applied to a resource is 50.</p>
64
+ *
65
+ *
66
+ * @example CreatePublicDnsNamespace example
67
+ * ```javascript
68
+ * // This example creates a public namespace based on DNS.
69
+ * const input = {
70
+ * "CreatorRequestId": "example-creator-request-id-0003",
71
+ * "Description": "Example.com AWS Cloud Map Public DNS Namespace",
72
+ * "Name": "example-public-dns.com"
73
+ * };
74
+ * const command = new CreatePublicDnsNamespaceCommand(input);
75
+ * const response = await client.send(command);
76
+ * /* response ==
77
+ * {
78
+ * "OperationId": "dns2voqozuhfet5kzxoxg-a-response-example"
79
+ * }
80
+ * *\/
81
+ * // example id: createpublicdnsnamespace-example-1590114940910
82
+ * ```
83
+ *
41
84
  */
42
85
  export declare class CreatePublicDnsNamespaceCommand extends $Command<CreatePublicDnsNamespaceCommandInput, CreatePublicDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
43
86
  readonly input: CreatePublicDnsNamespaceCommandInput;
@@ -70,6 +70,76 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
70
70
  * @see {@link CreateServiceCommandOutput} for command's `response` shape.
71
71
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
72
72
  *
73
+ * @throws {@link InvalidInput} (client fault)
74
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
75
+ * numeric value might be outside the allowed range, or a string value might exceed length
76
+ * constraints.</p>
77
+ *
78
+ * @throws {@link NamespaceNotFound} (client fault)
79
+ * <p>No namespace exists with the specified ID.</p>
80
+ *
81
+ * @throws {@link RequestLimitExceeded} (client fault)
82
+ * <p>The operation can't be completed because you've reached the quota for the number of
83
+ * 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
84
+ * <i>Cloud Map Developer Guide</i>.</p>
85
+ *
86
+ * @throws {@link ResourceLimitExceeded} (client fault)
87
+ * <p>The resource can't be created because you've reached the quota on the number of
88
+ * resources.</p>
89
+ *
90
+ * @throws {@link ServiceAlreadyExists} (client fault)
91
+ * <p>The service can't be created because a service with the same name already exists.</p>
92
+ *
93
+ * @throws {@link TooManyTagsException} (client fault)
94
+ * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
95
+ * applied to a resource is 50.</p>
96
+ *
97
+ *
98
+ * @example Example: Create service
99
+ * ```javascript
100
+ * // Example: Create service
101
+ * const input = {
102
+ * "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25",
103
+ * "DnsConfig": {
104
+ * "DnsRecords": [
105
+ * {
106
+ * "TTL": 60,
107
+ * "Type": "A"
108
+ * }
109
+ * ],
110
+ * "NamespaceId": "ns-ylexjili4cdxy3xm",
111
+ * "RoutingPolicy": "MULTIVALUE"
112
+ * },
113
+ * "Name": "myservice",
114
+ * "NamespaceId": "ns-ylexjili4cdxy3xm"
115
+ * };
116
+ * const command = new CreateServiceCommand(input);
117
+ * const response = await client.send(command);
118
+ * /* response ==
119
+ * {
120
+ * "Service": {
121
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
122
+ * "CreateDate": 1587081768.334,
123
+ * "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25",
124
+ * "DnsConfig": {
125
+ * "DnsRecords": [
126
+ * {
127
+ * "TTL": 60,
128
+ * "Type": "A"
129
+ * }
130
+ * ],
131
+ * "NamespaceId": "ns-ylexjili4cdxy3xm",
132
+ * "RoutingPolicy": "MULTIVALUE"
133
+ * },
134
+ * "Id": "srv-p5zdwlg5uvvzjita",
135
+ * "Name": "myservice",
136
+ * "NamespaceId": "ns-ylexjili4cdxy3xm"
137
+ * }
138
+ * }
139
+ * *\/
140
+ * // example id: example-create-service-1587235913584
141
+ * ```
142
+ *
73
143
  */
74
144
  export declare class CreateServiceCommand extends $Command<CreateServiceCommandInput, CreateServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
75
145
  readonly input: CreateServiceCommandInput;
@@ -30,6 +30,43 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
30
30
  * @see {@link DeleteNamespaceCommandOutput} 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
+ *
54
+ * @example Example: Delete namespace
55
+ * ```javascript
56
+ * // Example: Delete namespace
57
+ * const input = {
58
+ * "Id": "ns-ylexjili4cdxy3xm"
59
+ * };
60
+ * const command = new DeleteNamespaceCommand(input);
61
+ * const response = await client.send(command);
62
+ * /* response ==
63
+ * {
64
+ * "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk"
65
+ * }
66
+ * *\/
67
+ * // example id: example-delete-namespace-1587416093508
68
+ * ```
69
+ *
33
70
  */
34
71
  export declare class DeleteNamespaceCommand extends $Command<DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
72
  readonly input: DeleteNamespaceCommandInput;
@@ -30,6 +30,35 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
30
30
  * @see {@link DeleteServiceCommandOutput} 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 ResourceInUse} (client fault)
44
+ * <p>The specified resource can't be deleted because it contains other resources. For example,
45
+ * you can't delete a service that contains any instances.</p>
46
+ *
47
+ * @throws {@link ServiceNotFound} (client fault)
48
+ * <p>No service exists with the specified ID.</p>
49
+ *
50
+ *
51
+ * @example Example: Delete service
52
+ * ```javascript
53
+ * // Example: Delete service
54
+ * const input = {
55
+ * "Id": "srv-p5zdwlg5uvvzjita"
56
+ * };
57
+ * const command = new DeleteServiceCommand(input);
58
+ * await client.send(command);
59
+ * // example id: example-delete-service-1587416462902
60
+ * ```
61
+ *
33
62
  */
34
63
  export declare class DeleteServiceCommand extends $Command<DeleteServiceCommandInput, DeleteServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
64
  readonly input: DeleteServiceCommandInput;
@@ -30,6 +30,48 @@ export interface DeregisterInstanceCommandOutput extends DeregisterInstanceRespo
30
30
  * @see {@link DeregisterInstanceCommandOutput} 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 InstanceNotFound} (client fault)
37
+ * <p>No instance exists with the specified ID, or the instance was recently registered, and
38
+ * information about the instance hasn't propagated yet.</p>
39
+ *
40
+ * @throws {@link InvalidInput} (client fault)
41
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
42
+ * numeric value might be outside the allowed range, or a string value might exceed length
43
+ * constraints.</p>
44
+ *
45
+ * @throws {@link RequestLimitExceeded} (client fault)
46
+ * <p>The operation can't be completed because you've reached the quota for the number of
47
+ * 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
48
+ * <i>Cloud Map Developer Guide</i>.</p>
49
+ *
50
+ * @throws {@link ResourceInUse} (client fault)
51
+ * <p>The specified resource can't be deleted because it contains other resources. For example,
52
+ * you can't delete a service that contains any instances.</p>
53
+ *
54
+ * @throws {@link ServiceNotFound} (client fault)
55
+ * <p>No service exists with the specified ID.</p>
56
+ *
57
+ *
58
+ * @example Example: Deregister a service instance
59
+ * ```javascript
60
+ * // Example: Deregister a service instance
61
+ * const input = {
62
+ * "InstanceId": "myservice-53",
63
+ * "ServiceId": "srv-p5zdwlg5uvvzjita"
64
+ * };
65
+ * const command = new DeregisterInstanceCommand(input);
66
+ * const response = await client.send(command);
67
+ * /* response ==
68
+ * {
69
+ * "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq"
70
+ * }
71
+ * *\/
72
+ * // example id: example-deregister-a-service-instance-1587416305738
73
+ * ```
74
+ *
33
75
  */
34
76
  export declare class DeregisterInstanceCommand extends $Command<DeregisterInstanceCommandInput, DeregisterInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
77
  readonly input: DeregisterInstanceCommandInput;
@@ -31,6 +31,53 @@ export interface DiscoverInstancesCommandOutput extends DiscoverInstancesRespons
31
31
  * @see {@link DiscoverInstancesCommandOutput} for command's `response` shape.
32
32
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
33
33
  *
34
+ * @throws {@link InvalidInput} (client fault)
35
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
36
+ * numeric value might be outside the allowed range, or a string value might exceed length
37
+ * constraints.</p>
38
+ *
39
+ * @throws {@link NamespaceNotFound} (client fault)
40
+ * <p>No namespace exists with the specified ID.</p>
41
+ *
42
+ * @throws {@link RequestLimitExceeded} (client fault)
43
+ * <p>The operation can't be completed because you've reached the quota for the number of
44
+ * 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
45
+ * <i>Cloud Map Developer Guide</i>.</p>
46
+ *
47
+ * @throws {@link ServiceNotFound} (client fault)
48
+ * <p>No service exists with the specified ID.</p>
49
+ *
50
+ *
51
+ * @example Example: Discover registered instances
52
+ * ```javascript
53
+ * // Example: Discover registered instances
54
+ * const input = {
55
+ * "HealthStatus": "ALL",
56
+ * "MaxResults": 10,
57
+ * "NamespaceName": "example.com",
58
+ * "ServiceName": "myservice"
59
+ * };
60
+ * const command = new DiscoverInstancesCommand(input);
61
+ * const response = await client.send(command);
62
+ * /* response ==
63
+ * {
64
+ * "Instances": [
65
+ * {
66
+ * "Attributes": {
67
+ * "AWS_INSTANCE_IPV4": "172.2.1.3",
68
+ * "AWS_INSTANCE_PORT": "808"
69
+ * },
70
+ * "HealthStatus": "UNKNOWN",
71
+ * "InstanceId": "myservice-53",
72
+ * "NamespaceName": "example.com",
73
+ * "ServiceName": "myservice"
74
+ * }
75
+ * ]
76
+ * }
77
+ * *\/
78
+ * // example id: example-discover-registered-instances-1587236343568
79
+ * ```
80
+ *
34
81
  */
35
82
  export declare class DiscoverInstancesCommand extends $Command<DiscoverInstancesCommandInput, DiscoverInstancesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
36
83
  readonly input: DiscoverInstancesCommandInput;
@@ -29,6 +29,50 @@ export interface GetInstanceCommandOutput extends GetInstanceResponse, __Metadat
29
29
  * @see {@link GetInstanceCommandOutput} for command's `response` shape.
30
30
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
31
31
  *
32
+ * @throws {@link InstanceNotFound} (client fault)
33
+ * <p>No instance exists with the specified ID, or the instance was recently registered, and
34
+ * information about the instance hasn't propagated yet.</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 RequestLimitExceeded} (client fault)
42
+ * <p>The operation can't be completed because you've reached the quota for the number of
43
+ * 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
44
+ * <i>Cloud Map Developer Guide</i>.</p>
45
+ *
46
+ * @throws {@link ServiceNotFound} (client fault)
47
+ * <p>No service exists with the specified ID.</p>
48
+ *
49
+ *
50
+ * @example GetInstance example
51
+ * ```javascript
52
+ * // This example gets information about a specified instance.
53
+ * const input = {
54
+ * "InstanceId": "i-abcd1234",
55
+ * "ServiceId": "srv-e4anhexample0004"
56
+ * };
57
+ * const command = new GetInstanceCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "Instance": {
62
+ * "Attributes": {
63
+ * "AWS_INSTANCE_IPV4": "192.0.2.44",
64
+ * "AWS_INSTANCE_PORT": "80",
65
+ * "color": "green",
66
+ * "region": "us-west-2",
67
+ * "stage": "beta"
68
+ * },
69
+ * "Id": "i-abcd1234"
70
+ * }
71
+ * }
72
+ * *\/
73
+ * // example id: getinstance-example-1590115065598
74
+ * ```
75
+ *
32
76
  */
33
77
  export declare class GetInstanceCommand extends $Command<GetInstanceCommandInput, GetInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
78
  readonly input: GetInstanceCommandInput;
@@ -35,6 +35,43 @@ export interface GetInstancesHealthStatusCommandOutput extends GetInstancesHealt
35
35
  * @see {@link GetInstancesHealthStatusCommandOutput} for command's `response` shape.
36
36
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
37
37
  *
38
+ * @throws {@link InstanceNotFound} (client fault)
39
+ * <p>No instance exists with the specified ID, or the instance was recently registered, and
40
+ * information about the instance hasn't propagated yet.</p>
41
+ *
42
+ * @throws {@link InvalidInput} (client fault)
43
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a
44
+ * numeric value might be outside the allowed range, or a string value might exceed length
45
+ * constraints.</p>
46
+ *
47
+ * @throws {@link RequestLimitExceeded} (client fault)
48
+ * <p>The operation can't be completed because you've reached the quota for the number of
49
+ * 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
50
+ * <i>Cloud Map Developer Guide</i>.</p>
51
+ *
52
+ * @throws {@link ServiceNotFound} (client fault)
53
+ * <p>No service exists with the specified ID.</p>
54
+ *
55
+ *
56
+ * @example GetInstancesHealthStatus example
57
+ * ```javascript
58
+ * // This example gets the current health status of one or more instances that are associate with a specified service.
59
+ * const input = {
60
+ * "ServiceId": "srv-e4anhexample0004"
61
+ * };
62
+ * const command = new GetInstancesHealthStatusCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "Status": {
67
+ * "i-abcd1234": "HEALTHY",
68
+ * "i-abcd1235": "UNHEALTHY"
69
+ * }
70
+ * }
71
+ * *\/
72
+ * // example id: getinstanceshealthstatus-example-1590115176146
73
+ * ```
74
+ *
38
75
  */
39
76
  export declare class GetInstancesHealthStatusCommand extends $Command<GetInstancesHealthStatusCommandInput, GetInstancesHealthStatusCommandOutput, ServiceDiscoveryClientResolvedConfig> {
40
77
  readonly input: GetInstancesHealthStatusCommandInput;
@@ -29,6 +29,45 @@ export interface GetNamespaceCommandOutput extends GetNamespaceResponse, __Metad
29
29
  * @see {@link GetNamespaceCommandOutput} 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 NamespaceNotFound} (client fault)
38
+ * <p>No namespace exists with the specified ID.</p>
39
+ *
40
+ *
41
+ * @example GetNamespace example
42
+ * ```javascript
43
+ * // This example gets information about a specified namespace.
44
+ * const input = {
45
+ * "Id": "ns-e4anhexample0004"
46
+ * };
47
+ * const command = new GetNamespaceCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "Namespace": {
52
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e1tpmexample0001",
53
+ * "CreateDate": "20181118T211712Z",
54
+ * "CreatorRequestId": "example-creator-request-id-0001",
55
+ * "Description": "Example.com AWS Cloud Map HTTP Namespace",
56
+ * "Id": "ns-e1tpmexample0001",
57
+ * "Name": "example-http.com",
58
+ * "Properties": {
59
+ * "DnsProperties": {},
60
+ * "HttpProperties": {
61
+ * "HttpName": "example-http.com"
62
+ * }
63
+ * },
64
+ * "Type": "HTTP"
65
+ * }
66
+ * }
67
+ * *\/
68
+ * // example id: getnamespace-example-1590115383708
69
+ * ```
70
+ *
32
71
  */
33
72
  export declare class GetNamespaceCommand extends $Command<GetNamespaceCommandInput, GetNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
73
  readonly input: GetNamespaceCommandInput;
@@ -33,6 +33,45 @@ export interface GetOperationCommandOutput extends GetOperationResponse, __Metad
33
33
  * @see {@link GetOperationCommandOutput} for command's `response` shape.
34
34
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
35
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 OperationNotFound} (client fault)
42
+ * <p>No operation 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
+ *
50
+ * @example Example: Get operation result
51
+ * ```javascript
52
+ * // Example: Get operation result
53
+ * const input = {
54
+ * "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
55
+ * };
56
+ * const command = new GetOperationCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "Operation": {
61
+ * "CreateDate": 1587055860.121,
62
+ * "Id": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
63
+ * "Status": "SUCCESS",
64
+ * "Targets": {
65
+ * "NAMESPACE": "ns-ylexjili4cdxy3xm"
66
+ * },
67
+ * "Type": "CREATE_NAMESPACE",
68
+ * "UpdateDate": 1587055900.469
69
+ * }
70
+ * }
71
+ * *\/
72
+ * // example id: example-get-operation-result-1587073807124
73
+ * ```
74
+ *
36
75
  */
37
76
  export declare class GetOperationCommand extends $Command<GetOperationCommandInput, GetOperationCommandOutput, ServiceDiscoveryClientResolvedConfig> {
38
77
  readonly input: GetOperationCommandInput;
@@ -29,6 +29,49 @@ export interface GetServiceCommandOutput extends GetServiceResponse, __MetadataB
29
29
  * @see {@link GetServiceCommandOutput} 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 ServiceNotFound} (client fault)
43
+ * <p>No service exists with the specified ID.</p>
44
+ *
45
+ *
46
+ * @example GetService Example
47
+ * ```javascript
48
+ * // This example gets the settings for a specified service.
49
+ * const input = {
50
+ * "Id": "srv-e4anhexample0004"
51
+ * };
52
+ * const command = new GetServiceCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "Service": {
57
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004",
58
+ * "CreateDate": "20181118T211707Z",
59
+ * "CreatorRequestId": "example-creator-request-id-0004",
60
+ * "Description": "Example.com AWS Cloud Map HTTP Service",
61
+ * "HealthCheckConfig": {
62
+ * "FailureThreshold": 3,
63
+ * "ResourcePath": "/",
64
+ * "Type": "HTTPS"
65
+ * },
66
+ * "Id": "srv-e4anhexample0004",
67
+ * "Name": "example-http-service",
68
+ * "NamespaceId": "ns-e4anhexample0004"
69
+ * }
70
+ * }
71
+ * *\/
72
+ * // example id: getservice-example-1590117234294
73
+ * ```
74
+ *
32
75
  */
33
76
  export declare class GetServiceCommand extends $Command<GetServiceCommandInput, GetServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
77
  readonly input: GetServiceCommandInput;