openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 60.4 kB

JSON

{"openapi":"3.0.0","info":{"version":"2017-03-14","x-release":"v4","title":"AWS Cloud Map","description":"AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records. ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"servicediscovery","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/servicediscovery-2017-03-14.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/servicediscovery/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"CreateHttpNamespace","description":"Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a <code>DiscoverInstances</code> request but can't be discovered using DNS. For the current limit on the number of namespaces that you can create using the same AWS account, see <a href=\"http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html\">AWS Cloud Map Limits</a> in the AWS Cloud Map Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHttpNamespaceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"NamespaceAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamespaceAlreadyExists"}}}},"482":{"description":"ResourceLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceeded"}}}},"483":{"description":"DuplicateRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequest"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHttpNamespaceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreatePrivateDnsNamespace":{"post":{"operationId":"CreatePrivateDnsNamespace","description":"Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for the service will be <code>backend.example.com</code>. For the current limit on the number of namespaces that you can create using the same AWS account, see <a href=\"http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html\">AWS Cloud Map Limits</a> in the AWS Cloud Map Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrivateDnsNamespaceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"NamespaceAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamespaceAlreadyExists"}}}},"482":{"description":"ResourceLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceeded"}}}},"483":{"description":"DuplicateRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequest"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrivateDnsNamespaceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreatePublicDnsNamespace":{"post":{"operationId":"CreatePublicDnsNamespace","description":"Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for the service will be <code>backend.example.com</code>. For the current limit on the number of namespaces that you can create using the same AWS account, see <a href=\"http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html\">AWS Cloud Map Limits</a> in the AWS Cloud Map Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePublicDnsNamespaceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"NamespaceAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamespaceAlreadyExists"}}}},"482":{"description":"ResourceLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceeded"}}}},"483":{"description":"DuplicateRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequest"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePublicDnsNamespaceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateService":{"post":{"operationId":"CreateService","description":"Creates a service, which defines the configuration for the following entities: <ul> <li> For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: <ul> <li> A </li> <li> AAAA </li> <li> A and AAAA </li> <li> SRV </li> <li> CNAME </li> </ul> </li> <li> Optionally, a health check </li> </ul> After you create the service, you can submit a <a>RegisterInstance</a> request, and AWS Cloud Map uses the values in the configuration to create the specified entities. For the current limit on the number of instances that you can register using the same namespace and using the same service, see <a href=\"http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html\">AWS Cloud Map Limits</a> in the AWS Cloud Map Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"ResourceLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceeded"}}}},"482":{"description":"NamespaceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamespaceNotFound"}}}},"483":{"description":"ServiceAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceAlreadyExists"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteNamespace":{"post":{"operationId":"DeleteNamespace","description":"Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNamespaceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"NamespaceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamespaceNotFound"}}}},"482":{"description":"ResourceInUse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInUse"}}}},"483":{"description":"DuplicateRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequest"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNamespaceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteService":{"post":{"operationId":"DeleteService","description":"Deletes a specified service. If the service still contains one or more registered instances, the request fails.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteServiceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}},"482":{"description":"ResourceInUse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInUse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteServiceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeregisterInstance":{"post":{"operationId":"DeregisterInstance","description":"Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeregisterInstanceResponse"}}}},"480":{"description":"DuplicateRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequest"}}}},"481":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"482":{"description":"InstanceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceNotFound"}}}},"483":{"description":"ResourceInUse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInUse"}}}},"484":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeregisterInstanceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DiscoverInstances":{"post":{"operationId":"DiscoverInstances","description":"Discovers registered instances for a specified namespace and service.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverInstancesResponse"}}}},"480":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}},"481":{"description":"NamespaceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamespaceNotFound"}}}},"482":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverInstancesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetInstance":{"post":{"operationId":"GetInstance","description":"Gets information about a specified instance.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceResponse"}}}},"480":{"description":"InstanceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceNotFound"}}}},"481":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"482":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetInstancesHealthStatus":{"post":{"operationId":"GetInstancesHealthStatus","description":"Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or <code>Unknown</code>) of one or more instances that are associated with a specified service. <note> There is a brief delay between when you register an instance and when the health status for the instance is available. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstancesHealthStatusResponse"}}}},"480":{"description":"InstanceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceNotFound"}}}},"481":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"482":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstancesHealthStatusRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetNamespace":{"post":{"operationId":"GetNamespace","description":"Gets information about a namespace.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNamespaceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"NamespaceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamespaceNotFound"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNamespaceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetOperation":{"post":{"operationId":"GetOperation","description":"Gets information about any operation that returns an operation ID in the response, such as a <code>CreateService</code> request. <note> To get a list of operations that match specified criteria, see <a>ListOperations</a>. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOperationResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"OperationNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationNotFound"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOperationRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetService":{"post":{"operationId":"GetService","description":"Gets the settings for a specified service.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListInstances":{"post":{"operationId":"ListInstances","description":"Lists summary information about the instances that you registered by using a specified service.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInstancesResponse"}}}},"480":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}},"481":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInstancesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListNamespaces":{"post":{"operationId":"ListNamespaces","description":"Lists summary information about the namespaces that were created by the current AWS account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNamespacesResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNamespacesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListOperations":{"post":{"operationId":"ListOperations","description":"Lists operations that match the criteria that you specify.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListServices":{"post":{"operationId":"ListServices","description":"Lists summary information for all the services that are associated with one or more specified namespaces.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListServicesResponse"}}}},"480":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListServicesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#RegisterInstance":{"post":{"operationId":"RegisterInstance","description":"Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a <code>RegisterInstance</code> request, the following occurs: <ul> <li> For each DNS record that you define in the service that is specified by <code>ServiceId</code>, a record is created or updated in the hosted zone that is associated with the corresponding namespace. </li> <li> If the service includes <code>HealthCheckConfig</code>, a health check is created based on the settings in the health check configuration. </li> <li> The health check, if any, is associated with each of the new or updated records. </li> </ul> <important> One <code>RegisterInstance</code> request must complete before you can submit another request and specify the same service ID and instance ID. </important> For more information, see <a>CreateService</a>. When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value: <ul> <li> If the health check is healthy: returns all the records </li> <li> If the health check is unhealthy: returns the applicable value for the last healthy instance </li> <li> If you didn't specify a health check configuration: returns all the records </li> </ul> For the current limit on the number of instances that you can register using the same namespace and using the same service, see <a href=\"http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html\">AWS Cloud Map Limits</a> in the AWS Cloud Map Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstanceResponse"}}}},"480":{"description":"DuplicateRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequest"}}}},"481":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"482":{"description":"ResourceInUse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInUse"}}}},"483":{"description":"ResourceLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceeded"}}}},"484":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstanceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#UpdateInstanceCustomHealthStatus":{"post":{"operationId":"UpdateInstanceCustomHealthStatus","description":"Submits a request to change the health status of a custom health check to healthy or unhealthy. You can use <code>UpdateInstanceCustomHealthStatus</code> to change the status only for custom health checks, which you define using <code>HealthCheckCustomConfig</code> when you create a service. You can't use it to change the status for Route 53 health checks, which you define using <code>HealthCheckConfig</code>. For more information, see <a>HealthCheckCustomConfig</a>.","responses":{"200":{"description":"Success"},"480":{"description":"InstanceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceNotFound"}}}},"481":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}},"482":{"description":"CustomHealthNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomHealthNotFound"}}}},"483":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInstanceCustomHealthStatusRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#UpdateService":{"post":{"operationId":"UpdateService","description":"Submits a request to perform the following operations: <ul> <li> Add or delete <code>DnsRecords</code> configurations </li> <li> Update the TTL setting for existing <code>DnsRecords</code> configurations </li> <li> Add, update, or delete <code>HealthCheckConfig</code> for a specified service </li> </ul> For public and private DNS namespaces, you must specify all <code>DnsRecords</code> configurations (and, optionally, <code>HealthCheckConfig</code>) that you want to appear in the updated service. Any current configurations that don't appear in an <code>UpdateService</code> request are deleted. When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceResponse"}}}},"480":{"description":"DuplicateRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequest"}}}},"481":{"description":"InvalidInput","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"482":{"description":"ServiceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceNotFound"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://servicediscovery.amazonaws.com/"},{"url":"http://servicediscovery.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreateHttpNamespaceResponse":{"type":"object","properties":{"OperationId":{"$ref":"#/components/schemas/OperationId"}}},"CreateHttpNamespaceRequest":{"type":"object","required":["Name"],"properties":{"Name":{"$ref":"#/components/schemas/NamespaceName"},"CreatorRequestId":{"$ref":"#/components/schemas/ResourceId"},"Description":{"$ref":"#/components/schemas/ResourceDescription"}}},"InvalidInput":{},"NamespaceAlreadyExists":{},"ResourceLimitExceeded":{},"DuplicateRequest":{},"CreatePrivateDnsNamespaceResponse":{"type":"object","properties":{"OperationId":{"$ref":"#/components/schemas/OperationId"}}},"CreatePrivateDnsNamespaceRequest":{"type":"object","required":["Name","Vpc"],"properties":{"Name":{"$ref":"#/components/schemas/NamespaceName"},"CreatorRequestId":{"$ref":"#/components/schemas/ResourceId"},"Description":{"$ref":"#/components/schemas/ResourceDescription"},"Vpc":{"$ref":"#/components/schemas/ResourceId"}}},"CreatePublicDnsNamespaceResponse":{"type":"object","properties":{"OperationId":{"$ref":"#/components/schemas/OperationId"}}},"CreatePublicDnsNamespaceRequest":{"type":"object","required":["Name"],"properties":{"Name":{"$ref":"#/components/schemas/NamespaceName"},"CreatorRequestId":{"$ref":"#/components/schemas/ResourceId"},"Description":{"$ref":"#/components/schemas/ResourceDescription"}}},"CreateServiceResponse":{"type":"object","properties":{"Service":{"$ref":"#/components/schemas/Service"}}},"CreateServiceRequest":{"type":"object","required":["Name"],"properties":{"Name":{"$ref":"#/components/schemas/ServiceName"},"NamespaceId":{"$ref":"#/components/schemas/ResourceId"},"CreatorRequestId":{"$ref":"#/components/schemas/ResourceId"},"Description":{"$ref":"#/components/schemas/ResourceDescription"},"DnsConfig":{"$ref":"#/components/schemas/DnsConfig"},"HealthCheckConfig":{"$ref":"#/components/schemas/HealthCheckConfig"},"HealthCheckCustomConfig":{"$ref":"#/components/schemas/HealthCheckCustomConfig"}}},"NamespaceNotFound":{},"ServiceAlreadyExists":{},"DeleteNamespaceResponse":{"type":"object","properties":{"OperationId":{"$ref":"#/components/schemas/OperationId"}}},"DeleteNamespaceRequest":{"type":"object","required":["Id"],"properties":{"Id":{"$ref":"#/components/schemas/ResourceId"}}},"ResourceInUse":{},"DeleteServiceResponse":{"type":"object","properties":{}},"DeleteServiceRequest":{"type":"object","required":["Id"],"properties":{"Id":{"$ref":"#/components/schemas/ResourceId"}}},"ServiceNotFound":{},"DeregisterInstanceResponse":{"type":"object","properties":{"OperationId":{"$ref":"#/components/schemas/OperationId"}}},"DeregisterInstanceRequest":{"type":"object","required":["ServiceId","InstanceId"],"properties":{"ServiceId":{"$ref":"#/components/schemas/ResourceId"},"InstanceId":{"$ref":"#/components/schemas/ResourceId"}}},"InstanceNotFound":{},"DiscoverInstancesResponse":{"type":"object","properties":{"Instances":{"$ref":"#/components/schemas/HttpInstanceSummaryList"}}},"DiscoverInstancesRequest":{"type":"object","required":["NamespaceName","ServiceName"],"properties":{"NamespaceName":{"$ref":"#/components/schemas/NamespaceName"},"ServiceName":{"$ref":"#/components/schemas/ServiceName"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"QueryParameters":{"$ref":"#/components/schemas/Attributes"},"HealthStatus":{"$ref":"#/components/schemas/HealthStatusFilter"}}},"GetInstanceResponse":{"type":"object","properties":{"Instance":{"$ref":"#/components/schemas/Instance"}}},"GetInstanceRequest":{"type":"object","required":["ServiceId","InstanceId"],"properties":{"ServiceId":{"$ref":"#/components/schemas/ResourceId"},"InstanceId":{"$ref":"#/components/schemas/ResourceId"}}},"GetInstancesHealthStatusResponse":{"type":"object","properties":{"Status":{"$ref":"#/components/schemas/InstanceHealthStatusMap"},"NextToken":{"$ref":"#/components/schemas/NextToken"}}},"GetInstancesHealthStatusRequest":{"type":"object","required":["ServiceId"],"properties":{"ServiceId":{"$ref":"#/components/schemas/ResourceId"},"Instances":{"$ref":"#/components/schemas/InstanceIdList"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"NextToken":{"$ref":"#/components/schemas/NextToken"}}},"GetNamespaceResponse":{"type":"object","properties":{"Namespace":{"$ref":"#/components/schemas/Namespace"}}},"GetNamespaceRequest":{"type":"object","required":["Id"],"properties":{"Id":{"$ref":"#/components/schemas/ResourceId"}}},"GetOperationResponse":{"type":"object","properties":{"Operation":{"$ref":"#/components/schemas/Operation"}}},"GetOperationRequest":{"type":"object","required":["OperationId"],"properties":{"OperationId":{"$ref":"#/components/schemas/ResourceId"}}},"OperationNotFound":{},"GetServiceResponse":{"type":"object","properties":{"Service":{"$ref":"#/components/schemas/Service"}}},"GetServiceRequest":{"type":"object","required":["Id"],"properties":{"Id":{"$ref":"#/components/schemas/ResourceId"}}},"ListInstancesResponse":{"type":"object","properties":{"Instances":{"$ref":"#/components/schemas/InstanceSummaryList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}}},"ListInstancesRequest":{"type":"object","required":["ServiceId"],"properties":{"ServiceId":{"$ref":"#/components/schemas/ResourceId"},"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"}}},"ListNamespacesResponse":{"type":"object","properties":{"Namespaces":{"$ref":"#/components/schemas/NamespaceSummariesList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}}},"ListNamespacesRequest":{"type":"object","properties":{"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"Filters":{"$ref":"#/components/schemas/NamespaceFilters"}}},"ListOperationsResponse":{"type":"object","properties":{"Operations":{"$ref":"#/components/schemas/OperationSummaryList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}}},"ListOperationsRequest":{"type":"object","properties":{"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"Filters":{"$ref":"#/components/schemas/OperationFilters"}}},"ListServicesResponse":{"type":"object","properties":{"Services":{"$ref":"#/components/schemas/ServiceSummariesList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}}},"ListServicesRequest":{"type":"object","properties":{"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"Filters":{"$ref":"#/components/schemas/ServiceFilters"}}},"RegisterInstanceResponse":{"type":"object","properties":{"OperationId":{"$ref":"#/components/schemas/OperationId"}}},"RegisterInstanceRequest":{"type":"object","required":["ServiceId","InstanceId","Attributes"],"properties":{"ServiceId":{"$ref":"#/components/schemas/ResourceId"},"InstanceId":{"$ref":"#/components/schemas/ResourceId"},"CreatorRequestId":{"$ref":"#/components/schemas/ResourceId"},"Attributes":{"$ref":"#/components/schemas/Attributes"}}},"UpdateInstanceCustomHealthStatusRequest":{"type":"object","required":["ServiceId","InstanceId","Status"],"properties":{"ServiceId":{"$ref":"#/components/schemas/ResourceId"},"InstanceId":{"$ref":"#/components/schemas/ResourceId"},"Status":{"$ref":"#/components/schemas/CustomHealthStatus"}}},"CustomHealthNotFound":{},"UpdateServiceResponse":{"type":"object","properties":{"OperationId":{"$ref":"#/components/schemas/OperationId"}}},"UpdateServiceRequest":{"type":"object","required":["Id","Service"],"properties":{"Id":{"$ref":"#/components/schemas/ResourceId"},"Service":{"$ref":"#/components/schemas/ServiceChange"}}},"Arn":{"type":"string","maxLength":255},"AttrKey":{"type":"string","maxLength":255},"AttrValue":{"type":"string","maxLength":1024},"Attributes":{"type":"array","items":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/AttrKey"},"value":{"$ref":"#/components/schemas/AttrValue"}}}},"Code":{"type":"string"},"NamespaceName":{"type":"string","maxLength":1024},"ResourceId":{"type":"string","maxLength":64},"ResourceDescription":{"type":"string","maxLength":1024},"OperationId":{"type":"string","maxLength":255},"ServiceName":{"type":"string","pattern":"((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^\\.$)"},"DnsConfig":{"type":"object","required":["DnsRecords"],"properties":{"NamespaceId":{"$ref":"#/components/schemas/ResourceId"},"RoutingPolicy":{"$ref":"#/components/schemas/RoutingPolicy"},"DnsRecords":{"$ref":"#/components/schemas/DnsRecordList"}},"description":"A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance."},"HealthCheckConfig":{"type":"object","required":["Type"],"properties":{"Type":{"$ref":"#/components/schemas/HealthCheckType"},"ResourcePath":{"$ref":"#/components/schemas/ResourcePath"},"FailureThreshold":{"$ref":"#/components/schemas/FailureThreshold"}},"description":" Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in <code>DnsConfig</code>. <important> If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both. </important> Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>. Note the following about configuring health checks. A and AAAA records If <code>DnsConfig</code> includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy. CNAME records You can't specify settings for <code>HealthCheckConfig</code> when the <code>DNSConfig</code> includes <code>CNAME</code> for the value of <code>Type</code>. If you do, the <code>CreateService</code> request will fail with an <code>InvalidInput</code> error. Request interval A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all. Health checking regions Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see <a href=\"http://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions\">Regions</a>. Alias records When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code> attribute, AWS Cloud Map creates a Route 53 alias record. Note the following: <ul> <li> Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records. When <code>EvaluateTargetHealth</code> is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth\">EvaluateTargetHealth</a>. </li> <li> If you include <code>HealthCheckConfig</code> and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check. </li> </ul> Charges for health checks Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>."},"HealthCheckCustomConfig":{"type":"object","properties":{"FailureThreshold":{"$ref":"#/components/schemas/FailureThreshold"}},"description":"A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances: <ul> <li> You can't use a health check that is defined by <code>HealthCheckConfig</code> because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.) </li> <li> You want to use a third-party health checker regardless of where your resources are. </li> </ul> <important> If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both. </important> To change the status of a custom health check, submit an <code>UpdateInstanceCustomHealthStatus</code> request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent <code>UpdateInstanceCustomHealthStatus</code> request. Here's how custom health checks work: <ol> <li> You create a service and specify a value for <code>FailureThreshold</code>. The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an <a>UpdateInstanceCustomHealthStatus</a> request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource. </li> <li> You register an instance. </li> <li> You configure a third-party health checker to monitor the resource that is associated with the new instance. <note> AWS Cloud Map doesn't check the health of the resource directly. </note> </li> <li> The third-party health-checker determines that the resource is unhealthy and notifies your application. </li> <li> Your application submits an <code>UpdateInstanceCustomHealthStatus</code> request. </li> <li> AWS Cloud Map waits for (<code>FailureThreshold</code> x 30) seconds. </li> <li> If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource. </li> </ol> Note the following about configuring custom health checks."},"Service":{"type":"object","proper