describe-domain¶

Description¶

Returns a DomainDescription object that contains information about the requested domain.

Synopsis¶

  describe-domain
--domain <value>
[--domain-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--domain (string)

A string that specifies the name of the requested domain.

--domain-owner (string)

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

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

Examples¶

To get information about a domain

The following describe-domain example returns a DomainDescription object for a domain named test-domain.

aws codeartifact create-domain \
    --domain test-domain

Output:

{
    "domain": {
        "name": "test-domain",
        "owner": "111122223333",
        "arn": "arn:aws:codeartifact:us-west-2:111122223333:domain/test-domain",
        "status": "Active",
        "createdTime": "2020-10-20T13:16:48.559000-04:00",
        "encryptionKey": "arn:aws:kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "repositoryCount": 2,
        "assetSizeBytes": 0
    }
}

For more information, see Domain overview in the AWS CodeArtifact User Guide.

Output¶

domain -> (structure)

Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.

name -> (string)

The name of the domain.

owner -> (string)

The Amazon Web Services account ID that owns the domain.

arn -> (string)

The Amazon Resource Name (ARN) of the domain.

status -> (string)

The current status of a domain.

createdTime -> (timestamp)

A timestamp that represents the date and time the domain was created.

encryptionKey -> (string)

The ARN of an Key Management Service (KMS) key associated with a domain.

repositoryCount -> (integer)

The number of repositories in the domain.

assetSizeBytes -> (long)

The total size of all assets in the domain.

s3BucketArn -> (string)

The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

Table of Contents

Feedback

User Guide