DeleteRepository
Deletes a repository in a public registry. If the repository contains images, you must
either manually delete all images in the repository or use the force
option.
This option deletes all images on your behalf before deleting the repository.
Request Syntax
{
"force": boolean
,
"registryId": "string
",
"repositoryName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- force
-
The force option can be used to delete a repository that contains images. If the force option is not used, the repository must be empty prior to deletion.
Type: Boolean
Required: No
- registryId
-
The AWS account ID that's associated with the public registry that contains the repository to delete. If you do not specify a registry, the default public registry is assumed.
Type: String
Pattern:
[0-9]{12}
Required: No
- repositoryName
-
The name of the repository to delete.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 205.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Required: Yes
Response Syntax
{
"repository": {
"createdAt": number,
"registryId": "string",
"repositoryArn": "string",
"repositoryName": "string",
"repositoryUri": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- repository
-
The repository that was deleted.
Type: Repository object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- RepositoryNotEmptyException
-
The specified repository contains images. To delete a repository that contains images, you must force the deletion with the
force
parameter.HTTP Status Code: 400
- RepositoryNotFoundException
-
The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- UnsupportedCommandException
-
The action isn't supported in this Region.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: