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