@aws-sdk/client-imagebuilder 3.300.0 → 3.303.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 (118) hide show
  1. package/README.md +51 -3
  2. package/dist-cjs/Imagebuilder.js +90 -0
  3. package/dist-cjs/commands/GetWorkflowExecutionCommand.js +45 -0
  4. package/dist-cjs/commands/GetWorkflowStepExecutionCommand.js +45 -0
  5. package/dist-cjs/commands/ListImageScanFindingAggregationsCommand.js +45 -0
  6. package/dist-cjs/commands/ListImageScanFindingsCommand.js +45 -0
  7. package/dist-cjs/commands/ListWorkflowExecutionsCommand.js +45 -0
  8. package/dist-cjs/commands/ListWorkflowStepExecutionsCommand.js +45 -0
  9. package/dist-cjs/commands/index.js +6 -0
  10. package/dist-cjs/endpoint/ruleset.js +3 -3
  11. package/dist-cjs/models/models_0.js +113 -92
  12. package/dist-cjs/pagination/ListImageScanFindingAggregationsPaginator.js +28 -0
  13. package/dist-cjs/pagination/ListImageScanFindingsPaginator.js +29 -0
  14. package/dist-cjs/pagination/ListWorkflowExecutionsPaginator.js +29 -0
  15. package/dist-cjs/pagination/ListWorkflowStepExecutionsPaginator.js +29 -0
  16. package/dist-cjs/pagination/index.js +4 -0
  17. package/dist-cjs/protocols/Aws_restJson1.js +945 -13
  18. package/dist-es/Imagebuilder.js +90 -0
  19. package/dist-es/commands/GetWorkflowExecutionCommand.js +41 -0
  20. package/dist-es/commands/GetWorkflowStepExecutionCommand.js +41 -0
  21. package/dist-es/commands/ListImageScanFindingAggregationsCommand.js +41 -0
  22. package/dist-es/commands/ListImageScanFindingsCommand.js +41 -0
  23. package/dist-es/commands/ListWorkflowExecutionsCommand.js +41 -0
  24. package/dist-es/commands/ListWorkflowStepExecutionsCommand.js +41 -0
  25. package/dist-es/commands/index.js +6 -0
  26. package/dist-es/endpoint/ruleset.js +3 -3
  27. package/dist-es/models/models_0.js +112 -91
  28. package/dist-es/pagination/ListImageScanFindingAggregationsPaginator.js +24 -0
  29. package/dist-es/pagination/ListImageScanFindingsPaginator.js +25 -0
  30. package/dist-es/pagination/ListWorkflowExecutionsPaginator.js +25 -0
  31. package/dist-es/pagination/ListWorkflowStepExecutionsPaginator.js +25 -0
  32. package/dist-es/pagination/index.js +4 -0
  33. package/dist-es/protocols/Aws_restJson1.js +931 -12
  34. package/dist-types/Imagebuilder.d.ts +165 -75
  35. package/dist-types/ImagebuilderClient.d.ts +11 -5
  36. package/dist-types/commands/CancelImageCreationCommand.d.ts +9 -8
  37. package/dist-types/commands/CreateComponentCommand.d.ts +19 -16
  38. package/dist-types/commands/CreateContainerRecipeCommand.d.ts +25 -21
  39. package/dist-types/commands/CreateDistributionConfigurationCommand.d.ts +35 -32
  40. package/dist-types/commands/CreateImageCommand.d.ts +26 -13
  41. package/dist-types/commands/CreateImagePipelineCommand.d.ts +25 -13
  42. package/dist-types/commands/CreateImageRecipeCommand.d.ts +25 -22
  43. package/dist-types/commands/CreateInfrastructureConfigurationCommand.d.ts +21 -18
  44. package/dist-types/commands/DeleteComponentCommand.d.ts +10 -9
  45. package/dist-types/commands/DeleteContainerRecipeCommand.d.ts +9 -8
  46. package/dist-types/commands/DeleteDistributionConfigurationCommand.d.ts +10 -9
  47. package/dist-types/commands/DeleteImageCommand.d.ts +17 -15
  48. package/dist-types/commands/DeleteImagePipelineCommand.d.ts +10 -9
  49. package/dist-types/commands/DeleteImageRecipeCommand.d.ts +10 -9
  50. package/dist-types/commands/DeleteInfrastructureConfigurationCommand.d.ts +10 -9
  51. package/dist-types/commands/GetComponentCommand.d.ts +8 -7
  52. package/dist-types/commands/GetComponentPolicyCommand.d.ts +5 -4
  53. package/dist-types/commands/GetContainerRecipeCommand.d.ts +7 -6
  54. package/dist-types/commands/GetContainerRecipePolicyCommand.d.ts +4 -3
  55. package/dist-types/commands/GetDistributionConfigurationCommand.d.ts +8 -7
  56. package/dist-types/commands/GetImageCommand.d.ts +8 -7
  57. package/dist-types/commands/GetImagePipelineCommand.d.ts +8 -7
  58. package/dist-types/commands/GetImagePolicyCommand.d.ts +5 -4
  59. package/dist-types/commands/GetImageRecipeCommand.d.ts +8 -7
  60. package/dist-types/commands/GetImageRecipePolicyCommand.d.ts +5 -4
  61. package/dist-types/commands/GetInfrastructureConfigurationCommand.d.ts +8 -7
  62. package/dist-types/commands/GetWorkflowExecutionCommand.d.ts +85 -0
  63. package/dist-types/commands/GetWorkflowStepExecutionCommand.d.ts +85 -0
  64. package/dist-types/commands/ImportComponentCommand.d.ts +12 -11
  65. package/dist-types/commands/ImportVmImageCommand.d.ts +14 -14
  66. package/dist-types/commands/ListComponentBuildVersionsCommand.d.ts +9 -7
  67. package/dist-types/commands/ListComponentsCommand.d.ts +13 -12
  68. package/dist-types/commands/ListContainerRecipesCommand.d.ts +10 -9
  69. package/dist-types/commands/ListDistributionConfigurationsCommand.d.ts +10 -9
  70. package/dist-types/commands/ListImageBuildVersionsCommand.d.ts +11 -10
  71. package/dist-types/commands/ListImagePackagesCommand.d.ts +9 -7
  72. package/dist-types/commands/ListImagePipelineImagesCommand.d.ts +10 -9
  73. package/dist-types/commands/ListImagePipelinesCommand.d.ts +10 -9
  74. package/dist-types/commands/ListImageRecipesCommand.d.ts +11 -10
  75. package/dist-types/commands/ListImageScanFindingAggregationsCommand.d.ts +120 -0
  76. package/dist-types/commands/ListImageScanFindingsCommand.d.ts +96 -0
  77. package/dist-types/commands/ListImagesCommand.d.ts +12 -11
  78. package/dist-types/commands/ListInfrastructureConfigurationsCommand.d.ts +11 -10
  79. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
  80. package/dist-types/commands/ListWorkflowExecutionsCommand.d.ts +90 -0
  81. package/dist-types/commands/ListWorkflowStepExecutionsCommand.d.ts +90 -0
  82. package/dist-types/commands/PutComponentPolicyCommand.d.ts +10 -9
  83. package/dist-types/commands/PutContainerRecipePolicyCommand.d.ts +15 -7
  84. package/dist-types/commands/PutImagePolicyCommand.d.ts +9 -8
  85. package/dist-types/commands/PutImageRecipePolicyCommand.d.ts +10 -9
  86. package/dist-types/commands/StartImagePipelineExecutionCommand.d.ts +10 -9
  87. package/dist-types/commands/TagResourceCommand.d.ts +5 -4
  88. package/dist-types/commands/UntagResourceCommand.d.ts +5 -4
  89. package/dist-types/commands/UpdateDistributionConfigurationCommand.d.ts +31 -30
  90. package/dist-types/commands/UpdateImagePipelineCommand.d.ts +24 -14
  91. package/dist-types/commands/UpdateInfrastructureConfigurationCommand.d.ts +17 -16
  92. package/dist-types/commands/index.d.ts +6 -0
  93. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  94. package/dist-types/models/models_0.d.ts +1712 -524
  95. package/dist-types/pagination/ListImageScanFindingAggregationsPaginator.d.ts +7 -0
  96. package/dist-types/pagination/ListImageScanFindingsPaginator.d.ts +7 -0
  97. package/dist-types/pagination/ListWorkflowExecutionsPaginator.d.ts +7 -0
  98. package/dist-types/pagination/ListWorkflowStepExecutionsPaginator.d.ts +7 -0
  99. package/dist-types/pagination/index.d.ts +4 -0
  100. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  101. package/dist-types/ts3.4/Imagebuilder.d.ts +102 -0
  102. package/dist-types/ts3.4/ImagebuilderClient.d.ts +36 -0
  103. package/dist-types/ts3.4/commands/GetWorkflowExecutionCommand.d.ts +41 -0
  104. package/dist-types/ts3.4/commands/GetWorkflowStepExecutionCommand.d.ts +41 -0
  105. package/dist-types/ts3.4/commands/ListImageScanFindingAggregationsCommand.d.ts +41 -0
  106. package/dist-types/ts3.4/commands/ListImageScanFindingsCommand.d.ts +41 -0
  107. package/dist-types/ts3.4/commands/ListWorkflowExecutionsCommand.d.ts +41 -0
  108. package/dist-types/ts3.4/commands/ListWorkflowStepExecutionsCommand.d.ts +41 -0
  109. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  110. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  111. package/dist-types/ts3.4/models/models_0.d.ts +372 -76
  112. package/dist-types/ts3.4/pagination/ListImageScanFindingAggregationsPaginator.d.ts +11 -0
  113. package/dist-types/ts3.4/pagination/ListImageScanFindingsPaginator.d.ts +11 -0
  114. package/dist-types/ts3.4/pagination/ListWorkflowExecutionsPaginator.d.ts +11 -0
  115. package/dist-types/ts3.4/pagination/ListWorkflowStepExecutionsPaginator.d.ts +11 -0
  116. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  117. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
  118. package/package.json +34 -34
@@ -27,7 +27,7 @@ export interface CancelImageCreationCommandOutput extends CancelImageCreationRes
27
27
  * import { ImagebuilderClient, CancelImageCreationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
28
28
  * // const { ImagebuilderClient, CancelImageCreationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
29
29
  * const client = new ImagebuilderClient(config);
30
- * const input = {
30
+ * const input = { // CancelImageCreationRequest
31
31
  * imageBuildVersionArn: "STRING_VALUE", // required
32
32
  * clientToken: "STRING_VALUE", // required
33
33
  * };
@@ -45,26 +45,27 @@ export interface CancelImageCreationCommandOutput extends CancelImageCreationRes
45
45
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
46
46
  *
47
47
  * @throws {@link ClientException} (client fault)
48
- * <p>These errors are usually caused by a client action, such as using an action or resource on
49
- * behalf of a user that doesn't have permissions to use the action or resource, or specifying an
50
- * invalid resource identifier.</p>
48
+ * <p>These errors are usually caused by a client action, such as using an action or
49
+ * resource on behalf of a user that doesn't have permissions to use the action or
50
+ * resource, or specifying an invalid resource identifier.</p>
51
51
  *
52
52
  * @throws {@link ForbiddenException} (client fault)
53
53
  * <p>You are not authorized to perform the requested operation.</p>
54
54
  *
55
55
  * @throws {@link IdempotentParameterMismatchException} (client fault)
56
- * <p>You have specified a client token for an operation using parameter values that differ from
57
- * a previous request that used the same client token.</p>
56
+ * <p>You have specified a client token for an operation using parameter values that differ
57
+ * from a previous request that used the same client token.</p>
58
58
  *
59
59
  * @throws {@link InvalidRequestException} (client fault)
60
- * <p>You have made a request for an action that is not supported by the service.</p>
60
+ * <p>You have requested an action that that the service doesn't support.</p>
61
61
  *
62
62
  * @throws {@link ResourceInUseException} (client fault)
63
63
  * <p>The resource that you are trying to operate on is currently in use. Review the message
64
64
  * details and retry later.</p>
65
65
  *
66
66
  * @throws {@link ServiceException} (server fault)
67
- * <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
67
+ * <p>This exception is thrown when the service encounters an unrecoverable
68
+ * exception.</p>
68
69
  *
69
70
  * @throws {@link ServiceUnavailableException} (server fault)
70
71
  * <p>The service is unable to process your request at this time.</p>
@@ -20,15 +20,15 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
20
20
  /**
21
21
  * @public
22
22
  * <p>Creates a new component that can be used to build, validate, test, and assess your
23
- * image. The component is based on a YAML document that you specify using exactly one
24
- * of the following methods:</p>
23
+ * image. The component is based on a YAML document that you specify using exactly one of
24
+ * the following methods:</p>
25
25
  * <ul>
26
26
  * <li>
27
27
  * <p>Inline, using the <code>data</code> property in the request body.</p>
28
28
  * </li>
29
29
  * <li>
30
30
  * <p>A URL that points to a YAML document file stored in Amazon S3, using the
31
- * <code>uri</code> property in the request body.</p>
31
+ * <code>uri</code> property in the request body.</p>
32
32
  * </li>
33
33
  * </ul>
34
34
  * @example
@@ -37,19 +37,19 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
37
37
  * import { ImagebuilderClient, CreateComponentCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
38
38
  * // const { ImagebuilderClient, CreateComponentCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
39
39
  * const client = new ImagebuilderClient(config);
40
- * const input = {
40
+ * const input = { // CreateComponentRequest
41
41
  * name: "STRING_VALUE", // required
42
42
  * semanticVersion: "STRING_VALUE", // required
43
43
  * description: "STRING_VALUE",
44
44
  * changeDescription: "STRING_VALUE",
45
45
  * platform: "Windows" || "Linux", // required
46
- * supportedOsVersions: [
46
+ * supportedOsVersions: [ // OsVersionList
47
47
  * "STRING_VALUE",
48
48
  * ],
49
49
  * data: "STRING_VALUE",
50
50
  * uri: "STRING_VALUE",
51
51
  * kmsKeyId: "STRING_VALUE",
52
- * tags: {
52
+ * tags: { // TagMap
53
53
  * "<keys>": "STRING_VALUE",
54
54
  * },
55
55
  * clientToken: "STRING_VALUE", // required
@@ -68,23 +68,23 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
68
68
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
69
69
  *
70
70
  * @throws {@link ClientException} (client fault)
71
- * <p>These errors are usually caused by a client action, such as using an action or resource on
72
- * behalf of a user that doesn't have permissions to use the action or resource, or specifying an
73
- * invalid resource identifier.</p>
71
+ * <p>These errors are usually caused by a client action, such as using an action or
72
+ * resource on behalf of a user that doesn't have permissions to use the action or
73
+ * resource, or specifying an invalid resource identifier.</p>
74
74
  *
75
75
  * @throws {@link ForbiddenException} (client fault)
76
76
  * <p>You are not authorized to perform the requested operation.</p>
77
77
  *
78
78
  * @throws {@link IdempotentParameterMismatchException} (client fault)
79
- * <p>You have specified a client token for an operation using parameter values that differ from
80
- * a previous request that used the same client token.</p>
79
+ * <p>You have specified a client token for an operation using parameter values that differ
80
+ * from a previous request that used the same client token.</p>
81
81
  *
82
82
  * @throws {@link InvalidParameterCombinationException} (client fault)
83
- * <p>You have specified two or more mutually exclusive parameters. Review the error message for
84
- * details.</p>
83
+ * <p>You have specified two or more mutually exclusive parameters. Review the error message
84
+ * for details.</p>
85
85
  *
86
86
  * @throws {@link InvalidRequestException} (client fault)
87
- * <p>You have made a request for an action that is not supported by the service.</p>
87
+ * <p>You have requested an action that that the service doesn't support.</p>
88
88
  *
89
89
  * @throws {@link InvalidVersionNumberException} (client fault)
90
90
  * <p>Your version number is out of bounds or does not follow the required syntax.</p>
@@ -94,10 +94,13 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
94
94
  * details and retry later.</p>
95
95
  *
96
96
  * @throws {@link ServiceException} (server fault)
97
- * <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
97
+ * <p>This exception is thrown when the service encounters an unrecoverable
98
+ * exception.</p>
98
99
  *
99
100
  * @throws {@link ServiceQuotaExceededException} (client fault)
100
- * <p>You have exceeded the number of permitted resources or operations for this service. For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and quotas</a>.</p>
101
+ * <p>You have exceeded the number of permitted resources or operations for this service.
102
+ * For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and
103
+ * quotas</a>.</p>
101
104
  *
102
105
  * @throws {@link ServiceUnavailableException} (server fault)
103
106
  * <p>The service is unable to process your request at this time.</p>
@@ -19,37 +19,38 @@ export interface CreateContainerRecipeCommandOutput extends CreateContainerRecip
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.</p>
22
+ * <p>Creates a new container recipe. Container recipes define how images are configured,
23
+ * tested, and assessed.</p>
23
24
  * @example
24
25
  * Use a bare-bones client and the command you need to make an API call.
25
26
  * ```javascript
26
27
  * import { ImagebuilderClient, CreateContainerRecipeCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
27
28
  * // const { ImagebuilderClient, CreateContainerRecipeCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
28
29
  * const client = new ImagebuilderClient(config);
29
- * const input = {
30
+ * const input = { // CreateContainerRecipeRequest
30
31
  * containerType: "DOCKER", // required
31
32
  * name: "STRING_VALUE", // required
32
33
  * description: "STRING_VALUE",
33
34
  * semanticVersion: "STRING_VALUE", // required
34
- * components: [ // required
35
- * {
35
+ * components: [ // ComponentConfigurationList // required
36
+ * { // ComponentConfiguration
36
37
  * componentArn: "STRING_VALUE", // required
37
- * parameters: [
38
- * {
38
+ * parameters: [ // ComponentParameterList
39
+ * { // ComponentParameter
39
40
  * name: "STRING_VALUE", // required
40
- * value: [ // required
41
+ * value: [ // ComponentParameterValueList // required
41
42
  * "STRING_VALUE",
42
43
  * ],
43
44
  * },
44
45
  * ],
45
46
  * },
46
47
  * ],
47
- * instanceConfiguration: {
48
+ * instanceConfiguration: { // InstanceConfiguration
48
49
  * image: "STRING_VALUE",
49
- * blockDeviceMappings: [
50
- * {
50
+ * blockDeviceMappings: [ // InstanceBlockDeviceMappings
51
+ * { // InstanceBlockDeviceMapping
51
52
  * deviceName: "STRING_VALUE",
52
- * ebs: {
53
+ * ebs: { // EbsInstanceBlockDeviceSpecification
53
54
  * encrypted: true || false,
54
55
  * deleteOnTermination: true || false,
55
56
  * iops: Number("int"),
@@ -69,11 +70,11 @@ export interface CreateContainerRecipeCommandOutput extends CreateContainerRecip
69
70
  * platformOverride: "Windows" || "Linux",
70
71
  * imageOsVersionOverride: "STRING_VALUE",
71
72
  * parentImage: "STRING_VALUE", // required
72
- * tags: {
73
+ * tags: { // TagMap
73
74
  * "<keys>": "STRING_VALUE",
74
75
  * },
75
76
  * workingDirectory: "STRING_VALUE",
76
- * targetRepository: {
77
+ * targetRepository: { // TargetContainerRepository
77
78
  * service: "ECR", // required
78
79
  * repositoryName: "STRING_VALUE", // required
79
80
  * },
@@ -94,19 +95,19 @@ export interface CreateContainerRecipeCommandOutput extends CreateContainerRecip
94
95
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
95
96
  *
96
97
  * @throws {@link ClientException} (client fault)
97
- * <p>These errors are usually caused by a client action, such as using an action or resource on
98
- * behalf of a user that doesn't have permissions to use the action or resource, or specifying an
99
- * invalid resource identifier.</p>
98
+ * <p>These errors are usually caused by a client action, such as using an action or
99
+ * resource on behalf of a user that doesn't have permissions to use the action or
100
+ * resource, or specifying an invalid resource identifier.</p>
100
101
  *
101
102
  * @throws {@link ForbiddenException} (client fault)
102
103
  * <p>You are not authorized to perform the requested operation.</p>
103
104
  *
104
105
  * @throws {@link IdempotentParameterMismatchException} (client fault)
105
- * <p>You have specified a client token for an operation using parameter values that differ from
106
- * a previous request that used the same client token.</p>
106
+ * <p>You have specified a client token for an operation using parameter values that differ
107
+ * from a previous request that used the same client token.</p>
107
108
  *
108
109
  * @throws {@link InvalidRequestException} (client fault)
109
- * <p>You have made a request for an action that is not supported by the service.</p>
110
+ * <p>You have requested an action that that the service doesn't support.</p>
110
111
  *
111
112
  * @throws {@link InvalidVersionNumberException} (client fault)
112
113
  * <p>Your version number is out of bounds or does not follow the required syntax.</p>
@@ -119,10 +120,13 @@ export interface CreateContainerRecipeCommandOutput extends CreateContainerRecip
119
120
  * details and retry later.</p>
120
121
  *
121
122
  * @throws {@link ServiceException} (server fault)
122
- * <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
123
+ * <p>This exception is thrown when the service encounters an unrecoverable
124
+ * exception.</p>
123
125
  *
124
126
  * @throws {@link ServiceQuotaExceededException} (client fault)
125
- * <p>You have exceeded the number of permitted resources or operations for this service. For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and quotas</a>.</p>
127
+ * <p>You have exceeded the number of permitted resources or operations for this service.
128
+ * For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and
129
+ * quotas</a>.</p>
126
130
  *
127
131
  * @throws {@link ServiceUnavailableException} (server fault)
128
132
  * <p>The service is unable to process your request at this time.</p>
@@ -19,79 +19,79 @@ export interface CreateDistributionConfigurationCommandOutput extends CreateDist
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Creates a new distribution configuration. Distribution configurations define and configure
23
- * the outputs of your pipeline.</p>
22
+ * <p>Creates a new distribution configuration. Distribution configurations define and
23
+ * configure the outputs of your pipeline.</p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
26
26
  * ```javascript
27
27
  * import { ImagebuilderClient, CreateDistributionConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
28
28
  * // const { ImagebuilderClient, CreateDistributionConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
29
29
  * const client = new ImagebuilderClient(config);
30
- * const input = {
30
+ * const input = { // CreateDistributionConfigurationRequest
31
31
  * name: "STRING_VALUE", // required
32
32
  * description: "STRING_VALUE",
33
- * distributions: [ // required
34
- * {
33
+ * distributions: [ // DistributionList // required
34
+ * { // Distribution
35
35
  * region: "STRING_VALUE", // required
36
- * amiDistributionConfiguration: {
36
+ * amiDistributionConfiguration: { // AmiDistributionConfiguration
37
37
  * name: "STRING_VALUE",
38
38
  * description: "STRING_VALUE",
39
- * targetAccountIds: [
39
+ * targetAccountIds: [ // AccountList
40
40
  * "STRING_VALUE",
41
41
  * ],
42
- * amiTags: {
42
+ * amiTags: { // TagMap
43
43
  * "<keys>": "STRING_VALUE",
44
44
  * },
45
45
  * kmsKeyId: "STRING_VALUE",
46
- * launchPermission: {
46
+ * launchPermission: { // LaunchPermissionConfiguration
47
47
  * userIds: [
48
48
  * "STRING_VALUE",
49
49
  * ],
50
- * userGroups: [
50
+ * userGroups: [ // StringList
51
51
  * "STRING_VALUE",
52
52
  * ],
53
- * organizationArns: [
53
+ * organizationArns: [ // OrganizationArnList
54
54
  * "STRING_VALUE",
55
55
  * ],
56
- * organizationalUnitArns: [
56
+ * organizationalUnitArns: [ // OrganizationalUnitArnList
57
57
  * "STRING_VALUE",
58
58
  * ],
59
59
  * },
60
60
  * },
61
- * containerDistributionConfiguration: {
61
+ * containerDistributionConfiguration: { // ContainerDistributionConfiguration
62
62
  * description: "STRING_VALUE",
63
63
  * containerTags: [
64
64
  * "STRING_VALUE",
65
65
  * ],
66
- * targetRepository: {
66
+ * targetRepository: { // TargetContainerRepository
67
67
  * service: "ECR", // required
68
68
  * repositoryName: "STRING_VALUE", // required
69
69
  * },
70
70
  * },
71
- * licenseConfigurationArns: [
71
+ * licenseConfigurationArns: [ // LicenseConfigurationArnList
72
72
  * "STRING_VALUE",
73
73
  * ],
74
- * launchTemplateConfigurations: [
75
- * {
74
+ * launchTemplateConfigurations: [ // LaunchTemplateConfigurationList
75
+ * { // LaunchTemplateConfiguration
76
76
  * launchTemplateId: "STRING_VALUE", // required
77
77
  * accountId: "STRING_VALUE",
78
78
  * setDefaultVersion: true || false,
79
79
  * },
80
80
  * ],
81
- * s3ExportConfiguration: {
81
+ * s3ExportConfiguration: { // S3ExportConfiguration
82
82
  * roleName: "STRING_VALUE", // required
83
83
  * diskImageFormat: "VMDK" || "RAW" || "VHD", // required
84
84
  * s3Bucket: "STRING_VALUE", // required
85
85
  * s3Prefix: "STRING_VALUE",
86
86
  * },
87
- * fastLaunchConfigurations: [
88
- * {
87
+ * fastLaunchConfigurations: [ // FastLaunchConfigurationList
88
+ * { // FastLaunchConfiguration
89
89
  * enabled: true || false, // required
90
- * snapshotConfiguration: {
90
+ * snapshotConfiguration: { // FastLaunchSnapshotConfiguration
91
91
  * targetResourceCount: Number("int"),
92
92
  * },
93
93
  * maxParallelLaunches: Number("int"),
94
- * launchTemplate: {
94
+ * launchTemplate: { // FastLaunchLaunchTemplateSpecification
95
95
  * launchTemplateId: "STRING_VALUE",
96
96
  * launchTemplateName: "STRING_VALUE",
97
97
  * launchTemplateVersion: "STRING_VALUE",
@@ -120,23 +120,23 @@ export interface CreateDistributionConfigurationCommandOutput extends CreateDist
120
120
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
121
121
  *
122
122
  * @throws {@link ClientException} (client fault)
123
- * <p>These errors are usually caused by a client action, such as using an action or resource on
124
- * behalf of a user that doesn't have permissions to use the action or resource, or specifying an
125
- * invalid resource identifier.</p>
123
+ * <p>These errors are usually caused by a client action, such as using an action or
124
+ * resource on behalf of a user that doesn't have permissions to use the action or
125
+ * resource, or specifying an invalid resource identifier.</p>
126
126
  *
127
127
  * @throws {@link ForbiddenException} (client fault)
128
128
  * <p>You are not authorized to perform the requested operation.</p>
129
129
  *
130
130
  * @throws {@link IdempotentParameterMismatchException} (client fault)
131
- * <p>You have specified a client token for an operation using parameter values that differ from
132
- * a previous request that used the same client token.</p>
131
+ * <p>You have specified a client token for an operation using parameter values that differ
132
+ * from a previous request that used the same client token.</p>
133
133
  *
134
134
  * @throws {@link InvalidParameterCombinationException} (client fault)
135
- * <p>You have specified two or more mutually exclusive parameters. Review the error message for
136
- * details.</p>
135
+ * <p>You have specified two or more mutually exclusive parameters. Review the error message
136
+ * for details.</p>
137
137
  *
138
138
  * @throws {@link InvalidRequestException} (client fault)
139
- * <p>You have made a request for an action that is not supported by the service.</p>
139
+ * <p>You have requested an action that that the service doesn't support.</p>
140
140
  *
141
141
  * @throws {@link ResourceAlreadyExistsException} (client fault)
142
142
  * <p>The resource that you are trying to create already exists.</p>
@@ -146,10 +146,13 @@ export interface CreateDistributionConfigurationCommandOutput extends CreateDist
146
146
  * details and retry later.</p>
147
147
  *
148
148
  * @throws {@link ServiceException} (server fault)
149
- * <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
149
+ * <p>This exception is thrown when the service encounters an unrecoverable
150
+ * exception.</p>
150
151
  *
151
152
  * @throws {@link ServiceQuotaExceededException} (client fault)
152
- * <p>You have exceeded the number of permitted resources or operations for this service. For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and quotas</a>.</p>
153
+ * <p>You have exceeded the number of permitted resources or operations for this service.
154
+ * For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and
155
+ * quotas</a>.</p>
153
156
  *
154
157
  * @throws {@link ServiceUnavailableException} (server fault)
155
158
  * <p>The service is unable to process your request at this time.</p>
@@ -19,29 +19,39 @@ export interface CreateImageCommandOutput extends CreateImageResponse, __Metadat
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p> Creates a new image. This request will create a new image along with all of the
22
+ * <p>Creates a new image. This request will create a new image along with all of the
23
23
  * configured output resources defined in the distribution configuration. You must specify
24
- * exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.</p>
24
+ * exactly one recipe for your image, using either a ContainerRecipeArn or an
25
+ * ImageRecipeArn.</p>
25
26
  * @example
26
27
  * Use a bare-bones client and the command you need to make an API call.
27
28
  * ```javascript
28
29
  * import { ImagebuilderClient, CreateImageCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
29
30
  * // const { ImagebuilderClient, CreateImageCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
30
31
  * const client = new ImagebuilderClient(config);
31
- * const input = {
32
+ * const input = { // CreateImageRequest
32
33
  * imageRecipeArn: "STRING_VALUE",
33
34
  * containerRecipeArn: "STRING_VALUE",
34
35
  * distributionConfigurationArn: "STRING_VALUE",
35
36
  * infrastructureConfigurationArn: "STRING_VALUE", // required
36
- * imageTestsConfiguration: {
37
+ * imageTestsConfiguration: { // ImageTestsConfiguration
37
38
  * imageTestsEnabled: true || false,
38
39
  * timeoutMinutes: Number("int"),
39
40
  * },
40
41
  * enhancedImageMetadataEnabled: true || false,
41
- * tags: {
42
+ * tags: { // TagMap
42
43
  * "<keys>": "STRING_VALUE",
43
44
  * },
44
45
  * clientToken: "STRING_VALUE", // required
46
+ * imageScanningConfiguration: { // ImageScanningConfiguration
47
+ * imageScanningEnabled: true || false,
48
+ * ecrConfiguration: { // EcrConfiguration
49
+ * repositoryName: "STRING_VALUE",
50
+ * containerTags: [ // StringList
51
+ * "STRING_VALUE",
52
+ * ],
53
+ * },
54
+ * },
45
55
  * };
46
56
  * const command = new CreateImageCommand(input);
47
57
  * const response = await client.send(command);
@@ -57,29 +67,32 @@ export interface CreateImageCommandOutput extends CreateImageResponse, __Metadat
57
67
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
58
68
  *
59
69
  * @throws {@link ClientException} (client fault)
60
- * <p>These errors are usually caused by a client action, such as using an action or resource on
61
- * behalf of a user that doesn't have permissions to use the action or resource, or specifying an
62
- * invalid resource identifier.</p>
70
+ * <p>These errors are usually caused by a client action, such as using an action or
71
+ * resource on behalf of a user that doesn't have permissions to use the action or
72
+ * resource, or specifying an invalid resource identifier.</p>
63
73
  *
64
74
  * @throws {@link ForbiddenException} (client fault)
65
75
  * <p>You are not authorized to perform the requested operation.</p>
66
76
  *
67
77
  * @throws {@link IdempotentParameterMismatchException} (client fault)
68
- * <p>You have specified a client token for an operation using parameter values that differ from
69
- * a previous request that used the same client token.</p>
78
+ * <p>You have specified a client token for an operation using parameter values that differ
79
+ * from a previous request that used the same client token.</p>
70
80
  *
71
81
  * @throws {@link InvalidRequestException} (client fault)
72
- * <p>You have made a request for an action that is not supported by the service.</p>
82
+ * <p>You have requested an action that that the service doesn't support.</p>
73
83
  *
74
84
  * @throws {@link ResourceInUseException} (client fault)
75
85
  * <p>The resource that you are trying to operate on is currently in use. Review the message
76
86
  * details and retry later.</p>
77
87
  *
78
88
  * @throws {@link ServiceException} (server fault)
79
- * <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
89
+ * <p>This exception is thrown when the service encounters an unrecoverable
90
+ * exception.</p>
80
91
  *
81
92
  * @throws {@link ServiceQuotaExceededException} (client fault)
82
- * <p>You have exceeded the number of permitted resources or operations for this service. For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and quotas</a>.</p>
93
+ * <p>You have exceeded the number of permitted resources or operations for this service.
94
+ * For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and
95
+ * quotas</a>.</p>
83
96
  *
84
97
  * @throws {@link ServiceUnavailableException} (server fault)
85
98
  * <p>The service is unable to process your request at this time.</p>
@@ -19,7 +19,7 @@ export interface CreateImagePipelineCommandOutput extends CreateImagePipelineRes
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p> Creates a new image pipeline. Image pipelines enable you to automate the creation and
22
+ * <p>Creates a new image pipeline. Image pipelines enable you to automate the creation and
23
23
  * distribution of images.</p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,28 +27,37 @@ export interface CreateImagePipelineCommandOutput extends CreateImagePipelineRes
27
27
  * import { ImagebuilderClient, CreateImagePipelineCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
28
28
  * // const { ImagebuilderClient, CreateImagePipelineCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
29
29
  * const client = new ImagebuilderClient(config);
30
- * const input = {
30
+ * const input = { // CreateImagePipelineRequest
31
31
  * name: "STRING_VALUE", // required
32
32
  * description: "STRING_VALUE",
33
33
  * imageRecipeArn: "STRING_VALUE",
34
34
  * containerRecipeArn: "STRING_VALUE",
35
35
  * infrastructureConfigurationArn: "STRING_VALUE", // required
36
36
  * distributionConfigurationArn: "STRING_VALUE",
37
- * imageTestsConfiguration: {
37
+ * imageTestsConfiguration: { // ImageTestsConfiguration
38
38
  * imageTestsEnabled: true || false,
39
39
  * timeoutMinutes: Number("int"),
40
40
  * },
41
41
  * enhancedImageMetadataEnabled: true || false,
42
- * schedule: {
42
+ * schedule: { // Schedule
43
43
  * scheduleExpression: "STRING_VALUE",
44
44
  * timezone: "STRING_VALUE",
45
45
  * pipelineExecutionStartCondition: "EXPRESSION_MATCH_ONLY" || "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE",
46
46
  * },
47
47
  * status: "DISABLED" || "ENABLED",
48
- * tags: {
48
+ * tags: { // TagMap
49
49
  * "<keys>": "STRING_VALUE",
50
50
  * },
51
51
  * clientToken: "STRING_VALUE", // required
52
+ * imageScanningConfiguration: { // ImageScanningConfiguration
53
+ * imageScanningEnabled: true || false,
54
+ * ecrConfiguration: { // EcrConfiguration
55
+ * repositoryName: "STRING_VALUE",
56
+ * containerTags: [ // StringList
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * },
60
+ * },
52
61
  * };
53
62
  * const command = new CreateImagePipelineCommand(input);
54
63
  * const response = await client.send(command);
@@ -64,19 +73,19 @@ export interface CreateImagePipelineCommandOutput extends CreateImagePipelineRes
64
73
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
65
74
  *
66
75
  * @throws {@link ClientException} (client fault)
67
- * <p>These errors are usually caused by a client action, such as using an action or resource on
68
- * behalf of a user that doesn't have permissions to use the action or resource, or specifying an
69
- * invalid resource identifier.</p>
76
+ * <p>These errors are usually caused by a client action, such as using an action or
77
+ * resource on behalf of a user that doesn't have permissions to use the action or
78
+ * resource, or specifying an invalid resource identifier.</p>
70
79
  *
71
80
  * @throws {@link ForbiddenException} (client fault)
72
81
  * <p>You are not authorized to perform the requested operation.</p>
73
82
  *
74
83
  * @throws {@link IdempotentParameterMismatchException} (client fault)
75
- * <p>You have specified a client token for an operation using parameter values that differ from
76
- * a previous request that used the same client token.</p>
84
+ * <p>You have specified a client token for an operation using parameter values that differ
85
+ * from a previous request that used the same client token.</p>
77
86
  *
78
87
  * @throws {@link InvalidRequestException} (client fault)
79
- * <p>You have made a request for an action that is not supported by the service.</p>
88
+ * <p>You have requested an action that that the service doesn't support.</p>
80
89
  *
81
90
  * @throws {@link ResourceAlreadyExistsException} (client fault)
82
91
  * <p>The resource that you are trying to create already exists.</p>
@@ -86,10 +95,13 @@ export interface CreateImagePipelineCommandOutput extends CreateImagePipelineRes
86
95
  * details and retry later.</p>
87
96
  *
88
97
  * @throws {@link ServiceException} (server fault)
89
- * <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
98
+ * <p>This exception is thrown when the service encounters an unrecoverable
99
+ * exception.</p>
90
100
  *
91
101
  * @throws {@link ServiceQuotaExceededException} (client fault)
92
- * <p>You have exceeded the number of permitted resources or operations for this service. For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and quotas</a>.</p>
102
+ * <p>You have exceeded the number of permitted resources or operations for this service.
103
+ * For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and
104
+ * quotas</a>.</p>
93
105
  *
94
106
  * @throws {@link ServiceUnavailableException} (server fault)
95
107
  * <p>The service is unable to process your request at this time.</p>