github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/servicediscovery/2017-03-14/examples-1.json (about) 1 { 2 "version": "1.0", 3 "examples": { 4 "CreateHttpNamespace": [ 5 { 6 "input": { 7 "CreatorRequestId": "example-creator-request-id-0001", 8 "Description": "Example.com AWS Cloud Map HTTP Namespace", 9 "Name": "example-http.com" 10 }, 11 "output": { 12 "OperationId": "httpvoqozuhfet5kzxoxg-a-response-example" 13 }, 14 "comments": { 15 "input": { 16 }, 17 "output": { 18 } 19 }, 20 "description": "This example creates an HTTP namespace.", 21 "id": "createhttpnamespace-example-1590114811304", 22 "title": "CreateHttpNamespace example" 23 } 24 ], 25 "CreatePrivateDnsNamespace": [ 26 { 27 "input": { 28 "CreatorRequestId": "eedd6892-50f3-41b2-8af9-611d6e1d1a8c", 29 "Name": "example.com", 30 "Vpc": "vpc-1c56417b" 31 }, 32 "output": { 33 "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" 34 }, 35 "comments": { 36 "input": { 37 }, 38 "output": { 39 } 40 }, 41 "description": "Example: Create private DNS namespace", 42 "id": "example-create-private-dns-namespace-1587058592930", 43 "title": "Example: Create private DNS namespace" 44 } 45 ], 46 "CreatePublicDnsNamespace": [ 47 { 48 "input": { 49 "CreatorRequestId": "example-creator-request-id-0003", 50 "Description": "Example.com AWS Cloud Map Public DNS Namespace", 51 "Name": "example-public-dns.com" 52 }, 53 "output": { 54 "OperationId": "dns2voqozuhfet5kzxoxg-a-response-example" 55 }, 56 "comments": { 57 "input": { 58 }, 59 "output": { 60 } 61 }, 62 "description": "This example creates a public namespace based on DNS.", 63 "id": "createpublicdnsnamespace-example-1590114940910", 64 "title": "CreatePublicDnsNamespace example" 65 } 66 ], 67 "CreateService": [ 68 { 69 "input": { 70 "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25", 71 "DnsConfig": { 72 "DnsRecords": [ 73 { 74 "TTL": 60, 75 "Type": "A" 76 } 77 ], 78 "NamespaceId": "ns-ylexjili4cdxy3xm", 79 "RoutingPolicy": "MULTIVALUE" 80 }, 81 "Name": "myservice", 82 "NamespaceId": "ns-ylexjili4cdxy3xm" 83 }, 84 "output": { 85 "Service": { 86 "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita", 87 "CreateDate": 1587081768.334, 88 "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25", 89 "DnsConfig": { 90 "DnsRecords": [ 91 { 92 "TTL": 60, 93 "Type": "A" 94 } 95 ], 96 "NamespaceId": "ns-ylexjili4cdxy3xm", 97 "RoutingPolicy": "MULTIVALUE" 98 }, 99 "Id": "srv-p5zdwlg5uvvzjita", 100 "Name": "myservice", 101 "NamespaceId": "ns-ylexjili4cdxy3xm" 102 } 103 }, 104 "comments": { 105 "input": { 106 }, 107 "output": { 108 } 109 }, 110 "description": "Example: Create service", 111 "id": "example-create-service-1587235913584", 112 "title": "Example: Create service" 113 } 114 ], 115 "DeleteNamespace": [ 116 { 117 "input": { 118 "Id": "ns-ylexjili4cdxy3xm" 119 }, 120 "output": { 121 "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk" 122 }, 123 "comments": { 124 "input": { 125 }, 126 "output": { 127 } 128 }, 129 "description": "Example: Delete namespace", 130 "id": "example-delete-namespace-1587416093508", 131 "title": "Example: Delete namespace" 132 } 133 ], 134 "DeleteService": [ 135 { 136 "input": { 137 "Id": "srv-p5zdwlg5uvvzjita" 138 }, 139 "output": { 140 }, 141 "comments": { 142 "input": { 143 }, 144 "output": { 145 } 146 }, 147 "description": "Example: Delete service", 148 "id": "example-delete-service-1587416462902", 149 "title": "Example: Delete service" 150 } 151 ], 152 "DeregisterInstance": [ 153 { 154 "input": { 155 "InstanceId": "myservice-53", 156 "ServiceId": "srv-p5zdwlg5uvvzjita" 157 }, 158 "output": { 159 "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq" 160 }, 161 "comments": { 162 "input": { 163 }, 164 "output": { 165 } 166 }, 167 "description": "Example: Deregister a service instance", 168 "id": "example-deregister-a-service-instance-1587416305738", 169 "title": "Example: Deregister a service instance" 170 } 171 ], 172 "DiscoverInstances": [ 173 { 174 "input": { 175 "HealthStatus": "ALL", 176 "MaxResults": 10, 177 "NamespaceName": "example.com", 178 "ServiceName": "myservice" 179 }, 180 "output": { 181 "Instances": [ 182 { 183 "Attributes": { 184 "AWS_INSTANCE_IPV4": "172.2.1.3", 185 "AWS_INSTANCE_PORT": "808" 186 }, 187 "HealthStatus": "UNKNOWN", 188 "InstanceId": "myservice-53", 189 "NamespaceName": "example.com", 190 "ServiceName": "myservice" 191 } 192 ] 193 }, 194 "comments": { 195 "input": { 196 }, 197 "output": { 198 } 199 }, 200 "description": "Example: Discover registered instances", 201 "id": "example-discover-registered-instances-1587236343568", 202 "title": "Example: Discover registered instances" 203 } 204 ], 205 "GetInstance": [ 206 { 207 "input": { 208 "InstanceId": "i-abcd1234", 209 "ServiceId": "srv-e4anhexample0004" 210 }, 211 "output": { 212 "Instance": { 213 "Attributes": { 214 "AWS_INSTANCE_IPV4": "192.0.2.44", 215 "AWS_INSTANCE_PORT": "80", 216 "color": "green", 217 "region": "us-west-2", 218 "stage": "beta" 219 }, 220 "Id": "i-abcd1234" 221 } 222 }, 223 "comments": { 224 "input": { 225 }, 226 "output": { 227 } 228 }, 229 "description": "This example gets information about a specified instance.", 230 "id": "getinstance-example-1590115065598", 231 "title": "GetInstance example" 232 } 233 ], 234 "GetInstancesHealthStatus": [ 235 { 236 "input": { 237 "ServiceId": "srv-e4anhexample0004" 238 }, 239 "output": { 240 "Status": { 241 "i-abcd1234": "HEALTHY", 242 "i-abcd1235": "UNHEALTHY" 243 } 244 }, 245 "comments": { 246 "input": { 247 }, 248 "output": { 249 } 250 }, 251 "description": "This example gets the current health status of one or more instances that are associate with a specified service.", 252 "id": "getinstanceshealthstatus-example-1590115176146", 253 "title": "GetInstancesHealthStatus example" 254 } 255 ], 256 "GetNamespace": [ 257 { 258 "input": { 259 "Id": "ns-e4anhexample0004" 260 }, 261 "output": { 262 "Namespace": { 263 "Arn": "arn:aws:servicediscovery:us-west-2: 123456789120:namespace/ns-e1tpmexample0001", 264 "CreateDate": "20181118T211712Z", 265 "CreatorRequestId": "example-creator-request-id-0001", 266 "Description": "Example.com AWS Cloud Map HTTP Namespace", 267 "Id": "ns-e1tpmexample0001", 268 "Name": "example-http.com", 269 "Properties": { 270 "DnsProperties": { 271 }, 272 "HttpProperties": { 273 "HttpName": "example-http.com" 274 } 275 }, 276 "Type": "HTTP" 277 } 278 }, 279 "comments": { 280 "input": { 281 }, 282 "output": { 283 } 284 }, 285 "description": "This example gets information about a specified namespace.", 286 "id": "getnamespace-example-1590115383708", 287 "title": "GetNamespace example" 288 } 289 ], 290 "GetOperation": [ 291 { 292 "input": { 293 "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" 294 }, 295 "output": { 296 "Operation": { 297 "CreateDate": 1587055860.121, 298 "Id": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd", 299 "Status": "SUCCESS", 300 "Targets": { 301 "NAMESPACE": "ns-ylexjili4cdxy3xm" 302 }, 303 "Type": "CREATE_NAMESPACE", 304 "UpdateDate": 1587055900.469 305 } 306 }, 307 "comments": { 308 "input": { 309 }, 310 "output": { 311 } 312 }, 313 "description": "Example: Get operation result", 314 "id": "example-get-operation-result-1587073807124", 315 "title": "Example: Get operation result" 316 } 317 ], 318 "GetService": [ 319 { 320 "input": { 321 "Id": "srv-e4anhexample0004" 322 }, 323 "output": { 324 "Service": { 325 "Arn": "arn:aws:servicediscovery:us-west-2:123456789120:service/srv-e4anhexample0004", 326 "CreateDate": "20181118T211707Z", 327 "CreatorRequestId": "example-creator-request-id-0004", 328 "Description": "Example.com AWS Cloud Map HTTP Service", 329 "HealthCheckConfig": { 330 "FailureThreshold": 3, 331 "ResourcePath": "/", 332 "Type": "HTTPS" 333 }, 334 "Id": "srv-e4anhexample0004", 335 "Name": "example-http-service", 336 "NamespaceId": "ns-e4anhexample0004" 337 } 338 }, 339 "comments": { 340 "input": { 341 }, 342 "output": { 343 } 344 }, 345 "description": "This example gets the settings for a specified service.", 346 "id": "getservice-example-1590117234294", 347 "title": "GetService Example" 348 } 349 ], 350 "ListInstances": [ 351 { 352 "input": { 353 "ServiceId": "srv-qzpwvt2tfqcegapy" 354 }, 355 "output": { 356 "Instances": [ 357 { 358 "Attributes": { 359 "AWS_INSTANCE_IPV4": "172.2.1.3", 360 "AWS_INSTANCE_PORT": "808" 361 }, 362 "Id": "i-06bdabbae60f65a4e" 363 } 364 ] 365 }, 366 "comments": { 367 "input": { 368 }, 369 "output": { 370 } 371 }, 372 "description": "Example: List service instances", 373 "id": "example-list-service-instances-1587236237008", 374 "title": "Example: List service instances" 375 } 376 ], 377 "ListNamespaces": [ 378 { 379 "input": { 380 }, 381 "output": { 382 "Namespaces": [ 383 { 384 "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile", 385 "CreateDate": 1585354387.357, 386 "Id": "ns-a3ccy2e7e3a7rile", 387 "Name": "local", 388 "Properties": { 389 "DnsProperties": { 390 "HostedZoneId": "Z06752353VBUDTC32S84S" 391 }, 392 "HttpProperties": { 393 "HttpName": "local" 394 } 395 }, 396 "Type": "DNS_PRIVATE" 397 }, 398 { 399 "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx", 400 "CreateDate": 1586468974.698, 401 "Description": "My second namespace", 402 "Id": "ns-pocfyjtrsmwtvcxx", 403 "Name": "My-second-namespace", 404 "Properties": { 405 "DnsProperties": { 406 }, 407 "HttpProperties": { 408 "HttpName": "My-second-namespace" 409 } 410 }, 411 "Type": "HTTP" 412 }, 413 { 414 "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm", 415 "CreateDate": 1587055896.798, 416 "Id": "ns-ylexjili4cdxy3xm", 417 "Name": "example.com", 418 "Properties": { 419 "DnsProperties": { 420 "HostedZoneId": "Z09983722P0QME1B3KC8I" 421 }, 422 "HttpProperties": { 423 "HttpName": "example.com" 424 } 425 }, 426 "Type": "DNS_PRIVATE" 427 } 428 ] 429 }, 430 "comments": { 431 "input": { 432 }, 433 "output": { 434 } 435 }, 436 "description": "Example: List namespaces", 437 "id": "example-list-namespaces-1587401553154", 438 "title": "Example: List namespaces" 439 } 440 ], 441 "ListOperations": [ 442 { 443 "input": { 444 "Filters": [ 445 { 446 "Condition": "IN", 447 "Name": "STATUS", 448 "Values": [ 449 "PENDING", 450 "SUCCESS" 451 ] 452 } 453 ] 454 }, 455 "output": { 456 "Operations": [ 457 { 458 "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample", 459 "Status": "SUCCESS" 460 }, 461 { 462 "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample", 463 "Status": "SUCCESS" 464 }, 465 { 466 "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example", 467 "Status": "PENDING" 468 } 469 ] 470 }, 471 "comments": { 472 "input": { 473 }, 474 "output": { 475 } 476 }, 477 "description": "This example gets the operations that have a STATUS of either PENDING or SUCCESS.", 478 "id": "listoperations-example-1590117354396", 479 "title": "ListOperations Example" 480 } 481 ], 482 "ListServices": [ 483 { 484 "input": { 485 }, 486 "output": { 487 "Services": [ 488 { 489 "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita", 490 "CreateDate": 1587081768.334, 491 "DnsConfig": { 492 "DnsRecords": [ 493 { 494 "TTL": 60, 495 "Type": "A" 496 } 497 ], 498 "RoutingPolicy": "MULTIVALUE" 499 }, 500 "Id": "srv-p5zdwlg5uvvzjita", 501 "Name": "myservice" 502 } 503 ] 504 }, 505 "comments": { 506 "input": { 507 }, 508 "output": { 509 } 510 }, 511 "description": "Example: List services", 512 "id": "example-list-services-1587236889840", 513 "title": "Example: List services" 514 } 515 ], 516 "ListTagsForResource": [ 517 { 518 "input": { 519 "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm" 520 }, 521 "output": { 522 "Tags": [ 523 { 524 "Key": "Project", 525 "Value": "Zeta" 526 }, 527 { 528 "Key": "Department", 529 "Value": "Engineering" 530 } 531 ] 532 }, 533 "comments": { 534 "input": { 535 }, 536 "output": { 537 } 538 }, 539 "description": "This example lists the tags of a resource.", 540 "id": "listtagsforresource-example-1590093928416", 541 "title": "ListTagsForResource example" 542 } 543 ], 544 "RegisterInstance": [ 545 { 546 "input": { 547 "Attributes": { 548 "AWS_INSTANCE_IPV4": "172.2.1.3", 549 "AWS_INSTANCE_PORT": "808" 550 }, 551 "CreatorRequestId": "7a48a98a-72e6-4849-bfa7-1a458e030d7b", 552 "InstanceId": "myservice-53", 553 "ServiceId": "srv-p5zdwlg5uvvzjita" 554 }, 555 "output": { 556 "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7" 557 }, 558 "comments": { 559 "input": { 560 }, 561 "output": { 562 } 563 }, 564 "description": "Example: Register Instance", 565 "id": "example-register-instance-1587236116314", 566 "title": "Example: Register Instance" 567 } 568 ], 569 "TagResource": [ 570 { 571 "input": { 572 "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm", 573 "Tags": [ 574 { 575 "Key": "Department", 576 "Value": "Engineering" 577 }, 578 { 579 "Key": "Project", 580 "Value": "Zeta" 581 } 582 ] 583 }, 584 "output": { 585 }, 586 "comments": { 587 "input": { 588 }, 589 "output": { 590 } 591 }, 592 "description": "This example adds \"Department\" and \"Project\" tags to a resource.", 593 "id": "tagresource-example-1590093532240", 594 "title": "TagResource example" 595 } 596 ], 597 "UntagResource": [ 598 { 599 "input": { 600 "ResourceARN": "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm", 601 "TagKeys": [ 602 "Project", 603 "Department" 604 ] 605 }, 606 "output": { 607 }, 608 "comments": { 609 "input": { 610 }, 611 "output": { 612 } 613 }, 614 "description": "This example removes the \"Department\" and \"Project\" tags from a resource.", 615 "id": "untagresource-example-1590094024672", 616 "title": "UntagResource example" 617 } 618 ], 619 "UpdateInstanceCustomHealthStatus": [ 620 { 621 "input": { 622 "InstanceId": "i-abcd1234", 623 "ServiceId": "srv-e4anhexample0004", 624 "Status": "HEALTHY" 625 }, 626 "comments": { 627 "input": { 628 }, 629 "output": { 630 } 631 }, 632 "description": "This example submits a request to change the health status of an instance associated with a service with a custom health check to HEALTHY.", 633 "id": "updateinstancecustomhealthstatus-example-1590118408574", 634 "title": "UpdateInstanceCustomHealthStatus Example" 635 } 636 ], 637 "UpdateService": [ 638 { 639 "input": { 640 "Id": "srv-e4anhexample0004", 641 "Service": { 642 "DnsConfig": { 643 "DnsRecords": [ 644 { 645 "TTL": 60, 646 "Type": "A" 647 } 648 ] 649 }, 650 "HealthCheckConfig": { 651 "FailureThreshold": 2, 652 "ResourcePath": "/", 653 "Type": "HTTP" 654 } 655 } 656 }, 657 "output": { 658 "OperationId": "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5" 659 }, 660 "comments": { 661 "input": { 662 }, 663 "output": { 664 } 665 }, 666 "description": "This example submits a request to replace the DnsConfig and HealthCheckConfig settings of a specified service.", 667 "id": "updateservice-example-1590117830880", 668 "title": "UpdateService Example" 669 } 670 ] 671 } 672 }