@aws-sdk/client-servicediscovery 3.288.0 → 3.289.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 (24) hide show
  1. package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +18 -0
  2. package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +18 -0
  3. package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +18 -0
  4. package/dist-types/commands/CreateServiceCommand.d.ts +45 -0
  5. package/dist-types/commands/DeleteNamespaceCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteServiceCommand.d.ts +11 -0
  7. package/dist-types/commands/DeregisterInstanceCommand.d.ts +17 -0
  8. package/dist-types/commands/DiscoverInstancesCommand.d.ts +30 -0
  9. package/dist-types/commands/GetInstanceCommand.d.ts +26 -0
  10. package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +19 -0
  11. package/dist-types/commands/GetNamespaceCommand.d.ts +30 -0
  12. package/dist-types/commands/GetOperationCommand.d.ts +25 -0
  13. package/dist-types/commands/GetServiceCommand.d.ts +29 -0
  14. package/dist-types/commands/ListInstancesCommand.d.ts +24 -0
  15. package/dist-types/commands/ListNamespacesCommand.d.ts +59 -0
  16. package/dist-types/commands/ListOperationsCommand.d.ts +38 -0
  17. package/dist-types/commands/ListServicesCommand.d.ts +30 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +25 -0
  19. package/dist-types/commands/RegisterInstanceCommand.d.ts +22 -0
  20. package/dist-types/commands/TagResourceCommand.d.ts +21 -0
  21. package/dist-types/commands/UntagResourceCommand.d.ts +15 -0
  22. package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +13 -0
  23. package/dist-types/commands/UpdateServiceCommand.d.ts +31 -0
  24. package/package.json +29 -29
@@ -33,6 +33,24 @@ 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
+ * @example CreateHttpNamespace example
37
+ * ```javascript
38
+ * // This example creates an HTTP namespace.
39
+ * const input = {
40
+ * "CreatorRequestId": "example-creator-request-id-0001",
41
+ * "Description": "Example.com AWS Cloud Map HTTP Namespace",
42
+ * "Name": "example-http.com"
43
+ * };
44
+ * const command = new CreateHttpNamespaceCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "OperationId": "httpvoqozuhfet5kzxoxg-a-response-example"
49
+ * }
50
+ * *\/
51
+ * // example id: createhttpnamespace-example-1590114811304
52
+ * ```
53
+ *
36
54
  */
37
55
  export declare class CreateHttpNamespaceCommand extends $Command<CreateHttpNamespaceCommandInput, CreateHttpNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
38
56
  readonly input: CreateHttpNamespaceCommandInput;
@@ -36,6 +36,24 @@ 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
+ * @example Example: Create private DNS namespace
40
+ * ```javascript
41
+ * // Example: Create private DNS namespace
42
+ * const input = {
43
+ * "CreatorRequestId": "eedd6892-50f3-41b2-8af9-611d6e1d1a8c",
44
+ * "Name": "example.com",
45
+ * "Vpc": "vpc-1c56417b"
46
+ * };
47
+ * const command = new CreatePrivateDnsNamespaceCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
52
+ * }
53
+ * *\/
54
+ * // example id: example-create-private-dns-namespace-1587058592930
55
+ * ```
56
+ *
39
57
  */
40
58
  export declare class CreatePrivateDnsNamespaceCommand extends $Command<CreatePrivateDnsNamespaceCommandInput, CreatePrivateDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
41
59
  readonly input: CreatePrivateDnsNamespaceCommandInput;
@@ -38,6 +38,24 @@ 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
+ * @example CreatePublicDnsNamespace example
42
+ * ```javascript
43
+ * // This example creates a public namespace based on DNS.
44
+ * const input = {
45
+ * "CreatorRequestId": "example-creator-request-id-0003",
46
+ * "Description": "Example.com AWS Cloud Map Public DNS Namespace",
47
+ * "Name": "example-public-dns.com"
48
+ * };
49
+ * const command = new CreatePublicDnsNamespaceCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "OperationId": "dns2voqozuhfet5kzxoxg-a-response-example"
54
+ * }
55
+ * *\/
56
+ * // example id: createpublicdnsnamespace-example-1590114940910
57
+ * ```
58
+ *
41
59
  */
42
60
  export declare class CreatePublicDnsNamespaceCommand extends $Command<CreatePublicDnsNamespaceCommandInput, CreatePublicDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
43
61
  readonly input: CreatePublicDnsNamespaceCommandInput;
@@ -70,6 +70,51 @@ 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
+ * @example Example: Create service
74
+ * ```javascript
75
+ * // Example: Create service
76
+ * const input = {
77
+ * "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25",
78
+ * "DnsConfig": {
79
+ * "DnsRecords": [
80
+ * {
81
+ * "TTL": 60,
82
+ * "Type": "A"
83
+ * }
84
+ * ],
85
+ * "NamespaceId": "ns-ylexjili4cdxy3xm",
86
+ * "RoutingPolicy": "MULTIVALUE"
87
+ * },
88
+ * "Name": "myservice",
89
+ * "NamespaceId": "ns-ylexjili4cdxy3xm"
90
+ * };
91
+ * const command = new CreateServiceCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "Service": {
96
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
97
+ * "CreateDate": 1587081768.334,
98
+ * "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25",
99
+ * "DnsConfig": {
100
+ * "DnsRecords": [
101
+ * {
102
+ * "TTL": 60,
103
+ * "Type": "A"
104
+ * }
105
+ * ],
106
+ * "NamespaceId": "ns-ylexjili4cdxy3xm",
107
+ * "RoutingPolicy": "MULTIVALUE"
108
+ * },
109
+ * "Id": "srv-p5zdwlg5uvvzjita",
110
+ * "Name": "myservice",
111
+ * "NamespaceId": "ns-ylexjili4cdxy3xm"
112
+ * }
113
+ * }
114
+ * *\/
115
+ * // example id: example-create-service-1587235913584
116
+ * ```
117
+ *
73
118
  */
74
119
  export declare class CreateServiceCommand extends $Command<CreateServiceCommandInput, CreateServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
75
120
  readonly input: CreateServiceCommandInput;
@@ -30,6 +30,22 @@ 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
+ * @example Example: Delete namespace
34
+ * ```javascript
35
+ * // Example: Delete namespace
36
+ * const input = {
37
+ * "Id": "ns-ylexjili4cdxy3xm"
38
+ * };
39
+ * const command = new DeleteNamespaceCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk"
44
+ * }
45
+ * *\/
46
+ * // example id: example-delete-namespace-1587416093508
47
+ * ```
48
+ *
33
49
  */
34
50
  export declare class DeleteNamespaceCommand extends $Command<DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
51
  readonly input: DeleteNamespaceCommandInput;
@@ -30,6 +30,17 @@ 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
+ * @example Example: Delete service
34
+ * ```javascript
35
+ * // Example: Delete service
36
+ * const input = {
37
+ * "Id": "srv-p5zdwlg5uvvzjita"
38
+ * };
39
+ * const command = new DeleteServiceCommand(input);
40
+ * await client.send(command);
41
+ * // example id: example-delete-service-1587416462902
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteServiceCommand extends $Command<DeleteServiceCommandInput, DeleteServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
46
  readonly input: DeleteServiceCommandInput;
@@ -30,6 +30,23 @@ 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
+ * @example Example: Deregister a service instance
34
+ * ```javascript
35
+ * // Example: Deregister a service instance
36
+ * const input = {
37
+ * "InstanceId": "myservice-53",
38
+ * "ServiceId": "srv-p5zdwlg5uvvzjita"
39
+ * };
40
+ * const command = new DeregisterInstanceCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq"
45
+ * }
46
+ * *\/
47
+ * // example id: example-deregister-a-service-instance-1587416305738
48
+ * ```
49
+ *
33
50
  */
34
51
  export declare class DeregisterInstanceCommand extends $Command<DeregisterInstanceCommandInput, DeregisterInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
52
  readonly input: DeregisterInstanceCommandInput;
@@ -31,6 +31,36 @@ 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
+ * @example Example: Discover registered instances
35
+ * ```javascript
36
+ * // Example: Discover registered instances
37
+ * const input = {
38
+ * "HealthStatus": "ALL",
39
+ * "MaxResults": 10,
40
+ * "NamespaceName": "example.com",
41
+ * "ServiceName": "myservice"
42
+ * };
43
+ * const command = new DiscoverInstancesCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "Instances": [
48
+ * {
49
+ * "Attributes": {
50
+ * "AWS_INSTANCE_IPV4": "172.2.1.3",
51
+ * "AWS_INSTANCE_PORT": "808"
52
+ * },
53
+ * "HealthStatus": "UNKNOWN",
54
+ * "InstanceId": "myservice-53",
55
+ * "NamespaceName": "example.com",
56
+ * "ServiceName": "myservice"
57
+ * }
58
+ * ]
59
+ * }
60
+ * *\/
61
+ * // example id: example-discover-registered-instances-1587236343568
62
+ * ```
63
+ *
34
64
  */
35
65
  export declare class DiscoverInstancesCommand extends $Command<DiscoverInstancesCommandInput, DiscoverInstancesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
36
66
  readonly input: DiscoverInstancesCommandInput;
@@ -29,6 +29,32 @@ 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
+ * @example GetInstance example
33
+ * ```javascript
34
+ * // This example gets information about a specified instance.
35
+ * const input = {
36
+ * "InstanceId": "i-abcd1234",
37
+ * "ServiceId": "srv-e4anhexample0004"
38
+ * };
39
+ * const command = new GetInstanceCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Instance": {
44
+ * "Attributes": {
45
+ * "AWS_INSTANCE_IPV4": "192.0.2.44",
46
+ * "AWS_INSTANCE_PORT": "80",
47
+ * "color": "green",
48
+ * "region": "us-west-2",
49
+ * "stage": "beta"
50
+ * },
51
+ * "Id": "i-abcd1234"
52
+ * }
53
+ * }
54
+ * *\/
55
+ * // example id: getinstance-example-1590115065598
56
+ * ```
57
+ *
32
58
  */
33
59
  export declare class GetInstanceCommand extends $Command<GetInstanceCommandInput, GetInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
60
  readonly input: GetInstanceCommandInput;
@@ -35,6 +35,25 @@ 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
+ * @example GetInstancesHealthStatus example
39
+ * ```javascript
40
+ * // This example gets the current health status of one or more instances that are associate with a specified service.
41
+ * const input = {
42
+ * "ServiceId": "srv-e4anhexample0004"
43
+ * };
44
+ * const command = new GetInstancesHealthStatusCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Status": {
49
+ * "i-abcd1234": "HEALTHY",
50
+ * "i-abcd1235": "UNHEALTHY"
51
+ * }
52
+ * }
53
+ * *\/
54
+ * // example id: getinstanceshealthstatus-example-1590115176146
55
+ * ```
56
+ *
38
57
  */
39
58
  export declare class GetInstancesHealthStatusCommand extends $Command<GetInstancesHealthStatusCommandInput, GetInstancesHealthStatusCommandOutput, ServiceDiscoveryClientResolvedConfig> {
40
59
  readonly input: GetInstancesHealthStatusCommandInput;
@@ -29,6 +29,36 @@ 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
+ * @example GetNamespace example
33
+ * ```javascript
34
+ * // This example gets information about a specified namespace.
35
+ * const input = {
36
+ * "Id": "ns-e4anhexample0004"
37
+ * };
38
+ * const command = new GetNamespaceCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Namespace": {
43
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e1tpmexample0001",
44
+ * "CreateDate": "20181118T211712Z",
45
+ * "CreatorRequestId": "example-creator-request-id-0001",
46
+ * "Description": "Example.com AWS Cloud Map HTTP Namespace",
47
+ * "Id": "ns-e1tpmexample0001",
48
+ * "Name": "example-http.com",
49
+ * "Properties": {
50
+ * "DnsProperties": {},
51
+ * "HttpProperties": {
52
+ * "HttpName": "example-http.com"
53
+ * }
54
+ * },
55
+ * "Type": "HTTP"
56
+ * }
57
+ * }
58
+ * *\/
59
+ * // example id: getnamespace-example-1590115383708
60
+ * ```
61
+ *
32
62
  */
33
63
  export declare class GetNamespaceCommand extends $Command<GetNamespaceCommandInput, GetNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
64
  readonly input: GetNamespaceCommandInput;
@@ -33,6 +33,31 @@ 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
+ * @example Example: Get operation result
37
+ * ```javascript
38
+ * // Example: Get operation result
39
+ * const input = {
40
+ * "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
41
+ * };
42
+ * const command = new GetOperationCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "Operation": {
47
+ * "CreateDate": 1587055860.121,
48
+ * "Id": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
49
+ * "Status": "SUCCESS",
50
+ * "Targets": {
51
+ * "NAMESPACE": "ns-ylexjili4cdxy3xm"
52
+ * },
53
+ * "Type": "CREATE_NAMESPACE",
54
+ * "UpdateDate": 1587055900.469
55
+ * }
56
+ * }
57
+ * *\/
58
+ * // example id: example-get-operation-result-1587073807124
59
+ * ```
60
+ *
36
61
  */
37
62
  export declare class GetOperationCommand extends $Command<GetOperationCommandInput, GetOperationCommandOutput, ServiceDiscoveryClientResolvedConfig> {
38
63
  readonly input: GetOperationCommandInput;
@@ -29,6 +29,35 @@ 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
+ * @example GetService Example
33
+ * ```javascript
34
+ * // This example gets the settings for a specified service.
35
+ * const input = {
36
+ * "Id": "srv-e4anhexample0004"
37
+ * };
38
+ * const command = new GetServiceCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Service": {
43
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004",
44
+ * "CreateDate": "20181118T211707Z",
45
+ * "CreatorRequestId": "example-creator-request-id-0004",
46
+ * "Description": "Example.com AWS Cloud Map HTTP Service",
47
+ * "HealthCheckConfig": {
48
+ * "FailureThreshold": 3,
49
+ * "ResourcePath": "/",
50
+ * "Type": "HTTPS"
51
+ * },
52
+ * "Id": "srv-e4anhexample0004",
53
+ * "Name": "example-http-service",
54
+ * "NamespaceId": "ns-e4anhexample0004"
55
+ * }
56
+ * }
57
+ * *\/
58
+ * // example id: getservice-example-1590117234294
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class GetServiceCommand extends $Command<GetServiceCommandInput, GetServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
63
  readonly input: GetServiceCommandInput;
@@ -30,6 +30,30 @@ 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
+ * @example Example: List service instances
34
+ * ```javascript
35
+ * // Example: List service instances
36
+ * const input = {
37
+ * "ServiceId": "srv-qzpwvt2tfqcegapy"
38
+ * };
39
+ * const command = new ListInstancesCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Instances": [
44
+ * {
45
+ * "Attributes": {
46
+ * "AWS_INSTANCE_IPV4": "172.2.1.3",
47
+ * "AWS_INSTANCE_PORT": "808"
48
+ * },
49
+ * "Id": "i-06bdabbae60f65a4e"
50
+ * }
51
+ * ]
52
+ * }
53
+ * *\/
54
+ * // example id: example-list-service-instances-1587236237008
55
+ * ```
56
+ *
33
57
  */
34
58
  export declare class ListInstancesCommand extends $Command<ListInstancesCommandInput, ListInstancesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
59
  readonly input: ListInstancesCommandInput;
@@ -29,6 +29,65 @@ 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
+ * @example Example: List namespaces
33
+ * ```javascript
34
+ * // Example: List namespaces
35
+ * const input = {};
36
+ * const command = new ListNamespacesCommand(input);
37
+ * const response = await client.send(command);
38
+ * /* response ==
39
+ * {
40
+ * "Namespaces": [
41
+ * {
42
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile",
43
+ * "CreateDate": 1585354387.357,
44
+ * "Id": "ns-a3ccy2e7e3a7rile",
45
+ * "Name": "local",
46
+ * "Properties": {
47
+ * "DnsProperties": {
48
+ * "HostedZoneId": "Z06752353VBUDTC32S84S"
49
+ * },
50
+ * "HttpProperties": {
51
+ * "HttpName": "local"
52
+ * }
53
+ * },
54
+ * "Type": "DNS_PRIVATE"
55
+ * },
56
+ * {
57
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx",
58
+ * "CreateDate": 1586468974.698,
59
+ * "Description": "My second namespace",
60
+ * "Id": "ns-pocfyjtrsmwtvcxx",
61
+ * "Name": "My-second-namespace",
62
+ * "Properties": {
63
+ * "DnsProperties": {},
64
+ * "HttpProperties": {
65
+ * "HttpName": "My-second-namespace"
66
+ * }
67
+ * },
68
+ * "Type": "HTTP"
69
+ * },
70
+ * {
71
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm",
72
+ * "CreateDate": 1587055896.798,
73
+ * "Id": "ns-ylexjili4cdxy3xm",
74
+ * "Name": "example.com",
75
+ * "Properties": {
76
+ * "DnsProperties": {
77
+ * "HostedZoneId": "Z09983722P0QME1B3KC8I"
78
+ * },
79
+ * "HttpProperties": {
80
+ * "HttpName": "example.com"
81
+ * }
82
+ * },
83
+ * "Type": "DNS_PRIVATE"
84
+ * }
85
+ * ]
86
+ * }
87
+ * *\/
88
+ * // example id: example-list-namespaces-1587401553154
89
+ * ```
90
+ *
32
91
  */
33
92
  export declare class ListNamespacesCommand extends $Command<ListNamespacesCommandInput, ListNamespacesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
93
  readonly input: ListNamespacesCommandInput;
@@ -29,6 +29,44 @@ 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
+ * @example ListOperations Example
33
+ * ```javascript
34
+ * // This example gets the operations that have a STATUS of either PENDING or SUCCESS.
35
+ * const input = {
36
+ * "Filters": [
37
+ * {
38
+ * "Condition": "IN",
39
+ * "Name": "STATUS",
40
+ * "Values": [
41
+ * "PENDING",
42
+ * "SUCCESS"
43
+ * ]
44
+ * }
45
+ * ]
46
+ * };
47
+ * const command = new ListOperationsCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "Operations": [
52
+ * {
53
+ * "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample",
54
+ * "Status": "SUCCESS"
55
+ * },
56
+ * {
57
+ * "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample",
58
+ * "Status": "SUCCESS"
59
+ * },
60
+ * {
61
+ * "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example",
62
+ * "Status": "PENDING"
63
+ * }
64
+ * ]
65
+ * }
66
+ * *\/
67
+ * // example id: listoperations-example-1590117354396
68
+ * ```
69
+ *
32
70
  */
33
71
  export declare class ListOperationsCommand extends $Command<ListOperationsCommandInput, ListOperationsCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
72
  readonly input: ListOperationsCommandInput;
@@ -30,6 +30,36 @@ 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
+ * @example Example: List services
34
+ * ```javascript
35
+ * // Example: List services
36
+ * const input = {};
37
+ * const command = new ListServicesCommand(input);
38
+ * const response = await client.send(command);
39
+ * /* response ==
40
+ * {
41
+ * "Services": [
42
+ * {
43
+ * "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
44
+ * "CreateDate": 1587081768.334,
45
+ * "DnsConfig": {
46
+ * "DnsRecords": [
47
+ * {
48
+ * "TTL": 60,
49
+ * "Type": "A"
50
+ * }
51
+ * ],
52
+ * "RoutingPolicy": "MULTIVALUE"
53
+ * },
54
+ * "Id": "srv-p5zdwlg5uvvzjita",
55
+ * "Name": "myservice"
56
+ * }
57
+ * ]
58
+ * }
59
+ * *\/
60
+ * // example id: example-list-services-1587236889840
61
+ * ```
62
+ *
33
63
  */
34
64
  export declare class ListServicesCommand extends $Command<ListServicesCommandInput, ListServicesCommandOutput, ServiceDiscoveryClientResolvedConfig> {
35
65
  readonly input: ListServicesCommandInput;
@@ -29,6 +29,31 @@ 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
+ * @example ListTagsForResource example
33
+ * ```javascript
34
+ * // This example lists the tags of a resource.
35
+ * const input = {
36
+ * "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm"
37
+ * };
38
+ * const command = new ListTagsForResourceCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Tags": [
43
+ * {
44
+ * "Key": "Project",
45
+ * "Value": "Zeta"
46
+ * },
47
+ * {
48
+ * "Key": "Department",
49
+ * "Value": "Engineering"
50
+ * }
51
+ * ]
52
+ * }
53
+ * *\/
54
+ * // example id: listtagsforresource-example-1590093928416
55
+ * ```
56
+ *
32
57
  */
33
58
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
59
  readonly input: ListTagsForResourceCommandInput;
@@ -72,6 +72,28 @@ 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
+ * @example Example: Register Instance
76
+ * ```javascript
77
+ * // Example: Register Instance
78
+ * const input = {
79
+ * "Attributes": {
80
+ * "AWS_INSTANCE_IPV4": "172.2.1.3",
81
+ * "AWS_INSTANCE_PORT": "808"
82
+ * },
83
+ * "CreatorRequestId": "7a48a98a-72e6-4849-bfa7-1a458e030d7b",
84
+ * "InstanceId": "myservice-53",
85
+ * "ServiceId": "srv-p5zdwlg5uvvzjita"
86
+ * };
87
+ * const command = new RegisterInstanceCommand(input);
88
+ * const response = await client.send(command);
89
+ * /* response ==
90
+ * {
91
+ * "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7"
92
+ * }
93
+ * *\/
94
+ * // example id: example-register-instance-1587236116314
95
+ * ```
96
+ *
75
97
  */
76
98
  export declare class RegisterInstanceCommand extends $Command<RegisterInstanceCommandInput, RegisterInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
77
99
  readonly input: RegisterInstanceCommandInput;
@@ -29,6 +29,27 @@ 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
+ * @example TagResource example
33
+ * ```javascript
34
+ * // This example adds "Department" and "Project" tags to a resource.
35
+ * const input = {
36
+ * "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm",
37
+ * "Tags": [
38
+ * {
39
+ * "Key": "Department",
40
+ * "Value": "Engineering"
41
+ * },
42
+ * {
43
+ * "Key": "Project",
44
+ * "Value": "Zeta"
45
+ * }
46
+ * ]
47
+ * };
48
+ * const command = new TagResourceCommand(input);
49
+ * await client.send(command);
50
+ * // example id: tagresource-example-1590093532240
51
+ * ```
52
+ *
32
53
  */
33
54
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
55
  readonly input: TagResourceCommandInput;
@@ -29,6 +29,21 @@ 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
+ * @example UntagResource example
33
+ * ```javascript
34
+ * // This example removes the "Department" and "Project" tags from a resource.
35
+ * const input = {
36
+ * "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm",
37
+ * "TagKeys": [
38
+ * "Project",
39
+ * "Department"
40
+ * ]
41
+ * };
42
+ * const command = new UntagResourceCommand(input);
43
+ * await client.send(command);
44
+ * // example id: untagresource-example-1590094024672
45
+ * ```
46
+ *
32
47
  */
33
48
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
34
49
  readonly input: UntagResourceCommandInput;
@@ -35,6 +35,19 @@ 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
+ * @example UpdateInstanceCustomHealthStatus Example
39
+ * ```javascript
40
+ * // This example submits a request to change the health status of an instance associated with a service with a custom health check to HEALTHY.
41
+ * const input = {
42
+ * "InstanceId": "i-abcd1234",
43
+ * "ServiceId": "srv-e4anhexample0004",
44
+ * "Status": "HEALTHY"
45
+ * };
46
+ * const command = new UpdateInstanceCustomHealthStatusCommand(input);
47
+ * await client.send(command);
48
+ * // example id: updateinstancecustomhealthstatus-example-1590118408574
49
+ * ```
50
+ *
38
51
  */
39
52
  export declare class UpdateInstanceCustomHealthStatusCommand extends $Command<UpdateInstanceCustomHealthStatusCommandInput, UpdateInstanceCustomHealthStatusCommandOutput, ServiceDiscoveryClientResolvedConfig> {
40
53
  readonly input: UpdateInstanceCustomHealthStatusCommandInput;
@@ -55,6 +55,37 @@ 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
+ * @example UpdateService Example
59
+ * ```javascript
60
+ * // This example submits a request to replace the DnsConfig and HealthCheckConfig settings of a specified service.
61
+ * const input = {
62
+ * "Id": "srv-e4anhexample0004",
63
+ * "Service": {
64
+ * "DnsConfig": {
65
+ * "DnsRecords": [
66
+ * {
67
+ * "TTL": 60,
68
+ * "Type": "A"
69
+ * }
70
+ * ]
71
+ * },
72
+ * "HealthCheckConfig": {
73
+ * "FailureThreshold": 2,
74
+ * "ResourcePath": "/",
75
+ * "Type": "HTTP"
76
+ * }
77
+ * }
78
+ * };
79
+ * const command = new UpdateServiceCommand(input);
80
+ * const response = await client.send(command);
81
+ * /* response ==
82
+ * {
83
+ * "OperationId": "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5"
84
+ * }
85
+ * *\/
86
+ * // example id: updateservice-example-1590117830880
87
+ * ```
88
+ *
58
89
  */
59
90
  export declare class UpdateServiceCommand extends $Command<UpdateServiceCommandInput, UpdateServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
60
91
  readonly input: UpdateServiceCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-servicediscovery",
3
3
  "description": "AWS SDK for JavaScript Servicediscovery Client for Node.js, Browser and React Native",
4
- "version": "3.288.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
55
  "tslib": "^2.3.1",
56
56
  "uuid": "^8.3.2"