Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a\n DiscoverInstances request but can't be discovered using DNS.
For the current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map quotas in the\n AWS Cloud Map Developer Guide.
" } }, "com.amazonaws.servicediscovery#CreateHttpNamespaceRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.servicediscovery#NamespaceNameHttp", "traits": { "smithy.api#documentation": "The name that you want to assign to this namespace.
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "A unique string that identifies the request and that allows failed CreateHttpNamespace requests to\n be retried without the risk of running the operation twice. CreatorRequestId can be any unique string,\n for example, a date/time stamp.
A description for the namespace.
" } }, "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.
" } } } }, "com.amazonaws.servicediscovery#CreateHttpNamespaceResponse": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" } } } }, "com.amazonaws.servicediscovery#CreatePrivateDnsNamespace": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#CreatePrivateDnsNamespaceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#CreatePrivateDnsNamespaceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#DuplicateRequest" }, { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#NamespaceAlreadyExists" }, { "target": "com.amazonaws.servicediscovery#ResourceLimitExceeded" }, { "target": "com.amazonaws.servicediscovery#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace\n defines your service naming scheme. For example, if you name your namespace example.com and\n name your service backend, the resulting DNS name for the service is backend.example.com. For the current quota on the number of namespaces that you can create using the\n same AWS account, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.
The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string, for example, a date/timestamp.
A description for the namespace.
" } }, "Vpc": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the Amazon VPC that you want to associate the namespace with.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.
" } } } }, "com.amazonaws.servicediscovery#CreatePrivateDnsNamespaceResponse": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" } } } }, "com.amazonaws.servicediscovery#CreatePublicDnsNamespace": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#CreatePublicDnsNamespaceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#CreatePublicDnsNamespaceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#DuplicateRequest" }, { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#NamespaceAlreadyExists" }, { "target": "com.amazonaws.servicediscovery#ResourceLimitExceeded" }, { "target": "com.amazonaws.servicediscovery#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service\n naming scheme. For example, if you name your namespace example.com and name your service\n backend, the resulting DNS name for the service is backend.example.com. For the\n current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the\n AWS Cloud Map Developer Guide.
The name that you want to assign to this namespace.
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "A unique string that identifies the request and that allows failed CreatePublicDnsNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string, for example, a date/timestamp.
A description for the namespace.
" } }, "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.
" } } } }, "com.amazonaws.servicediscovery#CreatePublicDnsNamespaceResponse": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" } } } }, "com.amazonaws.servicediscovery#CreateService": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#CreateServiceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#CreateServiceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#NamespaceNotFound" }, { "target": "com.amazonaws.servicediscovery#ResourceLimitExceeded" }, { "target": "com.amazonaws.servicediscovery#ServiceAlreadyExists" }, { "target": "com.amazonaws.servicediscovery#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Creates a service, which defines the configuration for the following entities:
\nFor public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
\n\n A\n
\n AAAA\n
\n A and AAAA\n
\n SRV\n
\n CNAME\n
Optionally, a health check
\nAfter you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the\n values in the configuration to create the specified entities.
\nFor the current quota on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.
" } }, "com.amazonaws.servicediscovery#CreateServiceRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { "smithy.api#documentation": "The name that you want to assign to the service.
\nIf you want AWS Cloud Map to create an SRV record when you register an instance and you're using a\n 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, AWS Cloud Map creates an SRV record and assigns a name to the record by\n concatenating the service name and the namespace name, for example:
\n _exampleservice._tcp.example.com\n
For services that are accessible by DNS queries, you can't create multiple services with names that differ only\n by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished.\n However, if you use a namespace that's only accessible by API calls, then you can create services that with names\n that differ only by case.
\nThe ID of the namespace that you want to use to create the\n service. The namespace ID must be specified,\n but it can be specified either here or in the DnsConfig object.
A unique string that identifies the request and that allows failed CreateService requests to be\n retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for\n example, a date/timestamp.
A description for the service.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { "smithy.api#documentation": "A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you\n register an instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the\n Route 53 DNS records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.
For information about the charges for health checks, see AWS Cloud Map Pricing.
" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { "smithy.api#documentation": "A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.
You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing\n service.
The tags to add to the service. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceTypeOption", "traits": { "smithy.api#documentation": "If present, specifies that the service\n instances are only discoverable using the DiscoverInstances API operation. No DNS records will be\n registered for the service instances. The only valid value is HTTP.
A complex type that contains information about the new service.
" } } } }, "com.amazonaws.servicediscovery#CustomHealthNotFound": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The health check for the instance that's specified by ServiceId and InstanceId isn't a\n custom health check.
Deletes a namespace from the current account. If the namespace still contains one or more services, the request\n fails.
" } }, "com.amazonaws.servicediscovery#DeleteNamespaceRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the namespace that you want to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#DeleteNamespaceResponse": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" } } } }, "com.amazonaws.servicediscovery#DeleteService": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#DeleteServiceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#DeleteServiceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ResourceInUse" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Deletes a specified service. If the service still contains one or more registered instances, the request\n fails.
" } }, "com.amazonaws.servicediscovery#DeleteServiceRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that you want to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#DeleteServiceResponse": { "type": "structure", "members": {} }, "com.amazonaws.servicediscovery#DeregisterInstance": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#DeregisterInstanceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#DeregisterInstanceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#DuplicateRequest" }, { "target": "com.amazonaws.servicediscovery#InstanceNotFound" }, { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ResourceInUse" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified\n instance.
" } }, "com.amazonaws.servicediscovery#DeregisterInstanceRequest": { "type": "structure", "members": { "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that the instance is associated with.
", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The value that you specified for Id in the RegisterInstance request.
A value that you can use to determine whether the request completed successfully. For more information, see\n GetOperation.
" } } } }, "com.amazonaws.servicediscovery#DiscoverInstances": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#DiscoverInstancesRequest" }, "output": { "target": "com.amazonaws.servicediscovery#DiscoverInstancesResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#NamespaceNotFound" }, { "target": "com.amazonaws.servicediscovery#RequestLimitExceeded" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Discovers registered instances for a specified namespace and service. You can use DiscoverInstances\n to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries\n to discover instances.
The HttpName name of the namespace, found in the HttpProperties member of the\n Properties member of the namespace.
The name of the service that you specified when you registered the instance.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#DiscoverMaxResults", "traits": { "smithy.api#documentation": "The maximum number of instances that you want AWS Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 instances.
Filters to scope the results based on custom attributes for the instance. For example, {version=v1,\n az=1a}. Only instances that match all the specified key-value pairs are returned.
Opportunistic filters to scope the results based on custom attributes. If there are instances that match\n both the filters specified in both the QueryParameters parameter and this parameter, they are\n returned. Otherwise, these filters are ignored and only instances that match the filters specified in the\n QueryParameters parameter are returned.
The health status of the instances that you want to discover.
" } } } }, "com.amazonaws.servicediscovery#DiscoverInstancesResponse": { "type": "structure", "members": { "Instances": { "target": "com.amazonaws.servicediscovery#HttpInstanceSummaryList", "traits": { "smithy.api#documentation": "A complex type that contains one HttpInstanceSummary for each registered instance.
The ID of the namespace to use for DNS configuration.
" } }, "RoutingPolicy": { "target": "com.amazonaws.servicediscovery#RoutingPolicy", "traits": { "smithy.api#documentation": "The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an\n instance and specify this service.
\nIf you want to use this service to register instances that create alias records, specify WEIGHTED\n for the routing policy.
You can specify the following values:
\nIf you define a health check for the service and the health check is healthy, Route 53 returns the applicable\n value for up to eight instances.
\nFor example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight\n healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP\n 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\n the values for up to eight instances.
\nFor more information about the multivalue routing policy, see Multivalue Answer\n Routing in the Route 53 Developer Guide.
\nRoute 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or less\n traffic to any instances.
\nFor example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one\n randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS\n 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\n the applicable value for one randomly selected instance.
\nFor more information about the weighted routing policy, see Weighted Routing in the\n Route 53 Developer Guide.
\nAn array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to\n create when you register an instance.
A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when\n you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsConfigChange": { "type": "structure", "members": { "DnsRecords": { "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { "smithy.api#documentation": "An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to\n create when you register an instance.
A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you\n register an instance.
" } }, "com.amazonaws.servicediscovery#DnsProperties": { "type": "structure", "members": { "HostedZoneId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.
" } }, "com.amazonaws.servicediscovery#DnsRecord": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.servicediscovery#RecordType", "traits": { "smithy.api#documentation": "The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You\n can specify values for Type in the following combinations:
\n \n A\n \n
\n \n AAAA\n \n
\n \n A\n and \n AAAA\n \n
\n \n SRV\n \n
\n \n CNAME\n \n
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or\n AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when you\n register an instance. For more information, see RegisterInstance.
The following values are supported:
\nRoute 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
\nRoute 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.
\nRoute 53 returns the domain name of the resource, such as www.example.com. Note the following:
\nYou specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.
\nYou must specify WEIGHTED for the value of RoutingPolicy.
You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an InvalidInput\n error.
Route 53 returns the value for an SRV record. The value for an SRV record uses the\n following values:
\n priority weight port service-hostname\n
Note the following about the values:
\nThe values of priority and weight are both set to 1 and can't be\n changed.
The value of port comes from the value that you specify for the AWS_INSTANCE_PORT\n 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.
\nThe name of the namespace.
\nFor example, if the value of InstanceId is test, the name of the service is\n backend, and the name of the namespace is example.com, the value of\n service-hostname is the following:
\n test.backend.example.com\n
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\n RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA\n records that have the same name as the value of service-hostname in the SRV record.\n 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\n specify the correct name format.
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
\nAlias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes\n traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the\n TTL value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.
" } }, "com.amazonaws.servicediscovery#DnsRecordList": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#DnsRecord" } }, "com.amazonaws.servicediscovery#DuplicateRequest": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" }, "DuplicateOperationId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the operation that is already in progress.
" } } }, "traits": { "smithy.api#documentation": "The operation is already in progress.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.servicediscovery#ErrorMessage": { "type": "string" }, "com.amazonaws.servicediscovery#FailureThreshold": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.servicediscovery#FilterCondition": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EQ", "name": "EQ" }, { "value": "IN", "name": "IN" }, { "value": "BETWEEN", "name": "BETWEEN" } ] } }, "com.amazonaws.servicediscovery#FilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.servicediscovery#FilterValues": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#FilterValue", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.servicediscovery#GetInstance": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#GetInstanceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#GetInstanceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InstanceNotFound" }, { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Gets information about a specified instance.
" } }, "com.amazonaws.servicediscovery#GetInstanceRequest": { "type": "structure", "members": { "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that the instance is associated with.
", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the instance that you want to get information about.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#GetInstanceResponse": { "type": "structure", "members": { "Instance": { "target": "com.amazonaws.servicediscovery#Instance", "traits": { "smithy.api#documentation": "A complex type that contains information about a specified instance.
" } } } }, "com.amazonaws.servicediscovery#GetInstancesHealthStatus": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#GetInstancesHealthStatusRequest" }, "output": { "target": "com.amazonaws.servicediscovery#GetInstancesHealthStatusResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InstanceNotFound" }, { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Gets the current health status (Healthy, Unhealthy, or Unknown) of one or\n 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\n available.
\nThe ID of the service that the instance is associated with.
", "smithy.api#required": {} } }, "Instances": { "target": "com.amazonaws.servicediscovery#InstanceIdList", "traits": { "smithy.api#documentation": "An array that contains the IDs of all the instances that you want to get the health status for.
\nIf you omit Instances, AWS Cloud Map returns the health status for all the instances that are\n 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.
\nThe maximum number of instances that you want AWS Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map\n returns up to 100 instances.
For the first GetInstancesHealthStatus request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another\n GetInstancesHealthStatus request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
A complex type that contains the IDs and the health status of the instances that you specified in the\n GetInstancesHealthStatus request.
If more than MaxResults instances match the specified criteria, you can submit another\n GetInstancesHealthStatus request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
Gets information about a namespace.
" } }, "com.amazonaws.servicediscovery#GetNamespaceRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the namespace that you want to get information about.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#GetNamespaceResponse": { "type": "structure", "members": { "Namespace": { "target": "com.amazonaws.servicediscovery#Namespace", "traits": { "smithy.api#documentation": "A complex type that contains information about the specified namespace.
" } } } }, "com.amazonaws.servicediscovery#GetOperation": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#GetOperationRequest" }, "output": { "target": "com.amazonaws.servicediscovery#GetOperationResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#OperationNotFound" } ], "traits": { "smithy.api#documentation": "Gets information about any operation that returns an operation ID in the response, such as a\n CreateService request.
To get a list of operations that match specified criteria, see ListOperations.
\nThe ID of the operation that you want to get more information about.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#GetOperationResponse": { "type": "structure", "members": { "Operation": { "target": "com.amazonaws.servicediscovery#Operation", "traits": { "smithy.api#documentation": "A complex type that contains information about the operation.
" } } } }, "com.amazonaws.servicediscovery#GetService": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#GetServiceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#GetServiceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Gets the settings for a specified service.
" } }, "com.amazonaws.servicediscovery#GetServiceRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that you want to get settings for.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#GetServiceResponse": { "type": "structure", "members": { "Service": { "target": "com.amazonaws.servicediscovery#Service", "traits": { "smithy.api#documentation": "A complex type that contains information about the service.
" } } } }, "com.amazonaws.servicediscovery#HealthCheckConfig": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.servicediscovery#HealthCheckType", "traits": { "smithy.api#documentation": "The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is\n healthy.
\nYou can't change the value of Type after you create a health check.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits\n an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
\nIf you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.
\n TCP: Route 53 tries to establish a TCP connection.
\nIf you specify TCP for Type, don't specify a value for\n ResourcePath.
For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.
", "smithy.api#required": {} } }, "ResourcePath": { "target": "com.amazonaws.servicediscovery#ResourcePath", "traits": { "smithy.api#documentation": "The path that you want Route 53 to request when performing health checks. The path can be any value for which your\n endpoint returns an HTTP status code of a 2xx or 3xx format when the endpoint is healthy, such as the file\n /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't\n specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for\n ResourcePath.
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.
\nNote the following about configuring health checks.
\nIf DnsConfig includes configurations for both A and AAAA records,\n AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint\n that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA\n records to be unhealthy.
You can't specify settings for HealthCheckConfig when the DNSConfig includes\n CNAME for the value of Type. If you do, the CreateService request will\n fail with an InvalidInput error.
A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30\n seconds. On average, your endpoint receives a health check request about every two seconds. However, health\n checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few\n seconds with no health checks at all.
\nHealth checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see\n Regions.
\nWhen you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map\n creates a Route 53 alias record. Note the following:
Route 53 automatically sets EvaluateTargetHealth to true for alias records. When\n EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource.\n 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\n an alias record, Route 53 doesn't create the health check.
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.
\nThis parameter has been deprecated and is always set to 1. AWS Cloud Map waits for approximately 30 seconds after\n receiving an UpdateInstanceCustomHealthStatus request before changing the status of the service\n instance.
The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a service\n instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before\n 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits 30 seconds after the first\n request to make the change.
A complex type that contains information about an optional custom health check. A custom health check, which\n requires that you use a third-party health checker to evaluate the health of your resources, is useful in the\n following circumstances:
\nYou can't use a health check that is defined by HealthCheckConfig because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC.\n (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.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request.\n AWS Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent\n UpdateInstanceCustomHealthStatus request.
Here's how custom health checks work:
\nYou create a service and specify a value for FailureThreshold.
The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time\n that your application sends an UpdateInstanceCustomHealthStatus\n request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.
\nYou register an instance.
\nYou configure a third-party health checker to monitor the resource that is associated with the new instance.
\nAWS Cloud Map doesn't check the health of the resource directly.
\nThe third-party health-checker determines that the resource is unhealthy and notifies your application.
\nYour application submits an UpdateInstanceCustomHealthStatus request.
AWS Cloud Map waits for (FailureThreshold x 30) seconds.
If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the\n status back to healthy, AWS Cloud Map stops routing traffic to the resource.
The ID of an instance that matches the values that you specified in the request.
" } }, "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceNameHttp", "traits": { "smithy.api#documentation": "\n \n \n \n
The HttpName name of the namespace, found in the HttpProperties member of the\n Properties member of the namespace.
The name of the service that you specified when you registered the instance.
" } }, "HealthStatus": { "target": "com.amazonaws.servicediscovery#HealthStatus", "traits": { "smithy.api#documentation": "If you configured health checking in the service, the current health status of the service instance.
" } }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { "smithy.api#documentation": "If you included any attributes when you registered the instance, the values of those attributes.
" } } }, "traits": { "smithy.api#documentation": "In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance that\n matches the values that you specified in the request.
The name of an HTTP namespace.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains the name of an HTTP namespace.
" } }, "com.amazonaws.servicediscovery#Instance": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "An identifier that you want to associate with the instance. Note the following:
\nIf the service that is specified by ServiceId includes settings for an SRV record,\n the value of InstanceId is automatically included as part of the value for the SRV\n record. For more information, see DnsRecord > Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that is unique among instances that you register by using\n the same service.
\nIf you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing\n DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new\n one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.
A unique string that identifies the request and that allows failed RegisterInstance requests to be\n retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string\n every time you submit a RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.
A string map that contains the following information for the service that you specify in\n ServiceId:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nIf you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify\n the DNS name that is associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that is specified by ServiceId must include settings for an\n A record, an AAAA record, or both.
In the service that is specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.
If the service that is specified by ServiceId includes HealthCheckConfig\n settings, AWS Cloud Map creates the health check, but it won't associate the health check with the alias\n record.
Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than\n ELB load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries, for example, example.com.
This value is required if the service specified by ServiceId includes settings for an\n CNAME record.
If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n 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\n A record. If the service includes settings for an SRV record, you must specify a value\n for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n 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\n AAAA record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service includes an SRV record, the value that you want Route 53 to return for the\n port.
If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check when\n you created the service.
A complex type that contains information about an instance that AWS Cloud Map creates when you submit a\n RegisterInstance request.
No instance exists with the specified ID, or the instance was recently registered, and information about the\n instance hasn't propagated yet.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.servicediscovery#InstanceSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID for an instance that you created by using a specified service.
" } }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { "smithy.api#documentation": "A string map that contains the following information:
\nThe attributes that are associate with the instance.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nFor an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the\n load balancer.
\nThe Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,\n then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example,\n example.com.
For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example,\n 192.0.2.44.
For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.
For an SRV record, the value that Route 53 returns for the port. In addition, if the service\n includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
A complex type that contains information about the instances that you registered by using a specified\n service.
" } }, "com.amazonaws.servicediscovery#InstanceSummaryList": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#InstanceSummary", "traits": { "smithy.api#xmlName": "InstanceSummary" } } }, "com.amazonaws.servicediscovery#InvalidInput": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "One or more specified values aren't valid. For example, a required value might be missing, a numeric value might\n be outside the allowed range, or a string value might exceed length constraints.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.servicediscovery#ListInstances": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#ListInstancesRequest" }, "output": { "target": "com.amazonaws.servicediscovery#ListInstancesResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Lists summary information about the instances that you registered by using a specified service.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.servicediscovery#ListInstancesRequest": { "type": "structure", "members": { "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that you want to list instances for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { "smithy.api#documentation": "For the first ListInstances request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of NextToken\n from the previous response in the next request.
The maximum number of instances that you want AWS Cloud Map to return in the response to a\n ListInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 instances.
Summary information about the instances that are associated with the specified service.
" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { "smithy.api#documentation": "If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of NextToken\n from the previous response in the next request.
Lists summary information about the namespaces that were created by the current AWS account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.servicediscovery#ListNamespacesRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { "smithy.api#documentation": "For the first ListNamespaces request, omit this value.
If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.
AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
The maximum number of namespaces that you want AWS Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 namespaces.
A complex type that contains specifications for the namespaces that you want to list.
\nIf you specify more than one filter, a namespace must match all filters to be returned by\n ListNamespaces.
An array that contains one NamespaceSummary object for each namespace that matches the specified\n filter criteria.
If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.
AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
Lists operations that match the criteria that you specify.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.servicediscovery#ListOperationsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { "smithy.api#documentation": "For the first ListOperations request, omit this value.
If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.
AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.
The maximum number of items that you want AWS Cloud Map to return in the response to a ListOperations\n request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 operations.
A complex type that contains specifications for the operations that you want to list, for example, operations\n that you started between a specified start date and end date.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListOperations.
Summary information about the operations that match the specified criteria.
" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { "smithy.api#documentation": "If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.
AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.
Lists summary information for all the services that are associated with one or more specified namespaces.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.servicediscovery#ListServicesRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { "smithy.api#documentation": "For the first ListServices request, omit this value.
If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.
AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.
The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices\n request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.
A complex type that contains specifications for the namespaces that you want to list services for.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListServices.
An array that contains one ServiceSummary object for each service that matches the specified filter\n criteria.
If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.
AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.
Lists tags for the specified resource.
" } }, "com.amazonaws.servicediscovery#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.servicediscovery#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { "smithy.api#documentation": "The tags that are assigned to the resource.
" } } } }, "com.amazonaws.servicediscovery#MaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.servicediscovery#Message": { "type": "string" }, "com.amazonaws.servicediscovery#Namespace": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of a namespace.
" } }, "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
" } }, "Name": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace, such as example.com.
The type of the namespace. The methods for discovering instances depends on the value that you specify:
\nInstances can be discovered only programmatically, using the AWS Cloud Map DiscoverInstances\n API.
Instances can be discovered using public DNS queries and using the DiscoverInstances API.
Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances\n API.
The description that you specify for the namespace when you create it.
" } }, "ServiceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { "smithy.api#documentation": "The number of services that are associated with the namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#NamespaceProperties", "traits": { "smithy.api#documentation": "A complex type that contains information that's specific to the type of the namespace.
" } }, "CreateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { "smithy.api#documentation": "The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The\n value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried without the risk of\n running an operation twice.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about a specified namespace.
" } }, "com.amazonaws.servicediscovery#NamespaceAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The CreatorRequestId that was used to create the namespace.
The ID of the existing namespace.
" } } }, "traits": { "smithy.api#documentation": "The namespace that you're trying to create already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.servicediscovery#NamespaceFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.servicediscovery#NamespaceFilterName", "traits": { "smithy.api#documentation": "Specify TYPE.
If you specify EQ for Condition, specify either DNS_PUBLIC or\n DNS_PRIVATE.
If you specify IN for Condition, you can specify DNS_PUBLIC,\n DNS_PRIVATE, or both.
The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid\n values for condition include:
When you specify EQ for the condition, you can choose to list only public namespaces or private\n namespaces, but not both. EQ is the default condition and can be omitted.
When you specify IN for the condition, you can choose to list public namespaces, private\n namespaces, or both.
Not applicable
\nA complex type that identifies the namespaces that you want to list. You can choose to list public or private\n namespaces.
" } }, "com.amazonaws.servicediscovery#NamespaceFilterName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TYPE", "name": "TYPE" } ] } }, "com.amazonaws.servicediscovery#NamespaceFilters": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#NamespaceFilter", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.servicediscovery#NamespaceName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.servicediscovery#NamespaceNameHttp": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[!-~]{1,1024}$" } }, "com.amazonaws.servicediscovery#NamespaceNamePrivate": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[!-~]{1,1024}$" } }, "com.amazonaws.servicediscovery#NamespaceNamePublic": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$" } }, "com.amazonaws.servicediscovery#NamespaceNotFound": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "No namespace exists with the specified ID.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.servicediscovery#NamespaceProperties": { "type": "structure", "members": { "DnsProperties": { "target": "com.amazonaws.servicediscovery#DnsProperties", "traits": { "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.
" } }, "HttpProperties": { "target": "com.amazonaws.servicediscovery#HttpProperties", "traits": { "smithy.api#documentation": "A complex type that contains the name of an HTTP namespace.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains information that is specific to the namespace type.
" } }, "com.amazonaws.servicediscovery#NamespaceSummariesList": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#NamespaceSummary" } }, "com.amazonaws.servicediscovery#NamespaceSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the namespace.
" } }, "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
" } }, "Name": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone\n that has the same name as the namespace.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#NamespaceType", "traits": { "smithy.api#documentation": "The type of the namespace, either public or private.
" } }, "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { "smithy.api#documentation": "A description for the namespace.
" } }, "ServiceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { "smithy.api#documentation": "The number of services that were created using the namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#NamespaceProperties", "traits": { "smithy.api#documentation": "The properties of the namespace.
" } }, "CreateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the namespace was created.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about a namespace.
" } }, "com.amazonaws.servicediscovery#NamespaceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DNS_PUBLIC", "name": "DNS_PUBLIC" }, { "value": "DNS_PRIVATE", "name": "DNS_PRIVATE" }, { "value": "HTTP", "name": "HTTP" } ] } }, "com.amazonaws.servicediscovery#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 } } }, "com.amazonaws.servicediscovery#Operation": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "The ID of the operation that you want to get information about.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#OperationType", "traits": { "smithy.api#documentation": "The name of the operation that is associated with the specified ID.
" } }, "Status": { "target": "com.amazonaws.servicediscovery#OperationStatus", "traits": { "smithy.api#documentation": "The status of the operation. Values include the following:
\nThis is the initial state immediately after you submit a request.
\nAWS Cloud Map is performing the operation.
\nThe operation succeeded.
\nThe operation failed. For the failure reason, see ErrorMessage.
If the value of Status is FAIL, the reason that the operation failed.
The code associated with ErrorMessage. Values for ErrorCode include the\n following:
\n ACCESS_DENIED\n
\n CANNOT_CREATE_HOSTED_ZONE\n
\n EXPIRED_TOKEN\n
\n HOSTED_ZONE_NOT_FOUND\n
\n INTERNAL_FAILURE\n
\n INVALID_CHANGE_BATCH\n
\n THROTTLED_REQUEST\n
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).\n The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the value of Status changed to the current value, in Unix date/time format\n and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example,\n the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The name of the target entity that is associated with the operation:
\nThe namespace ID is returned in the ResourceId property.
The service ID is returned in the ResourceId property.
The instance ID is returned in the ResourceId property.
A complex type that contains information about a specified operation.
" } }, "com.amazonaws.servicediscovery#OperationFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.servicediscovery#OperationFilterName", "traits": { "smithy.api#documentation": "Specify the operations that you want to get:
\n\n NAMESPACE_ID: Gets operations related to specified namespaces.
\n\n SERVICE_ID: Gets operations related to specified services.
\n\n STATUS: Gets operations based on the status of the operations:\n SUBMITTED, PENDING, SUCCEED, or FAIL.
\n TYPE: Gets specified types of operation.
\n\n UPDATE_DATE: Gets operations that changed status during a specified date/time\n range.
\nSpecify values that are applicable to the value that you specify for Name:
\n NAMESPACE_ID: Specify one namespace ID.
\n\n SERVICE_ID: Specify one service ID.
\n\n STATUS: Specify one or more statuses: SUBMITTED,\n PENDING, SUCCEED, or FAIL.
\n TYPE: Specify one or more of the following types:\n CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE,\n REGISTER_INSTANCE, or DEREGISTER_INSTANCE.
\n UPDATE_DATE: Specify a start date and an end date in Unix date/time format\n and Coordinated Universal Time (UTC). The start date must be the first value.
\nThe operator that you want to use to determine whether an operation matches the specified value. Valid values\n for condition include:
\n\n EQ: When you specify EQ for the condition, you can specify only one value.\n EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and\n TYPE. EQ is the default condition and can be omitted.
\n IN: When you specify IN for the condition, you can specify a list of one or more\n values. IN is supported for STATUS and TYPE. An operation must match one of\n the specified values to be returned in the response.
\n BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal\n Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.\n
A complex type that lets you select the operations that you want to list.
" } }, "com.amazonaws.servicediscovery#OperationFilterName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NAMESPACE_ID", "name": "NAMESPACE_ID" }, { "value": "SERVICE_ID", "name": "SERVICE_ID" }, { "value": "STATUS", "name": "STATUS" }, { "value": "TYPE", "name": "TYPE" }, { "value": "UPDATE_DATE", "name": "UPDATE_DATE" } ] } }, "com.amazonaws.servicediscovery#OperationFilters": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#OperationFilter", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.servicediscovery#OperationId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.servicediscovery#OperationNotFound": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "No operation exists with the specified ID.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.servicediscovery#OperationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SUBMITTED", "name": "SUBMITTED" }, { "value": "PENDING", "name": "PENDING" }, { "value": "SUCCESS", "name": "SUCCESS" }, { "value": "FAIL", "name": "FAIL" } ] } }, "com.amazonaws.servicediscovery#OperationSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "The ID for an operation.
" } }, "Status": { "target": "com.amazonaws.servicediscovery#OperationStatus", "traits": { "smithy.api#documentation": "The status of the operation. Values include the following:
\n\n SUBMITTED: This is the initial state immediately after you submit a\n request.
\n\n PENDING: AWS Cloud Map is performing the operation.
\n\n SUCCESS: The operation succeeded.
\n\n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.
A complex type that contains information about an operation that matches the criteria that you specified in a\n ListOperations\n request.
" } }, "com.amazonaws.servicediscovery#OperationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#OperationSummary", "traits": { "smithy.api#xmlName": "OperationSummary" } } }, "com.amazonaws.servicediscovery#OperationTargetType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NAMESPACE", "name": "NAMESPACE" }, { "value": "SERVICE", "name": "SERVICE" }, { "value": "INSTANCE", "name": "INSTANCE" } ] } }, "com.amazonaws.servicediscovery#OperationTargetsMap": { "type": "map", "key": { "target": "com.amazonaws.servicediscovery#OperationTargetType" }, "value": { "target": "com.amazonaws.servicediscovery#ResourceId" } }, "com.amazonaws.servicediscovery#OperationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATE_NAMESPACE", "name": "CREATE_NAMESPACE" }, { "value": "DELETE_NAMESPACE", "name": "DELETE_NAMESPACE" }, { "value": "UPDATE_SERVICE", "name": "UPDATE_SERVICE" }, { "value": "REGISTER_INSTANCE", "name": "REGISTER_INSTANCE" }, { "value": "DEREGISTER_INSTANCE", "name": "DEREGISTER_INSTANCE" } ] } }, "com.amazonaws.servicediscovery#RecordTTL": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 2147483647 } } }, "com.amazonaws.servicediscovery#RecordType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SRV", "name": "SRV" }, { "value": "A", "name": "A" }, { "value": "AAAA", "name": "AAAA" }, { "value": "CNAME", "name": "CNAME" } ] } }, "com.amazonaws.servicediscovery#RegisterInstance": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#RegisterInstanceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#RegisterInstanceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#DuplicateRequest" }, { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ResourceInUse" }, { "target": "com.amazonaws.servicediscovery#ResourceLimitExceeded" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance request, the following occurs:
For each DNS record that you define in the service that is specified by ServiceId, a record is\n created or updated in the hosted zone that is associated with the corresponding namespace.
If the service includes HealthCheckConfig, a health check is created based on the settings in the\n health check configuration.
The health check, if any, is associated with each of the new or updated records.
\nOne RegisterInstance request must complete before you can submit another request and specify the\n same service ID and instance ID.
For more information, see CreateService.
\nWhen AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
\n\n If the health check is healthy: returns all the records
\n\n If the health check is unhealthy: returns the applicable value for the last\n healthy instance
\n\n If you didn't specify a health check configuration: returns all the\n records
\nFor the current quota on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.
" } }, "com.amazonaws.servicediscovery#RegisterInstanceRequest": { "type": "structure", "members": { "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that you want to use for settings for the instance.
", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.servicediscovery#InstanceId", "traits": { "smithy.api#documentation": "An identifier that you want to associate with the instance. Note the following:
\nIf the service that is specified by ServiceId includes settings for an SRV record,\n the value of InstanceId is automatically included as part of the value for the SRV\n record. For more information, see DnsRecord > Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that is unique among instances that you register by using\n the same service.
\nIf you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing\n DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates\n a new one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.
A unique string that identifies the request and that allows failed RegisterInstance requests to be\n retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string\n every time you submit a RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.
A string map that contains the following information for the service that you specify in\n ServiceId:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nIf you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see\n \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that is specified by ServiceId must include settings for an\n A record, an AAAA record, or both.
In the service that is specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.
If the service that is specified by ServiceId includes HealthCheckConfig\n settings, AWS Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the\n alias record.
Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than\n Elastic Load Balancing load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be specified is\n AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the\n AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries, for example, example.com.
This value is required if the service specified by ServiceId includes settings for an\n CNAME record.
If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n 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\n A record. If the service includes settings for an SRV record, you must specify a value\n for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n 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\n AAAA record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service includes an SRV record, the value that you want Route 53 to return for the\n port.
If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check when\n you created the service.
You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is\n 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided\n attributes (sum of all keys and values) must not exceed 5,000 characters.
\nA value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" } } } }, "com.amazonaws.servicediscovery#RequestLimitExceeded": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The operation can't be completed because you've reached the quota for the number of requests. For more\n information, see AWS Cloud Map API request throttling\n quota in the AWS Cloud Map Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.servicediscovery#ResourceCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.servicediscovery#ResourceDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.servicediscovery#ResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 } } }, "com.amazonaws.servicediscovery#ResourceInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The specified resource can't be deleted because it contains other resources. For example, you can't delete a\n service that contains any instances.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.servicediscovery#ResourceLimitExceeded": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The resource can't be created because you've reached the quota on the number of resources.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.servicediscovery#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The operation can't be completed because the resource was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.servicediscovery#ResourcePath": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.servicediscovery#Route53AutoNaming_v20170314": { "type": "service", "version": "2017-03-14", "operations": [ { "target": "com.amazonaws.servicediscovery#CreateHttpNamespace" }, { "target": "com.amazonaws.servicediscovery#CreatePrivateDnsNamespace" }, { "target": "com.amazonaws.servicediscovery#CreatePublicDnsNamespace" }, { "target": "com.amazonaws.servicediscovery#CreateService" }, { "target": "com.amazonaws.servicediscovery#DeleteNamespace" }, { "target": "com.amazonaws.servicediscovery#DeleteService" }, { "target": "com.amazonaws.servicediscovery#DeregisterInstance" }, { "target": "com.amazonaws.servicediscovery#DiscoverInstances" }, { "target": "com.amazonaws.servicediscovery#GetInstance" }, { "target": "com.amazonaws.servicediscovery#GetInstancesHealthStatus" }, { "target": "com.amazonaws.servicediscovery#GetNamespace" }, { "target": "com.amazonaws.servicediscovery#GetOperation" }, { "target": "com.amazonaws.servicediscovery#GetService" }, { "target": "com.amazonaws.servicediscovery#ListInstances" }, { "target": "com.amazonaws.servicediscovery#ListNamespaces" }, { "target": "com.amazonaws.servicediscovery#ListOperations" }, { "target": "com.amazonaws.servicediscovery#ListServices" }, { "target": "com.amazonaws.servicediscovery#ListTagsForResource" }, { "target": "com.amazonaws.servicediscovery#RegisterInstance" }, { "target": "com.amazonaws.servicediscovery#TagResource" }, { "target": "com.amazonaws.servicediscovery#UntagResource" }, { "target": "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatus" }, { "target": "com.amazonaws.servicediscovery#UpdateService" } ], "traits": { "aws.api#service": { "sdkId": "ServiceDiscovery", "arnNamespace": "servicediscovery", "cloudFormationName": "ServiceDiscovery", "cloudTrailEventSource": "servicediscovery.amazonaws.com", "endpointPrefix": "servicediscovery" }, "aws.auth#sigv4": { "name": "servicediscovery" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "With AWS Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice\n applications run in. When an instance becomes available, you can call the AWS Cloud Map API to register the instance\n with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional\n health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer\n that contains up to eight healthy records.
", "smithy.api#title": "AWS Cloud Map" } }, "com.amazonaws.servicediscovery#RoutingPolicy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "MULTIVALUE", "name": "MULTIVALUE" }, { "value": "WEIGHTED", "name": "WEIGHTED" } ] } }, "com.amazonaws.servicediscovery#Service": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID that AWS Cloud Map assigned to the service when you created it.
" } }, "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
" } }, "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { "smithy.api#documentation": "The name of the service.
" } }, "NamespaceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the namespace that was used to create the service.
" } }, "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { "smithy.api#documentation": "The description of the service.
" } }, "InstanceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that have been deleted are not included in the count. The count might not reflect\n pending registrations and deregistrations.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { "smithy.api#documentation": "A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceType", "traits": { "smithy.api#documentation": "Describes the systems that can be used to\n discover the service instances.
\n \nThe service instances can be discovered using either DNS queries or the DiscoverInstances API\n operation.
The service instances can only be discovered using the DiscoverInstances API operation.
Reserved.
\n\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.
For information about the charges for health checks, see Amazon Route 53 Pricing.
" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { "smithy.api#documentation": "A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value\n of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried without the risk of\n running the operation twice. CreatorRequestId can be any unique string, for example, a\n date/timestamp.
A complex type that contains information about the specified service.
" } }, "com.amazonaws.servicediscovery#ServiceAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The CreatorRequestId that was used to create the service.
The ID of the existing service.
" } } }, "traits": { "smithy.api#documentation": "The service can't be created because a service with the same name already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.servicediscovery#ServiceChange": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { "smithy.api#documentation": "A description for the service.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfigChange", "traits": { "smithy.api#documentation": "Information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, AWS Cloud Map associates the health check with the records that you specify in\n DnsConfig.
A complex type that contains changes to an existing service.
" } }, "com.amazonaws.servicediscovery#ServiceFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.servicediscovery#ServiceFilterName", "traits": { "smithy.api#documentation": "Specify NAMESPACE_ID.
The values that are applicable to the value that you specify for Condition to filter the list of\n services.
The operator that you want to use to determine whether a service is returned by ListServices. Valid\n values for Condition include the following:
\n EQ: When you specify EQ, specify one namespace ID for Values.\n EQ is the default condition and can be omitted.
\n IN: When you specify IN, specify a list of the IDs for the namespaces that you want\n ListServices to return a list of services for.
\n BETWEEN: Not applicable.
A complex type that lets you specify the namespaces that you want to list services for.
" } }, "com.amazonaws.servicediscovery#ServiceFilterName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NAMESPACE_ID", "name": "NAMESPACE_ID" } ] } }, "com.amazonaws.servicediscovery#ServiceFilters": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#ServiceFilter", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.servicediscovery#ServiceName": { "type": "string", "traits": { "smithy.api#pattern": "((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^\\.$)" } }, "com.amazonaws.servicediscovery#ServiceNotFound": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "No service exists with the specified ID.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.servicediscovery#ServiceSummariesList": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#ServiceSummary" } }, "com.amazonaws.servicediscovery#ServiceSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID that AWS Cloud Map assigned to the service when you created it.
" } }, "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
" } }, "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { "smithy.api#documentation": "The name of the service.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceType", "traits": { "smithy.api#documentation": "Describes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the DiscoverInstances API\n operation.
The service instances can only be discovered using the DiscoverInstances API operation.
Reserved.
\nThe description that you specify when you create the service.
" } }, "InstanceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that have been deleted are not included in the count. The count might not reflect\n pending registrations and deregistrations.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { "smithy.api#documentation": "Information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, AWS Cloud Map associates the health check with the records that you specify in\n DnsConfig.
Information about an optional custom health check. A custom health check, which requires that you use a\n third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
\nYou can't use a health check that is defined by HealthCheckConfig because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC.\n (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.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.
The date and time that the service was created.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about a specified service.
" } }, "com.amazonaws.servicediscovery#ServiceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "HTTP", "name": "HTTP" }, { "value": "DNS_HTTP", "name": "DNS_HTTP" }, { "value": "DNS", "name": "DNS" } ] } }, "com.amazonaws.servicediscovery#ServiceTypeOption": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "HTTP", "name": "HTTP" } ] } }, "com.amazonaws.servicediscovery#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.servicediscovery#TagKey", "traits": { "smithy.api#documentation": "The key identifier, or name, of the tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.servicediscovery#TagValue", "traits": { "smithy.api#documentation": "The string value associated with the key of the tag. You can set the value of a tag to an empty string, but you\n can't set the value of a tag to null.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A custom key-value pair associated with a resource.
" } }, "com.amazonaws.servicediscovery#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.servicediscovery#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.servicediscovery#TagList": { "type": "list", "member": { "target": "com.amazonaws.servicediscovery#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.servicediscovery#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#TagResourceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ResourceNotFoundException" }, { "target": "com.amazonaws.servicediscovery#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to the specified resource.
" } }, "com.amazonaws.servicediscovery#TagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.servicediscovery#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { "smithy.api#documentation": "The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to\n an empty string, but you can't set the value of a tag to null.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.servicediscovery#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.servicediscovery#Timestamp": { "type": "timestamp" }, "com.amazonaws.servicediscovery#TooManyTagsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" }, "ResourceName": { "target": "com.amazonaws.servicediscovery#AmazonResourceName", "traits": { "smithy.api#documentation": "The name of the resource.
" } } }, "traits": { "smithy.api#documentation": "The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource\n is 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.servicediscovery#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#UntagResourceRequest" }, "output": { "target": "com.amazonaws.servicediscovery#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Removes one or more tags from the specified resource.
" } }, "com.amazonaws.servicediscovery#UntagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.servicediscovery#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.servicediscovery#TagKeyList", "traits": { "smithy.api#documentation": "The tag keys to remove from the specified resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatus": { "type": "operation", "input": { "target": "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatusRequest" }, "errors": [ { "target": "com.amazonaws.servicediscovery#CustomHealthNotFound" }, { "target": "com.amazonaws.servicediscovery#InstanceNotFound" }, { "target": "com.amazonaws.servicediscovery#InvalidInput" }, { "target": "com.amazonaws.servicediscovery#ServiceNotFound" } ], "traits": { "smithy.api#documentation": "Submits a request to change the health status of a custom health check to healthy or unhealthy.
\nYou can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks,\n which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the\n status for Route 53 health checks, which you define using HealthCheckConfig.
For more information, see HealthCheckCustomConfig.
" } }, "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatusRequest": { "type": "structure", "members": { "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that includes the configuration for the custom health check that you want to change the\n status for.
", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the instance that you want to change the health status for.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.servicediscovery#CustomHealthStatus", "traits": { "smithy.api#documentation": "The new status of the instance, HEALTHY or UNHEALTHY.
Submits a request to perform the following operations:
\nUpdate the TTL setting for existing DnsRecords configurations
Add, update, or delete HealthCheckConfig for a specified service
You can't add, update, or delete a HealthCheckCustomConfig configuration.
For public and private DNS namespaces, note the following:
\nIf you omit any existing DnsRecords or HealthCheckConfig configurations from an\n UpdateService request, the configurations are deleted from the service.
If you omit an existing HealthCheckCustomConfig configuration from an UpdateService\n request, the configuration isn't deleted from the service.
When you update settings for a service, AWS Cloud Map also updates the corresponding settings in all the records\n and health checks that were created by using the specified service.
" } }, "com.amazonaws.servicediscovery#UpdateServiceRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "The ID of the service that you want to update.
", "smithy.api#required": {} } }, "Service": { "target": "com.amazonaws.servicediscovery#ServiceChange", "traits": { "smithy.api#documentation": "A complex type that contains the new settings for the service.
", "smithy.api#required": {} } } } }, "com.amazonaws.servicediscovery#UpdateServiceResponse": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" } } } } } }