Module Smaws_Client_ServiceDiscovery

ServiceDiscovery client library built on EIO.

Types

type update_service_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type record_type =
  1. | CNAME
  2. | AAAA
  3. | A
  4. | SRV
type dns_record = {
  1. tt_l : int;
    (*

    The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

    Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.

    *)
  2. type_ : record_type;
    (*

    The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:

    • A
    • AAAA
    • A and AAAA
    • SRV
    • CNAME

    If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

    You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.

    The following values are supported:

    A Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

    AAAA Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    CNAME Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

    • You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
    • You must specify WEIGHTED for the value of RoutingPolicy.
    • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

    SRV Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

    priority weight port service-hostname

    Note the following about the values:

    • The values of priority and weight are both set to 1 and can't be changed.
    • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

    • The value of service-hostname is a concatenation of the following values:

      • The value that you specify for InstanceId when you register an instance.
      • The name of the service.
      • The name of the namespace.

      For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:

      test.backend.example.com

    If you specify settings for an SRV record, note the following:

    • If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.
    • If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.
    *)
}

A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

type dns_config_change = {
  1. dns_records : dns_record list;
    (*

    An array that contains one DnsRecord object for each Route 53 record that you want Cloud Map to create when you register an instance.

    *)
}

A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates when you register an instance.

type health_check_type =
  1. | TCP
  2. | HTTPS
  3. | HTTP
type health_check_config = {
  1. failure_threshold : int option;
    (*

    The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

    *)
  2. resource_path : string option;
    (*

    The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

    If you specify TCP for Type, you must not specify a value for ResourcePath.

    *)
  3. type_ : health_check_type;
    (*

    The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

    You can't change the value of Type after you create a health check.

    You can create the following types of health checks:

    • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

    • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

      If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

    • TCP: Route 53 tries to establish a TCP connection.

      If you specify TCP for Type, don't specify a value for ResourcePath.

    For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

    *)
}

Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

Note the following about configuring health checks.

A and AAAA records If DnsConfig includes configurations for both A and AAAA records, Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint tthat's 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 HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

Request interval A Route 53 health checker in each health-checking Amazon Web Services 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. Therefore, you might sometimes see several requests in one second that's 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 Regions.

Alias records When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Cloud Map creates a Route 53 alias record. Note the following:

  • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced Amazon Web Services resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.
  • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

Charges for health checks Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

type service_change = {
  1. health_check_config : health_check_config option;
    (*

    Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

    *)
  2. dns_config : dns_config_change option;
    (*

    Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

    *)
  3. description : string option;
    (*

    A description for the service.

    *)
}

A complex type that contains changes to an existing service.

type update_service_request = {
  1. service : service_change;
    (*

    A complex type that contains the new settings for the service.

    *)
  2. id : string;
    (*

    The ID of the service that you want to update.

    *)
}
type service_not_found = {
  1. message : string option;
}

No service exists with the specified ID.

type invalid_input = {
  1. message : string option;
}

One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

type duplicate_request = {
  1. duplicate_operation_id : string option;
    (*

    The ID of the operation that's already in progress.

    *)
  2. message : string option;
}

The operation is already in progress.

type update_public_dns_namespace_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type soa_change = {
  1. tt_l : int;
    (*

    The updated time to live (TTL) for purposes of negative caching.

    *)
}

Updated Start of Authority (SOA) properties for a public or private DNS namespace.

type public_dns_properties_mutable_change = {
  1. so_a : soa_change;
    (*

    Updated fields for the Start of Authority (SOA) record for the hosted zone for the public DNS namespace.

    *)
}

Updated DNS properties for the public DNS namespace.

type public_dns_namespace_properties_change = {
  1. dns_properties : public_dns_properties_mutable_change;
    (*

    Updated DNS properties for the hosted zone for the public DNS namespace.

    *)
}

Updated properties for the public DNS namespace.

type public_dns_namespace_change = {
  1. properties : public_dns_namespace_properties_change option;
    (*

    Properties to be updated in the public DNS namespace.

    *)
  2. description : string option;
    (*

    An updated description for the public DNS namespace.

    *)
}

Updated properties for the public DNS namespace.

type update_public_dns_namespace_request = {
  1. namespace : public_dns_namespace_change;
    (*

    Updated properties for the public DNS namespace.

    *)
  2. updater_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed UpdatePublicDnsNamespace requests to be retried without the risk of running the operation twice. UpdaterRequestId can be any unique string (for example, a date/timestamp).

    *)
  3. id : string;
    (*

    The ID of the namespace being updated.

    *)
}
type resource_in_use = {
  1. message : string option;
}

The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.

type namespace_not_found = {
  1. message : string option;
}

No namespace exists with the specified ID.

type update_private_dns_namespace_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type private_dns_properties_mutable_change = {
  1. so_a : soa_change;
    (*

    Updated fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.

    *)
}

Updated DNS properties for the private DNS namespace.

type private_dns_namespace_properties_change = {
  1. dns_properties : private_dns_properties_mutable_change;
    (*

    Updated DNS properties for the private DNS namespace.

    *)
}

Updated properties for the private DNS namespace.

type private_dns_namespace_change = {
  1. properties : private_dns_namespace_properties_change option;
    (*

    Properties to be updated in the private DNS namespace.

    *)
  2. description : string option;
    (*

    An updated description for the private DNS namespace.

    *)
}

Updated properties for the private DNS namespace.

type update_private_dns_namespace_request = {
  1. namespace : private_dns_namespace_change;
    (*

    Updated properties for the private DNS namespace.

    *)
  2. updater_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed UpdatePrivateDnsNamespace requests to be retried without the risk of running the operation twice. UpdaterRequestId can be any unique string (for example, a date/timestamp).

    *)
  3. id : string;
    (*

    The ID of the namespace that you want to update.

    *)
}
type custom_health_status =
  1. | UNHEALTHY
  2. | HEALTHY
type update_instance_custom_health_status_request = {
  1. status : custom_health_status;
    (*

    The new status of the instance, HEALTHY or UNHEALTHY.

    *)
  2. instance_id : string;
    (*

    The ID of the instance that you want to change the health status for.

    *)
  3. service_id : string;
    (*

    The ID of the service that includes the configuration for the custom health check that you want to change the status for.

    *)
}
type instance_not_found = {
  1. message : string option;
}

No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

type custom_health_not_found = {
  1. message : string option;
}

The health check for the instance that's specified by ServiceId and InstanceId isn't a custom health check.

type update_http_namespace_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type http_namespace_change = {
  1. description : string;
    (*

    An updated description for the HTTP namespace.

    *)
}

Updated properties for the HTTP namespace.

type update_http_namespace_request = {
  1. namespace : http_namespace_change;
    (*

    Updated properties for the the HTTP namespace.

    *)
  2. updater_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed UpdateHttpNamespace requests to be retried without the risk of running the operation twice. UpdaterRequestId can be any unique string (for example, a date/timestamp).

    *)
  3. id : string;
    (*

    The ID of the namespace that you want to update.

    *)
}
type untag_resource_response = unit
type untag_resource_request = {
  1. tag_keys : string list;
    (*

    The tag keys to remove from the specified resource.

    *)
  2. resource_ar_n : string;
    (*

    The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.

    *)
}
type resource_not_found_exception = {
  1. message : string option;
}

The operation can't be completed because the resource was not found.

type too_many_tags_exception = {
  1. resource_name : string option;
    (*

    The name of the resource.

    *)
  2. message : string option;
}

The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.

type tag_resource_response = unit
type tag = {
  1. value : string;
    (*

    The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

    *)
  2. key : string;
    (*

    The key identifier, or name, of the tag.

    *)
}

A custom key-value pair that's associated with a resource.

type tag_resource_request = {
  1. tags : tag list;
    (*

    The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

    *)
  2. resource_ar_n : string;
    (*

    The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.

    *)
}
type service_type_option =
  1. | HTTP
type service_type =
  1. | DNS
  2. | DNS_HTTP
  3. | HTTP
type routing_policy =
  1. | WEIGHTED
  2. | MULTIVALUE
type dns_config = {
  1. dns_records : dns_record list;
    (*

    An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.

    *)
  2. routing_policy : routing_policy option;
    (*

    The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

    If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

    You can specify the following values:

    MULTIVALUE If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

    For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

    For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

    WEIGHTED Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

    For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

    For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

    *)
  3. namespace_id : string option;
    (*

    Use NamespaceId in Service instead.

    The ID of the namespace to use for DNS configuration.

    *)
}

A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create when you register an instance.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

type health_check_custom_config = {
  1. failure_threshold : int option;
    (*

    This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus request before changing the status of the service instance.

    The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.

    Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the first request to make the change.

    *)
}

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:

  • You can't use a health check that's defined by HealthCheckConfig 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.)
  • You want to use a third-party health checker regardless of where your resources are located.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.

Here's how custom health checks work:

  1. You create a service.
  2. You register an instance.

  3. You configure a third-party health checker to monitor the resource that's associated with the new instance.

    Cloud Map doesn't check the health of the resource directly.

  4. The third-party health-checker determines that the resource is unhealthy and notifies your application.
  5. Your application submits an UpdateInstanceCustomHealthStatus request.
  6. Cloud Map waits for 30 seconds.
  7. If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, Cloud Map stops routing traffic to the resource.
type service_summary = {
  1. create_date : float option;
    (*

    The date and time that the service was created.

    *)
  2. health_check_custom_config : health_check_custom_config option;
    (*

    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:

    • You can't use a health check that's defined by HealthCheckConfig 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.)
    • You want to use a third-party health checker regardless of where your resources are located.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    *)
  3. health_check_config : health_check_config option;
    (*

    Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

    *)
  4. dns_config : dns_config option;
    (*

    Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

    *)
  5. instance_count : int option;
    (*

    The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

    *)
  6. description : string option;
    (*

    The description that you specify when you create the service.

    *)
  7. type_ : service_type option;
    (*

    Describes the systems that can be used to discover the service instances.

    DNS_HTTP The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

    HTTP The service instances can only be discovered using the DiscoverInstances API operation.

    DNS Reserved.

    *)
  8. name : string option;
    (*

    The name of the service.

    *)
  9. arn : string option;
    (*

    The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

    *)
  10. id : string option;
    (*

    The ID that Cloud Map assigned to the service when you created it.

    *)
}

A complex type that contains information about a specified service.

type service_filter_name =
  1. | NAMESPACE_ID
type filter_condition =
  1. | BEGINS_WITH
  2. | BETWEEN
  3. | IN
  4. | EQ
type service_filter = {
  1. condition : filter_condition option;
    (*

    The operator that you want to use to determine whether a service is returned by ListServices. Valid values for Condition include the following:

    • EQ: When you specify EQ, specify one namespace ID for Values. EQ is the default condition and can be omitted.
    *)
  2. values : string list;
    (*

    The values that are applicable to the value that you specify for Condition to filter the list of services.

    *)
  3. name : service_filter_name;
    (*

    Specify NAMESPACE_ID.

    *)
}

A complex type that lets you specify the namespaces that you want to list services for.

type service_already_exists = {
  1. service_id : string option;
    (*

    The ID of the existing service.

    *)
  2. creator_request_id : string option;
    (*

    The CreatorRequestId that was used to create the service.

    *)
  3. message : string option;
}

The service can't be created because a service with the same name already exists.

type service = {
  1. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

    *)
  2. create_date : float option;
    (*

    The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    *)
  3. health_check_custom_config : health_check_custom_config option;
    (*

    A complex type that contains information about an optional custom health check.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    *)
  4. health_check_config : health_check_config option;
    (*

    Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

    For information about the charges for health checks, see Amazon Route 53 Pricing.

    *)
  5. type_ : service_type option;
    (*

    Describes the systems that can be used to discover the service instances.

    DNS_HTTP The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

    HTTP The service instances can only be discovered using the DiscoverInstances API operation.

    DNS Reserved.

    *)
  6. dns_config : dns_config option;
    (*

    A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

    The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

    *)
  7. instance_count : int option;
    (*

    The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

    *)
  8. description : string option;
    (*

    The description of the service.

    *)
  9. namespace_id : string option;
    (*

    The ID of the namespace that was used to create the service.

    *)
  10. name : string option;
    (*

    The name of the service.

    *)
  11. arn : string option;
    (*

    The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

    *)
  12. id : string option;
    (*

    The ID that Cloud Map assigned to the service when you created it.

    *)
}

A complex type that contains information about the specified service.

type so_a = {
  1. tt_l : int;
    (*

    The time to live (TTL) for purposes of negative caching.

    *)
}

Start of Authority (SOA) properties for a public or private DNS namespace.

type resource_limit_exceeded = {
  1. message : string option;
}

The resource can't be created because you've reached the quota on the number of resources.

type register_instance_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type register_instance_request = {
  1. attributes : (string * string) list;
    (*

    A string map that contains the following information for the service that you specify in ServiceId:

    • The attributes that apply to the records that are defined in the service.
    • For each attribute, the applicable value.

    Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.

    The following are the supported attribute keys.

    AWS_ALIAS_DNS_NAME If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget in the Route 53 API Reference.

    Note the following:

    • The configuration for the service that's specified by ServiceId must include settings for an A record, an AAAA record, or both.
    • In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
    • If the service that's specified by ServiceId includes HealthCheckConfig settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias record.
    • Cloud Map currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.
    • If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
    • The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.

    AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be specified is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4 address.

    AWS_INIT_HEALTH_STATUS If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

    AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries (for example, example.com).

    This value is required if the service specified by ServiceId includes settings for an CNAME record.

    AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries (for example, 192.0.2.44).

    This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

    This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_PORT If the service includes an SRV record, the value that you want Route 53 to return for the port.

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.

    This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.

    Custom attributes You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters.

    *)
  2. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string (for example, a date/time stamp).

    *)
  3. instance_id : string;
    (*

    An identifier that you want to associate with the instance. Note the following:

    • If the service that's specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord > Type.
    • You can use this value to update an existing instance.
    • To register a new instance, you must specify a value that's unique among instances that you register by using the same service.

    • If you specify an existing InstanceId and ServiceId, Cloud Map updates the existing DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health check and creates a new one.

      The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.

    Do not include sensitive information in InstanceId if the namespace is discoverable by public DNS queries and any Type member of DnsRecord for the service contains SRV because the InstanceId is discoverable by public DNS queries.

    *)
  4. service_id : string;
    (*

    The ID of the service that you want to use for settings for the instance.

    *)
}
type list_tags_for_resource_response = {
  1. tags : tag list option;
    (*

    The tags that are assigned to the resource.

    *)
}
type list_tags_for_resource_request = {
  1. resource_ar_n : string;
    (*

    The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.

    *)
}
type list_services_response = {
  1. next_token : string option;
    (*

    If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

    *)
  2. services : service_summary list option;
    (*

    An array that contains one ServiceSummary object for each service that matches the specified filter criteria.

    *)
}
type list_services_request = {
  1. filters : service_filter list option;
    (*

    A complex type that contains specifications for the namespaces that you want to list services for.

    If you specify more than one filter, an operation must match all filters to be returned by ListServices.

    *)
  2. max_results : int option;
    (*

    The maximum number of services that you want Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 services.

    *)
  3. next_token : string option;
    (*

    For the first ListServices request, omit this value.

    If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

    *)
}
type operation_status =
  1. | FAIL
  2. | SUCCESS
  3. | PENDING
  4. | SUBMITTED
type operation_summary = {
  1. status : operation_status option;
    (*

    The status of the operation. Values include the following:

    • SUBMITTED: This is the initial state immediately after you submit a request.
    • PENDING: Cloud Map is performing the operation.
    • SUCCESS: The operation succeeded.
    • FAIL: The operation failed. For the failure reason, see ErrorMessage.
    *)
  2. id : string option;
    (*

    The ID for an operation.

    *)
}

A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.

type list_operations_response = {
  1. next_token : string option;
    (*

    If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.

    *)
  2. operations : operation_summary list option;
    (*

    Summary information about the operations that match the specified criteria.

    *)
}
type operation_filter_name =
  1. | UPDATE_DATE
  2. | TYPE
  3. | STATUS
  4. | SERVICE_ID
  5. | NAMESPACE_ID
type operation_filter = {
  1. condition : filter_condition option;
    (*

    The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:

    • EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted.
    • IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. An operation must match one of the specified values to be returned in the response.
    • BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.
    *)
  2. values : string list;
    (*

    Specify values that are applicable to the value that you specify for Name:

    • NAMESPACE_ID: Specify one namespace ID.
    • SERVICE_ID: Specify one service ID.
    • STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or FAIL.
    • TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE.
    • UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
    *)
  3. name : operation_filter_name;
    (*

    Specify the operations that you want to get:

    • NAMESPACE_ID: Gets operations related to specified namespaces.
    • SERVICE_ID: Gets operations related to specified services.
    • STATUS: Gets operations based on the status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL.
    • TYPE: Gets specified types of operation.
    • UPDATE_DATE: Gets operations that changed status during a specified date/time range.
    *)
}

A complex type that lets you select the operations that you want to list.

type list_operations_request = {
  1. filters : operation_filter list option;
    (*

    A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.

    If you specify more than one filter, an operation must match all filters to be returned by ListOperations.

    *)
  2. max_results : int option;
    (*

    The maximum number of items that you want Cloud Map to return in the response to a ListOperations request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 operations.

    *)
  3. next_token : string option;
    (*

    For the first ListOperations request, omit this value.

    If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.

    *)
}
type namespace_type =
  1. | HTTP
  2. | DNS_PRIVATE
  3. | DNS_PUBLIC
type dns_properties = {
  1. so_a : so_a option;
    (*

    Start of Authority (SOA) record for the hosted zone.

    *)
  2. hosted_zone_id : string option;
    (*

    The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

    *)
}

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

type http_properties = {
  1. http_name : string option;
    (*

    The name of an HTTP namespace.

    *)
}

A complex type that contains the name of an HTTP namespace.

type namespace_properties = {
  1. http_properties : http_properties option;
    (*

    A complex type that contains the name of an HTTP namespace.

    *)
  2. dns_properties : dns_properties option;
    (*

    A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

    *)
}

A complex type that contains information that's specific to the namespace type.

type namespace_summary = {
  1. create_date : float option;
    (*

    The date and time that the namespace was created.

    *)
  2. properties : namespace_properties option;
    (*

    The properties of the namespace.

    *)
  3. service_count : int option;
    (*

    The number of services that were created using the namespace.

    *)
  4. description : string option;
    (*

    A description for the namespace.

    *)
  5. type_ : namespace_type option;
    (*

    The type of the namespace, either public or private.

    *)
  6. name : string option;
    (*

    The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.

    *)
  7. arn : string option;
    (*

    The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

    *)
  8. id : string option;
    (*

    The ID of the namespace.

    *)
}

A complex type that contains information about a namespace.

type list_namespaces_response = {
  1. next_token : string option;
    (*

    If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    *)
  2. namespaces : namespace_summary list option;
    (*

    An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

    *)
}
type namespace_filter_name =
  1. | HTTP_NAME
  2. | NAME
  3. | TYPE
type namespace_filter = {
  1. condition : filter_condition option;
    (*

    Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.

    • EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default condition and can be omitted.
    • BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.
    *)
  2. values : string list;
    (*

    Specify the values that are applicable to the value that you specify for Name.

    • TYPE: Specify HTTP, DNS_PUBLIC, or DNS_PRIVATE.
    • NAME: Specify the name of the namespace, which is found in Namespace.Name.
    • HTTP_NAME: Specify the HTTP name of the namespace, which is found in Namespace.Properties.HttpProperties.HttpName.
    *)
  3. name : namespace_filter_name;
    (*

    Specify the namespaces that you want to get using one of the following.

    • TYPE: Gets the namespaces of the specified type.
    • NAME: Gets the namespaces with the specified name.
    • HTTP_NAME: Gets the namespaces with the specified HTTP name.
    *)
}

A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

type list_namespaces_request = {
  1. filters : namespace_filter list option;
    (*

    A complex type that contains specifications for the namespaces that you want to list.

    If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces.

    *)
  2. max_results : int option;
    (*

    The maximum number of namespaces that you want Cloud Map to return in the response to a ListNamespaces request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 namespaces.

    *)
  3. next_token : string option;
    (*

    For the first ListNamespaces request, omit this value.

    If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    *)
}
type instance_summary = {
  1. attributes : (string * string) list option;
    (*

    A string map that contains the following information:

    • The attributes that are associated with the instance.
    • For each attribute, the applicable value.

    Supported attribute keys include the following:

    AWS_ALIAS_DNS_NAME For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.

    AWS_EC2_INSTANCE_ID (HTTP namespaces only) The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

    AWS_INIT_HEALTH_STATUS If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

    AWS_INSTANCE_CNAME For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example, example.com).

    AWS_INSTANCE_IPV4 For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example, 192.0.2.44).

    AWS_INSTANCE_IPV6 For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

    AWS_INSTANCE_PORT For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

    *)
  2. id : string option;
    (*

    The ID for an instance that you created by using a specified service.

    *)
}

A complex type that contains information about the instances that you registered by using a specified service.

type list_instances_response = {
  1. next_token : string option;
    (*

    If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    *)
  2. instances : instance_summary list option;
    (*

    Summary information about the instances that are associated with the specified service.

    *)
}
type list_instances_request = {
  1. max_results : int option;
    (*

    The maximum number of instances that you want Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

    *)
  2. next_token : string option;
    (*

    For the first ListInstances request, omit this value.

    If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    *)
  3. service_id : string;
    (*

    The ID of the service that you want to list instances for.

    *)
}
type get_service_response = {
  1. service : service option;
    (*

    A complex type that contains information about the service.

    *)
}
type get_service_request = {
  1. id : string;
    (*

    The ID of the service that you want to get settings for.

    *)
}
type operation_not_found = {
  1. message : string option;
}

No operation exists with the specified ID.

type operation_type =
  1. | DEREGISTER_INSTANCE
  2. | REGISTER_INSTANCE
  3. | UPDATE_SERVICE
  4. | UPDATE_NAMESPACE
  5. | DELETE_NAMESPACE
  6. | CREATE_NAMESPACE
type operation_target_type =
  1. | INSTANCE
  2. | SERVICE
  3. | NAMESPACE
type operation = {
  1. targets : (string * string) list option;
    (*

    The name of the target entity that's associated with the operation:

    NAMESPACE The namespace ID is returned in the ResourceId property.

    SERVICE The service ID is returned in the ResourceId property.

    INSTANCE The instance ID is returned in the ResourceId property.

    *)
  2. update_date : float option;
    (*

    The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    *)
  3. create_date : float option;
    (*

    The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    *)
  4. error_code : string option;
    (*

    The code associated with ErrorMessage. Values for ErrorCode include the following:

    • ACCESS_DENIED
    • CANNOT_CREATE_HOSTED_ZONE
    • EXPIRED_TOKEN
    • HOSTED_ZONE_NOT_FOUND
    • INTERNAL_FAILURE
    • INVALID_CHANGE_BATCH
    • THROTTLED_REQUEST
    *)
  5. error_message : string option;
    (*

    If the value of Status is FAIL, the reason that the operation failed.

    *)
  6. status : operation_status option;
    (*

    The status of the operation. Values include the following:

    SUBMITTED This is the initial state that occurs immediately after you submit a request.

    PENDING Cloud Map is performing the operation.

    SUCCESS The operation succeeded.

    FAIL The operation failed. For the failure reason, see ErrorMessage.

    *)
  7. type_ : operation_type option;
    (*

    The name of the operation that's associated with the specified ID.

    *)
  8. id : string option;
    (*

    The ID of the operation that you want to get information about.

    *)
}

A complex type that contains information about a specified operation.

type get_operation_response = {
  1. operation : operation option;
    (*

    A complex type that contains information about the operation.

    *)
}
type get_operation_request = {
  1. operation_id : string;
    (*

    The ID of the operation that you want to get more information about.

    *)
}
type namespace = {
  1. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.

    *)
  2. create_date : float option;
    (*

    The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    *)
  3. properties : namespace_properties option;
    (*

    A complex type that contains information that's specific to the type of the namespace.

    *)
  4. service_count : int option;
    (*

    The number of services that are associated with the namespace.

    *)
  5. description : string option;
    (*

    The description that you specify for the namespace when you create it.

    *)
  6. type_ : namespace_type option;
    (*

    The type of the namespace. The methods for discovering instances depends on the value that you specify:

    HTTP Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances API.

    DNS_PUBLIC Instances can be discovered using public DNS queries and using the DiscoverInstances API.

    DNS_PRIVATE Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.

    *)
  7. name : string option;
    (*

    The name of the namespace, such as example.com.

    *)
  8. arn : string option;
    (*

    The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

    *)
  9. id : string option;
    (*

    The ID of a namespace.

    *)
}

A complex type that contains information about a specified namespace.

type get_namespace_response = {
  1. namespace : namespace option;
    (*

    A complex type that contains information about the specified namespace.

    *)
}
type get_namespace_request = {
  1. id : string;
    (*

    The ID of the namespace that you want to get information about.

    *)
}
type health_status =
  1. | UNKNOWN
  2. | UNHEALTHY
  3. | HEALTHY
type get_instances_health_status_response = {
  1. next_token : string option;
    (*

    If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    *)
  2. status : (string * health_status) list option;
    (*

    A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

    *)
}
type get_instances_health_status_request = {
  1. next_token : string option;
    (*

    For the first GetInstancesHealthStatus request, omit this value.

    If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    *)
  2. max_results : int option;
    (*

    The maximum number of instances that you want Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

    *)
  3. instances : string list option;
    (*

    An array that contains the IDs of all the instances that you want to get the health status for.

    If you omit Instances, Cloud Map returns the health status for all the instances that are associated with the specified service.

    To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

    *)
  4. service_id : string;
    (*

    The ID of the service that the instance is associated with.

    *)
}
type instance = {
  1. attributes : (string * string) list option;
    (*

    A string map that contains the following information for the service that you specify in ServiceId:

    • The attributes that apply to the records that are defined in the service.
    • For each attribute, the applicable value.

    Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.

    Supported attribute keys include the following:

    AWS_ALIAS_DNS_NAME If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.

    Note the following:

    • The configuration for the service that's specified by ServiceId must include settings for an A record, an AAAA record, or both.
    • In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
    • If the service that's specified by ServiceId includes HealthCheckConfig settings, Cloud Map creates the health check, but it won't associate the health check with the alias record.
    • Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than ELB load balancers.
    • If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.

    AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance ID for the instance. The AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

    AWS_INIT_HEALTH_STATUS If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

    AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries (for example, example.com).

    This value is required if the service specified by ServiceId includes settings for an CNAME record.

    AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries (for example, 192.0.2.44).

    This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

    This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_PORT If the service includes an SRV record, the value that you want Route 53 to return for the port.

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.

    This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.

    *)
  2. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string (for example, a date/time stamp).

    *)
  3. id : string;
    (*

    An identifier that you want to associate with the instance. Note the following:

    • If the service that's specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord > Type.
    • You can use this value to update an existing instance.
    • To register a new instance, you must specify a value that's unique among instances that you register by using the same service.

    • If you specify an existing InstanceId and ServiceId, Cloud Map updates the existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and creates a new one.

      The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.

    *)
}

A complex type that contains information about an instance that Cloud Map creates when you submit a RegisterInstance request.

type get_instance_response = {
  1. instance : instance option;
    (*

    A complex type that contains information about a specified instance.

    *)
}
type get_instance_request = {
  1. instance_id : string;
    (*

    The ID of the instance that you want to get information about.

    *)
  2. service_id : string;
    (*

    The ID of the service that the instance is associated with.

    *)
}
type request_limit_exceeded = {
  1. message : string option;
}

The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.

type discover_instances_revision_response = {
  1. instances_revision : int option;
    (*

    The increasing revision associated to the response Instances list. If a new instance is registered or deregistered, the InstancesRevision updates. The health status updates don't update InstancesRevision.

    *)
}
type discover_instances_revision_request = {
  1. service_name : string;
    (*

    The name of the service that you specified when you registered the instance.

    *)
  2. namespace_name : string;
    (*

    The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

    *)
}
type http_instance_summary = {
  1. attributes : (string * string) list option;
    (*

    If you included any attributes when you registered the instance, the values of those attributes.

    *)
  2. health_status : health_status option;
    (*

    If you configured health checking in the service, the current health status of the service instance.

    *)
  3. service_name : string option;
    (*

    The name of the service that you specified when you registered the instance.

    *)
  4. namespace_name : string option;
    (*

    The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

    *)
  5. instance_id : string option;
    (*

    The ID of an instance that matches the values that you specified in the request.

    *)
}

In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.

type discover_instances_response = {
  1. instances_revision : int option;
    (*

    The increasing revision associated to the response Instances list. If a new instance is registered or deregistered, the InstancesRevision updates. The health status updates don't update InstancesRevision.

    *)
  2. instances : http_instance_summary list option;
    (*

    A complex type that contains one HttpInstanceSummary for each registered instance.

    *)
}
type health_status_filter =
  1. | HEALTHY_OR_ELSE_ALL
  2. | ALL
  3. | UNHEALTHY
  4. | HEALTHY
type discover_instances_request = {
  1. health_status : health_status_filter option;
    (*

    The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

    HEALTHY Returns healthy instances.

    UNHEALTHY Returns unhealthy instances.

    ALL Returns all instances.

    HEALTHY_OR_ELSE_ALL Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

    *)
  2. optional_parameters : (string * string) list option;
    (*

    Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

    *)
  3. query_parameters : (string * string) list option;
    (*

    Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

    *)
  4. max_results : int option;
    (*

    The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

    *)
  5. service_name : string;
    (*

    The name of the service that you specified when you registered the instance.

    *)
  6. namespace_name : string;
    (*

    The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace. In most cases, Name and HttpName match. However, if you reuse Name for namespace creation, a generated hash is added to HttpName to distinguish the two.

    *)
}
type deregister_instance_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type deregister_instance_request = {
  1. instance_id : string;
    (*

    The value that you specified for Id in the RegisterInstance request.

    *)
  2. service_id : string;
    (*

    The ID of the service that the instance is associated with.

    *)
}
type delete_service_response = unit
type delete_service_request = {
  1. id : string;
    (*

    The ID of the service that you want to delete.

    *)
}
type delete_namespace_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type delete_namespace_request = {
  1. id : string;
    (*

    The ID of the namespace that you want to delete.

    *)
}
type create_service_response = {
  1. service : service option;
    (*

    A complex type that contains information about the new service.

    *)
}
type create_service_request = {
  1. type_ : service_type_option option;
    (*

    If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

    *)
  2. tags : tag list option;
    (*

    The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

    *)
  3. health_check_custom_config : health_check_custom_config option;
    (*

    A complex type that contains information about an optional custom health check.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

    *)
  4. health_check_config : health_check_config option;
    (*

    Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    For information about the charges for health checks, see Cloud Map Pricing.

    *)
  5. dns_config : dns_config option;
    (*

    A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

    *)
  6. description : string option;
    (*

    A description for the service.

    *)
  7. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

    *)
  8. namespace_id : string option;
    (*

    The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.

    *)
  9. name : string;
    (*

    The name that you want to assign to the service.

    Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.

    If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

    • Start the name with an underscore (_), such as _exampleservice.
    • End the name with ._protocol, such as ._tcp.

    When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

    _exampleservice._tcp.example.com).

    For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

    *)
}
type namespace_already_exists = {
  1. namespace_id : string option;
    (*

    The ID of the existing namespace.

    *)
  2. creator_request_id : string option;
    (*

    The CreatorRequestId that was used to create the namespace.

    *)
  3. message : string option;
}

The namespace that you're trying to create already exists.

type create_public_dns_namespace_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type public_dns_properties_mutable = {
  1. so_a : so_a;
    (*

    Start of Authority (SOA) record for the hosted zone for the public DNS namespace.

    *)
}

DNS properties for the public DNS namespace.

type public_dns_namespace_properties = {
  1. dns_properties : public_dns_properties_mutable;
    (*

    DNS properties for the public DNS namespace.

    *)
}

DNS properties for the public DNS namespace.

type create_public_dns_namespace_request = {
  1. properties : public_dns_namespace_properties option;
    (*

    Properties for the public DNS namespace.

    *)
  2. tags : tag list option;
    (*

    The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

    *)
  3. description : string option;
    (*

    A description for the namespace.

    *)
  4. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

    *)
  5. name : string;
    (*

    The name that you want to assign to this namespace.

    Do not include sensitive information in the name. The name is publicly available using DNS queries.

    *)
}
type create_private_dns_namespace_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type private_dns_properties_mutable = {
  1. so_a : so_a;
    (*

    Fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.

    *)
}

DNS properties for the private DNS namespace.

type private_dns_namespace_properties = {
  1. dns_properties : private_dns_properties_mutable;
    (*

    DNS properties for the private DNS namespace.

    *)
}

DNS properties for the private DNS namespace.

type create_private_dns_namespace_request = {
  1. properties : private_dns_namespace_properties option;
    (*

    Properties for the private DNS namespace.

    *)
  2. tags : tag list option;
    (*

    The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

    *)
  3. vpc : string;
    (*

    The ID of the Amazon VPC that you want to associate the namespace with.

    *)
  4. description : string option;
    (*

    A description for the namespace.

    *)
  5. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

    *)
  6. name : string;
    (*

    The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

    *)
}
type create_http_namespace_response = {
  1. operation_id : string option;
    (*

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    *)
}
type create_http_namespace_request = {
  1. tags : tag list option;
    (*

    The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

    *)
  2. description : string option;
    (*

    A description for the namespace.

    *)
  3. creator_request_id : string option;
    (*

    A unique string that identifies the request and that allows failed CreateHttpNamespace requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/time stamp).

    *)
  4. name : string;
    (*

    The name that you want to assign to this namespace.

    *)
}

Cloud Map With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, 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.

type base_document = Smaws_Lib.Json.t

Builders

val make_update_service_response : ?operation_id:string -> unit -> update_service_response

Create a update_service_response type

val make_dns_record : tt_l:int -> type_:record_type -> unit -> dns_record

Create a dns_record type

val make_dns_config_change : dns_records:dns_record list -> unit -> dns_config_change

Create a dns_config_change type

val make_health_check_config : ?failure_threshold:int -> ?resource_path:string -> type_:health_check_type -> unit -> health_check_config

Create a health_check_config type

val make_service_change : ?health_check_config:health_check_config -> ?dns_config:dns_config_change -> ?description:string -> unit -> service_change

Create a service_change type

val make_update_service_request : service:service_change -> id:string -> unit -> update_service_request

Create a update_service_request type

val make_update_public_dns_namespace_response : ?operation_id:string -> unit -> update_public_dns_namespace_response

Create a update_public_dns_namespace_response type

val make_soa_change : tt_l:int -> unit -> soa_change

Create a soa_change type

val make_public_dns_properties_mutable_change : so_a:soa_change -> unit -> public_dns_properties_mutable_change

Create a public_dns_properties_mutable_change type

val make_public_dns_namespace_properties_change : dns_properties:public_dns_properties_mutable_change -> unit -> public_dns_namespace_properties_change

Create a public_dns_namespace_properties_change type

val make_public_dns_namespace_change : ?properties:public_dns_namespace_properties_change -> ?description:string -> unit -> public_dns_namespace_change

Create a public_dns_namespace_change type

val make_update_public_dns_namespace_request : ?updater_request_id:string -> namespace:public_dns_namespace_change -> id:string -> unit -> update_public_dns_namespace_request

Create a update_public_dns_namespace_request type

val make_update_private_dns_namespace_response : ?operation_id:string -> unit -> update_private_dns_namespace_response

Create a update_private_dns_namespace_response type

val make_private_dns_properties_mutable_change : so_a:soa_change -> unit -> private_dns_properties_mutable_change

Create a private_dns_properties_mutable_change type

val make_private_dns_namespace_properties_change : dns_properties:private_dns_properties_mutable_change -> unit -> private_dns_namespace_properties_change

Create a private_dns_namespace_properties_change type

val make_private_dns_namespace_change : ?properties:private_dns_namespace_properties_change -> ?description:string -> unit -> private_dns_namespace_change

Create a private_dns_namespace_change type

val make_update_private_dns_namespace_request : ?updater_request_id:string -> namespace:private_dns_namespace_change -> id:string -> unit -> update_private_dns_namespace_request

Create a update_private_dns_namespace_request type

val make_update_instance_custom_health_status_request : status:custom_health_status -> instance_id:string -> service_id:string -> unit -> update_instance_custom_health_status_request

Create a update_instance_custom_health_status_request type

val make_update_http_namespace_response : ?operation_id:string -> unit -> update_http_namespace_response

Create a update_http_namespace_response type

val make_http_namespace_change : description:string -> unit -> http_namespace_change

Create a http_namespace_change type

val make_update_http_namespace_request : ?updater_request_id:string -> namespace:http_namespace_change -> id:string -> unit -> update_http_namespace_request

Create a update_http_namespace_request type

val make_untag_resource_response : unit -> untag_resource_response

Create a untag_resource_response type

val make_untag_resource_request : tag_keys:string list -> resource_ar_n:string -> unit -> untag_resource_request

Create a untag_resource_request type

val make_tag_resource_response : unit -> tag_resource_response

Create a tag_resource_response type

val make_tag : value:string -> key:string -> unit -> tag

Create a tag type

val make_tag_resource_request : tags:tag list -> resource_ar_n:string -> unit -> tag_resource_request

Create a tag_resource_request type

val make_dns_config : ?routing_policy:routing_policy -> ?namespace_id:string -> dns_records:dns_record list -> unit -> dns_config

Create a dns_config type

val make_health_check_custom_config : ?failure_threshold:int -> unit -> health_check_custom_config

Create a health_check_custom_config type

val make_service_summary : ?create_date:float -> ?health_check_custom_config:health_check_custom_config -> ?health_check_config:health_check_config -> ?dns_config:dns_config -> ?instance_count:int -> ?description:string -> ?type_:service_type -> ?name:string -> ?arn:string -> ?id:string -> unit -> service_summary

Create a service_summary type

val make_service_filter : ?condition:filter_condition -> values:string list -> name:service_filter_name -> unit -> service_filter

Create a service_filter type

val make_service : ?creator_request_id:string -> ?create_date:float -> ?health_check_custom_config:health_check_custom_config -> ?health_check_config:health_check_config -> ?type_:service_type -> ?dns_config:dns_config -> ?instance_count:int -> ?description:string -> ?namespace_id:string -> ?name:string -> ?arn:string -> ?id:string -> unit -> service

Create a service type

val make_so_a : tt_l:int -> unit -> so_a

Create a so_a type

val make_register_instance_response : ?operation_id:string -> unit -> register_instance_response

Create a register_instance_response type

val make_register_instance_request : ?creator_request_id:string -> attributes:(string * string) list -> instance_id:string -> service_id:string -> unit -> register_instance_request

Create a register_instance_request type

val make_list_tags_for_resource_response : ?tags:tag list -> unit -> list_tags_for_resource_response

Create a list_tags_for_resource_response type

val make_list_tags_for_resource_request : resource_ar_n:string -> unit -> list_tags_for_resource_request

Create a list_tags_for_resource_request type

val make_list_services_response : ?next_token:string -> ?services:service_summary list -> unit -> list_services_response

Create a list_services_response type

val make_list_services_request : ?filters:service_filter list -> ?max_results:int -> ?next_token:string -> unit -> list_services_request

Create a list_services_request type

val make_operation_summary : ?status:operation_status -> ?id:string -> unit -> operation_summary

Create a operation_summary type

val make_list_operations_response : ?next_token:string -> ?operations:operation_summary list -> unit -> list_operations_response

Create a list_operations_response type

val make_operation_filter : ?condition:filter_condition -> values:string list -> name:operation_filter_name -> unit -> operation_filter

Create a operation_filter type

val make_list_operations_request : ?filters:operation_filter list -> ?max_results:int -> ?next_token:string -> unit -> list_operations_request

Create a list_operations_request type

val make_dns_properties : ?so_a:so_a -> ?hosted_zone_id:string -> unit -> dns_properties

Create a dns_properties type

val make_http_properties : ?http_name:string -> unit -> http_properties

Create a http_properties type

val make_namespace_properties : ?http_properties:http_properties -> ?dns_properties:dns_properties -> unit -> namespace_properties

Create a namespace_properties type

val make_namespace_summary : ?create_date:float -> ?properties:namespace_properties -> ?service_count:int -> ?description:string -> ?type_:namespace_type -> ?name:string -> ?arn:string -> ?id:string -> unit -> namespace_summary

Create a namespace_summary type

val make_list_namespaces_response : ?next_token:string -> ?namespaces:namespace_summary list -> unit -> list_namespaces_response

Create a list_namespaces_response type

val make_namespace_filter : ?condition:filter_condition -> values:string list -> name:namespace_filter_name -> unit -> namespace_filter

Create a namespace_filter type

val make_list_namespaces_request : ?filters:namespace_filter list -> ?max_results:int -> ?next_token:string -> unit -> list_namespaces_request

Create a list_namespaces_request type

val make_instance_summary : ?attributes:(string * string) list -> ?id:string -> unit -> instance_summary

Create a instance_summary type

val make_list_instances_response : ?next_token:string -> ?instances:instance_summary list -> unit -> list_instances_response

Create a list_instances_response type

val make_list_instances_request : ?max_results:int -> ?next_token:string -> service_id:string -> unit -> list_instances_request

Create a list_instances_request type

val make_get_service_response : ?service:service -> unit -> get_service_response

Create a get_service_response type

val make_get_service_request : id:string -> unit -> get_service_request

Create a get_service_request type

val make_operation : ?targets:(string * string) list -> ?update_date:float -> ?create_date:float -> ?error_code:string -> ?error_message:string -> ?status:operation_status -> ?type_:operation_type -> ?id:string -> unit -> operation

Create a operation type

val make_get_operation_response : ?operation:operation -> unit -> get_operation_response

Create a get_operation_response type

val make_get_operation_request : operation_id:string -> unit -> get_operation_request

Create a get_operation_request type

val make_namespace : ?creator_request_id:string -> ?create_date:float -> ?properties:namespace_properties -> ?service_count:int -> ?description:string -> ?type_:namespace_type -> ?name:string -> ?arn:string -> ?id:string -> unit -> namespace

Create a namespace type

val make_get_namespace_response : ?namespace:namespace -> unit -> get_namespace_response

Create a get_namespace_response type

val make_get_namespace_request : id:string -> unit -> get_namespace_request

Create a get_namespace_request type

val make_get_instances_health_status_response : ?next_token:string -> ?status:(string * health_status) list -> unit -> get_instances_health_status_response

Create a get_instances_health_status_response type

val make_get_instances_health_status_request : ?next_token:string -> ?max_results:int -> ?instances:string list -> service_id:string -> unit -> get_instances_health_status_request

Create a get_instances_health_status_request type

val make_instance : ?attributes:(string * string) list -> ?creator_request_id:string -> id:string -> unit -> instance

Create a instance type

val make_get_instance_response : ?instance:instance -> unit -> get_instance_response

Create a get_instance_response type

val make_get_instance_request : instance_id:string -> service_id:string -> unit -> get_instance_request

Create a get_instance_request type

val make_discover_instances_revision_response : ?instances_revision:int -> unit -> discover_instances_revision_response

Create a discover_instances_revision_response type

val make_discover_instances_revision_request : service_name:string -> namespace_name:string -> unit -> discover_instances_revision_request

Create a discover_instances_revision_request type

val make_http_instance_summary : ?attributes:(string * string) list -> ?health_status:health_status -> ?service_name:string -> ?namespace_name:string -> ?instance_id:string -> unit -> http_instance_summary

Create a http_instance_summary type

val make_discover_instances_response : ?instances_revision:int -> ?instances:http_instance_summary list -> unit -> discover_instances_response

Create a discover_instances_response type

val make_discover_instances_request : ?health_status:health_status_filter -> ?optional_parameters:(string * string) list -> ?query_parameters:(string * string) list -> ?max_results:int -> service_name:string -> namespace_name:string -> unit -> discover_instances_request

Create a discover_instances_request type

val make_deregister_instance_response : ?operation_id:string -> unit -> deregister_instance_response

Create a deregister_instance_response type

val make_deregister_instance_request : instance_id:string -> service_id:string -> unit -> deregister_instance_request

Create a deregister_instance_request type

val make_delete_service_response : unit -> delete_service_response

Create a delete_service_response type

val make_delete_service_request : id:string -> unit -> delete_service_request

Create a delete_service_request type

val make_delete_namespace_response : ?operation_id:string -> unit -> delete_namespace_response

Create a delete_namespace_response type

val make_delete_namespace_request : id:string -> unit -> delete_namespace_request

Create a delete_namespace_request type

val make_create_service_response : ?service:service -> unit -> create_service_response

Create a create_service_response type

val make_create_service_request : ?type_:service_type_option -> ?tags:tag list -> ?health_check_custom_config:health_check_custom_config -> ?health_check_config:health_check_config -> ?dns_config:dns_config -> ?description:string -> ?creator_request_id:string -> ?namespace_id:string -> name:string -> unit -> create_service_request

Create a create_service_request type

val make_create_public_dns_namespace_response : ?operation_id:string -> unit -> create_public_dns_namespace_response

Create a create_public_dns_namespace_response type

val make_public_dns_properties_mutable : so_a:so_a -> unit -> public_dns_properties_mutable

Create a public_dns_properties_mutable type

val make_public_dns_namespace_properties : dns_properties:public_dns_properties_mutable -> unit -> public_dns_namespace_properties

Create a public_dns_namespace_properties type

val make_create_public_dns_namespace_request : ?properties:public_dns_namespace_properties -> ?tags:tag list -> ?description:string -> ?creator_request_id:string -> name:string -> unit -> create_public_dns_namespace_request

Create a create_public_dns_namespace_request type

val make_create_private_dns_namespace_response : ?operation_id:string -> unit -> create_private_dns_namespace_response

Create a create_private_dns_namespace_response type

val make_private_dns_properties_mutable : so_a:so_a -> unit -> private_dns_properties_mutable

Create a private_dns_properties_mutable type

val make_private_dns_namespace_properties : dns_properties:private_dns_properties_mutable -> unit -> private_dns_namespace_properties

Create a private_dns_namespace_properties type

val make_create_private_dns_namespace_request : ?properties:private_dns_namespace_properties -> ?tags:tag list -> ?description:string -> ?creator_request_id:string -> vpc:string -> name:string -> unit -> create_private_dns_namespace_request

Create a create_private_dns_namespace_request type

val make_create_http_namespace_response : ?operation_id:string -> unit -> create_http_namespace_response

Create a create_http_namespace_response type

val make_create_http_namespace_request : ?tags:tag list -> ?description:string -> ?creator_request_id:string -> name:string -> unit -> create_http_namespace_request

Create a create_http_namespace_request type

Operations

module CreateHttpNamespace : sig ... end
module CreatePrivateDnsNamespace : sig ... end
module CreatePublicDnsNamespace : sig ... end
module CreateService : sig ... end
module DeleteNamespace : sig ... end
module DeleteService : sig ... end
module DeregisterInstance : sig ... end
module DiscoverInstances : sig ... end
module DiscoverInstancesRevision : sig ... end
module GetInstance : sig ... end
module GetInstancesHealthStatus : sig ... end
module GetNamespace : sig ... end
module GetOperation : sig ... end
module GetService : sig ... end
module ListInstances : sig ... end
module ListNamespaces : sig ... end
module ListOperations : sig ... end
module ListServices : sig ... end
module ListTagsForResource : sig ... end
module RegisterInstance : sig ... end
module TagResource : sig ... end
module UntagResource : sig ... end
module UpdateHttpNamespace : sig ... end
module UpdatePrivateDnsNamespace : sig ... end
module UpdatePublicDnsNamespace : sig ... end
module UpdateService : sig ... end