Skip to content

Commit 3002abd

Browse files
author
awstools
committed
feat(client-servicediscovery): Added support for cross account through Id parameter overloading with ARN and allow owner account for some APIs instead of ARN
1 parent 53414a9 commit 3002abd

37 files changed

+1596
-1099
lines changed

‎clients/client-servicediscovery/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ AWS SDK for JavaScript ServiceDiscovery Client for Node.js, Browser and React Na
88

99
<fullname>Cloud Map</fullname>
1010

11-
<p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice
12-
applications run in. When an instance becomes available, you can call the Cloud Map API to register the
13-
instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and
14-
an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service
15-
receive an answer that contains up to eight healthy records. </p>
11+
<p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
12+
microservice applications run in. When an instance becomes available, you can call the Cloud Map
13+
API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map
14+
automatically creates DNS records and an optional health check. Clients that submit public or
15+
private DNS queries, or HTTP requests, for the service receive an answer that contains up to
16+
eight healthy records. </p>
1617

1718
## Installing
1819

‎clients/client-servicediscovery/src/ServiceDiscovery.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -617,11 +617,12 @@ export interface ServiceDiscovery {
617617

618618
/**
619619
* <fullname>Cloud Map</fullname>
620-
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice
621-
* applications run in. When an instance becomes available, you can call the Cloud Map API to register the
622-
* instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and
623-
* an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service
624-
* receive an answer that contains up to eight healthy records. </p>
620+
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
621+
* microservice applications run in. When an instance becomes available, you can call the Cloud Map
622+
* API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map
623+
* automatically creates DNS records and an optional health check. Clients that submit public or
624+
* private DNS queries, or HTTP requests, for the service receive an answer that contains up to
625+
* eight healthy records. </p>
625626
* @public
626627
*/
627628
export class ServiceDiscovery extends ServiceDiscoveryClient implements ServiceDiscovery {}

‎clients/client-servicediscovery/src/ServiceDiscoveryClient.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -395,11 +395,12 @@ export interface ServiceDiscoveryClientResolvedConfig extends ServiceDiscoveryCl
395395

396396
/**
397397
* <fullname>Cloud Map</fullname>
398-
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice
399-
* applications run in. When an instance becomes available, you can call the Cloud Map API to register the
400-
* instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and
401-
* an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service
402-
* receive an answer that contains up to eight healthy records. </p>
398+
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
399+
* microservice applications run in. When an instance becomes available, you can call the Cloud Map
400+
* API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map
401+
* automatically creates DNS records and an optional health check. Clients that submit public or
402+
* private DNS queries, or HTTP requests, for the service receive an answer that contains up to
403+
* eight healthy records. </p>
403404
* @public
404405
*/
405406
export class ServiceDiscoveryClient extends __Client<

‎clients/client-servicediscovery/src/commands/CreateHttpNamespaceCommand.ts

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ export interface CreateHttpNamespaceCommandInput extends CreateHttpNamespaceRequ
2828
export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a
32-
* <code>DiscoverInstances</code> request but can't be discovered using DNS.</p>
33-
* <p>For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
34-
* quotas</a> in the <i>Cloud Map Developer Guide</i>.</p>
31+
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
32+
* discovered using a <code>DiscoverInstances</code> request but can't be discovered using
33+
* DNS.</p>
34+
* <p>For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
35+
* <i>Cloud Map Developer Guide</i>.</p>
3536
* @example
3637
* Use a bare-bones client and the command you need to make an API call.
3738
* ```javascript
@@ -67,18 +68,20 @@ export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceRes
6768
* <p>The operation is already in progress.</p>
6869
*
6970
* @throws {@link InvalidInput} (client fault)
70-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
71-
* might be outside the allowed range, or a string value might exceed length constraints.</p>
71+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
72+
* numeric value might be outside the allowed range, or a string value might exceed length
73+
* constraints.</p>
7274
*
7375
* @throws {@link NamespaceAlreadyExists} (client fault)
7476
* <p>The namespace that you're trying to create already exists.</p>
7577
*
7678
* @throws {@link ResourceLimitExceeded} (client fault)
77-
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
79+
* <p>The resource can't be created because you've reached the quota on the number of
80+
* resources.</p>
7881
*
7982
* @throws {@link TooManyTagsException} (client fault)
80-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
81-
* resource is 50.</p>
83+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
84+
* applied to a resource is 50.</p>
8285
*
8386
* @throws {@link ServiceDiscoveryServiceException}
8487
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

‎clients/client-servicediscovery/src/commands/CreatePrivateDnsNamespaceCommand.ts

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,13 @@ export interface CreatePrivateDnsNamespaceCommandInput extends CreatePrivateDnsN
2828
export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDnsNamespaceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The
32-
* namespace defines your service naming scheme. For example, if you name your namespace <code>example.com</code>
33-
* and name your service <code>backend</code>, the resulting DNS name for the service is
34-
* <code>backend.example.com</code>. Service instances that are registered using a private DNS namespace can be
35-
* discovered using either a <code>DiscoverInstances</code> request or using DNS. For the current quota on the
36-
* number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
31+
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
32+
* VPC. The namespace defines your service naming scheme. For example, if you name your namespace
33+
* <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
34+
* the service is <code>backend.example.com</code>. Service instances that are registered using a
35+
* private DNS namespace can be discovered using either a <code>DiscoverInstances</code> request or
36+
* using DNS. For the current quota on the number of namespaces that you can create using the same
37+
* Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
3738
* <i>Cloud Map Developer Guide</i>.</p>
3839
* @example
3940
* Use a bare-bones client and the command you need to make an API call.
@@ -78,18 +79,20 @@ export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDns
7879
* <p>The operation is already in progress.</p>
7980
*
8081
* @throws {@link InvalidInput} (client fault)
81-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
82-
* might be outside the allowed range, or a string value might exceed length constraints.</p>
82+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
83+
* numeric value might be outside the allowed range, or a string value might exceed length
84+
* constraints.</p>
8385
*
8486
* @throws {@link NamespaceAlreadyExists} (client fault)
8587
* <p>The namespace that you're trying to create already exists.</p>
8688
*
8789
* @throws {@link ResourceLimitExceeded} (client fault)
88-
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
90+
* <p>The resource can't be created because you've reached the quota on the number of
91+
* resources.</p>
8992
*
9093
* @throws {@link TooManyTagsException} (client fault)
91-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
92-
* resource is 50.</p>
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>
9396
*
9497
* @throws {@link ServiceDiscoveryServiceException}
9598
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

‎clients/client-servicediscovery/src/commands/CreatePublicDnsNamespaceCommand.ts

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,15 @@ export interface CreatePublicDnsNamespaceCommandInput extends CreatePublicDnsNam
2828
export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNamespaceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your
32-
* service naming scheme. For example, if you name your namespace <code>example.com</code> and name your service
33-
* <code>backend</code>, the resulting DNS name for the service is <code>backend.example.com</code>. You can
34-
* discover instances that were registered with a public DNS namespace by using either a
35-
* <code>DiscoverInstances</code> request or using DNS. For the current quota on the number of namespaces that you
36-
* can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
31+
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
32+
* defines your service naming scheme. For example, if you name your namespace
33+
* <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
34+
* the service is <code>backend.example.com</code>. You can discover instances that were registered
35+
* with a public DNS namespace by using either a <code>DiscoverInstances</code> request or using
36+
* DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
3737
* <i>Cloud Map Developer Guide</i>.</p>
3838
* <important>
39-
* <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US)
40-
* Regions.</p>
39+
* <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US) Regions.</p>
4140
* </important>
4241
* @example
4342
* Use a bare-bones client and the command you need to make an API call.
@@ -81,18 +80,20 @@ export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNa
8180
* <p>The operation is already in progress.</p>
8281
*
8382
* @throws {@link InvalidInput} (client fault)
84-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
85-
* might be outside the allowed range, or a string value might exceed length constraints.</p>
83+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
84+
* numeric value might be outside the allowed range, or a string value might exceed length
85+
* constraints.</p>
8686
*
8787
* @throws {@link NamespaceAlreadyExists} (client fault)
8888
* <p>The namespace that you're trying to create already exists.</p>
8989
*
9090
* @throws {@link ResourceLimitExceeded} (client fault)
91-
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
91+
* <p>The resource can't be created because you've reached the quota on the number of
92+
* resources.</p>
9293
*
9394
* @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 applied to a
95-
* resource is 50.</p>
95+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
96+
* applied to a resource is 50.</p>
9697
*
9798
* @throws {@link ServiceDiscoveryServiceException}
9899
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

‎clients/client-servicediscovery/src/commands/CreateServiceCommand.ts

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
6565
* <p>Optionally, a health check</p>
6666
* </li>
6767
* </ul>
68-
* <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and Cloud Map uses the
69-
* values in the configuration to create the specified entities.</p>
70-
* <p>For the current quota on the number of instances that you can register using the same namespace and using
71-
* the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
72-
* quotas</a> in the <i>Cloud Map Developer Guide</i>.</p>
68+
* <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and
69+
* Cloud Map uses the values in the configuration to create the specified entities.</p>
70+
* <p>For the current quota on the number of instances that you can register using the same
71+
* namespace and using the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
72+
* <i>Cloud Map Developer Guide</i>.</p>
7373
* @example
7474
* Use a bare-bones client and the command you need to make an API call.
7575
* ```javascript
@@ -113,6 +113,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
113113
* // Service: { // Service
114114
* // Id: "STRING_VALUE",
115115
* // Arn: "STRING_VALUE",
116+
* // ResourceOwner: "STRING_VALUE",
116117
* // Name: "STRING_VALUE",
117118
* // NamespaceId: "STRING_VALUE",
118119
* // Description: "STRING_VALUE",
@@ -138,6 +139,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
138139
* // },
139140
* // CreateDate: new Date("TIMESTAMP"),
140141
* // CreatorRequestId: "STRING_VALUE",
142+
* // CreatedByAccount: "STRING_VALUE",
141143
* // },
142144
* // };
143145
*
@@ -150,21 +152,23 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
150152
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
151153
*
152154
* @throws {@link InvalidInput} (client fault)
153-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
154-
* might be outside the allowed range, or a string value might exceed length constraints.</p>
155+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
156+
* numeric value might be outside the allowed range, or a string value might exceed length
157+
* constraints.</p>
155158
*
156159
* @throws {@link NamespaceNotFound} (client fault)
157160
* <p>No namespace exists with the specified ID.</p>
158161
*
159162
* @throws {@link ResourceLimitExceeded} (client fault)
160-
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
163+
* <p>The resource can't be created because you've reached the quota on the number of
164+
* resources.</p>
161165
*
162166
* @throws {@link ServiceAlreadyExists} (client fault)
163167
* <p>The service can't be created because a service with the same name already exists.</p>
164168
*
165169
* @throws {@link TooManyTagsException} (client fault)
166-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
167-
* resource is 50.</p>
170+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
171+
* applied to a resource is 50.</p>
168172
*
169173
* @throws {@link ServiceDiscoveryServiceException}
170174
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

‎clients/client-servicediscovery/src/commands/DeleteNamespaceCommand.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {}
2828
export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a namespace from the current account. If the namespace still contains one or more services, the
32-
* request fails.</p>
31+
* <p>Deletes a namespace from the current account. If the namespace still contains one or more
32+
* services, the request fails.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript
@@ -57,15 +57,16 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
5757
* <p>The operation is already in progress.</p>
5858
*
5959
* @throws {@link InvalidInput} (client fault)
60-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
61-
* might be outside the allowed range, or a string value might exceed length constraints.</p>
60+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
61+
* numeric value might be outside the allowed range, or a string value might exceed length
62+
* constraints.</p>
6263
*
6364
* @throws {@link NamespaceNotFound} (client fault)
6465
* <p>No namespace exists with the specified ID.</p>
6566
*
6667
* @throws {@link ResourceInUse} (client fault)
67-
* <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
68-
* a service that contains any instances.</p>
68+
* <p>The specified resource can't be deleted because it contains other resources. For example,
69+
* you can't delete a service that contains any instances.</p>
6970
*
7071
* @throws {@link ServiceDiscoveryServiceException}
7172
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

‎clients/client-servicediscovery/src/commands/DeleteServiceAttributesCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,9 @@ export interface DeleteServiceAttributesCommandOutput extends DeleteServiceAttri
5454
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
5555
*
5656
* @throws {@link InvalidInput} (client fault)
57-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
58-
* might be outside the allowed range, or a string value might exceed length constraints.</p>
57+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
58+
* numeric value might be outside the allowed range, or a string value might exceed length
59+
* constraints.</p>
5960
*
6061
* @throws {@link ServiceNotFound} (client fault)
6162
* <p>No service exists with the specified ID.</p>

0 commit comments

Comments
 (0)