[ aws . customer-profiles ]

get-domain

Description

Returns information about a specific domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-domain
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

A unique name for the domain.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

DomainName -> (string)

The unique name of the domain.

DefaultExpirationDays -> (integer)

The default number of days until the data within the domain expires.

DefaultEncryptionKey -> (string)

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

DeadLetterQueueUrl -> (string)

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

Stats -> (structure)

Usage-specific statistics about the domain.

ProfileCount -> (long)

The total number of profiles currently in the domain.

MeteringProfileCount -> (long)

The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.

ObjectCount -> (long)

The total number of objects in domain.

TotalSize -> (long)

The total size, in bytes, of all objects in the domain.

CreatedAt -> (timestamp)

The timestamp of when the domain was created.

LastUpdatedAt -> (timestamp)

The timestamp of when the domain was most recently edited.

Tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)