@aws-sdk/client-ecr 3.1156.0 → 3.1157.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/README.md +28 -0
- package/dist-cjs/index.js +231 -5
- package/dist-es/ECR.js +12 -0
- package/dist-es/commands/DescribeReplicationBackfillResultsCommand.js +4 -0
- package/dist-es/commands/ListReplicationBackfillsCommand.js +4 -0
- package/dist-es/commands/StartReplicationBackfillCommand.js +4 -0
- package/dist-es/commands/StopReplicationBackfillCommand.js +4 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +12 -0
- package/dist-es/models/errors.js +39 -0
- package/dist-es/pagination/DescribeReplicationBackfillResultsPaginator.js +4 -0
- package/dist-es/pagination/ListReplicationBackfillsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +130 -5
- package/dist-types/ECR.d.ts +43 -0
- package/dist-types/ECRClient.d.ts +6 -2
- package/dist-types/commands/DescribeReplicationBackfillResultsCommand.d.ts +127 -0
- package/dist-types/commands/ListReplicationBackfillsCommand.d.ts +110 -0
- package/dist-types/commands/StartReplicationBackfillCommand.d.ts +120 -0
- package/dist-types/commands/StopReplicationBackfillCommand.d.ts +104 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +28 -0
- package/dist-types/models/errors.d.ts +47 -0
- package/dist-types/models/models_0.d.ts +393 -3
- package/dist-types/pagination/DescribeReplicationBackfillResultsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListReplicationBackfillsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +18 -0
- package/dist-types/ts3.4/ECR.d.ts +83 -0
- package/dist-types/ts3.4/ECRClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/DescribeReplicationBackfillResultsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListReplicationBackfillsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartReplicationBackfillCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StopReplicationBackfillCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +16 -0
- package/dist-types/ts3.4/models/errors.d.ts +20 -0
- package/dist-types/ts3.4/models/models_0.d.ts +75 -0
- package/dist-types/ts3.4/pagination/DescribeReplicationBackfillResultsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListReplicationBackfillsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +18 -0
- package/package.json +5 -5
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeReplicationBackfillResultsRequest, DescribeReplicationBackfillResultsResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeReplicationBackfillResultsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeReplicationBackfillResultsCommandInput extends DescribeReplicationBackfillResultsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeReplicationBackfillResultsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeReplicationBackfillResultsCommandOutput extends DescribeReplicationBackfillResultsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeReplicationBackfillResultsCommand_base: {
|
|
22
|
+
new (input: DescribeReplicationBackfillResultsCommandInput): import("@smithy/core/client").CommandImpl<DescribeReplicationBackfillResultsCommandInput, DescribeReplicationBackfillResultsCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeReplicationBackfillResultsCommandInput): import("@smithy/core/client").CommandImpl<DescribeReplicationBackfillResultsCommandInput, DescribeReplicationBackfillResultsCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns the status, progress, and per-image results for a replication backfill. The
|
|
28
|
+
* backfill to describe is identified by the <code>replicationBackfillId</code> returned by
|
|
29
|
+
* the <a>StartReplicationBackfill</a> operation.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>The per-image results are available only after the replication backfill reaches a
|
|
32
|
+
* terminal status.</p>
|
|
33
|
+
* </note>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { ECRClient, DescribeReplicationBackfillResultsCommand } from "@aws-sdk/client-ecr"; // ES Modules import
|
|
38
|
+
* // const { ECRClient, DescribeReplicationBackfillResultsCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
|
|
39
|
+
* // import type { ECRClientConfig } from "@aws-sdk/client-ecr";
|
|
40
|
+
* const config = {}; // type is ECRClientConfig
|
|
41
|
+
* const client = new ECRClient(config);
|
|
42
|
+
* const input = { // DescribeReplicationBackfillResultsRequest
|
|
43
|
+
* registryId: "STRING_VALUE",
|
|
44
|
+
* replicationBackfillId: "STRING_VALUE", // required
|
|
45
|
+
* resultStatusFilter: "COMPLETE" || "FAILED",
|
|
46
|
+
* maxResults: Number("int"),
|
|
47
|
+
* nextToken: "STRING_VALUE",
|
|
48
|
+
* };
|
|
49
|
+
* const command = new DescribeReplicationBackfillResultsCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // DescribeReplicationBackfillResultsResponse
|
|
52
|
+
* // registryId: "STRING_VALUE",
|
|
53
|
+
* // replicationBackfillId: "STRING_VALUE",
|
|
54
|
+
* // destination: { // ReplicationDestination
|
|
55
|
+
* // region: "STRING_VALUE", // required
|
|
56
|
+
* // registryId: "STRING_VALUE", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // status: "PREPARING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED",
|
|
59
|
+
* // failureCode: "STRING_VALUE",
|
|
60
|
+
* // progress: { // ReplicationBackfillProgress
|
|
61
|
+
* // totalReplicationCount: Number("int"), // required
|
|
62
|
+
* // completedReplicationCount: Number("int"), // required
|
|
63
|
+
* // failedReplicationCount: Number("int"), // required
|
|
64
|
+
* // failureCodes: [ // ReplicationErrorList // required
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // },
|
|
68
|
+
* // results: [ // ReplicationBackfillResultList
|
|
69
|
+
* // { // ReplicationBackfillResult
|
|
70
|
+
* // repositoryName: "STRING_VALUE", // required
|
|
71
|
+
* // imageId: { // ImageIdentifier
|
|
72
|
+
* // imageDigest: "STRING_VALUE",
|
|
73
|
+
* // imageTag: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // status: "COMPLETE" || "FAILED", // required
|
|
76
|
+
* // failureCode: "STRING_VALUE",
|
|
77
|
+
* // subImageFailureCodes: [
|
|
78
|
+
* // "STRING_VALUE",
|
|
79
|
+
* // ],
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // startedAt: new Date("TIMESTAMP"),
|
|
83
|
+
* // endedAt: new Date("TIMESTAMP"),
|
|
84
|
+
* // nextToken: "STRING_VALUE",
|
|
85
|
+
* // };
|
|
86
|
+
*
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
89
|
+
* @param DescribeReplicationBackfillResultsCommandInput - {@link DescribeReplicationBackfillResultsCommandInput}
|
|
90
|
+
* @returns {@link DescribeReplicationBackfillResultsCommandOutput}
|
|
91
|
+
* @see {@link DescribeReplicationBackfillResultsCommandInput} for command's `input` shape.
|
|
92
|
+
* @see {@link DescribeReplicationBackfillResultsCommandOutput} for command's `response` shape.
|
|
93
|
+
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
96
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
97
|
+
* request.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ReplicationBackfillNotFoundException} (client fault)
|
|
100
|
+
* <p>The specified replication backfill could not be found. Check the specified replication
|
|
101
|
+
* backfill ID and ensure that you are operating on the correct registry.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ServerException} (server fault)
|
|
104
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ValidationException} (client fault)
|
|
107
|
+
* <p>There was an exception validating this request.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link ECRServiceException}
|
|
110
|
+
* <p>Base exception class for all service exceptions from ECR service.</p>
|
|
111
|
+
*
|
|
112
|
+
*
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export declare class DescribeReplicationBackfillResultsCommand extends DescribeReplicationBackfillResultsCommand_base {
|
|
116
|
+
/** @internal type navigation helper, not in runtime. */
|
|
117
|
+
protected static __types: {
|
|
118
|
+
api: {
|
|
119
|
+
input: DescribeReplicationBackfillResultsRequest;
|
|
120
|
+
output: DescribeReplicationBackfillResultsResponse;
|
|
121
|
+
};
|
|
122
|
+
sdk: {
|
|
123
|
+
input: DescribeReplicationBackfillResultsCommandInput;
|
|
124
|
+
output: DescribeReplicationBackfillResultsCommandOutput;
|
|
125
|
+
};
|
|
126
|
+
};
|
|
127
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListReplicationBackfillsRequest, ListReplicationBackfillsResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListReplicationBackfillsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListReplicationBackfillsCommandInput extends ListReplicationBackfillsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListReplicationBackfillsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListReplicationBackfillsCommandOutput extends ListReplicationBackfillsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListReplicationBackfillsCommand_base: {
|
|
22
|
+
new (input: ListReplicationBackfillsCommandInput): import("@smithy/core/client").CommandImpl<ListReplicationBackfillsCommandInput, ListReplicationBackfillsCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListReplicationBackfillsCommandInput]): import("@smithy/core/client").CommandImpl<ListReplicationBackfillsCommandInput, ListReplicationBackfillsCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Lists the replication backfills for a registry, including their status and
|
|
28
|
+
* progress.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>Replication backfills that have reached a terminal status are retained for 90 days
|
|
31
|
+
* after they end, after which they are no longer returned.</p>
|
|
32
|
+
* </note>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { ECRClient, ListReplicationBackfillsCommand } from "@aws-sdk/client-ecr"; // ES Modules import
|
|
37
|
+
* // const { ECRClient, ListReplicationBackfillsCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
|
|
38
|
+
* // import type { ECRClientConfig } from "@aws-sdk/client-ecr";
|
|
39
|
+
* const config = {}; // type is ECRClientConfig
|
|
40
|
+
* const client = new ECRClient(config);
|
|
41
|
+
* const input = { // ListReplicationBackfillsRequest
|
|
42
|
+
* registryId: "STRING_VALUE",
|
|
43
|
+
* maxResults: Number("int"),
|
|
44
|
+
* nextToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListReplicationBackfillsCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListReplicationBackfillsResponse
|
|
49
|
+
* // registryId: "STRING_VALUE",
|
|
50
|
+
* // backfills: [ // ReplicationBackfillSummaryList
|
|
51
|
+
* // { // ReplicationBackfillSummary
|
|
52
|
+
* // replicationBackfillId: "STRING_VALUE", // required
|
|
53
|
+
* // destination: { // ReplicationDestination
|
|
54
|
+
* // region: "STRING_VALUE", // required
|
|
55
|
+
* // registryId: "STRING_VALUE", // required
|
|
56
|
+
* // },
|
|
57
|
+
* // status: "PREPARING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED", // required
|
|
58
|
+
* // failureCode: "STRING_VALUE",
|
|
59
|
+
* // progress: { // ReplicationBackfillProgress
|
|
60
|
+
* // totalReplicationCount: Number("int"), // required
|
|
61
|
+
* // completedReplicationCount: Number("int"), // required
|
|
62
|
+
* // failedReplicationCount: Number("int"), // required
|
|
63
|
+
* // failureCodes: [ // ReplicationErrorList // required
|
|
64
|
+
* // "STRING_VALUE",
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // startedAt: new Date("TIMESTAMP"), // required
|
|
68
|
+
* // endedAt: new Date("TIMESTAMP"),
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // nextToken: "STRING_VALUE",
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* @param ListReplicationBackfillsCommandInput - {@link ListReplicationBackfillsCommandInput}
|
|
77
|
+
* @returns {@link ListReplicationBackfillsCommandOutput}
|
|
78
|
+
* @see {@link ListReplicationBackfillsCommandInput} for command's `input` shape.
|
|
79
|
+
* @see {@link ListReplicationBackfillsCommandOutput} for command's `response` shape.
|
|
80
|
+
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
83
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
84
|
+
* request.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ServerException} (server fault)
|
|
87
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <p>There was an exception validating this request.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ECRServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from ECR service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class ListReplicationBackfillsCommand extends ListReplicationBackfillsCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: ListReplicationBackfillsRequest;
|
|
103
|
+
output: ListReplicationBackfillsResponse;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: ListReplicationBackfillsCommandInput;
|
|
107
|
+
output: ListReplicationBackfillsCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { StartReplicationBackfillRequest, StartReplicationBackfillResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link StartReplicationBackfillCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface StartReplicationBackfillCommandInput extends StartReplicationBackfillRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link StartReplicationBackfillCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface StartReplicationBackfillCommandOutput extends StartReplicationBackfillResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const StartReplicationBackfillCommand_base: {
|
|
22
|
+
new (input: StartReplicationBackfillCommandInput): import("@smithy/core/client").CommandImpl<StartReplicationBackfillCommandInput, StartReplicationBackfillCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: StartReplicationBackfillCommandInput): import("@smithy/core/client").CommandImpl<StartReplicationBackfillCommandInput, StartReplicationBackfillCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Starts a replication backfill for a registry. A replication backfill replicates a
|
|
28
|
+
* registry's existing images that match its replication configuration to the specified
|
|
29
|
+
* destination. Use the <a>DescribeReplicationBackfillResults</a> operation to
|
|
30
|
+
* monitor the progress of a replication backfill, and to retrieve its per-image results
|
|
31
|
+
* after it reaches a terminal status.</p>
|
|
32
|
+
* <note>
|
|
33
|
+
* <p>The destination must already be configured in the registry's replication
|
|
34
|
+
* configuration.</p>
|
|
35
|
+
* </note>
|
|
36
|
+
* <note>
|
|
37
|
+
* <p>Only one replication backfill can be in progress for a given destination Region at
|
|
38
|
+
* a time. Starting a replication backfill for a destination Region that already has one
|
|
39
|
+
* in progress fails with a <code>ReplicationBackfillInProgressException</code>. In
|
|
40
|
+
* addition, a registry can have at most 10 replication backfills in progress at once.
|
|
41
|
+
* Starting a replication backfill that would exceed this limit fails with a
|
|
42
|
+
* <code>LimitExceededException</code>.</p>
|
|
43
|
+
* </note>
|
|
44
|
+
* @example
|
|
45
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
46
|
+
* ```javascript
|
|
47
|
+
* import { ECRClient, StartReplicationBackfillCommand } from "@aws-sdk/client-ecr"; // ES Modules import
|
|
48
|
+
* // const { ECRClient, StartReplicationBackfillCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
|
|
49
|
+
* // import type { ECRClientConfig } from "@aws-sdk/client-ecr";
|
|
50
|
+
* const config = {}; // type is ECRClientConfig
|
|
51
|
+
* const client = new ECRClient(config);
|
|
52
|
+
* const input = { // StartReplicationBackfillRequest
|
|
53
|
+
* registryId: "STRING_VALUE",
|
|
54
|
+
* destination: { // ReplicationDestination
|
|
55
|
+
* region: "STRING_VALUE", // required
|
|
56
|
+
* registryId: "STRING_VALUE", // required
|
|
57
|
+
* },
|
|
58
|
+
* };
|
|
59
|
+
* const command = new StartReplicationBackfillCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* // { // StartReplicationBackfillResponse
|
|
62
|
+
* // replicationBackfillId: "STRING_VALUE",
|
|
63
|
+
* // registryId: "STRING_VALUE",
|
|
64
|
+
* // destination: { // ReplicationDestination
|
|
65
|
+
* // region: "STRING_VALUE", // required
|
|
66
|
+
* // registryId: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // status: "PREPARING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED",
|
|
69
|
+
* // startedAt: new Date("TIMESTAMP"),
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param StartReplicationBackfillCommandInput - {@link StartReplicationBackfillCommandInput}
|
|
75
|
+
* @returns {@link StartReplicationBackfillCommandOutput}
|
|
76
|
+
* @see {@link StartReplicationBackfillCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link StartReplicationBackfillCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
81
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
82
|
+
* request.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
85
|
+
* <p>The operation did not succeed because it would have exceeded a service limit for your
|
|
86
|
+
* account. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html">Amazon ECR service quotas</a> in
|
|
87
|
+
* the Amazon Elastic Container Registry User Guide.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ReplicationBackfillInProgressException} (client fault)
|
|
90
|
+
* <p>A replication backfill is already in progress for the specified destination Region.
|
|
91
|
+
* This occurs because only one replication backfill can be in progress for a given
|
|
92
|
+
* destination Region at a time. Wait for the in progress backfill to reach a terminal
|
|
93
|
+
* status, or stop it with the <a>StopReplicationBackfill</a> operation, before
|
|
94
|
+
* starting another one.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ServerException} (server fault)
|
|
97
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ValidationException} (client fault)
|
|
100
|
+
* <p>There was an exception validating this request.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ECRServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from ECR service.</p>
|
|
104
|
+
*
|
|
105
|
+
*
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export declare class StartReplicationBackfillCommand extends StartReplicationBackfillCommand_base {
|
|
109
|
+
/** @internal type navigation helper, not in runtime. */
|
|
110
|
+
protected static __types: {
|
|
111
|
+
api: {
|
|
112
|
+
input: StartReplicationBackfillRequest;
|
|
113
|
+
output: StartReplicationBackfillResponse;
|
|
114
|
+
};
|
|
115
|
+
sdk: {
|
|
116
|
+
input: StartReplicationBackfillCommandInput;
|
|
117
|
+
output: StartReplicationBackfillCommandOutput;
|
|
118
|
+
};
|
|
119
|
+
};
|
|
120
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { StopReplicationBackfillRequest, StopReplicationBackfillResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link StopReplicationBackfillCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface StopReplicationBackfillCommandInput extends StopReplicationBackfillRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link StopReplicationBackfillCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface StopReplicationBackfillCommandOutput extends StopReplicationBackfillResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const StopReplicationBackfillCommand_base: {
|
|
22
|
+
new (input: StopReplicationBackfillCommandInput): import("@smithy/core/client").CommandImpl<StopReplicationBackfillCommandInput, StopReplicationBackfillCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: StopReplicationBackfillCommandInput): import("@smithy/core/client").CommandImpl<StopReplicationBackfillCommandInput, StopReplicationBackfillCommandOutput, import("..").ECRClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Stops an in progress replication backfill for a registry. The backfill to stop is
|
|
28
|
+
* identified by the <code>replicationBackfillId</code> returned by the <a>StartReplicationBackfill</a> operation.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>Images that have already been replicated are not affected, and replications that
|
|
31
|
+
* are already in progress continue to completion.</p>
|
|
32
|
+
* </note>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { ECRClient, StopReplicationBackfillCommand } from "@aws-sdk/client-ecr"; // ES Modules import
|
|
37
|
+
* // const { ECRClient, StopReplicationBackfillCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
|
|
38
|
+
* // import type { ECRClientConfig } from "@aws-sdk/client-ecr";
|
|
39
|
+
* const config = {}; // type is ECRClientConfig
|
|
40
|
+
* const client = new ECRClient(config);
|
|
41
|
+
* const input = { // StopReplicationBackfillRequest
|
|
42
|
+
* registryId: "STRING_VALUE",
|
|
43
|
+
* replicationBackfillId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new StopReplicationBackfillCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // StopReplicationBackfillResponse
|
|
48
|
+
* // registryId: "STRING_VALUE",
|
|
49
|
+
* // replicationBackfillId: "STRING_VALUE",
|
|
50
|
+
* // destination: { // ReplicationDestination
|
|
51
|
+
* // region: "STRING_VALUE", // required
|
|
52
|
+
* // registryId: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // status: "PREPARING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED",
|
|
55
|
+
* // startedAt: new Date("TIMESTAMP"),
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param StopReplicationBackfillCommandInput - {@link StopReplicationBackfillCommandInput}
|
|
61
|
+
* @returns {@link StopReplicationBackfillCommandOutput}
|
|
62
|
+
* @see {@link StopReplicationBackfillCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link StopReplicationBackfillCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
67
|
+
* <p>The specified parameter is invalid. Review the available parameters for the API
|
|
68
|
+
* request.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ReplicationBackfillInvalidStatusException} (client fault)
|
|
71
|
+
* <p>The requested operation can't be performed on the replication backfill because it is
|
|
72
|
+
* not in a valid status for that operation. For example, you can't stop a replication
|
|
73
|
+
* backfill that has already reached a terminal status. Use the <a>DescribeReplicationBackfillResults</a> operation to check the current status
|
|
74
|
+
* before retrying.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ReplicationBackfillNotFoundException} (client fault)
|
|
77
|
+
* <p>The specified replication backfill could not be found. Check the specified replication
|
|
78
|
+
* backfill ID and ensure that you are operating on the correct registry.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ServerException} (server fault)
|
|
81
|
+
* <p>These errors are usually caused by a server-side issue.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ValidationException} (client fault)
|
|
84
|
+
* <p>There was an exception validating this request.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ECRServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from ECR service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class StopReplicationBackfillCommand extends StopReplicationBackfillCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: StopReplicationBackfillRequest;
|
|
97
|
+
output: StopReplicationBackfillResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: StopReplicationBackfillCommandInput;
|
|
101
|
+
output: StopReplicationBackfillCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -20,6 +20,7 @@ export * from "./DescribeImageSigningStatusCommand";
|
|
|
20
20
|
export * from "./DescribeImagesCommand";
|
|
21
21
|
export * from "./DescribePullThroughCacheRulesCommand";
|
|
22
22
|
export * from "./DescribeRegistryCommand";
|
|
23
|
+
export * from "./DescribeReplicationBackfillResultsCommand";
|
|
23
24
|
export * from "./DescribeRepositoriesCommand";
|
|
24
25
|
export * from "./DescribeRepositoryCreationTemplatesCommand";
|
|
25
26
|
export * from "./GetAccountSettingCommand";
|
|
@@ -35,6 +36,7 @@ export * from "./InitiateLayerUploadCommand";
|
|
|
35
36
|
export * from "./ListImageReferrersCommand";
|
|
36
37
|
export * from "./ListImagesCommand";
|
|
37
38
|
export * from "./ListPullTimeUpdateExclusionsCommand";
|
|
39
|
+
export * from "./ListReplicationBackfillsCommand";
|
|
38
40
|
export * from "./ListTagsForResourceCommand";
|
|
39
41
|
export * from "./PutAccountSettingCommand";
|
|
40
42
|
export * from "./PutImageCommand";
|
|
@@ -49,6 +51,8 @@ export * from "./RegisterPullTimeUpdateExclusionCommand";
|
|
|
49
51
|
export * from "./SetRepositoryPolicyCommand";
|
|
50
52
|
export * from "./StartImageScanCommand";
|
|
51
53
|
export * from "./StartLifecyclePolicyPreviewCommand";
|
|
54
|
+
export * from "./StartReplicationBackfillCommand";
|
|
55
|
+
export * from "./StopReplicationBackfillCommand";
|
|
52
56
|
export * from "./TagResourceCommand";
|
|
53
57
|
export * from "./UntagResourceCommand";
|
|
54
58
|
export * from "./UpdateImageStorageClassCommand";
|
|
@@ -273,6 +273,34 @@ export declare const RepositoryFilterType: {
|
|
|
273
273
|
* @public
|
|
274
274
|
*/
|
|
275
275
|
export type RepositoryFilterType = (typeof RepositoryFilterType)[keyof typeof RepositoryFilterType];
|
|
276
|
+
/**
|
|
277
|
+
* @public
|
|
278
|
+
* @enum
|
|
279
|
+
*/
|
|
280
|
+
export declare const ReplicationBackfillResultStatus: {
|
|
281
|
+
readonly COMPLETE: "COMPLETE";
|
|
282
|
+
readonly FAILED: "FAILED";
|
|
283
|
+
};
|
|
284
|
+
/**
|
|
285
|
+
* @public
|
|
286
|
+
*/
|
|
287
|
+
export type ReplicationBackfillResultStatus = (typeof ReplicationBackfillResultStatus)[keyof typeof ReplicationBackfillResultStatus];
|
|
288
|
+
/**
|
|
289
|
+
* @public
|
|
290
|
+
* @enum
|
|
291
|
+
*/
|
|
292
|
+
export declare const ReplicationBackfillStatus: {
|
|
293
|
+
readonly COMPLETE: "COMPLETE";
|
|
294
|
+
readonly FAILED: "FAILED";
|
|
295
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
296
|
+
readonly PREPARING: "PREPARING";
|
|
297
|
+
readonly STOPPED: "STOPPED";
|
|
298
|
+
readonly STOPPING: "STOPPING";
|
|
299
|
+
};
|
|
300
|
+
/**
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
export type ReplicationBackfillStatus = (typeof ReplicationBackfillStatus)[keyof typeof ReplicationBackfillStatus];
|
|
276
304
|
/**
|
|
277
305
|
* @public
|
|
278
306
|
* @enum
|
|
@@ -430,6 +430,20 @@ export declare class ScanNotFoundException extends __BaseException {
|
|
|
430
430
|
*/
|
|
431
431
|
constructor(opts: __ExceptionOptionType<ScanNotFoundException, __BaseException>);
|
|
432
432
|
}
|
|
433
|
+
/**
|
|
434
|
+
* <p>The specified replication backfill could not be found. Check the specified replication
|
|
435
|
+
* backfill ID and ensure that you are operating on the correct registry.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
export declare class ReplicationBackfillNotFoundException extends __BaseException {
|
|
439
|
+
static readonly shapeId: string;
|
|
440
|
+
readonly name: "ReplicationBackfillNotFoundException";
|
|
441
|
+
readonly $fault: "client";
|
|
442
|
+
/**
|
|
443
|
+
* @internal
|
|
444
|
+
*/
|
|
445
|
+
constructor(opts: __ExceptionOptionType<ReplicationBackfillNotFoundException, __BaseException>);
|
|
446
|
+
}
|
|
433
447
|
/**
|
|
434
448
|
* <p>The specified layer is not available because it is not associated with an image.
|
|
435
449
|
* Unassociated image layers may be cleaned up at any time.</p>
|
|
@@ -621,6 +635,39 @@ export declare class LifecyclePolicyPreviewInProgressException extends __BaseExc
|
|
|
621
635
|
*/
|
|
622
636
|
constructor(opts: __ExceptionOptionType<LifecyclePolicyPreviewInProgressException, __BaseException>);
|
|
623
637
|
}
|
|
638
|
+
/**
|
|
639
|
+
* <p>A replication backfill is already in progress for the specified destination Region.
|
|
640
|
+
* This occurs because only one replication backfill can be in progress for a given
|
|
641
|
+
* destination Region at a time. Wait for the in progress backfill to reach a terminal
|
|
642
|
+
* status, or stop it with the <a>StopReplicationBackfill</a> operation, before
|
|
643
|
+
* starting another one.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
export declare class ReplicationBackfillInProgressException extends __BaseException {
|
|
647
|
+
static readonly shapeId: string;
|
|
648
|
+
readonly name: "ReplicationBackfillInProgressException";
|
|
649
|
+
readonly $fault: "client";
|
|
650
|
+
/**
|
|
651
|
+
* @internal
|
|
652
|
+
*/
|
|
653
|
+
constructor(opts: __ExceptionOptionType<ReplicationBackfillInProgressException, __BaseException>);
|
|
654
|
+
}
|
|
655
|
+
/**
|
|
656
|
+
* <p>The requested operation can't be performed on the replication backfill because it is
|
|
657
|
+
* not in a valid status for that operation. For example, you can't stop a replication
|
|
658
|
+
* backfill that has already reached a terminal status. Use the <a>DescribeReplicationBackfillResults</a> operation to check the current status
|
|
659
|
+
* before retrying.</p>
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
export declare class ReplicationBackfillInvalidStatusException extends __BaseException {
|
|
663
|
+
static readonly shapeId: string;
|
|
664
|
+
readonly name: "ReplicationBackfillInvalidStatusException";
|
|
665
|
+
readonly $fault: "client";
|
|
666
|
+
/**
|
|
667
|
+
* @internal
|
|
668
|
+
*/
|
|
669
|
+
constructor(opts: __ExceptionOptionType<ReplicationBackfillInvalidStatusException, __BaseException>);
|
|
670
|
+
}
|
|
624
671
|
/**
|
|
625
672
|
* <p>The requested image storage class update is not supported.</p>
|
|
626
673
|
* @public
|