Operations for managing service discovery namespaces
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-cloud-map:amazon-cloud-map-namespaces-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: AWS Cloud Map Namespaces API
version: '2017-03-14'
description: Generated from AWS's published Smithy model for AWS Cloud Map. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://servicediscovery.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/#DeleteNamespace:
post:
operationId: DeleteNamespace
summary: Delete Namespace
description: Deletes a namespace from the current account. If the namespace still contains one or more services, the
request fails.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteNamespaceResponse'
example:
OperationId: abcd1234-xmpl-5678-9012-abcd1234xmplabcd
'409':
description: DuplicateRequest; ResourceInUse
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DuplicateRequest'
'400':
description: InvalidInput
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInput'
'404':
description: NamespaceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/NamespaceNotFound'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53AutoNaming_v20170314.DeleteNamespace
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteNamespaceRequest'
example:
Id: ns-ylexjili4cdxy3xm
tags:
- Namespaces
/#GetNamespace:
post:
operationId: GetNamespace
summary: Get Namespace
description: Gets information about a namespace.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/GetNamespaceResponse'
'400':
description: InvalidInput
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInput'
'404':
description: NamespaceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/NamespaceNotFound'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53AutoNaming_v20170314.GetNamespace
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/GetNamespaceRequest'
tags:
- Namespaces
/#ListNamespaces:
post:
operationId: ListNamespaces
summary: List Namespaces
description: 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.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListNamespacesResponse'
example:
Namespaces:
- Id: ns-a3ccy2e7e3a7rile
Arn: arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile
ResourceOwner: '123456789012'
Name: local
Type: DNS_PRIVATE
Properties:
DnsProperties:
HostedZoneId: Z06752353VBUDTC32S84S
SOA:
TTL: 60
HttpProperties:
HttpName: local
CreateDate: 1705161600.0
ServiceCount: 2
- Id: ns-pocfyjtrsmwtvcxx
Arn: arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx
ResourceOwner: '123456789012'
Name: My-second-namespace
Type: HTTP
Description: My second namespace
Properties:
DnsProperties:
SOA:
TTL: 60
HttpProperties:
HttpName: My-second-namespace
CreateDate: 1705161600.0
ServiceCount: 1
- Id: ns-ylexjili4cdxy3xm
Arn: arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm
ResourceOwner: '123456789012'
Name: example.com
Type: DNS_PRIVATE
Properties:
DnsProperties:
HostedZoneId: Z09983722P0QME1B3KC8I
SOA:
TTL: 60
HttpProperties:
HttpName: example.com
CreateDate: 1705161600.0
ServiceCount: 3
'400':
description: InvalidInput
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53AutoNaming_v20170314.ListNamespaces
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListNamespacesRequest'
tags:
- Namespaces
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: servicediscovery
schemas:
DeleteNamespaceRequest:
type: object
properties:
Id:
type: string
description: The ID or Amazon Resource Name (ARN) of the namespace that you want to delete.
required:
- Id
DeleteNamespaceResponse:
type: object
properties:
OperationId:
type: string
description: A value that you can use to determine whether the request completed successfully. To get the status
of the operation, see GetOperation.
DnsProperties:
type: object
properties:
HostedZoneId:
type: string
description: The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
SOA:
$ref: '#/components/schemas/SOA'
DuplicateRequest:
type: object
properties:
Message:
type: string
DuplicateOperationId:
type: string
description: The ID of the operation that's already in progress.
GetNamespaceRequest:
type: object
properties:
Id:
type: string
description: 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
required:
- Id
GetNamespaceResponse:
type: object
properties:
Namespace:
$ref: '#/components/schemas/Namespace'
HttpProperties:
type: object
properties:
HttpName:
type: string
description: The name of an HTTP namespace.
InvalidInput:
type: object
properties:
Message:
type: string
ListNamespacesRequest:
type: object
properties:
NextToken:
type: string
description: For the first ListNamespaces request, omit this value. If the response contains NextToken, submit another
ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response
in the next request. Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria.
It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent
groups of MaxResults namespaces do contain namespaces that match the criteria.
MaxResults:
type: integer
description: 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.
Filters:
type: array
items:
$ref: '#/components/schemas/NamespaceFilter'
description: A complex type that contains specifications for the namespaces that you want to list. If you specify
more than one filter, a namespace must match all filters to be returned by ListNamespaces.
ListNamespacesResponse:
type: object
properties:
Namespaces:
type: array
items:
$ref: '#/components/schemas/NamespaceSummary'
description: An array that contains one NamespaceSummary object for each namespace that matches the specified filter
criteria.
NextToken:
type: string
description: If the response contains NextToken, submit another ListNamespaces request to get the next group of
results. Specify the value of NextToken from the previous response in the next request. Cloud Map gets MaxResults
namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first
MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain
namespaces that match the criteria.
Namespace:
type: object
properties:
Id:
type: string
description: The ID of a namespace.
Arn:
type: string
description: The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
ResourceOwner:
type: string
description: 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:
type: string
description: The name of the namespace, such as example.com.
Type:
type: string
enum:
- DNS_PUBLIC
- DNS_PRIVATE
- HTTP
description: '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:
type: string
description: The description that you specify for the namespace when you create it.
ServiceCount:
type: integer
description: The number of services that are associated with the namespace.
Properties:
$ref: '#/components/schemas/NamespaceProperties'
CreateDate:
type: string
format: date-time
description: 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:
type: string
description: A unique string that identifies the request and that allows failed requests to be retried without the
risk of running an operation twice.
NamespaceFilter:
type: object
properties:
Name:
type: string
enum:
- TYPE
- NAME
- HTTP_NAME
- RESOURCE_OWNER
description: '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:
type: array
items:
type: string
description: '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.'
Condition:
type: string
enum:
- EQ
- IN
- BETWEEN
- BEGINS_WITH
description: '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.'
required:
- Name
- Values
NamespaceNotFound:
type: object
properties:
Message:
type: string
NamespaceProperties:
type: object
properties:
DnsProperties:
$ref: '#/components/schemas/DnsProperties'
HttpProperties:
$ref: '#/components/schemas/HttpProperties'
NamespaceSummary:
type: object
properties:
Id:
type: string
description: The ID of the namespace.
Arn:
type: string
description: The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
ResourceOwner:
type: string
description: 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:
type: string
description: 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:
type: string
enum:
- DNS_PUBLIC
- DNS_PRIVATE
- HTTP
description: The type of the namespace, either public or private.
Description:
type: string
description: A description for the namespace.
ServiceCount:
type: integer
description: The number of services that were created using the namespace.
Properties:
$ref: '#/components/schemas/NamespaceProperties'
CreateDate:
type: string
format: date-time
description: The date and time that the namespace was created.
SOA:
type: object
properties:
TTL:
type: integer
description: The time to live (TTL) for purposes of negative caching.
required:
- TTL
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/servicediscovery/service/2017-03-14/servicediscovery-2017-03-14.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)