import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ImagebuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ImagebuilderClient"; import type { GetImageRequest, GetImageResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetImageCommand}. */ export interface GetImageCommandInput extends GetImageRequest { } /** * @public * * The output of {@link GetImageCommand}. */ export interface GetImageCommandOutput extends GetImageResponse, __MetadataBearer { } declare const GetImageCommand_base: { new (input: GetImageCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetImageCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Gets an image.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ImagebuilderClient, GetImageCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import * // const { ImagebuilderClient, GetImageCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import * // import type { ImagebuilderClientConfig } from "@aws-sdk/client-imagebuilder"; * const config = {}; // type is ImagebuilderClientConfig * const client = new ImagebuilderClient(config); * const input = { // GetImageRequest * imageBuildVersionArn: "STRING_VALUE", // required * }; * const command = new GetImageCommand(input); * const response = await client.send(command); * // { // GetImageResponse * // requestId: "STRING_VALUE", * // image: { // Image * // arn: "STRING_VALUE", * // type: "AMI" || "DOCKER", * // name: "STRING_VALUE", * // version: "STRING_VALUE", * // platform: "Windows" || "Linux" || "macOS", * // enhancedImageMetadataEnabled: true || false, * // osVersion: "STRING_VALUE", * // state: { // ImageState * // status: "PENDING" || "CREATING" || "BUILDING" || "TESTING" || "DISTRIBUTING" || "INTEGRATING" || "AVAILABLE" || "CANCELLED" || "FAILED" || "DEPRECATED" || "DELETED" || "DISABLED", * // reason: "STRING_VALUE", * // }, * // imageRecipe: { // ImageRecipe * // arn: "STRING_VALUE", * // type: "AMI" || "DOCKER", * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // platform: "Windows" || "Linux" || "macOS", * // owner: "STRING_VALUE", * // version: "STRING_VALUE", * // components: [ // ComponentConfigurationList * // { // ComponentConfiguration * // componentArn: "STRING_VALUE", // required * // parameters: [ // ComponentParameterList * // { // ComponentParameter * // name: "STRING_VALUE", // required * // value: [ // ComponentParameterValueList // required * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // ], * // parentImage: "STRING_VALUE", * // blockDeviceMappings: [ // InstanceBlockDeviceMappings * // { // InstanceBlockDeviceMapping * // deviceName: "STRING_VALUE", * // ebs: { // EbsInstanceBlockDeviceSpecification * // encrypted: true || false, * // deleteOnTermination: true || false, * // iops: Number("int"), * // kmsKeyId: "STRING_VALUE", * // snapshotId: "STRING_VALUE", * // volumeSize: Number("int"), * // volumeType: "standard" || "io1" || "io2" || "gp2" || "gp3" || "sc1" || "st1", * // throughput: Number("int"), * // }, * // virtualName: "STRING_VALUE", * // noDevice: "STRING_VALUE", * // }, * // ], * // dateCreated: "STRING_VALUE", * // tags: { // TagMap * // "": "STRING_VALUE", * // }, * // workingDirectory: "STRING_VALUE", * // additionalInstanceConfiguration: { // AdditionalInstanceConfiguration * // systemsManagerAgent: { // SystemsManagerAgent * // uninstallAfterBuild: true || false, * // }, * // userDataOverride: "STRING_VALUE", * // }, * // amiTags: { * // "": "STRING_VALUE", * // }, * // }, * // containerRecipe: { // ContainerRecipe * // arn: "STRING_VALUE", * // containerType: "DOCKER", * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // platform: "Windows" || "Linux" || "macOS", * // owner: "STRING_VALUE", * // version: "STRING_VALUE", * // components: [ * // { * // componentArn: "STRING_VALUE", // required * // parameters: [ * // { * // name: "STRING_VALUE", // required * // value: [ // required * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // ], * // instanceConfiguration: { // InstanceConfiguration * // image: "STRING_VALUE", * // blockDeviceMappings: [ * // { * // deviceName: "STRING_VALUE", * // ebs: { * // encrypted: true || false, * // deleteOnTermination: true || false, * // iops: Number("int"), * // kmsKeyId: "STRING_VALUE", * // snapshotId: "STRING_VALUE", * // volumeSize: Number("int"), * // volumeType: "standard" || "io1" || "io2" || "gp2" || "gp3" || "sc1" || "st1", * // throughput: Number("int"), * // }, * // virtualName: "STRING_VALUE", * // noDevice: "STRING_VALUE", * // }, * // ], * // }, * // dockerfileTemplateData: "STRING_VALUE", * // kmsKeyId: "STRING_VALUE", * // encrypted: true || false, * // parentImage: "STRING_VALUE", * // dateCreated: "STRING_VALUE", * // tags: { * // "": "STRING_VALUE", * // }, * // workingDirectory: "STRING_VALUE", * // targetRepository: { // TargetContainerRepository * // service: "ECR", // required * // repositoryName: "STRING_VALUE", // required * // }, * // }, * // sourcePipelineName: "STRING_VALUE", * // sourcePipelineArn: "STRING_VALUE", * // infrastructureConfiguration: { // InfrastructureConfiguration * // arn: "STRING_VALUE", * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // instanceTypes: [ // InstanceTypeList * // "STRING_VALUE", * // ], * // instanceProfileName: "STRING_VALUE", * // securityGroupIds: [ // SecurityGroupIds * // "STRING_VALUE", * // ], * // subnetId: "STRING_VALUE", * // logging: { // Logging * // s3Logs: { // S3Logs * // s3BucketName: "STRING_VALUE", * // s3KeyPrefix: "STRING_VALUE", * // }, * // }, * // keyPair: "STRING_VALUE", * // terminateInstanceOnFailure: true || false, * // snsTopicArn: "STRING_VALUE", * // dateCreated: "STRING_VALUE", * // dateUpdated: "STRING_VALUE", * // resourceTags: { // ResourceTagMap * // "": "STRING_VALUE", * // }, * // instanceMetadataOptions: { // InstanceMetadataOptions * // httpTokens: "STRING_VALUE", * // httpPutResponseHopLimit: Number("int"), * // }, * // tags: { * // "": "STRING_VALUE", * // }, * // placement: { // Placement * // availabilityZone: "STRING_VALUE", * // tenancy: "default" || "dedicated" || "host", * // hostId: "STRING_VALUE", * // hostResourceGroupArn: "STRING_VALUE", * // }, * // }, * // distributionConfiguration: { // DistributionConfiguration * // arn: "STRING_VALUE", * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // distributions: [ // DistributionList * // { // Distribution * // region: "STRING_VALUE", // required * // amiDistributionConfiguration: { // AmiDistributionConfiguration * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // targetAccountIds: [ // AccountList * // "STRING_VALUE", * // ], * // amiTags: { * // "": "STRING_VALUE", * // }, * // kmsKeyId: "STRING_VALUE", * // launchPermission: { // LaunchPermissionConfiguration * // userIds: [ * // "STRING_VALUE", * // ], * // userGroups: [ // StringList * // "STRING_VALUE", * // ], * // organizationArns: [ // OrganizationArnList * // "STRING_VALUE", * // ], * // organizationalUnitArns: [ // OrganizationalUnitArnList * // "STRING_VALUE", * // ], * // }, * // }, * // containerDistributionConfiguration: { // ContainerDistributionConfiguration * // description: "STRING_VALUE", * // containerTags: [ * // "STRING_VALUE", * // ], * // targetRepository: { * // service: "ECR", // required * // repositoryName: "STRING_VALUE", // required * // }, * // }, * // licenseConfigurationArns: [ // LicenseConfigurationArnList * // "STRING_VALUE", * // ], * // launchTemplateConfigurations: [ // LaunchTemplateConfigurationList * // { // LaunchTemplateConfiguration * // launchTemplateId: "STRING_VALUE", // required * // accountId: "STRING_VALUE", * // setDefaultVersion: true || false, * // }, * // ], * // s3ExportConfiguration: { // S3ExportConfiguration * // roleName: "STRING_VALUE", // required * // diskImageFormat: "VMDK" || "RAW" || "VHD", // required * // s3Bucket: "STRING_VALUE", // required * // s3Prefix: "STRING_VALUE", * // }, * // fastLaunchConfigurations: [ // FastLaunchConfigurationList * // { // FastLaunchConfiguration * // enabled: true || false, // required * // snapshotConfiguration: { // FastLaunchSnapshotConfiguration * // targetResourceCount: Number("int"), * // }, * // maxParallelLaunches: Number("int"), * // launchTemplate: { // FastLaunchLaunchTemplateSpecification * // launchTemplateId: "STRING_VALUE", * // launchTemplateName: "STRING_VALUE", * // launchTemplateVersion: "STRING_VALUE", * // }, * // accountId: "STRING_VALUE", * // }, * // ], * // ssmParameterConfigurations: [ // SsmParameterConfigurationList * // { // SsmParameterConfiguration * // amiAccountId: "STRING_VALUE", * // parameterName: "STRING_VALUE", // required * // dataType: "text" || "aws:ec2:image", * // }, * // ], * // }, * // ], * // timeoutMinutes: Number("int"), // required * // dateCreated: "STRING_VALUE", * // dateUpdated: "STRING_VALUE", * // tags: "", * // }, * // imageTestsConfiguration: { // ImageTestsConfiguration * // imageTestsEnabled: true || false, * // timeoutMinutes: Number("int"), * // }, * // dateCreated: "STRING_VALUE", * // outputResources: { // OutputResources * // amis: [ // AmiList * // { // Ami * // region: "STRING_VALUE", * // image: "STRING_VALUE", * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // state: { * // status: "PENDING" || "CREATING" || "BUILDING" || "TESTING" || "DISTRIBUTING" || "INTEGRATING" || "AVAILABLE" || "CANCELLED" || "FAILED" || "DEPRECATED" || "DELETED" || "DISABLED", * // reason: "STRING_VALUE", * // }, * // accountId: "STRING_VALUE", * // }, * // ], * // containers: [ // ContainerList * // { // Container * // region: "STRING_VALUE", * // imageUris: "", * // }, * // ], * // }, * // tags: "", * // buildType: "USER_INITIATED" || "SCHEDULED" || "IMPORT" || "IMPORT_ISO", * // imageSource: "AMAZON_MANAGED" || "AWS_MARKETPLACE" || "IMPORTED" || "CUSTOM", * // scanState: { // ImageScanState * // status: "PENDING" || "SCANNING" || "COLLECTING" || "COMPLETED" || "ABANDONED" || "FAILED" || "TIMED_OUT", * // reason: "STRING_VALUE", * // }, * // imageScanningConfiguration: { // ImageScanningConfiguration * // imageScanningEnabled: true || false, * // ecrConfiguration: { // EcrConfiguration * // repositoryName: "STRING_VALUE", * // containerTags: "", * // }, * // }, * // deprecationTime: new Date("TIMESTAMP"), * // lifecycleExecutionId: "STRING_VALUE", * // executionRole: "STRING_VALUE", * // workflows: [ // WorkflowConfigurationList * // { // WorkflowConfiguration * // workflowArn: "STRING_VALUE", // required * // parameters: [ // WorkflowParameterList * // { // WorkflowParameter * // name: "STRING_VALUE", // required * // value: [ // WorkflowParameterValueList // required * // "STRING_VALUE", * // ], * // }, * // ], * // parallelGroup: "STRING_VALUE", * // onFailure: "CONTINUE" || "ABORT", * // }, * // ], * // loggingConfiguration: { // ImageLoggingConfiguration * // logGroupName: "STRING_VALUE", * // }, * // }, * // latestVersionReferences: { // LatestVersionReferences * // latestVersionArn: "STRING_VALUE", * // latestMajorVersionArn: "STRING_VALUE", * // latestMinorVersionArn: "STRING_VALUE", * // latestPatchVersionArn: "STRING_VALUE", * // }, * // }; * * ``` * * @param GetImageCommandInput - {@link GetImageCommandInput} * @returns {@link GetImageCommandOutput} * @see {@link GetImageCommandInput} for command's `input` shape. * @see {@link GetImageCommandOutput} for command's `response` shape. * @see {@link ImagebuilderClientResolvedConfig | config} for ImagebuilderClient's `config` shape. * * @throws {@link CallRateLimitExceededException} (client fault) *

You have exceeded the permitted request rate for the specific operation.

* * @throws {@link ClientException} (client fault) *

These errors are usually caused by a client action, such as using an action or * resource on behalf of a user that doesn't have permissions to use the action or * resource, or specifying an invalid resource identifier.

* * @throws {@link ForbiddenException} (client fault) *

You are not authorized to perform the requested operation.

* * @throws {@link InvalidRequestException} (client fault) *

You have requested an action that that the service doesn't support.

* * @throws {@link ServiceException} (server fault) *

This exception is thrown when the service encounters an unrecoverable * exception.

* * @throws {@link ServiceUnavailableException} (server fault) *

The service is unable to process your request at this time.

* * @throws {@link ImagebuilderServiceException} *

Base exception class for all service exceptions from Imagebuilder service.

* * * @public */ export declare class GetImageCommand extends GetImageCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetImageRequest; output: GetImageResponse; }; sdk: { input: GetImageCommandInput; output: GetImageCommandOutput; }; }; }