@aws-sdk/client-ecr 3.288.0 → 3.290.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/BatchCheckLayerAvailabilityCommand.d.ts +12 -0
- package/dist-types/commands/BatchDeleteImageCommand.d.ts +39 -0
- package/dist-types/commands/BatchGetImageCommand.d.ts +44 -0
- package/dist-types/commands/BatchGetRepositoryScanningConfigurationCommand.d.ts +15 -0
- package/dist-types/commands/CompleteLayerUploadCommand.d.ts +32 -0
- package/dist-types/commands/CreatePullThroughCacheRuleCommand.d.ts +23 -0
- package/dist-types/commands/CreateRepositoryCommand.d.ts +47 -0
- package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +16 -0
- package/dist-types/commands/DeletePullThroughCacheRuleCommand.d.ts +15 -0
- package/dist-types/commands/DeleteRegistryPolicyCommand.d.ts +14 -0
- package/dist-types/commands/DeleteRepositoryCommand.d.ts +40 -0
- package/dist-types/commands/DeleteRepositoryPolicyCommand.d.ts +34 -0
- package/dist-types/commands/DescribeImageReplicationStatusCommand.d.ts +18 -0
- package/dist-types/commands/DescribeImageScanFindingsCommand.d.ts +22 -0
- package/dist-types/commands/DescribeImagesCommand.d.ts +15 -0
- package/dist-types/commands/DescribePullThroughCacheRulesCommand.d.ts +15 -0
- package/dist-types/commands/DescribeRegistryCommand.d.ts +11 -0
- package/dist-types/commands/DescribeRepositoriesCommand.d.ts +37 -0
- package/dist-types/commands/GetAuthorizationTokenCommand.d.ts +28 -0
- package/dist-types/commands/GetDownloadUrlForLayerCommand.d.ts +20 -0
- package/dist-types/commands/GetLifecyclePolicyCommand.d.ts +16 -0
- package/dist-types/commands/GetLifecyclePolicyPreviewCommand.d.ts +15 -0
- package/dist-types/commands/GetRegistryPolicyCommand.d.ts +14 -0
- package/dist-types/commands/GetRegistryScanningConfigurationCommand.d.ts +11 -0
- package/dist-types/commands/GetRepositoryPolicyCommand.d.ts +34 -0
- package/dist-types/commands/InitiateLayerUploadCommand.d.ts +15 -0
- package/dist-types/commands/ListImagesCommand.d.ts +33 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
- package/dist-types/commands/PutImageCommand.d.ts +39 -0
- package/dist-types/commands/PutImageScanningConfigurationCommand.d.ts +15 -0
- package/dist-types/commands/PutImageTagMutabilityCommand.d.ts +12 -0
- package/dist-types/commands/PutLifecyclePolicyCommand.d.ts +12 -0
- package/dist-types/commands/PutRegistryPolicyCommand.d.ts +11 -0
- package/dist-types/commands/PutRegistryScanningConfigurationCommand.d.ts +11 -0
- package/dist-types/commands/PutReplicationConfigurationCommand.d.ts +11 -0
- package/dist-types/commands/SetRepositoryPolicyCommand.d.ts +12 -0
- package/dist-types/commands/StartImageScanCommand.d.ts +26 -0
- package/dist-types/commands/StartLifecyclePolicyPreviewCommand.d.ts +20 -0
- package/dist-types/commands/TagResourceCommand.d.ts +20 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +20 -0
- package/dist-types/commands/UploadLayerPartCommand.d.ts +28 -0
- package/package.json +30 -30
|
@@ -36,6 +36,18 @@ export interface BatchCheckLayerAvailabilityCommandOutput extends BatchCheckLaye
|
|
|
36
36
|
* @see {@link BatchCheckLayerAvailabilityCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
40
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
41
|
+
* request.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
44
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
45
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServerException} (server fault)
|
|
48
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
39
51
|
*/
|
|
40
52
|
export declare class BatchCheckLayerAvailabilityCommand extends $Command<BatchCheckLayerAvailabilityCommandInput, BatchCheckLayerAvailabilityCommandOutput, ECRClientResolvedConfig> {
|
|
41
53
|
readonly input: BatchCheckLayerAvailabilityCommandInput;
|
|
@@ -34,6 +34,45 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse,
|
|
|
34
34
|
* @see {@link BatchDeleteImageCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
38
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
39
|
+
* request.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
42
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
43
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link ServerException} (server fault)
|
|
46
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example To delete multiple images
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "imageIds": [
|
|
54
|
+
* {
|
|
55
|
+
* "imageTag": "precise"
|
|
56
|
+
* }
|
|
57
|
+
* ],
|
|
58
|
+
* "repositoryName": "ubuntu"
|
|
59
|
+
* };
|
|
60
|
+
* const command = new BatchDeleteImageCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* /* response ==
|
|
63
|
+
* {
|
|
64
|
+
* "failures": [],
|
|
65
|
+
* "imageIds": [
|
|
66
|
+
* {
|
|
67
|
+
* "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f",
|
|
68
|
+
* "imageTag": "precise"
|
|
69
|
+
* }
|
|
70
|
+
* ]
|
|
71
|
+
* }
|
|
72
|
+
* *\/
|
|
73
|
+
* // example id: batchdeleteimages-example-1470860541707
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
37
76
|
*/
|
|
38
77
|
export declare class BatchDeleteImageCommand extends $Command<BatchDeleteImageCommandInput, BatchDeleteImageCommandOutput, ECRClientResolvedConfig> {
|
|
39
78
|
readonly input: BatchDeleteImageCommandInput;
|
|
@@ -32,6 +32,50 @@ export interface BatchGetImageCommandOutput extends BatchGetImageResponse, __Met
|
|
|
32
32
|
* @see {@link BatchGetImageCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
36
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
37
|
+
* request.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
40
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
41
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ServerException} (server fault)
|
|
44
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
47
|
+
* @example To obtain multiple images in a single request
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.
|
|
50
|
+
* const input = {
|
|
51
|
+
* "imageIds": [
|
|
52
|
+
* {
|
|
53
|
+
* "imageTag": "precise"
|
|
54
|
+
* }
|
|
55
|
+
* ],
|
|
56
|
+
* "repositoryName": "ubuntu"
|
|
57
|
+
* };
|
|
58
|
+
* const command = new BatchGetImageCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* /* response ==
|
|
61
|
+
* {
|
|
62
|
+
* "failures": [],
|
|
63
|
+
* "images": [
|
|
64
|
+
* {
|
|
65
|
+
* "imageId": {
|
|
66
|
+
* "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a",
|
|
67
|
+
* "imageTag": "precise"
|
|
68
|
+
* },
|
|
69
|
+
* "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...",
|
|
70
|
+
* "registryId": "244698725403",
|
|
71
|
+
* "repositoryName": "ubuntu"
|
|
72
|
+
* }
|
|
73
|
+
* ]
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: batchgetimage-example-1470862771437
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
35
79
|
*/
|
|
36
80
|
export declare class BatchGetImageCommand extends $Command<BatchGetImageCommandInput, BatchGetImageCommandOutput, ECRClientResolvedConfig> {
|
|
37
81
|
readonly input: BatchGetImageCommandInput;
|
|
@@ -29,6 +29,21 @@ export interface BatchGetRepositoryScanningConfigurationCommandOutput extends Ba
|
|
|
29
29
|
* @see {@link BatchGetRepositoryScanningConfigurationCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
33
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
34
|
+
* request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
37
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
38
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link ServerException} (server fault)
|
|
41
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ValidationException} (client fault)
|
|
44
|
+
* <p>There was an exception validating this request.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
32
47
|
*/
|
|
33
48
|
export declare class BatchGetRepositoryScanningConfigurationCommand extends $Command<BatchGetRepositoryScanningConfigurationCommandInput, BatchGetRepositoryScanningConfigurationCommandOutput, ECRClientResolvedConfig> {
|
|
34
49
|
readonly input: BatchGetRepositoryScanningConfigurationCommandInput;
|
|
@@ -37,6 +37,38 @@ export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadRes
|
|
|
37
37
|
* @see {@link CompleteLayerUploadCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link EmptyUploadException} (client fault)
|
|
41
|
+
* <p>The specified layer upload does not contain any layer parts.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidLayerException} (client fault)
|
|
44
|
+
* <p>The layer digest calculation performed by Amazon ECR upon receipt of the image layer does
|
|
45
|
+
* not match the digest specified.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
48
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
49
|
+
* request.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link KmsException} (client fault)
|
|
52
|
+
* <p>The operation failed due to a KMS exception.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link LayerAlreadyExistsException} (client fault)
|
|
55
|
+
* <p>The image layer already exists in the associated repository.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link LayerPartTooSmallException} (client fault)
|
|
58
|
+
* <p>Layer parts must be at least 5 MiB in size.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
61
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
62
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ServerException} (server fault)
|
|
65
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link UploadNotFoundException} (client fault)
|
|
68
|
+
* <p>The upload could not be found, or the specified upload ID is not valid for this
|
|
69
|
+
* repository.</p>
|
|
70
|
+
*
|
|
71
|
+
*
|
|
40
72
|
*/
|
|
41
73
|
export declare class CompleteLayerUploadCommand extends $Command<CompleteLayerUploadCommandInput, CompleteLayerUploadCommandOutput, ECRClientResolvedConfig> {
|
|
42
74
|
readonly input: CompleteLayerUploadCommandInput;
|
|
@@ -30,6 +30,29 @@ export interface CreatePullThroughCacheRuleCommandOutput extends CreatePullThrou
|
|
|
30
30
|
* @see {@link CreatePullThroughCacheRuleCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
34
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
35
|
+
* request.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
38
|
+
* <p>The operation did not succeed because it would have exceeded a service limit for your
|
|
39
|
+
* account. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html">Amazon ECR service quotas</a> in
|
|
40
|
+
* the Amazon Elastic Container Registry User Guide.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link PullThroughCacheRuleAlreadyExistsException} (client fault)
|
|
43
|
+
* <p>A pull through cache rule with these settings already exists for the private
|
|
44
|
+
* registry.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link ServerException} (server fault)
|
|
47
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link UnsupportedUpstreamRegistryException} (client fault)
|
|
50
|
+
* <p>The specified upstream registry isn't supported.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ValidationException} (client fault)
|
|
53
|
+
* <p>There was an exception validating this request.</p>
|
|
54
|
+
*
|
|
55
|
+
*
|
|
33
56
|
*/
|
|
34
57
|
export declare class CreatePullThroughCacheRuleCommand extends $Command<CreatePullThroughCacheRuleCommandInput, CreatePullThroughCacheRuleCommandOutput, ECRClientResolvedConfig> {
|
|
35
58
|
readonly input: CreatePullThroughCacheRuleCommandInput;
|
|
@@ -30,6 +30,53 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResponse,
|
|
|
30
30
|
* @see {@link CreateRepositoryCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
34
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
35
|
+
* request.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidTagParameterException} (client fault)
|
|
38
|
+
* <p>An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have
|
|
39
|
+
* a maximum length of 256 characters.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link KmsException} (client fault)
|
|
42
|
+
* <p>The operation failed due to a KMS exception.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
45
|
+
* <p>The operation did not succeed because it would have exceeded a service limit for your
|
|
46
|
+
* account. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html">Amazon ECR service quotas</a> in
|
|
47
|
+
* the Amazon Elastic Container Registry User Guide.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link RepositoryAlreadyExistsException} (client fault)
|
|
50
|
+
* <p>The specified repository already exists in the specified registry.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ServerException} (server fault)
|
|
53
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link TooManyTagsException} (client fault)
|
|
56
|
+
* <p>The list of tags on the repository is over the limit. The maximum number of tags that
|
|
57
|
+
* can be applied to a repository is 50.</p>
|
|
58
|
+
*
|
|
59
|
+
*
|
|
60
|
+
* @example To create a new repository
|
|
61
|
+
* ```javascript
|
|
62
|
+
* // This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.
|
|
63
|
+
* const input = {
|
|
64
|
+
* "repositoryName": "project-a/nginx-web-app"
|
|
65
|
+
* };
|
|
66
|
+
* const command = new CreateRepositoryCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "repository": {
|
|
71
|
+
* "registryId": "012345678901",
|
|
72
|
+
* "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app",
|
|
73
|
+
* "repositoryName": "project-a/nginx-web-app"
|
|
74
|
+
* }
|
|
75
|
+
* }
|
|
76
|
+
* *\/
|
|
77
|
+
* // example id: createrepository-example-1470863688724
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
33
80
|
*/
|
|
34
81
|
export declare class CreateRepositoryCommand extends $Command<CreateRepositoryCommandInput, CreateRepositoryCommandOutput, ECRClientResolvedConfig> {
|
|
35
82
|
readonly input: CreateRepositoryCommandInput;
|
|
@@ -29,6 +29,22 @@ export interface DeleteLifecyclePolicyCommandOutput extends DeleteLifecyclePolic
|
|
|
29
29
|
* @see {@link DeleteLifecyclePolicyCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
33
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
34
|
+
* request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link LifecyclePolicyNotFoundException} (client fault)
|
|
37
|
+
* <p>The lifecycle policy could not be found, and no policy is set to the
|
|
38
|
+
* repository.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
41
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
42
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link ServerException} (server fault)
|
|
45
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
32
48
|
*/
|
|
33
49
|
export declare class DeleteLifecyclePolicyCommand extends $Command<DeleteLifecyclePolicyCommandInput, DeleteLifecyclePolicyCommandOutput, ECRClientResolvedConfig> {
|
|
34
50
|
readonly input: DeleteLifecyclePolicyCommandInput;
|
|
@@ -29,6 +29,21 @@ export interface DeletePullThroughCacheRuleCommandOutput extends DeletePullThrou
|
|
|
29
29
|
* @see {@link DeletePullThroughCacheRuleCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
33
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
34
|
+
* request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link PullThroughCacheRuleNotFoundException} (client fault)
|
|
37
|
+
* <p>The pull through cache rule was not found. Specify a valid pull through cache rule and
|
|
38
|
+
* try again.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link ServerException} (server fault)
|
|
41
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ValidationException} (client fault)
|
|
44
|
+
* <p>There was an exception validating this request.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
32
47
|
*/
|
|
33
48
|
export declare class DeletePullThroughCacheRuleCommand extends $Command<DeletePullThroughCacheRuleCommandInput, DeletePullThroughCacheRuleCommandOutput, ECRClientResolvedConfig> {
|
|
34
49
|
readonly input: DeletePullThroughCacheRuleCommandInput;
|
|
@@ -29,6 +29,20 @@ export interface DeleteRegistryPolicyCommandOutput extends DeleteRegistryPolicyR
|
|
|
29
29
|
* @see {@link DeleteRegistryPolicyCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
33
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
34
|
+
* request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link RegistryPolicyNotFoundException} (client fault)
|
|
37
|
+
* <p>The registry doesn't have an associated registry policy.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link ServerException} (server fault)
|
|
40
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link ValidationException} (client fault)
|
|
43
|
+
* <p>There was an exception validating this request.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
32
46
|
*/
|
|
33
47
|
export declare class DeleteRegistryPolicyCommand extends $Command<DeleteRegistryPolicyCommandInput, DeleteRegistryPolicyCommandOutput, ECRClientResolvedConfig> {
|
|
34
48
|
readonly input: DeleteRegistryPolicyCommandInput;
|
|
@@ -31,6 +31,46 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse,
|
|
|
31
31
|
* @see {@link DeleteRepositoryCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
35
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
36
|
+
* request.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link KmsException} (client fault)
|
|
39
|
+
* <p>The operation failed due to a KMS exception.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link RepositoryNotEmptyException} (client fault)
|
|
42
|
+
* <p>The specified repository contains images. To delete a repository that contains images,
|
|
43
|
+
* you must force the deletion with the <code>force</code> parameter.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
46
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
47
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ServerException} (server fault)
|
|
50
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
51
|
+
*
|
|
52
|
+
*
|
|
53
|
+
* @example To force delete a repository
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // 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.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "force": true,
|
|
58
|
+
* "repositoryName": "ubuntu"
|
|
59
|
+
* };
|
|
60
|
+
* const command = new DeleteRepositoryCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* /* response ==
|
|
63
|
+
* {
|
|
64
|
+
* "repository": {
|
|
65
|
+
* "registryId": "012345678901",
|
|
66
|
+
* "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/ubuntu",
|
|
67
|
+
* "repositoryName": "ubuntu"
|
|
68
|
+
* }
|
|
69
|
+
* }
|
|
70
|
+
* *\/
|
|
71
|
+
* // example id: deleterepository-example-1470863805703
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
34
74
|
*/
|
|
35
75
|
export declare class DeleteRepositoryCommand extends $Command<DeleteRepositoryCommandInput, DeleteRepositoryCommandOutput, ECRClientResolvedConfig> {
|
|
36
76
|
readonly input: DeleteRepositoryCommandInput;
|
|
@@ -29,6 +29,40 @@ export interface DeleteRepositoryPolicyCommandOutput extends DeleteRepositoryPol
|
|
|
29
29
|
* @see {@link DeleteRepositoryPolicyCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
33
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
34
|
+
* request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
37
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
38
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link RepositoryPolicyNotFoundException} (client fault)
|
|
41
|
+
* <p>The specified repository and registry combination does not have an associated
|
|
42
|
+
* repository policy.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link ServerException} (server fault)
|
|
45
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
48
|
+
* @example To delete the policy associated with a repository
|
|
49
|
+
* ```javascript
|
|
50
|
+
* // This example deletes the policy associated with the repository named ubuntu in the current account.
|
|
51
|
+
* const input = {
|
|
52
|
+
* "repositoryName": "ubuntu"
|
|
53
|
+
* };
|
|
54
|
+
* const command = new DeleteRepositoryPolicyCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* /* response ==
|
|
57
|
+
* {
|
|
58
|
+
* "policyText": "{ ... }",
|
|
59
|
+
* "registryId": "012345678901",
|
|
60
|
+
* "repositoryName": "ubuntu"
|
|
61
|
+
* }
|
|
62
|
+
* *\/
|
|
63
|
+
* // example id: deleterepositorypolicy-example-1470866943748
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
32
66
|
*/
|
|
33
67
|
export declare class DeleteRepositoryPolicyCommand extends $Command<DeleteRepositoryPolicyCommandInput, DeleteRepositoryPolicyCommandOutput, ECRClientResolvedConfig> {
|
|
34
68
|
readonly input: DeleteRepositoryPolicyCommandInput;
|
|
@@ -29,6 +29,24 @@ export interface DescribeImageReplicationStatusCommandOutput extends DescribeIma
|
|
|
29
29
|
* @see {@link DescribeImageReplicationStatusCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ImageNotFoundException} (client fault)
|
|
33
|
+
* <p>The image requested does not exist in the specified repository.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
36
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
37
|
+
* request.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
40
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
41
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ServerException} (server fault)
|
|
44
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link ValidationException} (client fault)
|
|
47
|
+
* <p>There was an exception validating this request.</p>
|
|
48
|
+
*
|
|
49
|
+
*
|
|
32
50
|
*/
|
|
33
51
|
export declare class DescribeImageReplicationStatusCommand extends $Command<DescribeImageReplicationStatusCommandInput, DescribeImageReplicationStatusCommandOutput, ECRClientResolvedConfig> {
|
|
34
52
|
readonly input: DescribeImageReplicationStatusCommandInput;
|
|
@@ -29,6 +29,28 @@ export interface DescribeImageScanFindingsCommandOutput extends DescribeImageSca
|
|
|
29
29
|
* @see {@link DescribeImageScanFindingsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ImageNotFoundException} (client fault)
|
|
33
|
+
* <p>The image requested does not exist in the specified repository.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
36
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
37
|
+
* request.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
40
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
41
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ScanNotFoundException} (client fault)
|
|
44
|
+
* <p>The specified image scan could not be found. Ensure that image scanning is enabled on
|
|
45
|
+
* the repository and try again.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServerException} (server fault)
|
|
48
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ValidationException} (client fault)
|
|
51
|
+
* <p>There was an exception validating this request.</p>
|
|
52
|
+
*
|
|
53
|
+
*
|
|
32
54
|
*/
|
|
33
55
|
export declare class DescribeImageScanFindingsCommand extends $Command<DescribeImageScanFindingsCommandInput, DescribeImageScanFindingsCommandOutput, ECRClientResolvedConfig> {
|
|
34
56
|
readonly input: DescribeImageScanFindingsCommandInput;
|
|
@@ -35,6 +35,21 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResponse, __M
|
|
|
35
35
|
* @see {@link DescribeImagesCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link ImageNotFoundException} (client fault)
|
|
39
|
+
* <p>The image requested does not exist in the specified repository.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
42
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
43
|
+
* request.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
46
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
47
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ServerException} (server fault)
|
|
50
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
51
|
+
*
|
|
52
|
+
*
|
|
38
53
|
*/
|
|
39
54
|
export declare class DescribeImagesCommand extends $Command<DescribeImagesCommandInput, DescribeImagesCommandOutput, ECRClientResolvedConfig> {
|
|
40
55
|
readonly input: DescribeImagesCommandInput;
|
|
@@ -29,6 +29,21 @@ export interface DescribePullThroughCacheRulesCommandOutput extends DescribePull
|
|
|
29
29
|
* @see {@link DescribePullThroughCacheRulesCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
33
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
34
|
+
* request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link PullThroughCacheRuleNotFoundException} (client fault)
|
|
37
|
+
* <p>The pull through cache rule was not found. Specify a valid pull through cache rule and
|
|
38
|
+
* try again.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link ServerException} (server fault)
|
|
41
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ValidationException} (client fault)
|
|
44
|
+
* <p>There was an exception validating this request.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
32
47
|
*/
|
|
33
48
|
export declare class DescribePullThroughCacheRulesCommand extends $Command<DescribePullThroughCacheRulesCommandInput, DescribePullThroughCacheRulesCommandOutput, ECRClientResolvedConfig> {
|
|
34
49
|
readonly input: DescribePullThroughCacheRulesCommandInput;
|
|
@@ -31,6 +31,17 @@ export interface DescribeRegistryCommandOutput extends DescribeRegistryResponse,
|
|
|
31
31
|
* @see {@link DescribeRegistryCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
35
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
36
|
+
* request.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link ServerException} (server fault)
|
|
39
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ValidationException} (client fault)
|
|
42
|
+
* <p>There was an exception validating this request.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
34
45
|
*/
|
|
35
46
|
export declare class DescribeRegistryCommand extends $Command<DescribeRegistryCommandInput, DescribeRegistryCommandOutput, ECRClientResolvedConfig> {
|
|
36
47
|
readonly input: DescribeRegistryCommandInput;
|
|
@@ -29,6 +29,43 @@ export interface DescribeRepositoriesCommandOutput extends DescribeRepositoriesR
|
|
|
29
29
|
* @see {@link DescribeRepositoriesCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
33
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
34
|
+
* request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
37
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
38
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link ServerException} (server fault)
|
|
41
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
44
|
+
* @example To describe all repositories in the current account
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // The following example obtains a list and description of all repositories in the default registry to which the current user has access.
|
|
47
|
+
* const input = {};
|
|
48
|
+
* const command = new DescribeRepositoriesCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* /* response ==
|
|
51
|
+
* {
|
|
52
|
+
* "repositories": [
|
|
53
|
+
* {
|
|
54
|
+
* "registryId": "012345678910",
|
|
55
|
+
* "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu",
|
|
56
|
+
* "repositoryName": "ubuntu"
|
|
57
|
+
* },
|
|
58
|
+
* {
|
|
59
|
+
* "registryId": "012345678910",
|
|
60
|
+
* "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test",
|
|
61
|
+
* "repositoryName": "test"
|
|
62
|
+
* }
|
|
63
|
+
* ]
|
|
64
|
+
* }
|
|
65
|
+
* *\/
|
|
66
|
+
* // example id: describe-repositories-1470856017467
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
32
69
|
*/
|
|
33
70
|
export declare class DescribeRepositoriesCommand extends $Command<DescribeRepositoriesCommandInput, DescribeRepositoriesCommandOutput, ECRClientResolvedConfig> {
|
|
34
71
|
readonly input: DescribeRepositoriesCommandInput;
|
|
@@ -36,6 +36,34 @@ export interface GetAuthorizationTokenCommandOutput extends GetAuthorizationToke
|
|
|
36
36
|
* @see {@link GetAuthorizationTokenCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
40
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
41
|
+
* request.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ServerException} (server fault)
|
|
44
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
47
|
+
* @example To obtain an authorization token
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // This example gets an authorization token for your default registry.
|
|
50
|
+
* const input = {};
|
|
51
|
+
* const command = new GetAuthorizationTokenCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* /* response ==
|
|
54
|
+
* {
|
|
55
|
+
* "authorizationData": [
|
|
56
|
+
* {
|
|
57
|
+
* "authorizationToken": "QVdTOkN...",
|
|
58
|
+
* "expiresAt": "1470951892432",
|
|
59
|
+
* "proxyEndpoint": "https://012345678901.dkr.ecr.us-west-2.amazonaws.com"
|
|
60
|
+
* }
|
|
61
|
+
* ]
|
|
62
|
+
* }
|
|
63
|
+
* *\/
|
|
64
|
+
* // example id: getauthorizationtoken-example-1470867047084
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
39
67
|
*/
|
|
40
68
|
export declare class GetAuthorizationTokenCommand extends $Command<GetAuthorizationTokenCommandInput, GetAuthorizationTokenCommandOutput, ECRClientResolvedConfig> {
|
|
41
69
|
readonly input: GetAuthorizationTokenCommandInput;
|
|
@@ -36,6 +36,26 @@ export interface GetDownloadUrlForLayerCommandOutput extends GetDownloadUrlForLa
|
|
|
36
36
|
* @see {@link GetDownloadUrlForLayerCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
40
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
41
|
+
* request.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link LayerInaccessibleException} (client fault)
|
|
44
|
+
* <p>The specified layer is not available because it is not associated with an image.
|
|
45
|
+
* Unassociated image layers may be cleaned up at any time.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link LayersNotFoundException} (client fault)
|
|
48
|
+
* <p>The specified layers could not be found, or the specified layer is not valid for this
|
|
49
|
+
* repository.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link RepositoryNotFoundException} (client fault)
|
|
52
|
+
* <p>The specified repository could not be found. Check the spelling of the specified
|
|
53
|
+
* repository and ensure that you are performing operations on the correct registry.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ServerException} (server fault)
|
|
56
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
57
|
+
*
|
|
58
|
+
*
|
|
39
59
|
*/
|
|
40
60
|
export declare class GetDownloadUrlForLayerCommand extends $Command<GetDownloadUrlForLayerCommandInput, GetDownloadUrlForLayerCommandOutput, ECRClientResolvedConfig> {
|
|
41
61
|
readonly input: GetDownloadUrlForLayerCommandInput;
|