@aws-sdk/client-imagebuilder 3.936.0 → 3.939.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.
Files changed (36) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +240 -17
  3. package/dist-es/Imagebuilder.js +4 -0
  4. package/dist-es/commands/DistributeImageCommand.js +16 -0
  5. package/dist-es/commands/RetryImageCommand.js +16 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/errors.js +36 -0
  8. package/dist-es/schemas/schemas_0.js +174 -18
  9. package/dist-types/Imagebuilder.d.ts +14 -0
  10. package/dist-types/ImagebuilderClient.d.ts +4 -2
  11. package/dist-types/commands/CreateComponentCommand.d.ts +10 -0
  12. package/dist-types/commands/CreateContainerRecipeCommand.d.ts +6 -0
  13. package/dist-types/commands/CreateImageCommand.d.ts +6 -0
  14. package/dist-types/commands/CreateImageRecipeCommand.d.ts +6 -0
  15. package/dist-types/commands/CreateWorkflowCommand.d.ts +10 -0
  16. package/dist-types/commands/DistributeImageCommand.d.ts +127 -0
  17. package/dist-types/commands/GetComponentCommand.d.ts +6 -0
  18. package/dist-types/commands/GetContainerRecipeCommand.d.ts +6 -0
  19. package/dist-types/commands/GetImageCommand.d.ts +6 -0
  20. package/dist-types/commands/GetImageRecipeCommand.d.ts +6 -0
  21. package/dist-types/commands/GetWorkflowCommand.d.ts +6 -0
  22. package/dist-types/commands/ListWorkflowExecutionsCommand.d.ts +1 -0
  23. package/dist-types/commands/RetryImageCommand.d.ts +105 -0
  24. package/dist-types/commands/index.d.ts +2 -0
  25. package/dist-types/models/errors.d.ts +36 -0
  26. package/dist-types/models/models_0.d.ts +189 -15
  27. package/dist-types/schemas/schemas_0.d.ts +10 -0
  28. package/dist-types/ts3.4/Imagebuilder.d.ts +34 -0
  29. package/dist-types/ts3.4/ImagebuilderClient.d.ts +12 -0
  30. package/dist-types/ts3.4/commands/DistributeImageCommand.d.ts +50 -0
  31. package/dist-types/ts3.4/commands/RetryImageCommand.d.ts +47 -0
  32. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  33. package/dist-types/ts3.4/models/errors.d.ts +21 -0
  34. package/dist-types/ts3.4/models/models_0.d.ts +39 -0
  35. package/dist-types/ts3.4/schemas/schemas_0.d.ts +10 -0
  36. package/package.json +2 -2
@@ -0,0 +1,127 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ImagebuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ImagebuilderClient";
4
+ import { DistributeImageRequest, DistributeImageResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DistributeImageCommand}.
14
+ */
15
+ export interface DistributeImageCommandInput extends DistributeImageRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DistributeImageCommand}.
21
+ */
22
+ export interface DistributeImageCommandOutput extends DistributeImageResponse, __MetadataBearer {
23
+ }
24
+ declare const DistributeImageCommand_base: {
25
+ new (input: DistributeImageCommandInput): import("@smithy/smithy-client").CommandImpl<DistributeImageCommandInput, DistributeImageCommandOutput, ImagebuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DistributeImageCommandInput): import("@smithy/smithy-client").CommandImpl<DistributeImageCommandInput, DistributeImageCommandOutput, ImagebuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>DistributeImage distributes existing AMIs to additional regions and accounts without rebuilding the image.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ImagebuilderClient, DistributeImageCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
35
+ * // const { ImagebuilderClient, DistributeImageCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
36
+ * // import type { ImagebuilderClientConfig } from "@aws-sdk/client-imagebuilder";
37
+ * const config = {}; // type is ImagebuilderClientConfig
38
+ * const client = new ImagebuilderClient(config);
39
+ * const input = { // DistributeImageRequest
40
+ * sourceImage: "STRING_VALUE", // required
41
+ * distributionConfigurationArn: "STRING_VALUE", // required
42
+ * executionRole: "STRING_VALUE", // required
43
+ * tags: { // TagMap
44
+ * "<keys>": "STRING_VALUE",
45
+ * },
46
+ * clientToken: "STRING_VALUE", // required
47
+ * loggingConfiguration: { // ImageLoggingConfiguration
48
+ * logGroupName: "STRING_VALUE",
49
+ * },
50
+ * };
51
+ * const command = new DistributeImageCommand(input);
52
+ * const response = await client.send(command);
53
+ * // { // DistributeImageResponse
54
+ * // clientToken: "STRING_VALUE",
55
+ * // imageBuildVersionArn: "STRING_VALUE",
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param DistributeImageCommandInput - {@link DistributeImageCommandInput}
61
+ * @returns {@link DistributeImageCommandOutput}
62
+ * @see {@link DistributeImageCommandInput} for command's `input` shape.
63
+ * @see {@link DistributeImageCommandOutput} for command's `response` shape.
64
+ * @see {@link ImagebuilderClientResolvedConfig | config} for ImagebuilderClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>You do not have permissions to perform the requested operation.</p>
68
+ *
69
+ * @throws {@link CallRateLimitExceededException} (client fault)
70
+ * <p>You have exceeded the permitted request rate for the specific operation.</p>
71
+ *
72
+ * @throws {@link ClientException} (client fault)
73
+ * <p>These errors are usually caused by a client action, such as using an action or
74
+ * resource on behalf of a user that doesn't have permissions to use the action or
75
+ * resource, or specifying an invalid resource identifier.</p>
76
+ *
77
+ * @throws {@link ForbiddenException} (client fault)
78
+ * <p>You are not authorized to perform the requested operation.</p>
79
+ *
80
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
81
+ * <p>You have specified a client token for an operation using parameter values that differ
82
+ * from a previous request that used the same client token.</p>
83
+ *
84
+ * @throws {@link InvalidRequestException} (client fault)
85
+ * <p>You have requested an action that that the service doesn't support.</p>
86
+ *
87
+ * @throws {@link ResourceInUseException} (client fault)
88
+ * <p>The resource that you are trying to operate on is currently in use. Review the message
89
+ * details and retry later.</p>
90
+ *
91
+ * @throws {@link ResourceNotFoundException} (client fault)
92
+ * <p>At least one of the resources referenced by your request does not exist.</p>
93
+ *
94
+ * @throws {@link ServiceException} (server fault)
95
+ * <p>This exception is thrown when the service encounters an unrecoverable
96
+ * exception.</p>
97
+ *
98
+ * @throws {@link ServiceQuotaExceededException} (client fault)
99
+ * <p>You have exceeded the number of permitted resources or operations for this service.
100
+ * For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and
101
+ * quotas</a>.</p>
102
+ *
103
+ * @throws {@link ServiceUnavailableException} (server fault)
104
+ * <p>The service is unable to process your request at this time.</p>
105
+ *
106
+ * @throws {@link TooManyRequestsException} (client fault)
107
+ * <p>You have attempted too many requests for the specific operation.</p>
108
+ *
109
+ * @throws {@link ImagebuilderServiceException}
110
+ * <p>Base exception class for all service exceptions from Imagebuilder service.</p>
111
+ *
112
+ *
113
+ * @public
114
+ */
115
+ export declare class DistributeImageCommand extends DistributeImageCommand_base {
116
+ /** @internal type navigation helper, not in runtime. */
117
+ protected static __types: {
118
+ api: {
119
+ input: DistributeImageRequest;
120
+ output: DistributeImageResponse;
121
+ };
122
+ sdk: {
123
+ input: DistributeImageCommandInput;
124
+ output: DistributeImageCommandOutput;
125
+ };
126
+ };
127
+ }
@@ -85,6 +85,12 @@ declare const GetComponentCommand_base: {
85
85
  * // },
86
86
  * // ],
87
87
  * // },
88
+ * // latestVersionReferences: { // LatestVersionReferences
89
+ * // latestVersionArn: "STRING_VALUE",
90
+ * // latestMajorVersionArn: "STRING_VALUE",
91
+ * // latestMinorVersionArn: "STRING_VALUE",
92
+ * // latestPatchVersionArn: "STRING_VALUE",
93
+ * // },
88
94
  * // };
89
95
  *
90
96
  * ```
@@ -98,6 +98,12 @@ declare const GetContainerRecipeCommand_base: {
98
98
  * // repositoryName: "STRING_VALUE", // required
99
99
  * // },
100
100
  * // },
101
+ * // latestVersionReferences: { // LatestVersionReferences
102
+ * // latestVersionArn: "STRING_VALUE",
103
+ * // latestMajorVersionArn: "STRING_VALUE",
104
+ * // latestMinorVersionArn: "STRING_VALUE",
105
+ * // latestPatchVersionArn: "STRING_VALUE",
106
+ * // },
101
107
  * // };
102
108
  *
103
109
  * ```
@@ -355,6 +355,12 @@ declare const GetImageCommand_base: {
355
355
  * // logGroupName: "STRING_VALUE",
356
356
  * // },
357
357
  * // },
358
+ * // latestVersionReferences: { // LatestVersionReferences
359
+ * // latestVersionArn: "STRING_VALUE",
360
+ * // latestMajorVersionArn: "STRING_VALUE",
361
+ * // latestMinorVersionArn: "STRING_VALUE",
362
+ * // latestPatchVersionArn: "STRING_VALUE",
363
+ * // },
358
364
  * // };
359
365
  *
360
366
  * ```
@@ -97,6 +97,12 @@ declare const GetImageRecipeCommand_base: {
97
97
  * // "<keys>": "STRING_VALUE",
98
98
  * // },
99
99
  * // },
100
+ * // latestVersionReferences: { // LatestVersionReferences
101
+ * // latestVersionArn: "STRING_VALUE",
102
+ * // latestMajorVersionArn: "STRING_VALUE",
103
+ * // latestMinorVersionArn: "STRING_VALUE",
104
+ * // latestPatchVersionArn: "STRING_VALUE",
105
+ * // },
100
106
  * // };
101
107
  *
102
108
  * ```
@@ -71,6 +71,12 @@ declare const GetWorkflowCommand_base: {
71
71
  * // },
72
72
  * // ],
73
73
  * // },
74
+ * // latestVersionReferences: { // LatestVersionReferences
75
+ * // latestVersionArn: "STRING_VALUE",
76
+ * // latestMajorVersionArn: "STRING_VALUE",
77
+ * // latestMinorVersionArn: "STRING_VALUE",
78
+ * // latestPatchVersionArn: "STRING_VALUE",
79
+ * // },
74
80
  * // };
75
81
  *
76
82
  * ```
@@ -60,6 +60,7 @@ declare const ListWorkflowExecutionsCommand_base: {
60
60
  * // startTime: "STRING_VALUE",
61
61
  * // endTime: "STRING_VALUE",
62
62
  * // parallelGroup: "STRING_VALUE",
63
+ * // retried: true || false,
63
64
  * // },
64
65
  * // ],
65
66
  * // imageBuildVersionArn: "STRING_VALUE",
@@ -0,0 +1,105 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ImagebuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ImagebuilderClient";
4
+ import { RetryImageRequest, RetryImageResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link RetryImageCommand}.
14
+ */
15
+ export interface RetryImageCommandInput extends RetryImageRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RetryImageCommand}.
21
+ */
22
+ export interface RetryImageCommandOutput extends RetryImageResponse, __MetadataBearer {
23
+ }
24
+ declare const RetryImageCommand_base: {
25
+ new (input: RetryImageCommandInput): import("@smithy/smithy-client").CommandImpl<RetryImageCommandInput, RetryImageCommandOutput, ImagebuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: RetryImageCommandInput): import("@smithy/smithy-client").CommandImpl<RetryImageCommandInput, RetryImageCommandOutput, ImagebuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>RetryImage retries an image distribution without rebuilding the image.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ImagebuilderClient, RetryImageCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
35
+ * // const { ImagebuilderClient, RetryImageCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
36
+ * // import type { ImagebuilderClientConfig } from "@aws-sdk/client-imagebuilder";
37
+ * const config = {}; // type is ImagebuilderClientConfig
38
+ * const client = new ImagebuilderClient(config);
39
+ * const input = { // RetryImageRequest
40
+ * imageBuildVersionArn: "STRING_VALUE", // required
41
+ * clientToken: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new RetryImageCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // RetryImageResponse
46
+ * // clientToken: "STRING_VALUE",
47
+ * // imageBuildVersionArn: "STRING_VALUE",
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param RetryImageCommandInput - {@link RetryImageCommandInput}
53
+ * @returns {@link RetryImageCommandOutput}
54
+ * @see {@link RetryImageCommandInput} for command's `input` shape.
55
+ * @see {@link RetryImageCommandOutput} for command's `response` shape.
56
+ * @see {@link ImagebuilderClientResolvedConfig | config} for ImagebuilderClient's `config` shape.
57
+ *
58
+ * @throws {@link CallRateLimitExceededException} (client fault)
59
+ * <p>You have exceeded the permitted request rate for the specific operation.</p>
60
+ *
61
+ * @throws {@link ClientException} (client fault)
62
+ * <p>These errors are usually caused by a client action, such as using an action or
63
+ * resource on behalf of a user that doesn't have permissions to use the action or
64
+ * resource, or specifying an invalid resource identifier.</p>
65
+ *
66
+ * @throws {@link ForbiddenException} (client fault)
67
+ * <p>You are not authorized to perform the requested operation.</p>
68
+ *
69
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
70
+ * <p>You have specified a client token for an operation using parameter values that differ
71
+ * from a previous request that used the same client token.</p>
72
+ *
73
+ * @throws {@link InvalidRequestException} (client fault)
74
+ * <p>You have requested an action that that the service doesn't support.</p>
75
+ *
76
+ * @throws {@link ResourceInUseException} (client fault)
77
+ * <p>The resource that you are trying to operate on is currently in use. Review the message
78
+ * details and retry later.</p>
79
+ *
80
+ * @throws {@link ServiceException} (server fault)
81
+ * <p>This exception is thrown when the service encounters an unrecoverable
82
+ * exception.</p>
83
+ *
84
+ * @throws {@link ServiceUnavailableException} (server fault)
85
+ * <p>The service is unable to process your request at this time.</p>
86
+ *
87
+ * @throws {@link ImagebuilderServiceException}
88
+ * <p>Base exception class for all service exceptions from Imagebuilder service.</p>
89
+ *
90
+ *
91
+ * @public
92
+ */
93
+ export declare class RetryImageCommand extends RetryImageCommand_base {
94
+ /** @internal type navigation helper, not in runtime. */
95
+ protected static __types: {
96
+ api: {
97
+ input: RetryImageRequest;
98
+ output: RetryImageResponse;
99
+ };
100
+ sdk: {
101
+ input: RetryImageCommandInput;
102
+ output: RetryImageCommandOutput;
103
+ };
104
+ };
105
+ }
@@ -18,6 +18,7 @@ export * from "./DeleteImageRecipeCommand";
18
18
  export * from "./DeleteInfrastructureConfigurationCommand";
19
19
  export * from "./DeleteLifecyclePolicyCommand";
20
20
  export * from "./DeleteWorkflowCommand";
21
+ export * from "./DistributeImageCommand";
21
22
  export * from "./GetComponentCommand";
22
23
  export * from "./GetComponentPolicyCommand";
23
24
  export * from "./GetContainerRecipeCommand";
@@ -64,6 +65,7 @@ export * from "./PutComponentPolicyCommand";
64
65
  export * from "./PutContainerRecipePolicyCommand";
65
66
  export * from "./PutImagePolicyCommand";
66
67
  export * from "./PutImageRecipePolicyCommand";
68
+ export * from "./RetryImageCommand";
67
69
  export * from "./SendWorkflowStepActionCommand";
68
70
  export * from "./StartImagePipelineExecutionCommand";
69
71
  export * from "./StartResourceStateUpdateCommand";
@@ -1,5 +1,17 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ImagebuilderServiceException as __BaseException } from "./ImagebuilderServiceException";
3
+ /**
4
+ * <p>You do not have permissions to perform the requested operation.</p>
5
+ * @public
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
+ }
3
15
  /**
4
16
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
5
17
  * @public
@@ -101,6 +113,18 @@ export declare class ServiceUnavailableException extends __BaseException {
101
113
  */
102
114
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
103
115
  }
116
+ /**
117
+ * <p>The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.</p>
118
+ * @public
119
+ */
120
+ export declare class DryRunOperationException extends __BaseException {
121
+ readonly name: "DryRunOperationException";
122
+ readonly $fault: "client";
123
+ /**
124
+ * @internal
125
+ */
126
+ constructor(opts: __ExceptionOptionType<DryRunOperationException, __BaseException>);
127
+ }
104
128
  /**
105
129
  * <p>You have specified two or more mutually exclusive parameters. Review the error message
106
130
  * for details.</p>
@@ -177,6 +201,18 @@ export declare class ResourceNotFoundException extends __BaseException {
177
201
  */
178
202
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
179
203
  }
204
+ /**
205
+ * <p>You have attempted too many requests for the specific operation.</p>
206
+ * @public
207
+ */
208
+ export declare class TooManyRequestsException extends __BaseException {
209
+ readonly name: "TooManyRequestsException";
210
+ readonly $fault: "client";
211
+ /**
212
+ * @internal
213
+ */
214
+ constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
215
+ }
180
216
  /**
181
217
  * <p>You have provided an invalid pagination token in your request.</p>
182
218
  * @public