describe_domain

describe_domain(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_domain(
    domain='string',
    domainOwner='string'
)

Parameters

• domain (string) --

  [REQUIRED]

  A string that specifies the name of the requested domain.

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

Return type

dict

Returns

Response Syntax

{
    'domain': {
        'name': 'string',
        'owner': 'string',
        'arn': 'string',
        'status': 'Active'|'Deleted',
        'createdTime': datetime(2015, 1, 1),
        'encryptionKey': 'string',
        'repositoryCount': 123,
        'assetSizeBytes': 123,
        's3BucketArn': 'string'
    }
}

Response Structure

• (dict) --

  • domain (dict) --

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

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

      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.

Exceptions

• CodeArtifact.Client.exceptions.AccessDeniedException
• CodeArtifact.Client.exceptions.InternalServerException
• CodeArtifact.Client.exceptions.ResourceNotFoundException
• CodeArtifact.Client.exceptions.ThrottlingException
• CodeArtifact.Client.exceptions.ValidationException