2025/08/14 - AWS Cloud Map - 11 updated api methods
Changes Added support for cross account through Id parameter overloading with ARN and allow owner account for some APIs instead of ARN
{'Service': {'CreatedByAccount': 'string', 'ResourceOwner': 'string'}}
Creates a service. This action defines the configuration for the following entities:
For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
A
AAAA
A and AAAA
SRV
CNAME
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_service(
Name='string',
NamespaceId='string',
CreatorRequestId='string',
Description='string',
DnsConfig={
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
HealthCheckConfig={
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
HealthCheckCustomConfig={
'FailureThreshold': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Type='HTTP'
)
string
[REQUIRED]
The name that you want to assign to the service.
If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:
Start the name with an underscore (_), such as _exampleservice.
End the name with ._protocol, such as ._tcp.
When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,
_exampleservice._tcp.example.com).
string
The ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service. For namespaces shared with your Amazon Web Services account, specify the namespace ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
string
A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).
This field is autopopulated if not provided.
string
A description for the service.
dict
A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.
NamespaceId (string) --
Use NamespaceId in Service instead.
The ID of the namespace to use for DNS configuration.
RoutingPolicy (string) --
The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
DnsRecords (list) -- [REQUIRED]
An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.
(dict) --
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
Type (string) -- [REQUIRED]
The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:
A
AAAA
A and AAAA
SRV
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.
The following values are supported:
A
Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
AAAA
Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
CNAME
Route 53 returns the domain name of the resource, such as www.example.com. Note the following:
You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
You must specify WEIGHTED for the value of RoutingPolicy.
You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
The values of priority and weight are both set to 1 and can't be changed.
The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.
The value of service-hostname is a concatenation of the following values:
The value that you specify for InstanceId when you register an instance.
The name of the service.
The name of the namespace.
For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:
test.backend.example.com
If you specify settings for an SRV record, note the following:
If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.
If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.
TTL (integer) -- [REQUIRED]
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
dict
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.
For information about the charges for health checks, see Cloud Map Pricing.
Type (string) -- [REQUIRED]
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
TCP: Route 53 tries to establish a TCP connection. If you specify TCP for Type, don't specify a value for ResourcePath.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
ResourcePath (string) --
The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for ResourcePath.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
dict
A complex type that contains information about an optional custom health check.
You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.
FailureThreshold (integer) --
The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the first request to make the change.
list
The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
(dict) --
A custom key-value pair that's associated with a resource.
Key (string) -- [REQUIRED]
The key identifier, or name, of the tag.
Value (string) -- [REQUIRED]
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
string
If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.
dict
Response Syntax
{
'Service': {
'Id': 'string',
'Arn': 'string',
'ResourceOwner': 'string',
'Name': 'string',
'NamespaceId': 'string',
'Description': 'string',
'InstanceCount': 123,
'DnsConfig': {
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'Type': 'HTTP'|'DNS_HTTP'|'DNS',
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
'HealthCheckCustomConfig': {
'FailureThreshold': 123
},
'CreateDate': datetime(2015, 1, 1),
'CreatorRequestId': 'string',
'CreatedByAccount': 'string'
}
}
Response Structure
(dict) --
Service (dict) --
A complex type that contains information about the new service.
Id (string) --
The ID that Cloud Map assigned to the service when you created it.
Arn (string) --
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace with which the service is associated. If this isn't your account ID, it is the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Name (string) --
The name of the service.
NamespaceId (string) --
The ID of the namespace that was used to create the service.
Description (string) --
The description of the service.
InstanceCount (integer) --
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig (dict) --
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
NamespaceId (string) --
Use NamespaceId in Service instead.
The ID of the namespace to use for DNS configuration.
RoutingPolicy (string) --
The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
DnsRecords (list) --
An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.
(dict) --
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
Type (string) --
The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:
A
AAAA
A and AAAA
SRV
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.
The following values are supported:
A
Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
AAAA
Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
CNAME
Route 53 returns the domain name of the resource, such as www.example.com. Note the following:
You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
You must specify WEIGHTED for the value of RoutingPolicy.
You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
The values of priority and weight are both set to 1 and can't be changed.
The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.
The value of service-hostname is a concatenation of the following values:
The value that you specify for InstanceId when you register an instance.
The name of the service.
The name of the namespace.
For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:
test.backend.example.com
If you specify settings for an SRV record, note the following:
If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.
If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.
TTL (integer) --
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Type (string) --
Describes the systems that can be used to discover the service instances.
DNS_HTTP
The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.
HTTP
The service instances can only be discovered using the DiscoverInstances API operation.
DNS
Reserved.
HealthCheckConfig (dict) --
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.
For information about the charges for health checks, see Amazon Route 53 Pricing.
Type (string) --
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
TCP: Route 53 tries to establish a TCP connection. If you specify TCP for Type, don't specify a value for ResourcePath.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
ResourcePath (string) --
The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for ResourcePath.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
HealthCheckCustomConfig (dict) --
A complex type that contains information about an optional custom health check.
FailureThreshold (integer) --
The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the first request to make the change.
CreateDate (datetime) --
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CreatorRequestId (string) --
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).
CreatedByAccount (string) --
The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is the ID of account of the namespace owner or of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
{'OwnerAccount': 'string'}
Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. DiscoverInstances returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances.
See also: AWS API Documentation
Request Syntax
client.discover_instances(
NamespaceName='string',
ServiceName='string',
MaxResults=123,
QueryParameters={
'string': 'string'
},
OptionalParameters={
'string': 'string'
},
HealthStatus='HEALTHY'|'UNHEALTHY'|'ALL'|'HEALTHY_OR_ELSE_ALL',
OwnerAccount='string'
)
string
[REQUIRED]
The HttpName name of the namespace. The HttpName is found in the HttpProperties member of the Properties member of the namespace. In most cases, Name and HttpName match. However, if you reuse Name for namespace creation, a generated hash is added to HttpName to distinguish the two.
string
[REQUIRED]
The name of the service that you specified when you registered the instance.
integer
The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.
dict
Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.
(string) --
(string) --
dict
Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.
(string) --
(string) --
string
The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.
HEALTHY
Returns healthy instances.
UNHEALTHY
Returns unhealthy instances.
ALL
Returns all instances.
HEALTHY_OR_ELSE_ALL
Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.
string
The ID of the Amazon Web Services account that owns the namespace associated with the instance, as specified in the namespace ResourceOwner field. For instances associated with namespaces that are shared with your account, you must specify an OwnerAccount.
dict
Response Syntax
{
'Instances': [
{
'InstanceId': 'string',
'NamespaceName': 'string',
'ServiceName': 'string',
'HealthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'Attributes': {
'string': 'string'
}
},
],
'InstancesRevision': 123
}
Response Structure
(dict) --
Instances (list) --
A complex type that contains one HttpInstanceSummary for each registered instance.
(dict) --
In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.
InstanceId (string) --
The ID of an instance that matches the values that you specified in the request.
NamespaceName (string) --
The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.
ServiceName (string) --
The name of the service that you specified when you registered the instance.
HealthStatus (string) --
If you configured health checking in the service, the current health status of the service instance.
Attributes (dict) --
If you included any attributes when you registered the instance, the values of those attributes.
(string) --
(string) --
InstancesRevision (integer) --
The increasing revision associated to the response Instances list. If a new instance is registered or deregistered, the InstancesRevision updates. The health status updates don't update InstancesRevision.
{'OwnerAccount': 'string'}
Discovers the increasing revision associated with an instance.
See also: AWS API Documentation
Request Syntax
client.discover_instances_revision(
NamespaceName='string',
ServiceName='string',
OwnerAccount='string'
)
string
[REQUIRED]
The HttpName name of the namespace. The HttpName is found in the HttpProperties member of the Properties member of the namespace.
string
[REQUIRED]
The name of the service that you specified when you registered the instance.
string
The ID of the Amazon Web Services account that owns the namespace associated with the instance, as specified in the namespace ResourceOwner field. For instances associated with namespaces that are shared with your account, you must specify an OwnerAccount. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
dict
Response Syntax
{
'InstancesRevision': 123
}
Response Structure
(dict) --
InstancesRevision (integer) --
The increasing revision associated to the response Instances list. If a new instance is registered or deregistered, the InstancesRevision updates. The health status updates don't update InstancesRevision.
{'Instance': {'CreatedByAccount': 'string'}, 'ResourceOwner': 'string'}
Gets information about a specified instance.
See also: AWS API Documentation
Request Syntax
client.get_instance(
ServiceId='string',
InstanceId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
string
[REQUIRED]
The ID of the instance that you want to get information about.
dict
Response Syntax
{
'ResourceOwner': 'string',
'Instance': {
'Id': 'string',
'CreatorRequestId': 'string',
'Attributes': {
'string': 'string'
},
'CreatedByAccount': 'string'
}
}
Response Structure
(dict) --
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace that contains the service that the instance is associated with. If this isn't your account ID, it's the ID of the account that shared the namespace with your account.
Instance (dict) --
A complex type that contains information about a specified instance.
Id (string) --
An identifier that you want to associate with the instance. Note the following:
If the service that's specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord > Type.
You can use this value to update an existing instance.
To register a new instance, you must specify a value that's unique among instances that you register by using the same service.
If you specify an existing InstanceId and ServiceId, Cloud Map updates the existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and creates a new one.
CreatorRequestId (string) --
A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string (for example, a date/time stamp).
Attributes (dict) --
A string map that contains the following information for the service that you specify in ServiceId:
The attributes that apply to the records that are defined in the service.
For each attribute, the applicable value.
Supported attribute keys include the following:
AWS_ALIAS_DNS_NAME
If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.
Note the following:
The configuration for the service that's specified by ServiceId must include settings for an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig settings, Cloud Map creates the health check, but it won't associate the health check with the alias record.
Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than ELB load balancers.
If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
AWS_EC2_INSTANCE_ID
HTTP namespaces only. The Amazon EC2 instance ID for the instance. The AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
AWS_INIT_HEALTH_STATUS
If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
AWS_INSTANCE_CNAME
If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries (for example, example.com).
This value is required if the service specified by ServiceId includes settings for an CNAME record.
AWS_INSTANCE_IPV4
If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries (for example, 192.0.2.44).
This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
AWS_INSTANCE_IPV6
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).
This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
AWS_INSTANCE_PORT
If the service includes an SRV record, the value that you want Route 53 to return for the port.
If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.
(string) --
(string) --
CreatedByAccount (string) --
The ID of the Amazon Web Services account that registered the instance. If this isn't your account ID, it's the ID of the account that shared the namespace with your account or the ID of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
{'Namespace': {'ResourceOwner': 'string'}}
Gets information about a namespace.
See also: AWS API Documentation
Request Syntax
client.get_namespace(
Id='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the namespace that you want to get information about. For namespaces shared with your Amazon Web Services account, specify the namespace ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide
dict
Response Syntax
{
'Namespace': {
'Id': 'string',
'Arn': 'string',
'ResourceOwner': 'string',
'Name': 'string',
'Type': 'DNS_PUBLIC'|'DNS_PRIVATE'|'HTTP',
'Description': 'string',
'ServiceCount': 123,
'Properties': {
'DnsProperties': {
'HostedZoneId': 'string',
'SOA': {
'TTL': 123
}
},
'HttpProperties': {
'HttpName': 'string'
}
},
'CreateDate': datetime(2015, 1, 1),
'CreatorRequestId': 'string'
}
}
Response Structure
(dict) --
Namespace (dict) --
A complex type that contains information about the specified namespace.
Id (string) --
The ID of a namespace.
Arn (string) --
The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Name (string) --
The name of the namespace, such as example.com.
Type (string) --
The type of the namespace. The methods for discovering instances depends on the value that you specify:
HTTP
Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances API.
DNS_PUBLIC
Instances can be discovered using public DNS queries and using the DiscoverInstances API.
DNS_PRIVATE
Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.
Description (string) --
The description that you specify for the namespace when you create it.
ServiceCount (integer) --
The number of services that are associated with the namespace.
Properties (dict) --
A complex type that contains information that's specific to the type of the namespace.
DnsProperties (dict) --
A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
HostedZoneId (string) --
The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
SOA (dict) --
Start of Authority (SOA) record for the hosted zone.
TTL (integer) --
The time to live (TTL) for purposes of negative caching.
HttpProperties (dict) --
A complex type that contains the name of an HTTP namespace.
HttpName (string) --
The name of an HTTP namespace.
CreateDate (datetime) --
The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CreatorRequestId (string) --
A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.
{'OwnerAccount': 'string'}
Response {'Operation': {'OwnerAccount': 'string'}}
Gets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request.
See also: AWS API Documentation
Request Syntax
client.get_operation(
OperationId='string',
OwnerAccount='string'
)
string
[REQUIRED]
The ID of the operation that you want to get more information about.
string
The ID of the Amazon Web Services account that owns the namespace associated with the operation, as specified in the namespace ResourceOwner field. For operations associated with namespaces that are shared with your account, you must specify an OwnerAccount.
dict
Response Syntax
{
'Operation': {
'Id': 'string',
'OwnerAccount': 'string',
'Type': 'CREATE_NAMESPACE'|'DELETE_NAMESPACE'|'UPDATE_NAMESPACE'|'UPDATE_SERVICE'|'REGISTER_INSTANCE'|'DEREGISTER_INSTANCE',
'Status': 'SUBMITTED'|'PENDING'|'SUCCESS'|'FAIL',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'CreateDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'Targets': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Operation (dict) --
A complex type that contains information about the operation.
Id (string) --
The ID of the operation that you want to get information about.
OwnerAccount (string) --
The ID of the Amazon Web Services account that owns the namespace associated with the operation.
Type (string) --
The name of the operation that's associated with the specified ID.
Status (string) --
The status of the operation. Values include the following:
SUBMITTED
This is the initial state that occurs immediately after you submit a request.
PENDING
Cloud Map is performing the operation.
SUCCESS
The operation succeeded.
FAIL
The operation failed. For the failure reason, see ErrorMessage.
ErrorMessage (string) --
If the value of Status is FAIL, the reason that the operation failed.
ErrorCode (string) --
The code associated with ErrorMessage. Values for ErrorCode include the following:
ACCESS_DENIED
CANNOT_CREATE_HOSTED_ZONE
EXPIRED_TOKEN
HOSTED_ZONE_NOT_FOUND
INTERNAL_FAILURE
INVALID_CHANGE_BATCH
THROTTLED_REQUEST
CreateDate (datetime) --
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
UpdateDate (datetime) --
The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Targets (dict) --
The name of the target entity that's associated with the operation:
NAMESPACE
The namespace ID is returned in the ResourceId property.
SERVICE
The service ID is returned in the ResourceId property.
INSTANCE
The instance ID is returned in the ResourceId property.
(string) --
(string) --
{'Service': {'CreatedByAccount': 'string', 'ResourceOwner': 'string'}}
Gets the settings for a specified service.
See also: AWS API Documentation
Request Syntax
client.get_service(
Id='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the service that you want to get settings for. For services created by consumers in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
dict
Response Syntax
{
'Service': {
'Id': 'string',
'Arn': 'string',
'ResourceOwner': 'string',
'Name': 'string',
'NamespaceId': 'string',
'Description': 'string',
'InstanceCount': 123,
'DnsConfig': {
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'Type': 'HTTP'|'DNS_HTTP'|'DNS',
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
'HealthCheckCustomConfig': {
'FailureThreshold': 123
},
'CreateDate': datetime(2015, 1, 1),
'CreatorRequestId': 'string',
'CreatedByAccount': 'string'
}
}
Response Structure
(dict) --
Service (dict) --
A complex type that contains information about the service.
Id (string) --
The ID that Cloud Map assigned to the service when you created it.
Arn (string) --
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace with which the service is associated. If this isn't your account ID, it is the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Name (string) --
The name of the service.
NamespaceId (string) --
The ID of the namespace that was used to create the service.
Description (string) --
The description of the service.
InstanceCount (integer) --
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig (dict) --
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
NamespaceId (string) --
Use NamespaceId in Service instead.
The ID of the namespace to use for DNS configuration.
RoutingPolicy (string) --
The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
DnsRecords (list) --
An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.
(dict) --
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
Type (string) --
The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:
A
AAAA
A and AAAA
SRV
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.
The following values are supported:
A
Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
AAAA
Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
CNAME
Route 53 returns the domain name of the resource, such as www.example.com. Note the following:
You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
You must specify WEIGHTED for the value of RoutingPolicy.
You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
The values of priority and weight are both set to 1 and can't be changed.
The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.
The value of service-hostname is a concatenation of the following values:
The value that you specify for InstanceId when you register an instance.
The name of the service.
The name of the namespace.
For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:
test.backend.example.com
If you specify settings for an SRV record, note the following:
If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.
If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.
TTL (integer) --
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Type (string) --
Describes the systems that can be used to discover the service instances.
DNS_HTTP
The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.
HTTP
The service instances can only be discovered using the DiscoverInstances API operation.
DNS
Reserved.
HealthCheckConfig (dict) --
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.
For information about the charges for health checks, see Amazon Route 53 Pricing.
Type (string) --
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
TCP: Route 53 tries to establish a TCP connection. If you specify TCP for Type, don't specify a value for ResourcePath.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
ResourcePath (string) --
The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for ResourcePath.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
HealthCheckCustomConfig (dict) --
A complex type that contains information about an optional custom health check.
FailureThreshold (integer) --
The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the first request to make the change.
CreateDate (datetime) --
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CreatorRequestId (string) --
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).
CreatedByAccount (string) --
The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is the ID of account of the namespace owner or of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
{'ServiceAttributes': {'ResourceOwner': 'string'}}
Returns the attributes associated with a specified service.
See also: AWS API Documentation
Request Syntax
client.get_service_attributes(
ServiceId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the service that you want to get attributes for. For services created in a namespace shared with your Amazon Web Services account, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
dict
Response Syntax
{
'ServiceAttributes': {
'ServiceArn': 'string',
'ResourceOwner': 'string',
'Attributes': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ServiceAttributes (dict) --
A complex type that contains the service ARN and a list of attribute key-value pairs associated with the service.
ServiceArn (string) --
The ARN of the service that the attributes are associated with.
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace with which the service is associated. If this isn't your account ID, it is the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Attributes (dict) --
A string map that contains the following information for the service that you specify in ServiceArn:
The attributes that apply to the service.
For each attribute, the applicable value.
You can specify a total of 30 attributes.
(string) --
(string) --
{'Instances': {'CreatedByAccount': 'string'}, 'ResourceOwner': 'string'}
Lists summary information about the instances that you registered by using a specified service.
See also: AWS API Documentation
Request Syntax
client.list_instances(
ServiceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the service that you want to list instances for. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
string
For the first ListInstances request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
integer
The maximum number of instances that you want Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.
dict
Response Syntax
{
'ResourceOwner': 'string',
'Instances': [
{
'Id': 'string',
'Attributes': {
'string': 'string'
},
'CreatedByAccount': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace that contains the specified service. If this isn't your account ID, it's the ID of the account that shared the namespace with your account.
Instances (list) --
Summary information about the instances that are associated with the specified service.
(dict) --
A complex type that contains information about the instances that you registered by using a specified service.
Id (string) --
The ID for an instance that you created by using a specified service.
Attributes (dict) --
A string map that contains the following information:
The attributes that are associated with the instance.
For each attribute, the applicable value.
Supported attribute keys include the following:
AWS_ALIAS_DNS_NAME
For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.
AWS_EC2_INSTANCE_ID (HTTP namespaces only)
The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
AWS_INIT_HEALTH_STATUS
If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
AWS_INSTANCE_CNAME
For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example, example.com).
AWS_INSTANCE_IPV4
For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example, 192.0.2.44).
AWS_INSTANCE_IPV6
For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).
AWS_INSTANCE_PORT
For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
(string) --
(string) --
CreatedByAccount (string) --
The ID of the Amazon Web Services account that registered the instance. If this isn't your account ID, it's the ID of the account that shared the namespace with your account or the ID of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
NextToken (string) --
If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
{'Filters': {'Name': {'RESOURCE_OWNER'}}}
Response {'Namespaces': {'ResourceOwner': 'string'}}
Lists summary information about the namespaces that were created by the current Amazon Web Services account and shared with the current Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_namespaces(
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'TYPE'|'NAME'|'HTTP_NAME'|'RESOURCE_OWNER',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'|'BEGINS_WITH'
},
]
)
string
For the first ListNamespaces request, omit this value.
If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
integer
The maximum number of namespaces that you want Cloud Map to return in the response to a ListNamespaces request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 namespaces.
list
A complex type that contains specifications for the namespaces that you want to list.
If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces.
(dict) --
A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.
Name (string) -- [REQUIRED]
Specify the namespaces that you want to get using one of the following.
TYPE: Gets the namespaces of the specified type.
NAME: Gets the namespaces with the specified name.
HTTP_NAME: Gets the namespaces with the specified HTTP name.
RESOURCE_OWNER: Gets the namespaces created by your Amazon Web Services account or by other accounts. This can be used to filter for shared namespaces. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Values (list) -- [REQUIRED]
Specify the values that are applicable to the value that you specify for Name.
TYPE: Specify HTTP, DNS_PUBLIC, or DNS_PRIVATE.
NAME: Specify the name of the namespace, which is found in Namespace.Name.
HTTP_NAME: Specify the HTTP name of the namespace, which is found in Namespace.Properties.HttpProperties.HttpName.
RESOURCE_OWNER: Specify one of SELF or OTHER_ACCOUNTS. SELF can be used to filter namespaces created by you and OTHER_ACCOUNTS can be used to filter namespaces shared with you that were created by other accounts.
(string) --
Condition (string) --
Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.
EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, RESOURCE_OWNER and HTTP_NAME. EQ is the default condition and can be omitted.
BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.
dict
Response Syntax
{
'Namespaces': [
{
'Id': 'string',
'Arn': 'string',
'ResourceOwner': 'string',
'Name': 'string',
'Type': 'DNS_PUBLIC'|'DNS_PRIVATE'|'HTTP',
'Description': 'string',
'ServiceCount': 123,
'Properties': {
'DnsProperties': {
'HostedZoneId': 'string',
'SOA': {
'TTL': 123
}
},
'HttpProperties': {
'HttpName': 'string'
}
},
'CreateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Namespaces (list) --
An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.
(dict) --
A complex type that contains information about a namespace.
Id (string) --
The ID of the namespace.
Arn (string) --
The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Name (string) --
The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.
Type (string) --
The type of the namespace, either public or private.
Description (string) --
A description for the namespace.
ServiceCount (integer) --
The number of services that were created using the namespace.
Properties (dict) --
The properties of the namespace.
DnsProperties (dict) --
A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
HostedZoneId (string) --
The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
SOA (dict) --
Start of Authority (SOA) record for the hosted zone.
TTL (integer) --
The time to live (TTL) for purposes of negative caching.
HttpProperties (dict) --
A complex type that contains the name of an HTTP namespace.
HttpName (string) --
The name of an HTTP namespace.
CreateDate (datetime) --
The date and time that the namespace was created.
NextToken (string) --
If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
{'Filters': {'Name': {'RESOURCE_OWNER'}}}
Response {'Services': {'CreatedByAccount': 'string', 'ResourceOwner': 'string'}}
Lists summary information for all the services that are associated with one or more namespaces.
See also: AWS API Documentation
Request Syntax
client.list_services(
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'NAMESPACE_ID'|'RESOURCE_OWNER',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'|'BEGINS_WITH'
},
]
)
string
For the first ListServices request, omit this value.
If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
integer
The maximum number of services that you want Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 services.
list
A complex type that contains specifications for the namespaces that you want to list services for.
If you specify more than one filter, an operation must match all filters to be returned by ListServices.
(dict) --
A complex type that lets you specify the namespaces that you want to list services for.
Name (string) -- [REQUIRED]
Specify the services that you want to get using one of the following.
NAMESPACE_ID: Gets the services associated with the specified namespace.
RESOURCE_OWNER: Gets the services associated with the namespaces created by your Amazon Web Services account or by other accounts. This can be used to filter for services created in a shared namespace. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Values (list) -- [REQUIRED]
The values that are applicable to the value that you specify for Condition to filter the list of services.
NAMESPACE_ID: Specify one namespace ID or ARN. Specify the namespace ARN for namespaces that are shared with your Amazon Web Services account.
RESOURCE_OWNER: Specify one of SELF or OTHER_ACCOUNTS. SELF can be used to filter services associated with namespaces created by you and OTHER_ACCOUNTS can be used to filter services associated with namespaces that were shared with you.
(string) --
Condition (string) --
The operator that you want to use to determine whether a service is returned by ListServices. Valid values for Condition include the following:
EQ: When you specify EQ, specify one value. EQ is the default condition and can be omitted.
dict
Response Syntax
{
'Services': [
{
'Id': 'string',
'Arn': 'string',
'ResourceOwner': 'string',
'Name': 'string',
'Type': 'HTTP'|'DNS_HTTP'|'DNS',
'Description': 'string',
'InstanceCount': 123,
'DnsConfig': {
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
'HealthCheckCustomConfig': {
'FailureThreshold': 123
},
'CreateDate': datetime(2015, 1, 1),
'CreatedByAccount': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Services (list) --
An array that contains one ServiceSummary object for each service that matches the specified filter criteria.
(dict) --
A complex type that contains information about a specified service.
Id (string) --
The ID that Cloud Map assigned to the service when you created it.
Arn (string) --
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
ResourceOwner (string) --
The ID of the Amazon Web Services account that created the namespace with which the service is associated. If this isn't your account ID, it is the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Name (string) --
The name of the service.
Type (string) --
Describes the systems that can be used to discover the service instances.
DNS_HTTP
The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.
HTTP
The service instances can only be discovered using the DiscoverInstances API operation.
DNS
Reserved.
Description (string) --
The description that you specify when you create the service.
InstanceCount (integer) --
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig (dict) --
Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
NamespaceId (string) --
Use NamespaceId in Service instead.
The ID of the namespace to use for DNS configuration.
RoutingPolicy (string) --
The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
DnsRecords (list) --
An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.
(dict) --
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
Type (string) --
The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:
A
AAAA
A and AAAA
SRV
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.
The following values are supported:
A
Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
AAAA
Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
CNAME
Route 53 returns the domain name of the resource, such as www.example.com. Note the following:
You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
You must specify WEIGHTED for the value of RoutingPolicy.
You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
The values of priority and weight are both set to 1 and can't be changed.
The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.
The value of service-hostname is a concatenation of the following values:
The value that you specify for InstanceId when you register an instance.
The name of the service.
The name of the namespace.
For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:
test.backend.example.com
If you specify settings for an SRV record, note the following:
If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.
If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.
TTL (integer) --
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
HealthCheckConfig (dict) --
Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.
Type (string) --
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
TCP: Route 53 tries to establish a TCP connection. If you specify TCP for Type, don't specify a value for ResourcePath.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
ResourcePath (string) --
The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for ResourcePath.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
HealthCheckCustomConfig (dict) --
Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are located.
FailureThreshold (integer) --
The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the first request to make the change.
CreateDate (datetime) --
The date and time that the service was created.
CreatedByAccount (string) --
The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is the account ID of the namespace owner or of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
NextToken (string) --
If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.