Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetNamespace

Gets information about a namespace.

Request Syntax


{
   "Id": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Id

The ID or Amazon Resource Name (ARN) of the namespace that you want to get information about. For namespaces shared with your AWS account, specify the namespace ARN. For more information about shared namespaces, see Cross-account AWS Cloud Map namespace sharing in the AWS Cloud Map Developer Guide

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax


{
   "Namespace": { 
      "Arn": "string",
      "CreateDate": number,
      "CreatorRequestId": "string",
      "Description": "string",
      "Id": "string",
      "Name": "string",
      "Properties": { 
         "DnsProperties": { 
            "HostedZoneId": "string",
            "SOA": { 
               "TTL": number
            }
         },
         "HttpProperties": { 
            "HttpName": "string"
         }
      },
      "ResourceOwner": "string",
      "ServiceCount": number,
      "Type": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Namespace

A complex type that contains information about the specified namespace.

Type: Namespace object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInput

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

HTTP Status Code: 400

NamespaceNotFound

No namespace exists with the specified ID.

HTTP Status Code: 400

Examples

GetNamespace Example

This example request retrieves information about the specified namespace.

Sample Request


POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20181118T211711Z
authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request,
               SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
               Signature=[calculated-signature]
x-amz-target:Route53AutoNaming_v20170314.GetNamespace
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]

{
    "Id": "ns-e4anhexample0004"
}

Sample Response


HTTP/1.1 200
Content-Length: [number of characters in the JSON string]
Content-Type: application/x-amz-json-1.1

{
    "Namespace": {
        "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e1tpmexample0001",
        "CreateDate": "20181118T211712Z",
        "CreatorRequestId": "example-creator-request-id-0001",
        "Description": "Example.com AWS Cloud Map HTTP Namespace",
        "Id": "ns-e1tpmexample0001",
        "Name": "example-http.com",
        "Properties": {
            "DnsProperties": {},
            "HttpProperties": {
                "HttpName": "example-http.com"
            }
        },
        "Type": "HTTP",
        "ResourceOwner": "123456789012"
    }
}

GetNamespace Example using ARN

This example request retrieves information about a shared namespace using its ARN. The namespace owner is account 123456789012 and the consumer is 111122223333.

Sample Request


POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20181118T211711Z
authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request,
               SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
               Signature=[calculated-signature]
x-amz-target:Route53AutoNaming_v20170314.GetNamespace
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]

{
    "Id": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004"
}

Sample Response


HTTP/1.1 200
Content-Length: [number of characters in the JSON string]
Content-Type: application/x-amz-json-1.1

{
    "Namespace": {
        "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e1tpmexample0001",
        "CreateDate": "20181118T211712Z",
        "CreatorRequestId": "example-creator-request-id-0001",
        "Description": "Example.com AWS Cloud Map HTTP Namespace",
        "Id": "ns-e1tpmexample0001",
        "Name": "example-http.com",
        "Properties": {
            "DnsProperties": {},
            "HttpProperties": {
                "HttpName": "example-http.com"
            }
        },
        "Type": "HTTP",
        "ResourceOwner": "123456789012"
    }
}