ecr-2015-09-21.examples.json 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. {
  2. "version": "1.0",
  3. "examples": {
  4. "BatchDeleteImage": [
  5. {
  6. "input": {
  7. "imageIds": [
  8. {
  9. "imageTag": "precise"
  10. }
  11. ],
  12. "repositoryName": "ubuntu"
  13. },
  14. "output": {
  15. "failures": [
  16. ],
  17. "imageIds": [
  18. {
  19. "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f",
  20. "imageTag": "precise"
  21. }
  22. ]
  23. },
  24. "comments": {
  25. },
  26. "description": "This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.",
  27. "id": "batchdeleteimages-example-1470860541707",
  28. "title": "To delete multiple images"
  29. }
  30. ],
  31. "BatchGetImage": [
  32. {
  33. "input": {
  34. "imageIds": [
  35. {
  36. "imageTag": "precise"
  37. }
  38. ],
  39. "repositoryName": "ubuntu"
  40. },
  41. "output": {
  42. "failures": [
  43. ],
  44. "images": [
  45. {
  46. "imageId": {
  47. "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a",
  48. "imageTag": "precise"
  49. },
  50. "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...",
  51. "registryId": "244698725403",
  52. "repositoryName": "ubuntu"
  53. }
  54. ]
  55. },
  56. "comments": {
  57. "output": {
  58. "imageManifest": "In this example, the imageManifest in the output JSON has been truncated."
  59. }
  60. },
  61. "description": "This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.",
  62. "id": "batchgetimage-example-1470862771437",
  63. "title": "To obtain multiple images in a single request"
  64. }
  65. ],
  66. "CreateRepository": [
  67. {
  68. "input": {
  69. "repositoryName": "project-a/nginx-web-app"
  70. },
  71. "output": {
  72. "repository": {
  73. "registryId": "012345678901",
  74. "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app",
  75. "repositoryName": "project-a/nginx-web-app"
  76. }
  77. },
  78. "comments": {
  79. "output": {
  80. "imageManifest": "In this example, the imageManifest in the output JSON has been truncated."
  81. }
  82. },
  83. "description": "This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.",
  84. "id": "createrepository-example-1470863688724",
  85. "title": "To create a new repository"
  86. }
  87. ],
  88. "DeleteRepository": [
  89. {
  90. "input": {
  91. "force": true,
  92. "repositoryName": "ubuntu"
  93. },
  94. "output": {
  95. "repository": {
  96. "registryId": "012345678901",
  97. "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/ubuntu",
  98. "repositoryName": "ubuntu"
  99. }
  100. },
  101. "comments": {
  102. "output": {
  103. "imageManifest": "In this example, the imageManifest in the output JSON has been truncated."
  104. }
  105. },
  106. "description": "This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.",
  107. "id": "deleterepository-example-1470863805703",
  108. "title": "To force delete a repository"
  109. }
  110. ],
  111. "DeleteRepositoryPolicy": [
  112. {
  113. "input": {
  114. "repositoryName": "ubuntu"
  115. },
  116. "output": {
  117. "policyText": "{ ... }",
  118. "registryId": "012345678901",
  119. "repositoryName": "ubuntu"
  120. },
  121. "comments": {
  122. },
  123. "description": "This example deletes the policy associated with the repository named ubuntu in the current account.",
  124. "id": "deleterepositorypolicy-example-1470866943748",
  125. "title": "To delete the policy associated with a repository"
  126. }
  127. ],
  128. "DescribeRepositories": [
  129. {
  130. "input": {
  131. },
  132. "output": {
  133. "repositories": [
  134. {
  135. "registryId": "012345678910",
  136. "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu",
  137. "repositoryName": "ubuntu"
  138. },
  139. {
  140. "registryId": "012345678910",
  141. "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test",
  142. "repositoryName": "test"
  143. }
  144. ]
  145. },
  146. "comments": {
  147. "output": {
  148. }
  149. },
  150. "description": "The following example obtains a list and description of all repositories in the default registry to which the current user has access.",
  151. "id": "describe-repositories-1470856017467",
  152. "title": "To describe all repositories in the current account"
  153. }
  154. ],
  155. "GetAuthorizationToken": [
  156. {
  157. "input": {
  158. },
  159. "output": {
  160. "authorizationData": [
  161. {
  162. "authorizationToken": "QVdTOkNEXAMPLE",
  163. "expiresAt": "2022-05-17T06:56:13.652000+00:00",
  164. "proxyEndpoint": "https://012345678901.dkr.ecr.us-west-2.amazonaws.com"
  165. }
  166. ]
  167. },
  168. "comments": {
  169. },
  170. "description": "This example gets an authorization token for your default registry.",
  171. "id": "getauthorizationtoken-example-1470867047084",
  172. "title": "To obtain an authorization token"
  173. }
  174. ],
  175. "GetRepositoryPolicy": [
  176. {
  177. "input": {
  178. "repositoryName": "ubuntu"
  179. },
  180. "output": {
  181. "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"new statement\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::012345678901:role/CodeDeployDemo\"\n },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}",
  182. "registryId": "012345678901",
  183. "repositoryName": "ubuntu"
  184. },
  185. "comments": {
  186. },
  187. "description": "This example obtains the repository policy for the repository named ubuntu.",
  188. "id": "getrepositorypolicy-example-1470867669211",
  189. "title": "To get the current policy for a repository"
  190. }
  191. ],
  192. "ListImages": [
  193. {
  194. "input": {
  195. "repositoryName": "ubuntu"
  196. },
  197. "output": {
  198. "imageIds": [
  199. {
  200. "imageDigest": "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a",
  201. "imageTag": "precise"
  202. }
  203. ]
  204. },
  205. "comments": {
  206. },
  207. "description": "This example lists all of the images in the repository named ubuntu in the default registry in the current account. ",
  208. "id": "listimages-example-1470868161594",
  209. "title": "To list all images in a repository"
  210. }
  211. ]
  212. }
  213. }