[ aws . servicediscovery ]

get-namespace

Description

Gets information about a namespace.

See also: AWS API Documentation

Synopsis

  get-namespace
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json

• text

• table

• yaml

• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on

• off

• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Namespace -> (structure)

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.

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 -> (structure)

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

DnsProperties -> (structure)

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 -> (structure)

Start of Authority (SOA) record for the hosted zone.

TTL -> (long)

The time to live (TTL) for purposes of negative caching.

HttpProperties -> (structure)

A complex type that contains the name of an HTTP namespace.

HttpName -> (string)

The name of an HTTP namespace.

CreateDate -> (timestamp)

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.