:doc:`CodeArtifact <../../codeartifact>` / Client / describe_domain

***************
describe_domain
***************



.. py:method:: CodeArtifact.Client.describe_domain(**kwargs)

  

  Returns a `DomainDescription <https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html>`__ object that contains information about the requested domain.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DescribeDomain>`_  


  **Request Syntax**
  ::

    response = client.describe_domain(
        domain='string',
        domainOwner='string'
    )
    
  :type domain: string
  :param domain: **[REQUIRED]** 

    A string that specifies the name of the requested domain.

    

  
  :type domainOwner: string
  :param domainOwner: 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`CodeArtifact.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.InternalServerException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.ValidationException`

  