@aws-sdk/client-imagebuilder 3.52.0 → 3.53.0

package/dist-types/Imagebuilder.d.ts

@@ -66,7 +66,17 @@ export declare class Imagebuilder extends ImagebuilderClient {
     cancelImageCreation(args: CancelImageCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelImageCreationCommandOutput) => void): void;
     /**
      * <p>Creates a new component that can be used to build, validate, test, and assess your
-     * 			image.</p>
+     * 			image. The component is based on a YAML document that you specify using exactly one
+     * 			of the following methods:</p>
+     * 		       <ul>
+     *             <li>
+     * 				           <p>Inline, using the <code>data</code> property in the request body.</p>
+     * 			         </li>
+     *             <li>
+     * 				           <p>A URL that points to a YAML document file stored in Amazon S3, using the
+     * 					<code>uri</code> property in the request body.</p>
+     * 			         </li>
+     *          </ul>
      */
     createComponent(args: CreateComponentCommandInput, options?: __HttpHandlerOptions): Promise<CreateComponentCommandOutput>;
     createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void;

package/dist-types/commands/CreateComponentCommand.d.ts

@@ -8,7 +8,17 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
 }
 /**
  * <p>Creates a new component that can be used to build, validate, test, and assess your
- * 			image.</p>
+ * 			image. The component is based on a YAML document that you specify using exactly one
+ * 			of the following methods:</p>
+ * 		       <ul>
+ *             <li>
+ * 				           <p>Inline, using the <code>data</code> property in the request body.</p>
+ * 			         </li>
+ *             <li>
+ * 				           <p>A URL that points to a YAML document file stored in Amazon S3, using the
+ * 					<code>uri</code> property in the request body.</p>
+ * 			         </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/index.d.ts

@@ -3,3 +3,4 @@ export * from "./ImagebuilderClient";
 export * from "./commands";
 export * from "./models";
 export * from "./pagination";
+export { ImagebuilderServiceException } from "./models/ImagebuilderServiceException";

package/dist-types/models/ImagebuilderServiceException.d.ts

@@ -0,0 +1,10 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * Base exception class for all service exceptions from Imagebuilder service.
+ */
+export declare class ImagebuilderServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,5 @@
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
+import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { ImagebuilderServiceException as __BaseException } from "./ImagebuilderServiceException";
 /**
  * <p>Contains settings for the Systems Manager agent on your build instance.</p>
  */
@@ -31,11 +32,19 @@ export interface AdditionalInstanceConfiguration {
     /**
      * <p>Use this property to provide commands or a command script to run when you launch
      * 			your build instance.</p>
+     * 		       <p>The userDataOverride property replaces any commands that Image Builder might have added to ensure
+     * 			that Systems Manager is installed on your Linux build instance. If you override the user data,
+     * 			make sure that you add commands to install Systems Manager, if it is not pre-installed on your
+     * 			base image.</p>
      * 		       <note>
-     * 			         <p>The userDataOverride property replaces any commands that Image Builder might have added to ensure
-     * 				that Systems Manager is installed on your Linux build instance. If you override the user data,
-     * 				make sure that you add commands to install Systems Manager, if it is not pre-installed on your
-     * 				base image.</p>
+     * 			         <p>The user data is always base 64 encoded. For example, the
+     * 				following commands are encoded as <code>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$</code>:</p>
+     *
+     * 			         <p>
+     *                <i>#!/bin/bash</i>
+     *             </p>
+     * 			         <p>mkdir -p /var/bb/</p>
+     * 			         <p>touch /var</p>
      * 		       </note>
      */
     userDataOverride?: string;
@@ -192,10 +201,13 @@ export declare enum BuildType {
 /**
  * <p>You have exceeded the permitted request rate for the specific operation.</p>
  */
-export interface CallRateLimitExceededException extends __SmithyException, $MetadataBearer {
-    name: "CallRateLimitExceededException";
-    $fault: "client";
-    message?: string;
+export declare class CallRateLimitExceededException extends __BaseException {
+    readonly name: "CallRateLimitExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CallRateLimitExceededException, __BaseException>);
 }
 export interface CancelImageCreationRequest {
     /**
@@ -240,60 +252,81 @@ export declare namespace CancelImageCreationResponse {
  * 			behalf of a user that doesn't have permissions to use the action or resource, or specifying an
  * 			invalid resource identifier.</p>
  */
-export interface ClientException extends __SmithyException, $MetadataBearer {
-    name: "ClientException";
-    $fault: "client";
-    message?: string;
+export declare class ClientException extends __BaseException {
+    readonly name: "ClientException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ClientException, __BaseException>);
 }
 /**
  * <p>You are not authorized to perform the requested operation.</p>
  */
-export interface ForbiddenException extends __SmithyException, $MetadataBearer {
-    name: "ForbiddenException";
-    $fault: "client";
-    message?: string;
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
  * <p>You have specified a client token for an operation using parameter values that differ from
  * 			a previous request that used the same client token.</p>
  */
-export interface IdempotentParameterMismatchException extends __SmithyException, $MetadataBearer {
-    name: "IdempotentParameterMismatchException";
-    $fault: "client";
-    message?: string;
+export declare class IdempotentParameterMismatchException extends __BaseException {
+    readonly name: "IdempotentParameterMismatchException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
 }
 /**
  * <p>You have made a request for an action that is not supported by the service.</p>
  */
-export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
-    name: "InvalidRequestException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidRequestException extends __BaseException {
+    readonly name: "InvalidRequestException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
  * <p>The resource that you are trying to operate on is currently in use. Review the message
  * 			details and retry later.</p>
  */
-export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
-    name: "ResourceInUseException";
-    $fault: "client";
-    message?: string;
+export declare class ResourceInUseException extends __BaseException {
+    readonly name: "ResourceInUseException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
 }
 /**
  * <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
  */
-export interface ServiceException extends __SmithyException, $MetadataBearer {
-    name: "ServiceException";
-    $fault: "server";
-    message?: string;
+export declare class ServiceException extends __BaseException {
+    readonly name: "ServiceException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceException, __BaseException>);
 }
 /**
  * <p>The service is unable to process your request at this time.</p>
  */
-export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
-    name: "ServiceUnavailableException";
-    $fault: "server";
-    message?: string;
+export declare class ServiceUnavailableException extends __BaseException {
+    readonly name: "ServiceUnavailableException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
  * <p>Defines a parameter that is used to provide configuration details for the component.</p>
@@ -406,7 +439,7 @@ export interface Component {
      */
     owner?: string;
     /**
-     * <p>The data of the component.</p>
+     * <p>Component data contains the YAML document content for the component.</p>
      */
     data?: string;
     /**
@@ -991,15 +1024,18 @@ export interface CreateComponentRequest {
      */
     supportedOsVersions?: string[];
     /**
-     * <p>The data of the component. Used to specify the data inline. Either <code>data</code> or
-     * 			<code>uri</code> can be used to specify the data within the component.</p>
+     * <p>Component <code>data</code> contains inline YAML document content for the component.
+     * 			Alternatively, you can specify the <code>uri</code> of a YAML document file stored in
+     * 			Amazon S3. However, you cannot specify both properties.</p>
      */
     data?: string;
     /**
-     * <p>The uri of the component. Must be an Amazon S3 URL and the requester must have permission to
-     * 			access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service
-     * 			quota. Either <code>data</code> or <code>uri</code> can be used to specify the data within the
-     * 			component.</p>
+     * <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL
+     * 			(<code>s3://bucket/key</code>), and the requester must have permission to access
+     * 			the S3 bucket it points to. If you use Amazon S3, you can specify component content
+     * 			up to your service quota.</p>
+     * 		       <p>Alternatively, you can specify the YAML document inline, using the component
+     * 			<code>data</code> property. You cannot specify both properties.</p>
      */
     uri?: string;
     /**
@@ -1047,26 +1083,35 @@ export declare namespace CreateComponentResponse {
  * <p>You have specified two or more mutually exclusive parameters. Review the error message for
  * 			details.</p>
  */
-export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
-    name: "InvalidParameterCombinationException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidParameterCombinationException extends __BaseException {
+    readonly name: "InvalidParameterCombinationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterCombinationException, __BaseException>);
 }
 /**
  * <p>Your version number is out of bounds or does not follow the required syntax.</p>
  */
-export interface InvalidVersionNumberException extends __SmithyException, $MetadataBearer {
-    name: "InvalidVersionNumberException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidVersionNumberException extends __BaseException {
+    readonly name: "InvalidVersionNumberException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidVersionNumberException, __BaseException>);
 }
 /**
  * <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>
  */
-export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
-    name: "ServiceQuotaExceededException";
-    $fault: "client";
-    message?: string;
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 export interface CreateContainerRecipeRequest {
     /**
@@ -1177,10 +1222,95 @@ export declare namespace CreateContainerRecipeResponse {
 /**
  * <p>The resource that you are trying to create already exists.</p>
  */
-export interface ResourceAlreadyExistsException extends __SmithyException, $MetadataBearer {
-    name: "ResourceAlreadyExistsException";
-    $fault: "client";
-    message?: string;
+export declare class ResourceAlreadyExistsException extends __BaseException {
+    readonly name: "ResourceAlreadyExistsException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
+}
+/**
+ * <p>Identifies the launch template that the associated Windows AMI uses for
+ * 			launching an instance when faster launching is enabled.</p>
+ * 		       <note>
+ * 			         <p>You can specify either the <code>launchTemplateName</code> or the
+ * 				<code>launchTemplateId</code>, but not both.</p>
+ * 		       </note>
+ */
+export interface FastLaunchLaunchTemplateSpecification {
+    /**
+     * <p>The ID of the launch template to use for faster launching for a Windows AMI.</p>
+     */
+    launchTemplateId?: string;
+    /**
+     * <p>The name of the launch template to use for faster launching for a Windows AMI.</p>
+     */
+    launchTemplateName?: string;
+    /**
+     * <p>The version of the launch template to use for faster launching for a Windows AMI.</p>
+     */
+    launchTemplateVersion?: string;
+}
+export declare namespace FastLaunchLaunchTemplateSpecification {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: FastLaunchLaunchTemplateSpecification) => any;
+}
+/**
+ * <p>Configuration settings for creating and managing pre-provisioned snapshots
+ * 			for a fast-launch enabled Windows AMI.</p>
+ */
+export interface FastLaunchSnapshotConfiguration {
+    /**
+     * <p>The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled
+     * 			Windows AMI.</p>
+     */
+    targetResourceCount?: number;
+}
+export declare namespace FastLaunchSnapshotConfiguration {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: FastLaunchSnapshotConfiguration) => any;
+}
+/**
+ * <p>Define and configure faster launching for output Windows AMIs.</p>
+ */
+export interface FastLaunchConfiguration {
+    /**
+     * <p>A Boolean that represents the current state of faster launching for the
+     * 			Windows AMI. Set to <code>true</code> to start using Windows faster launching, or
+     * 			<code>false</code> to stop using it.</p>
+     */
+    enabled: boolean | undefined;
+    /**
+     * <p>Configuration settings for managing the number of snapshots that are
+     * 			created from pre-provisioned instances for the Windows AMI when faster
+     * 			launching is enabled.</p>
+     */
+    snapshotConfiguration?: FastLaunchSnapshotConfiguration;
+    /**
+     * <p>The maximum number of parallel instances that are launched for creating
+     * 			resources.</p>
+     */
+    maxParallelLaunches?: number;
+    /**
+     * <p>The launch template that the fast-launch enabled Windows AMI uses when it
+     * 			launches Windows instances to create pre-provisioned snapshots.</p>
+     */
+    launchTemplate?: FastLaunchLaunchTemplateSpecification;
+    /**
+     * <p>The owner account ID for the fast-launch enabled Windows AMI.</p>
+     */
+    accountId?: string;
+}
+export declare namespace FastLaunchConfiguration {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: FastLaunchConfiguration) => any;
 }
 /**
  * <p>Identifies an Amazon EC2 launch template to use for a specific account.</p>
@@ -1289,6 +1419,10 @@ export interface Distribution {
      * 			using a file format that is compatible with your VMs in that Region.</p>
      */
     s3ExportConfiguration?: S3ExportConfiguration;
+    /**
+     * <p>The Windows faster-launching configurations to use for AMI distribution.</p>
+     */
+    fastLaunchConfigurations?: FastLaunchConfiguration[];
 }
 export declare namespace Distribution {
     /**
@@ -1862,10 +1996,13 @@ export declare namespace DeleteComponentResponse {
  * <p>You have attempted to mutate or delete a resource with a dependency that prohibits this
  * 			action. See the error message for more details.</p>
  */
-export interface ResourceDependencyException extends __SmithyException, $MetadataBearer {
-    name: "ResourceDependencyException";
-    $fault: "client";
-    message?: string;
+export declare class ResourceDependencyException extends __BaseException {
+    readonly name: "ResourceDependencyException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceDependencyException, __BaseException>);
 }
 export interface DeleteContainerRecipeRequest {
     /**
@@ -2203,10 +2340,13 @@ export declare namespace GetComponentPolicyResponse {
 /**
  * <p>At least one of the resources referenced by your request does not exist.</p>
  */
-export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
-    name: "ResourceNotFoundException";
-    $fault: "client";
-    message?: string;
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 export interface GetContainerRecipeRequest {
     /**
@@ -3057,10 +3197,13 @@ export declare namespace ImportVmImageResponse {
 /**
  * <p>You have provided an invalid pagination token in your request.</p>
  */
-export interface InvalidPaginationTokenException extends __SmithyException, $MetadataBearer {
-    name: "InvalidPaginationTokenException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidPaginationTokenException extends __BaseException {
+    readonly name: "InvalidPaginationTokenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
 }
 export interface ListComponentBuildVersionsRequest {
     /**
@@ -4055,10 +4198,13 @@ export declare namespace ListInfrastructureConfigurationsResponse {
  * <p>The specified parameter is invalid. Review the available parameters for the API
  * 			request.</p>
  */
-export interface InvalidParameterException extends __SmithyException, $MetadataBearer {
-    name: "InvalidParameterException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidParameterException extends __BaseException {
+    readonly name: "InvalidParameterException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 export interface ListTagsForResourceRequest {
     /**
@@ -4089,10 +4235,13 @@ export declare namespace ListTagsForResourceResponse {
 /**
  * <p>The value that you provided for the specified parameter is invalid.</p>
  */
-export interface InvalidParameterValueException extends __SmithyException, $MetadataBearer {
-    name: "InvalidParameterValueException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidParameterValueException extends __BaseException {
+    readonly name: "InvalidParameterValueException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
 }
 export interface PutComponentPolicyRequest {
     /**

package/dist-types/ts3.4/index.d.ts

@@ -3,3 +3,4 @@ export * from "./ImagebuilderClient";
 export * from "./commands";
 export * from "./models";
 export * from "./pagination";
+export { ImagebuilderServiceException } from "./models/ImagebuilderServiceException";

package/dist-types/ts3.4/models/ImagebuilderServiceException.d.ts

@@ -0,0 +1,6 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+
+export declare class ImagebuilderServiceException extends __ServiceException {
+    
+    constructor(options: __ServiceExceptionOptions);
+}