Description¶

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

See also:AWS API Documentation

Synopsis¶

delete-domain--domain<value>[--domain-owner<value>][--cli-input-json|--cli-input-yaml][--generate-cli-skeleton<value>][--debug][--endpoint-url<value>][--no-verify-ssl][--no-paginate][--output<value>][--query<value>][--profile<value>][--region<value>][--version<value>][--color<value>][--no-sign-request][--ca-bundle<value>][--cli-read-timeout<value>][--cli-connect-timeout<value>][--cli-binary-format<value>][--no-cli-pager][--cli-auto-prompt][--no-cli-auto-prompt]

Options¶

--domain (string)

The name of the domain to delete.

--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 valueinput, prints a sample input JSON that can be used as an argument for--cli-input-json. Similarly, if providedyaml-input it will print a sample input YAML that can be used with--cli-input-yaml. If provided with the valueoutput, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blobfileb:// will always be treated as binary and use the file contents directly regardless of thecli-binary-format setting. When usingfile:// the file contents will need to properly formatted for the configuredcli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

To delete a domain

The followingdelete-domain example deletes a domain namedtest-domain.

awscodeartifactdelete-domain \--domaintest-domain

Output:

{"domain":{"name":"test-domain","owner":"417498243647","arn":"arn:aws:codeartifact:us-west-2:417498243647:domain/test-domain","status":"Deleted","createdTime":"2020-10-20T13:16:48.559000-04:00","encryptionKey":"arn:aws:kms:us-west-2:417498243647:key/c9fe2447-0795-4fda-afbe-8464574ae162","repositoryCount":0,"assetSizeBytes":0}}

For more information, seeDelete a domain in theAWS CodeArtifact User Guide.

Output¶

domain -> (structure)

Contains information about the deleted 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 -> (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.