{ "version":"2.0", "metadata":{ "apiVersion":"2017-03-14", "endpointPrefix":"servicediscovery", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"ServiceDiscovery", "serviceFullName":"Amazon Route 53 Auto Naming", "serviceId":"ServiceDiscovery", "signatureVersion":"v4", "targetPrefix":"Route53AutoNaming_v20170314", "uid":"servicediscovery-2017-03-14" }, "operations":{ "CreatePrivateDnsNamespace":{ "name":"CreatePrivateDnsNamespace", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePrivateDnsNamespaceRequest"}, "output":{"shape":"CreatePrivateDnsNamespaceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NamespaceAlreadyExists"}, {"shape":"ResourceLimitExceeded"}, {"shape":"DuplicateRequest"} ], "documentation":"

Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. You can associate more than one service with the same namespace.

" }, "CreatePublicDnsNamespace":{ "name":"CreatePublicDnsNamespace", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePublicDnsNamespaceRequest"}, "output":{"shape":"CreatePublicDnsNamespaceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NamespaceAlreadyExists"}, {"shape":"ResourceLimitExceeded"}, {"shape":"DuplicateRequest"} ], "documentation":"

Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. You can associate more than one service with the same namespace.

" }, "CreateService":{ "name":"CreateService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateServiceRequest"}, "output":{"shape":"CreateServiceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"ResourceLimitExceeded"}, {"shape":"NamespaceNotFound"}, {"shape":"ServiceAlreadyExists"} ], "documentation":"

Creates a service, which defines the configuration for the following entities:

After you create the service, you can submit a RegisterInstance request, and Amazon Route 53 uses the values in the configuration to create the specified entities.

" }, "DeleteNamespace":{ "name":"DeleteNamespace", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNamespaceRequest"}, "output":{"shape":"DeleteNamespaceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NamespaceNotFound"}, {"shape":"ResourceInUse"}, {"shape":"DuplicateRequest"} ], "documentation":"

Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

" }, "DeleteService":{ "name":"DeleteService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServiceRequest"}, "output":{"shape":"DeleteServiceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"ServiceNotFound"}, {"shape":"ResourceInUse"} ], "documentation":"

Deletes a specified service. If the service still contains one or more registered instances, the request fails.

" }, "DeregisterInstance":{ "name":"DeregisterInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterInstanceRequest"}, "output":{"shape":"DeregisterInstanceResponse"}, "errors":[ {"shape":"DuplicateRequest"}, {"shape":"InvalidInput"}, {"shape":"InstanceNotFound"}, {"shape":"ResourceInUse"}, {"shape":"ServiceNotFound"} ], "documentation":"

Deletes the records and the health check, if any, that Amazon Route 53 created for the specified instance.

" }, "GetInstance":{ "name":"GetInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceRequest"}, "output":{"shape":"GetInstanceResponse"}, "errors":[ {"shape":"InstanceNotFound"}, {"shape":"InvalidInput"}, {"shape":"ServiceNotFound"} ], "documentation":"

Gets information about a specified instance.

" }, "GetInstancesHealthStatus":{ "name":"GetInstancesHealthStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstancesHealthStatusRequest"}, "output":{"shape":"GetInstancesHealthStatusResponse"}, "errors":[ {"shape":"InstanceNotFound"}, {"shape":"InvalidInput"}, {"shape":"ServiceNotFound"} ], "documentation":"

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

There is a brief delay between when you register an instance and when the health status for the instance is available.

" }, "GetNamespace":{ "name":"GetNamespace", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetNamespaceRequest"}, "output":{"shape":"GetNamespaceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NamespaceNotFound"} ], "documentation":"

Gets information about a namespace.

" }, "GetOperation":{ "name":"GetOperation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOperationRequest"}, "output":{"shape":"GetOperationResponse"}, "errors":[ {"shape":"OperationNotFound"} ], "documentation":"

Gets information about any operation that returns an operation ID in the response, such as a CreateService request.

To get a list of operations that match specified criteria, see ListOperations.

" }, "GetService":{ "name":"GetService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetServiceRequest"}, "output":{"shape":"GetServiceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"ServiceNotFound"} ], "documentation":"

Gets the settings for a specified service.

" }, "ListInstances":{ "name":"ListInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInstancesRequest"}, "output":{"shape":"ListInstancesResponse"}, "errors":[ {"shape":"ServiceNotFound"}, {"shape":"InvalidInput"} ], "documentation":"

Lists summary information about the instances that you registered by using a specified service.

" }, "ListNamespaces":{ "name":"ListNamespaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListNamespacesRequest"}, "output":{"shape":"ListNamespacesResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

Lists summary information about the namespaces that were created by the current AWS account.

" }, "ListOperations":{ "name":"ListOperations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOperationsRequest"}, "output":{"shape":"ListOperationsResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

Lists operations that match the criteria that you specify.

" }, "ListServices":{ "name":"ListServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServicesRequest"}, "output":{"shape":"ListServicesResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

Lists summary information for all the services that are associated with one or more specified namespaces.

" }, "RegisterInstance":{ "name":"RegisterInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterInstanceRequest"}, "output":{"shape":"RegisterInstanceResponse"}, "errors":[ {"shape":"DuplicateRequest"}, {"shape":"InvalidInput"}, {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"}, {"shape":"ServiceNotFound"} ], "documentation":"

Creates or updates one or more records and optionally a health check based on the settings in a specified service. When you submit a RegisterInstance request, Amazon Route 53 does the following:

One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

For more information, see CreateService.

When Route 53 receives a DNS query for the specified DNS name, it returns the applicable value:

" }, "UpdateService":{ "name":"UpdateService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServiceRequest"}, "output":{"shape":"UpdateServiceResponse"}, "errors":[ {"shape":"DuplicateRequest"}, {"shape":"InvalidInput"}, {"shape":"ServiceNotFound"} ], "documentation":"

Submits a request to perform the following operations:

You must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, Amazon Route 53 also updates the corresponding settings in all the records and health checks that were created by using the specified service.

" } }, "shapes":{ "Arn":{ "type":"string", "max":255 }, "AttrKey":{ "type":"string", "max":255 }, "AttrValue":{ "type":"string", "max":255 }, "Attributes":{ "type":"map", "key":{"shape":"AttrKey"}, "value":{"shape":"AttrValue"} }, "Code":{"type":"string"}, "CreatePrivateDnsNamespaceRequest":{ "type":"structure", "required":[ "Name", "Vpc" ], "members":{ "Name":{ "shape":"NamespaceName", "documentation":"

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

" }, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

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

", "idempotencyToken":true }, "Description":{ "shape":"ResourceDescription", "documentation":"

A description for the namespace.

" }, "Vpc":{ "shape":"ResourceId", "documentation":"

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

" } } }, "CreatePrivateDnsNamespaceResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

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

" } } }, "CreatePublicDnsNamespaceRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"NamespaceName", "documentation":"

The name that you want to assign to this namespace.

" }, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

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

", "idempotencyToken":true }, "Description":{ "shape":"ResourceDescription", "documentation":"

A description for the namespace.

" } } }, "CreatePublicDnsNamespaceResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

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

" } } }, "CreateServiceRequest":{ "type":"structure", "required":[ "Name", "DnsConfig" ], "members":{ "Name":{ "shape":"ServiceName", "documentation":"

The name that you want to assign to the service.

" }, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

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

", "idempotencyToken":true }, "Description":{ "shape":"ResourceDescription", "documentation":"

A description for the service.

" }, "DnsConfig":{ "shape":"DnsConfig", "documentation":"

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

" }, "HealthCheckConfig":{ "shape":"HealthCheckConfig", "documentation":"

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

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

" } } }, "CreateServiceResponse":{ "type":"structure", "members":{ "Service":{ "shape":"Service", "documentation":"

A complex type that contains information about the new service.

" } } }, "DeleteNamespaceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the namespace that you want to delete.

" } } }, "DeleteNamespaceResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

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

" } } }, "DeleteServiceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the service that you want to delete.

" } } }, "DeleteServiceResponse":{ "type":"structure", "members":{ } }, "DeregisterInstanceRequest":{ "type":"structure", "required":[ "ServiceId", "InstanceId" ], "members":{ "ServiceId":{ "shape":"ResourceId", "documentation":"

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

" }, "InstanceId":{ "shape":"ResourceId", "documentation":"

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

" } } }, "DeregisterInstanceResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

A value that you can use to determine whether the request completed successfully. For more information, see GetOperation.

" } } }, "DnsConfig":{ "type":"structure", "required":[ "NamespaceId", "DnsRecords" ], "members":{ "NamespaceId":{ "shape":"ResourceId", "documentation":"

The ID of the namespace to use for DNS configuration.

" }, "RoutingPolicy":{ "shape":"RoutingPolicy", "documentation":"

The routing policy that you want to apply to all records that Route 53 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 the service includes configurations for one A record and a health check, and 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 the service includes configurations for one A record and a health check, and 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.

" }, "DnsRecords":{ "shape":"DnsRecordList", "documentation":"

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

" } }, "documentation":"

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

" }, "DnsConfigChange":{ "type":"structure", "required":["DnsRecords"], "members":{ "DnsRecords":{ "shape":"DnsRecordList", "documentation":"

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

" } }, "documentation":"

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

" }, "DnsProperties":{ "type":"structure", "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

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

" } }, "documentation":"

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

" }, "DnsRecord":{ "type":"structure", "required":[ "Type", "TTL" ], "members":{ "Type":{ "shape":"RecordType", "documentation":"

The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

Note the following:

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:

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:

If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Route 53 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.

" }, "TTL":{ "shape":"RecordTTL", "documentation":"

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 AWS 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.

" } }, "documentation":"

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

" }, "DnsRecordList":{ "type":"list", "member":{"shape":"DnsRecord"} }, "DuplicateRequest":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The operation is already in progress.

", "exception":true }, "ErrorMessage":{"type":"string"}, "FailureThreshold":{ "type":"integer", "max":10, "min":1 }, "FilterCondition":{ "type":"string", "enum":[ "EQ", "IN", "BETWEEN" ] }, "FilterValue":{ "type":"string", "max":255, "min":1 }, "FilterValues":{ "type":"list", "member":{"shape":"FilterValue"} }, "GetInstanceRequest":{ "type":"structure", "required":[ "ServiceId", "InstanceId" ], "members":{ "ServiceId":{ "shape":"ResourceId", "documentation":"

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

" }, "InstanceId":{ "shape":"ResourceId", "documentation":"

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

" } } }, "GetInstanceResponse":{ "type":"structure", "members":{ "Instance":{ "shape":"Instance", "documentation":"

A complex type that contains information about a specified instance.

" } } }, "GetInstancesHealthStatusRequest":{ "type":"structure", "required":["ServiceId"], "members":{ "ServiceId":{ "shape":"ResourceId", "documentation":"

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

" }, "Instances":{ "shape":"InstanceIdList", "documentation":"

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

If you omit Instances, Amazon Route 53 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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "GetInstancesHealthStatusResponse":{ "type":"structure", "members":{ "Status":{ "shape":"InstanceHealthStatusMap", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "GetNamespaceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

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

" } } }, "GetNamespaceResponse":{ "type":"structure", "members":{ "Namespace":{ "shape":"Namespace", "documentation":"

A complex type that contains information about the specified namespace.

" } } }, "GetOperationRequest":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"ResourceId", "documentation":"

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

" } } }, "GetOperationResponse":{ "type":"structure", "members":{ "Operation":{ "shape":"Operation", "documentation":"

A complex type that contains information about the operation.

" } } }, "GetServiceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

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

" } } }, "GetServiceResponse":{ "type":"structure", "members":{ "Service":{ "shape":"Service", "documentation":"

A complex type that contains information about the service.

" } } }, "HealthCheckConfig":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"HealthCheckType", "documentation":"

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:

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

" }, "ResourcePath":{ "shape":"ResourcePath", "documentation":"

The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service and a leading forward slash (/) character.

" }, "FailureThreshold":{ "shape":"FailureThreshold", "documentation":"

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 vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

" } }, "documentation":"

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

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

CNAME records

You can't specify settings for 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

The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

Health checking regions

Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions.

Alias records

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

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

" }, "HealthCheckType":{ "type":"string", "enum":[ "HTTP", "HTTPS", "TCP" ] }, "HealthStatus":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY", "UNKNOWN" ] }, "Instance":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

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

" }, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

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.

" }, "Attributes":{ "shape":"Attributes", "documentation":"

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

Supported attribute keys include the following:

" } }, "documentation":"

A complex type that contains information about an instance that Amazon Route 53 creates when you submit a RegisterInstance request.

" }, "InstanceHealthStatusMap":{ "type":"map", "key":{"shape":"ResourceId"}, "value":{"shape":"HealthStatus"} }, "InstanceIdList":{ "type":"list", "member":{"shape":"ResourceId"}, "min":1 }, "InstanceNotFound":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "InstanceSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ResourceId", "documentation":"

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

" }, "Attributes":{ "shape":"Attributes", "documentation":"

A string map that contains the following information:

Supported attribute keys include the following:

" } }, "documentation":"

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

" }, "InstanceSummaryList":{ "type":"list", "member":{"shape":"InstanceSummary"} }, "InvalidInput":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

", "exception":true }, "ListInstancesRequest":{ "type":"structure", "required":["ServiceId"], "members":{ "ServiceId":{ "shape":"ResourceId", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" } } }, "ListInstancesResponse":{ "type":"structure", "members":{ "Instances":{ "shape":"InstanceSummaryList", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "ListNamespacesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

Route 53 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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "Filters":{ "shape":"NamespaceFilters", "documentation":"

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.

" } } }, "ListNamespacesResponse":{ "type":"structure", "members":{ "Namespaces":{ "shape":"NamespaceSummariesList", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

Route 53 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.

" } } }, "ListOperationsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

Route 53 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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "Filters":{ "shape":"OperationFilters", "documentation":"

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.

" } } }, "ListOperationsResponse":{ "type":"structure", "members":{ "Operations":{ "shape":"OperationSummaryList", "documentation":"

Summary information about the operations that match the specified criteria.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

Route 53 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.

" } } }, "ListServicesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

Route 53 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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "Filters":{ "shape":"ServiceFilters", "documentation":"

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.

" } } }, "ListServicesResponse":{ "type":"structure", "members":{ "Services":{ "shape":"ServiceSummariesList", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

Route 53 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.

" } } }, "MaxResults":{ "type":"integer", "max":100, "min":1 }, "Message":{"type":"string"}, "Namespace":{ "type":"structure", "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of a namespace.

" }, "Arn":{ "shape":"Arn", "documentation":"

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

" }, "Name":{ "shape":"NamespaceName", "documentation":"

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

" }, "Type":{ "shape":"NamespaceType", "documentation":"

The type of the namespace. Valid values are DNS_PUBLIC and DNS_PRIVATE.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

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

" }, "ServiceCount":{ "shape":"ResourceCount", "documentation":"

The number of services that are associated with the namespace.

" }, "Properties":{ "shape":"NamespaceProperties", "documentation":"

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

" }, "CreateDate":{ "shape":"Timestamp", "documentation":"

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.

" }, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

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

" } }, "documentation":"

A complex type that contains information about a specified namespace.

" }, "NamespaceAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

The CreatorRequestId that was used to create the namespace.

" }, "NamespaceId":{ "shape":"ResourceId", "documentation":"

The ID of the existing namespace.

" } }, "documentation":"

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

", "exception":true }, "NamespaceFilter":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"NamespaceFilterName", "documentation":"

Specify TYPE.

" }, "Values":{ "shape":"FilterValues", "documentation":"

If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE.

If you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE, or both.

" }, "Condition":{ "shape":"FilterCondition", "documentation":"

The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include:

" } }, "documentation":"

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

" }, "NamespaceFilterName":{ "type":"string", "enum":["TYPE"] }, "NamespaceFilters":{ "type":"list", "member":{"shape":"NamespaceFilter"} }, "NamespaceName":{ "type":"string", "max":1024 }, "NamespaceNotFound":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

No namespace exists with the specified ID.

", "exception":true }, "NamespaceProperties":{ "type":"structure", "members":{ "DnsProperties":{ "shape":"DnsProperties", "documentation":"

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

" } }, "documentation":"

A complex type that contains information that is specific to the namespace type.

" }, "NamespaceSummariesList":{ "type":"list", "member":{"shape":"NamespaceSummary"} }, "NamespaceSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the namespace.

" }, "Arn":{ "shape":"Arn", "documentation":"

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

" }, "Name":{ "shape":"NamespaceName", "documentation":"

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

" }, "Type":{ "shape":"NamespaceType", "documentation":"

The type of the namespace, either public or private.

" } }, "documentation":"

A complex type that contains information about a namespace.

" }, "NamespaceType":{ "type":"string", "enum":[ "DNS_PUBLIC", "DNS_PRIVATE" ] }, "NextToken":{ "type":"string", "max":4096 }, "Operation":{ "type":"structure", "members":{ "Id":{ "shape":"OperationId", "documentation":"

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

" }, "Type":{ "shape":"OperationType", "documentation":"

The name of the operation that is associated with the specified ID.

" }, "Status":{ "shape":"OperationStatus", "documentation":"

The status of the operation. Values include the following:

" }, "ErrorMessage":{ "shape":"Message", "documentation":"

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

" }, "ErrorCode":{ "shape":"Code", "documentation":"

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

" }, "CreateDate":{ "shape":"Timestamp", "documentation":"

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.

" }, "UpdateDate":{ "shape":"Timestamp", "documentation":"

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.

" }, "Targets":{ "shape":"OperationTargetsMap", "documentation":"

The name of the target entity that is associated with the operation:

" } }, "documentation":"

A complex type that contains information about a specified operation.

" }, "OperationFilter":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"OperationFilterName", "documentation":"

Specify the operations that you want to get:

" }, "Values":{ "shape":"FilterValues", "documentation":"

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

" }, "Condition":{ "shape":"FilterCondition", "documentation":"

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

" } }, "documentation":"

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

" }, "OperationFilterName":{ "type":"string", "enum":[ "NAMESPACE_ID", "SERVICE_ID", "STATUS", "TYPE", "UPDATE_DATE" ] }, "OperationFilters":{ "type":"list", "member":{"shape":"OperationFilter"} }, "OperationId":{ "type":"string", "max":255 }, "OperationNotFound":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

No operation exists with the specified ID.

", "exception":true }, "OperationStatus":{ "type":"string", "enum":[ "SUBMITTED", "PENDING", "SUCCESS", "FAIL" ] }, "OperationSummary":{ "type":"structure", "members":{ "Id":{ "shape":"OperationId", "documentation":"

The ID for an operation.

" }, "Status":{ "shape":"OperationStatus", "documentation":"

The status of the operation. Values include the following:

" } }, "documentation":"

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

" }, "OperationSummaryList":{ "type":"list", "member":{"shape":"OperationSummary"} }, "OperationTargetType":{ "type":"string", "enum":[ "NAMESPACE", "SERVICE", "INSTANCE" ] }, "OperationTargetsMap":{ "type":"map", "key":{"shape":"OperationTargetType"}, "value":{"shape":"ResourceId"} }, "OperationType":{ "type":"string", "enum":[ "CREATE_NAMESPACE", "DELETE_NAMESPACE", "UPDATE_SERVICE", "REGISTER_INSTANCE", "DEREGISTER_INSTANCE" ] }, "RecordTTL":{ "type":"long", "max":2147483647, "min":0 }, "RecordType":{ "type":"string", "enum":[ "SRV", "A", "AAAA", "CNAME" ] }, "RegisterInstanceRequest":{ "type":"structure", "required":[ "ServiceId", "InstanceId", "Attributes" ], "members":{ "ServiceId":{ "shape":"ResourceId", "documentation":"

The ID of the service that you want to use for settings for the records and health check that Route 53 will create.

" }, "InstanceId":{ "shape":"ResourceId", "documentation":"

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

" }, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

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.

", "idempotencyToken":true }, "Attributes":{ "shape":"Attributes", "documentation":"

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

Supported attribute keys include the following:

AWS_ALIAS_DNS_NAME

If you want Route 53 to create an alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see \"DNSName\" in the topic AliasTarget.

Note the following:

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. Either AWS_INSTANCE_IPV4 or AWS_INSTANCE_IPV6 is required if the service includes settings for an SRV record.

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. Either AWS_INSTANCE_IPV4 or AWS_INSTANCE_IPV6 is required if the service includes settings for an SRV record.

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 when you created the service.

" } } }, "RegisterInstanceResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

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

" } } }, "ResourceCount":{"type":"integer"}, "ResourceDescription":{ "type":"string", "max":1024 }, "ResourceId":{ "type":"string", "max":64 }, "ResourceInUse":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "ResourceLimitExceeded":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "ResourcePath":{ "type":"string", "max":255 }, "RoutingPolicy":{ "type":"string", "enum":[ "MULTIVALUE", "WEIGHTED" ] }, "Service":{ "type":"structure", "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID that Route 53 assigned to the service when you created it.

" }, "Arn":{ "shape":"Arn", "documentation":"

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

" }, "Name":{ "shape":"ServiceName", "documentation":"

The name of the service.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The description of the service.

" }, "InstanceCount":{ "shape":"ResourceCount", "documentation":"

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.

" }, "DnsConfig":{ "shape":"DnsConfig", "documentation":"

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

" }, "HealthCheckConfig":{ "shape":"HealthCheckConfig", "documentation":"

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

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

" }, "CreateDate":{ "shape":"Timestamp", "documentation":"

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.

" }, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

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

" } }, "documentation":"

A complex type that contains information about the specified service.

" }, "ServiceAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "CreatorRequestId":{ "shape":"ResourceId", "documentation":"

The CreatorRequestId that was used to create the service.

" }, "ServiceId":{ "shape":"ResourceId", "documentation":"

The ID of the existing service.

" } }, "documentation":"

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

", "exception":true }, "ServiceChange":{ "type":"structure", "required":["DnsConfig"], "members":{ "Description":{ "shape":"ResourceDescription", "documentation":"

A description for the service.

" }, "DnsConfig":{ "shape":"DnsConfigChange", "documentation":"

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

" }, "HealthCheckConfig":{"shape":"HealthCheckConfig"} }, "documentation":"

A complex type that contains changes to an existing service.

" }, "ServiceFilter":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"ServiceFilterName", "documentation":"

Specify NAMESPACE_ID.

" }, "Values":{ "shape":"FilterValues", "documentation":"

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

" }, "Condition":{ "shape":"FilterCondition", "documentation":"

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

" } }, "documentation":"

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

" }, "ServiceFilterName":{ "type":"string", "enum":["NAMESPACE_ID"] }, "ServiceFilters":{ "type":"list", "member":{"shape":"ServiceFilter"} }, "ServiceName":{ "type":"string", "pattern":"((?=^.{1,127}$)^([a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]|[a-zA-Z])(\\.([a-z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]|[a-zA-Z]))*$)|(^\\.$)" }, "ServiceNotFound":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

No service exists with the specified ID.

", "exception":true }, "ServiceSummariesList":{ "type":"list", "member":{"shape":"ServiceSummary"} }, "ServiceSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID that Route 53 assigned to the service when you created it.

" }, "Arn":{ "shape":"Arn", "documentation":"

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

" }, "Name":{ "shape":"ServiceName", "documentation":"

The name of the service.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The description that you specify when you create the service.

" }, "InstanceCount":{ "shape":"ResourceCount", "documentation":"

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.

" } }, "documentation":"

A complex type that contains information about a specified service.

" }, "Timestamp":{"type":"timestamp"}, "UpdateServiceRequest":{ "type":"structure", "required":[ "Id", "Service" ], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the service that you want to update.

" }, "Service":{ "shape":"ServiceChange", "documentation":"

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

" } } }, "UpdateServiceResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

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

" } } } }, "documentation":"

Amazon Route 53 auto naming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the auto naming API to register the instance, and Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries for the service receive an answer that contains up to eight healthy records.

" }