docs-2.json 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632
  1. {
  2. "version": "2.0",
  3. "service": "<p>Amazon EC2 Container Registry (Amazon ECR) is a managed AWS Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using AWS IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.</p>",
  4. "operations": {
  5. "BatchCheckLayerAvailability": "<p>Check the availability of multiple image layers in a specified registry and repository.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>",
  6. "BatchDeleteImage": "<p>Deletes a list of specified images within a specified repository. Images are specified with either <code>imageTag</code> or <code>imageDigest</code>.</p>",
  7. "BatchGetImage": "<p>Gets detailed information for specified images within a specified repository. Images are specified with either <code>imageTag</code> or <code>imageDigest</code>.</p>",
  8. "CompleteLayerUpload": "<p>Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a <code>sha256</code> digest of the image layer for data validation purposes.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>",
  9. "CreateRepository": "<p>Creates an image repository.</p>",
  10. "DeleteRepository": "<p>Deletes an existing image repository. If a repository contains images, you must use the <code>force</code> option to delete it.</p>",
  11. "DeleteRepositoryPolicy": "<p>Deletes the repository policy from a specified repository.</p>",
  12. "DescribeRepositories": "<p>Describes image repositories in a registry.</p>",
  13. "GetAuthorizationToken": "<p>Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the <code>docker</code> CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.</p> <p>The <code>authorizationToken</code> returned for each registry specified is a base64 encoded string that can be decoded and used in a <code>docker login</code> command to authenticate to a registry. The AWS CLI offers an <code>aws ecr get-login</code> command that simplifies the login process.</p>",
  14. "GetDownloadUrlForLayer": "<p>Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>",
  15. "GetRepositoryPolicy": "<p>Retrieves the repository policy for a specified repository.</p>",
  16. "InitiateLayerUpload": "<p>Notify Amazon ECR that you intend to upload an image layer.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>",
  17. "ListImages": "<p>Lists all the image IDs for a given repository.</p>",
  18. "PutImage": "<p>Creates or updates the image manifest associated with an image.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>",
  19. "SetRepositoryPolicy": "<p>Applies a repository policy on a specified repository to control access permissions.</p>",
  20. "UploadLayerPart": "<p>Uploads an image layer part to Amazon ECR.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
  21. },
  22. "shapes": {
  23. "Arn": {
  24. "base": null,
  25. "refs": {
  26. "Repository$repositoryArn": "<p>The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the <code>arn:aws:ecr</code> namespace, followed by the region of the repository, the AWS account ID of the repository owner, the repository namespace, and then the repository name. For example, <code>arn:aws:ecr:region:012345678910:repository/test</code>.</p>"
  27. }
  28. },
  29. "AuthorizationData": {
  30. "base": "<p>An object representing authorization data for an Amazon ECR registry.</p>",
  31. "refs": {
  32. "AuthorizationDataList$member": null
  33. }
  34. },
  35. "AuthorizationDataList": {
  36. "base": null,
  37. "refs": {
  38. "GetAuthorizationTokenResponse$authorizationData": "<p>A list of authorization token data objects that correspond to the <code>registryIds</code> values in the request.</p>"
  39. }
  40. },
  41. "Base64": {
  42. "base": null,
  43. "refs": {
  44. "AuthorizationData$authorizationToken": "<p>A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format <code>user:password</code> for private registry authentication using <code>docker login</code>.</p>"
  45. }
  46. },
  47. "BatchCheckLayerAvailabilityRequest": {
  48. "base": null,
  49. "refs": {
  50. }
  51. },
  52. "BatchCheckLayerAvailabilityResponse": {
  53. "base": null,
  54. "refs": {
  55. }
  56. },
  57. "BatchDeleteImageRequest": {
  58. "base": "<p>Deletes specified images within a specified repository. Images are specified with either the <code>imageTag</code> or <code>imageDigest</code>.</p>",
  59. "refs": {
  60. }
  61. },
  62. "BatchDeleteImageResponse": {
  63. "base": null,
  64. "refs": {
  65. }
  66. },
  67. "BatchGetImageRequest": {
  68. "base": null,
  69. "refs": {
  70. }
  71. },
  72. "BatchGetImageResponse": {
  73. "base": null,
  74. "refs": {
  75. }
  76. },
  77. "BatchedOperationLayerDigest": {
  78. "base": null,
  79. "refs": {
  80. "BatchedOperationLayerDigestList$member": null,
  81. "LayerFailure$layerDigest": "<p>The layer digest associated with the failure.</p>"
  82. }
  83. },
  84. "BatchedOperationLayerDigestList": {
  85. "base": null,
  86. "refs": {
  87. "BatchCheckLayerAvailabilityRequest$layerDigests": "<p>The digests of the image layers to check.</p>"
  88. }
  89. },
  90. "CompleteLayerUploadRequest": {
  91. "base": null,
  92. "refs": {
  93. }
  94. },
  95. "CompleteLayerUploadResponse": {
  96. "base": null,
  97. "refs": {
  98. }
  99. },
  100. "CreateRepositoryRequest": {
  101. "base": null,
  102. "refs": {
  103. }
  104. },
  105. "CreateRepositoryResponse": {
  106. "base": null,
  107. "refs": {
  108. }
  109. },
  110. "DeleteRepositoryPolicyRequest": {
  111. "base": null,
  112. "refs": {
  113. }
  114. },
  115. "DeleteRepositoryPolicyResponse": {
  116. "base": null,
  117. "refs": {
  118. }
  119. },
  120. "DeleteRepositoryRequest": {
  121. "base": null,
  122. "refs": {
  123. }
  124. },
  125. "DeleteRepositoryResponse": {
  126. "base": null,
  127. "refs": {
  128. }
  129. },
  130. "DescribeRepositoriesRequest": {
  131. "base": null,
  132. "refs": {
  133. }
  134. },
  135. "DescribeRepositoriesResponse": {
  136. "base": null,
  137. "refs": {
  138. }
  139. },
  140. "EmptyUploadException": {
  141. "base": "<p>The specified layer upload does not contain any layer parts.</p>",
  142. "refs": {
  143. }
  144. },
  145. "ExceptionMessage": {
  146. "base": null,
  147. "refs": {
  148. "EmptyUploadException$message": "<p>The error message associated with the exception.</p>",
  149. "ImageAlreadyExistsException$message": "<p>The error message associated with the exception.</p>",
  150. "InvalidLayerException$message": "<p>The error message associated with the exception.</p>",
  151. "InvalidLayerPartException$message": "<p>The error message associated with the exception.</p>",
  152. "InvalidParameterException$message": "<p>The error message associated with the exception.</p>",
  153. "LayerAlreadyExistsException$message": "<p>The error message associated with the exception.</p>",
  154. "LayerInaccessibleException$message": "<p>The error message associated with the exception.</p>",
  155. "LayerPartTooSmallException$message": "<p>The error message associated with the exception.</p>",
  156. "LayersNotFoundException$message": "<p>The error message associated with the exception.</p>",
  157. "LimitExceededException$message": "<p>The error message associated with the exception.</p>",
  158. "RepositoryAlreadyExistsException$message": "<p>The error message associated with the exception.</p>",
  159. "RepositoryNotEmptyException$message": "<p>The error message associated with the exception.</p>",
  160. "RepositoryNotFoundException$message": "<p>The error message associated with the exception.</p>",
  161. "RepositoryPolicyNotFoundException$message": "<p>The error message associated with the exception.</p>",
  162. "ServerException$message": "<p>The error message associated with the exception.</p>",
  163. "UploadNotFoundException$message": "<p>The error message associated with the exception.</p>"
  164. }
  165. },
  166. "ExpirationTimestamp": {
  167. "base": null,
  168. "refs": {
  169. "AuthorizationData$expiresAt": "<p>The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.</p>"
  170. }
  171. },
  172. "ForceFlag": {
  173. "base": null,
  174. "refs": {
  175. "DeleteRepositoryRequest$force": "<p>Force the deletion of the repository if it contains images.</p>",
  176. "SetRepositoryPolicyRequest$force": "<p>If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the <a>SetRepositoryPolicy</a> operation. This is intended to prevent accidental repository lock outs.</p>"
  177. }
  178. },
  179. "GetAuthorizationTokenRegistryIdList": {
  180. "base": null,
  181. "refs": {
  182. "GetAuthorizationTokenRequest$registryIds": "<p>A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed.</p>"
  183. }
  184. },
  185. "GetAuthorizationTokenRequest": {
  186. "base": null,
  187. "refs": {
  188. }
  189. },
  190. "GetAuthorizationTokenResponse": {
  191. "base": null,
  192. "refs": {
  193. }
  194. },
  195. "GetDownloadUrlForLayerRequest": {
  196. "base": null,
  197. "refs": {
  198. }
  199. },
  200. "GetDownloadUrlForLayerResponse": {
  201. "base": null,
  202. "refs": {
  203. }
  204. },
  205. "GetRepositoryPolicyRequest": {
  206. "base": null,
  207. "refs": {
  208. }
  209. },
  210. "GetRepositoryPolicyResponse": {
  211. "base": null,
  212. "refs": {
  213. }
  214. },
  215. "Image": {
  216. "base": "<p>An object representing an Amazon ECR image.</p>",
  217. "refs": {
  218. "ImageList$member": null,
  219. "PutImageResponse$image": "<p>Details of the image uploaded.</p>"
  220. }
  221. },
  222. "ImageAlreadyExistsException": {
  223. "base": "<p>The specified image has already been pushed, and there are no changes to the manifest or image tag since the last push.</p>",
  224. "refs": {
  225. }
  226. },
  227. "ImageDigest": {
  228. "base": null,
  229. "refs": {
  230. "ImageIdentifier$imageDigest": "<p>The <code>sha256</code> digest of the image manifest.</p>"
  231. }
  232. },
  233. "ImageFailure": {
  234. "base": "<p>An object representing an Amazon ECR image failure.</p>",
  235. "refs": {
  236. "ImageFailureList$member": null
  237. }
  238. },
  239. "ImageFailureCode": {
  240. "base": null,
  241. "refs": {
  242. "ImageFailure$failureCode": "<p>The code associated with the failure.</p>"
  243. }
  244. },
  245. "ImageFailureList": {
  246. "base": null,
  247. "refs": {
  248. "BatchDeleteImageResponse$failures": "<p>Any failures associated with the call.</p>",
  249. "BatchGetImageResponse$failures": "<p>Any failures associated with the call.</p>"
  250. }
  251. },
  252. "ImageFailureReason": {
  253. "base": null,
  254. "refs": {
  255. "ImageFailure$failureReason": "<p>The reason for the failure.</p>"
  256. }
  257. },
  258. "ImageIdentifier": {
  259. "base": "<p>An object with identifying information for an Amazon ECR image.</p>",
  260. "refs": {
  261. "Image$imageId": "<p>An object containing the image tag and image digest associated with an image.</p>",
  262. "ImageFailure$imageId": "<p>The image ID associated with the failure.</p>",
  263. "ImageIdentifierList$member": null
  264. }
  265. },
  266. "ImageIdentifierList": {
  267. "base": null,
  268. "refs": {
  269. "BatchDeleteImageRequest$imageIds": "<p>A list of image ID references that correspond to images to delete. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</p>",
  270. "BatchDeleteImageResponse$imageIds": "<p>The image IDs of the deleted images.</p>",
  271. "BatchGetImageRequest$imageIds": "<p>A list of image ID references that correspond to images to describe. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</p>",
  272. "ListImagesResponse$imageIds": "<p>The list of image IDs for the requested repository.</p>"
  273. }
  274. },
  275. "ImageList": {
  276. "base": null,
  277. "refs": {
  278. "BatchGetImageResponse$images": "<p>A list of image objects corresponding to the image references in the request.</p>"
  279. }
  280. },
  281. "ImageManifest": {
  282. "base": null,
  283. "refs": {
  284. "Image$imageManifest": "<p>The image manifest associated with the image.</p>",
  285. "PutImageRequest$imageManifest": "<p>The image manifest corresponding to the image to be uploaded.</p>"
  286. }
  287. },
  288. "ImageTag": {
  289. "base": null,
  290. "refs": {
  291. "ImageIdentifier$imageTag": "<p>The tag used for the image.</p>"
  292. }
  293. },
  294. "InitiateLayerUploadRequest": {
  295. "base": null,
  296. "refs": {
  297. }
  298. },
  299. "InitiateLayerUploadResponse": {
  300. "base": null,
  301. "refs": {
  302. }
  303. },
  304. "InvalidLayerException": {
  305. "base": "<p>The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.</p>",
  306. "refs": {
  307. }
  308. },
  309. "InvalidLayerPartException": {
  310. "base": "<p>The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.</p>",
  311. "refs": {
  312. }
  313. },
  314. "InvalidParameterException": {
  315. "base": "<p>The specified parameter is invalid. Review the available parameters for the API request.</p>",
  316. "refs": {
  317. }
  318. },
  319. "Layer": {
  320. "base": "<p>An object representing an Amazon ECR image layer.</p>",
  321. "refs": {
  322. "LayerList$member": null
  323. }
  324. },
  325. "LayerAlreadyExistsException": {
  326. "base": "<p>The image layer already exists in the associated repository.</p>",
  327. "refs": {
  328. }
  329. },
  330. "LayerAvailability": {
  331. "base": null,
  332. "refs": {
  333. "Layer$layerAvailability": "<p>The availability status of the image layer. Valid values are <code>AVAILABLE</code> and <code>UNAVAILABLE</code>.</p>"
  334. }
  335. },
  336. "LayerDigest": {
  337. "base": null,
  338. "refs": {
  339. "CompleteLayerUploadResponse$layerDigest": "<p>The <code>sha256</code> digest of the image layer.</p>",
  340. "GetDownloadUrlForLayerRequest$layerDigest": "<p>The digest of the image layer to download.</p>",
  341. "GetDownloadUrlForLayerResponse$layerDigest": "<p>The digest of the image layer to download.</p>",
  342. "Layer$layerDigest": "<p>The <code>sha256</code> digest of the image layer.</p>",
  343. "LayerDigestList$member": null
  344. }
  345. },
  346. "LayerDigestList": {
  347. "base": null,
  348. "refs": {
  349. "CompleteLayerUploadRequest$layerDigests": "<p>The <code>sha256</code> digest of the image layer.</p>"
  350. }
  351. },
  352. "LayerFailure": {
  353. "base": "<p>An object representing an Amazon ECR image layer failure.</p>",
  354. "refs": {
  355. "LayerFailureList$member": null
  356. }
  357. },
  358. "LayerFailureCode": {
  359. "base": null,
  360. "refs": {
  361. "LayerFailure$failureCode": "<p>The failure code associated with the failure.</p>"
  362. }
  363. },
  364. "LayerFailureList": {
  365. "base": null,
  366. "refs": {
  367. "BatchCheckLayerAvailabilityResponse$failures": "<p>Any failures associated with the call.</p>"
  368. }
  369. },
  370. "LayerFailureReason": {
  371. "base": null,
  372. "refs": {
  373. "LayerFailure$failureReason": "<p>The reason for the failure.</p>"
  374. }
  375. },
  376. "LayerInaccessibleException": {
  377. "base": "<p>The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.</p>",
  378. "refs": {
  379. }
  380. },
  381. "LayerList": {
  382. "base": null,
  383. "refs": {
  384. "BatchCheckLayerAvailabilityResponse$layers": "<p>A list of image layer objects corresponding to the image layer references in the request.</p>"
  385. }
  386. },
  387. "LayerPartBlob": {
  388. "base": null,
  389. "refs": {
  390. "UploadLayerPartRequest$layerPartBlob": "<p>The base64-encoded layer part payload.</p>"
  391. }
  392. },
  393. "LayerPartTooSmallException": {
  394. "base": "<p>Layer parts must be at least 5 MiB in size.</p>",
  395. "refs": {
  396. }
  397. },
  398. "LayerSizeInBytes": {
  399. "base": null,
  400. "refs": {
  401. "Layer$layerSize": "<p>The size, in bytes, of the image layer.</p>"
  402. }
  403. },
  404. "LayersNotFoundException": {
  405. "base": "<p>The specified layers could not be found, or the specified layer is not valid for this repository.</p>",
  406. "refs": {
  407. }
  408. },
  409. "LimitExceededException": {
  410. "base": "<p>The operation did not succeed because it would have exceeded a service limit for your account. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECR/latest/userguide/service_limits.html\">Amazon ECR Default Service Limits</a> in the Amazon EC2 Container Registry User Guide.</p>",
  411. "refs": {
  412. }
  413. },
  414. "ListImagesFilter": {
  415. "base": null,
  416. "refs": {
  417. "ListImagesRequest$filter": null
  418. }
  419. },
  420. "ListImagesRequest": {
  421. "base": null,
  422. "refs": {
  423. }
  424. },
  425. "ListImagesResponse": {
  426. "base": null,
  427. "refs": {
  428. }
  429. },
  430. "MaxResults": {
  431. "base": null,
  432. "refs": {
  433. "DescribeRepositoriesRequest$maxResults": "<p>The maximum number of repository results returned by <code>DescribeRepositories</code> in paginated output. When this parameter is used, <code>DescribeRepositories</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeRepositories</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeRepositories</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>",
  434. "ListImagesRequest$maxResults": "<p>The maximum number of image results returned by <code>ListImages</code> in paginated output. When this parameter is used, <code>ListImages</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>"
  435. }
  436. },
  437. "NextToken": {
  438. "base": null,
  439. "refs": {
  440. "DescribeRepositoriesRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeRepositories</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
  441. "DescribeRepositoriesResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>DescribeRepositories</code> request. When the results of a <code>DescribeRepositories</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
  442. "ListImagesRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>ListImages</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
  443. "ListImagesResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListImages</code> request. When the results of a <code>ListImages</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
  444. }
  445. },
  446. "PartSize": {
  447. "base": null,
  448. "refs": {
  449. "InitiateLayerUploadResponse$partSize": "<p>The size, in bytes, that Amazon ECR expects future layer part uploads to be.</p>",
  450. "InvalidLayerPartException$lastValidByteReceived": "<p>The last valid byte received from the layer part upload that is associated with the exception.</p>",
  451. "UploadLayerPartRequest$partFirstByte": "<p>The integer value of the first byte of the layer part.</p>",
  452. "UploadLayerPartRequest$partLastByte": "<p>The integer value of the last byte of the layer part.</p>",
  453. "UploadLayerPartResponse$lastByteReceived": "<p>The integer value of the last byte received in the request.</p>"
  454. }
  455. },
  456. "ProxyEndpoint": {
  457. "base": null,
  458. "refs": {
  459. "AuthorizationData$proxyEndpoint": "<p>The registry URL to use for this authorization token in a <code>docker login</code> command. The Amazon ECR registry URL format is <code>https://aws_account_id.dkr.ecr.region.amazonaws.com</code>. For example, <code>https://012345678910.dkr.ecr.us-east-1.amazonaws.com</code>.. </p>"
  460. }
  461. },
  462. "PutImageRequest": {
  463. "base": null,
  464. "refs": {
  465. }
  466. },
  467. "PutImageResponse": {
  468. "base": null,
  469. "refs": {
  470. }
  471. },
  472. "RegistryId": {
  473. "base": null,
  474. "refs": {
  475. "BatchCheckLayerAvailabilityRequest$registryId": "<p>The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.</p>",
  476. "BatchDeleteImageRequest$registryId": "<p>The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.</p>",
  477. "BatchGetImageRequest$registryId": "<p>The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.</p>",
  478. "CompleteLayerUploadRequest$registryId": "<p>The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.</p>",
  479. "CompleteLayerUploadResponse$registryId": "<p>The registry ID associated with the request.</p>",
  480. "DeleteRepositoryPolicyRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.</p>",
  481. "DeleteRepositoryPolicyResponse$registryId": "<p>The registry ID associated with the request.</p>",
  482. "DeleteRepositoryRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.</p>",
  483. "DescribeRepositoriesRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.</p>",
  484. "GetAuthorizationTokenRegistryIdList$member": null,
  485. "GetDownloadUrlForLayerRequest$registryId": "<p>The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.</p>",
  486. "GetRepositoryPolicyRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>",
  487. "GetRepositoryPolicyResponse$registryId": "<p>The registry ID associated with the request.</p>",
  488. "Image$registryId": "<p>The AWS account ID associated with the registry containing the image.</p>",
  489. "InitiateLayerUploadRequest$registryId": "<p>The AWS account ID associated with the registry that you intend to upload layers to. If you do not specify a registry, the default registry is assumed.</p>",
  490. "InvalidLayerPartException$registryId": "<p>The registry ID associated with the exception.</p>",
  491. "ListImagesRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository to list images in. If you do not specify a registry, the default registry is assumed.</p>",
  492. "PutImageRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.</p>",
  493. "Repository$registryId": "<p>The AWS account ID associated with the registry that contains the repository.</p>",
  494. "SetRepositoryPolicyRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>",
  495. "SetRepositoryPolicyResponse$registryId": "<p>The registry ID associated with the request.</p>",
  496. "UploadLayerPartRequest$registryId": "<p>The AWS account ID associated with the registry that you are uploading layer parts to. If you do not specify a registry, the default registry is assumed.</p>",
  497. "UploadLayerPartResponse$registryId": "<p>The registry ID associated with the request.</p>"
  498. }
  499. },
  500. "Repository": {
  501. "base": "<p>An object representing a repository.</p>",
  502. "refs": {
  503. "CreateRepositoryResponse$repository": null,
  504. "DeleteRepositoryResponse$repository": null,
  505. "RepositoryList$member": null
  506. }
  507. },
  508. "RepositoryAlreadyExistsException": {
  509. "base": "<p>The specified repository already exists in the specified registry.</p>",
  510. "refs": {
  511. }
  512. },
  513. "RepositoryList": {
  514. "base": null,
  515. "refs": {
  516. "DescribeRepositoriesResponse$repositories": "<p>A list of repository objects corresponding to valid repositories.</p>"
  517. }
  518. },
  519. "RepositoryName": {
  520. "base": null,
  521. "refs": {
  522. "BatchCheckLayerAvailabilityRequest$repositoryName": "<p>The name of the repository that is associated with the image layers to check.</p>",
  523. "BatchDeleteImageRequest$repositoryName": "<p>The repository that contains the image to delete.</p>",
  524. "BatchGetImageRequest$repositoryName": "<p>The repository that contains the images to describe.</p>",
  525. "CompleteLayerUploadRequest$repositoryName": "<p>The name of the repository to associate with the image layer.</p>",
  526. "CompleteLayerUploadResponse$repositoryName": "<p>The repository name associated with the request.</p>",
  527. "CreateRepositoryRequest$repositoryName": "<p>The name to use for the repository. The repository name may be specified on its own (such as <code>nginx-web-app</code>) or it can be prepended with a namespace to group the repository into a category (such as <code>project-a/nginx-web-app</code>).</p>",
  528. "DeleteRepositoryPolicyRequest$repositoryName": "<p>The name of the repository that is associated with the repository policy to delete.</p>",
  529. "DeleteRepositoryPolicyResponse$repositoryName": "<p>The repository name associated with the request.</p>",
  530. "DeleteRepositoryRequest$repositoryName": "<p>The name of the repository to delete.</p>",
  531. "GetDownloadUrlForLayerRequest$repositoryName": "<p>The name of the repository that is associated with the image layer to download.</p>",
  532. "GetRepositoryPolicyRequest$repositoryName": "<p>The name of the repository whose policy you want to retrieve.</p>",
  533. "GetRepositoryPolicyResponse$repositoryName": "<p>The repository name associated with the request.</p>",
  534. "Image$repositoryName": "<p>The name of the repository associated with the image.</p>",
  535. "InitiateLayerUploadRequest$repositoryName": "<p>The name of the repository that you intend to upload layers to.</p>",
  536. "InvalidLayerPartException$repositoryName": "<p>The repository name associated with the exception.</p>",
  537. "ListImagesRequest$repositoryName": "<p>The repository whose image IDs are to be listed.</p>",
  538. "PutImageRequest$repositoryName": "<p>The name of the repository in which to put the image.</p>",
  539. "Repository$repositoryName": "<p>The name of the repository.</p>",
  540. "RepositoryNameList$member": null,
  541. "SetRepositoryPolicyRequest$repositoryName": "<p>The name of the repository to receive the policy.</p>",
  542. "SetRepositoryPolicyResponse$repositoryName": "<p>The repository name associated with the request.</p>",
  543. "UploadLayerPartRequest$repositoryName": "<p>The name of the repository that you are uploading layer parts to.</p>",
  544. "UploadLayerPartResponse$repositoryName": "<p>The repository name associated with the request.</p>"
  545. }
  546. },
  547. "RepositoryNameList": {
  548. "base": null,
  549. "refs": {
  550. "DescribeRepositoriesRequest$repositoryNames": "<p>A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.</p>"
  551. }
  552. },
  553. "RepositoryNotEmptyException": {
  554. "base": "<p>The specified repository contains images. To delete a repository that contains images, you must force the deletion with the <code>force</code> parameter.</p>",
  555. "refs": {
  556. }
  557. },
  558. "RepositoryNotFoundException": {
  559. "base": "<p>The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.</p>",
  560. "refs": {
  561. }
  562. },
  563. "RepositoryPolicyNotFoundException": {
  564. "base": "<p>The specified repository and registry combination does not have an associated repository policy.</p>",
  565. "refs": {
  566. }
  567. },
  568. "RepositoryPolicyText": {
  569. "base": null,
  570. "refs": {
  571. "DeleteRepositoryPolicyResponse$policyText": "<p>The JSON repository policy that was deleted from the repository.</p>",
  572. "GetRepositoryPolicyResponse$policyText": "<p>The JSON repository policy text associated with the repository.</p>",
  573. "SetRepositoryPolicyRequest$policyText": "<p>The JSON repository policy text to apply to the repository.</p>",
  574. "SetRepositoryPolicyResponse$policyText": "<p>The JSON repository policy text applied to the repository.</p>"
  575. }
  576. },
  577. "ServerException": {
  578. "base": "<p>These errors are usually caused by a server-side issue.</p>",
  579. "refs": {
  580. }
  581. },
  582. "SetRepositoryPolicyRequest": {
  583. "base": null,
  584. "refs": {
  585. }
  586. },
  587. "SetRepositoryPolicyResponse": {
  588. "base": null,
  589. "refs": {
  590. }
  591. },
  592. "TagStatus": {
  593. "base": null,
  594. "refs": {
  595. "ListImagesFilter$tagStatus": null
  596. }
  597. },
  598. "UploadId": {
  599. "base": null,
  600. "refs": {
  601. "CompleteLayerUploadRequest$uploadId": "<p>The upload ID from a previous <a>InitiateLayerUpload</a> operation to associate with the image layer.</p>",
  602. "CompleteLayerUploadResponse$uploadId": "<p>The upload ID associated with the layer.</p>",
  603. "InitiateLayerUploadResponse$uploadId": "<p>The upload ID for the layer upload. This parameter is passed to further <a>UploadLayerPart</a> and <a>CompleteLayerUpload</a> operations.</p>",
  604. "InvalidLayerPartException$uploadId": "<p>The upload ID associated with the exception.</p>",
  605. "UploadLayerPartRequest$uploadId": "<p>The upload ID from a previous <a>InitiateLayerUpload</a> operation to associate with the layer part upload.</p>",
  606. "UploadLayerPartResponse$uploadId": "<p>The upload ID associated with the request.</p>"
  607. }
  608. },
  609. "UploadLayerPartRequest": {
  610. "base": null,
  611. "refs": {
  612. }
  613. },
  614. "UploadLayerPartResponse": {
  615. "base": null,
  616. "refs": {
  617. }
  618. },
  619. "UploadNotFoundException": {
  620. "base": "<p>The upload could not be found, or the specified upload id is not valid for this repository.</p>",
  621. "refs": {
  622. }
  623. },
  624. "Url": {
  625. "base": null,
  626. "refs": {
  627. "GetDownloadUrlForLayerResponse$downloadUrl": "<p>The pre-signed Amazon S3 download URL for the requested layer.</p>",
  628. "Repository$repositoryUri": "<p>The URI for the repository. You can use this URI for Docker <code>push</code> and <code>pull</code> operations.</p>"
  629. }
  630. }
  631. }
  632. }