CodeArtifact / Client / create_domain

create_domain

CodeArtifact.Client.create_domain(**kwargs)

Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it’s in multiple repositories.

Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    domain='string',
    encryptionKey='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

• domain (string) –

  [REQUIRED]

  The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

• encryptionKey (string) –

  The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

  Warning

  CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

• tags (list) –

  One or more tag key-value pairs for the domain.

  • (dict) –

    A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.

    • key (string) – [REQUIRED]

      The tag key.

    • value (string) – [REQUIRED]

      The tag value.

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) –

    Contains information about the created domain after processing the request.

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

• CodeArtifact.Client.exceptions.InternalServerException

• CodeArtifact.Client.exceptions.ResourceNotFoundException

• CodeArtifact.Client.exceptions.ServiceQuotaExceededException

• CodeArtifact.Client.exceptions.ThrottlingException

• CodeArtifact.Client.exceptions.ValidationException