DescribeImagesCommand

Suggest an Edit

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppStreamClient, DescribeImagesCommand } from "@aws-sdk/client-appstream"; // ES Modules import
// const { AppStreamClient, DescribeImagesCommand } = require("@aws-sdk/client-appstream"); // CommonJS import
const client = new AppStreamClient(config);
const input = { // DescribeImagesRequest
  Names: [ // StringList
    "STRING_VALUE",
  ],
  Arns: [ // ArnList
    "STRING_VALUE",
  ],
  Type: "PUBLIC" || "PRIVATE" || "SHARED",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new DescribeImagesCommand(input);
const response = await client.send(command);
// { // DescribeImagesResult
//   Images: [ // ImageList
//     { // Image
//       Name: "STRING_VALUE", // required
//       Arn: "STRING_VALUE",
//       BaseImageArn: "STRING_VALUE",
//       DisplayName: "STRING_VALUE",
//       State: "PENDING" || "AVAILABLE" || "FAILED" || "COPYING" || "DELETING" || "CREATING" || "IMPORTING",
//       Visibility: "PUBLIC" || "PRIVATE" || "SHARED",
//       ImageBuilderSupported: true || false,
//       ImageBuilderName: "STRING_VALUE",
//       Platform: "WINDOWS" || "WINDOWS_SERVER_2016" || "WINDOWS_SERVER_2019" || "WINDOWS_SERVER_2022" || "AMAZON_LINUX2" || "RHEL8" || "ROCKY_LINUX8",
//       Description: "STRING_VALUE",
//       StateChangeReason: { // ImageStateChangeReason
//         Code: "INTERNAL_ERROR" || "IMAGE_BUILDER_NOT_AVAILABLE" || "IMAGE_COPY_FAILURE",
//         Message: "STRING_VALUE",
//       },
//       Applications: [ // Applications
//         { // Application
//           Name: "STRING_VALUE",
//           DisplayName: "STRING_VALUE",
//           IconURL: "STRING_VALUE",
//           LaunchPath: "STRING_VALUE",
//           LaunchParameters: "STRING_VALUE",
//           Enabled: true || false,
//           Metadata: { // Metadata
//             "<keys>": "STRING_VALUE",
//           },
//           WorkingDirectory: "STRING_VALUE",
//           Description: "STRING_VALUE",
//           Arn: "STRING_VALUE",
//           AppBlockArn: "STRING_VALUE",
//           IconS3Location: { // S3Location
//             S3Bucket: "STRING_VALUE", // required
//             S3Key: "STRING_VALUE",
//           },
//           Platforms: [ // Platforms
//             "WINDOWS" || "WINDOWS_SERVER_2016" || "WINDOWS_SERVER_2019" || "WINDOWS_SERVER_2022" || "AMAZON_LINUX2" || "RHEL8" || "ROCKY_LINUX8",
//           ],
//           InstanceFamilies: [ // StringList
//             "STRING_VALUE",
//           ],
//           CreatedTime: new Date("TIMESTAMP"),
//         },
//       ],
//       CreatedTime: new Date("TIMESTAMP"),
//       PublicBaseImageReleasedDate: new Date("TIMESTAMP"),
//       AppstreamAgentVersion: "STRING_VALUE",
//       ImagePermissions: { // ImagePermissions
//         allowFleet: true || false,
//         allowImageBuilder: true || false,
//       },
//       ImageErrors: [ // ResourceErrors
//         { // ResourceError
//           ErrorCode: "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION" || "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION" || "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION" || "NETWORK_INTERFACE_LIMIT_EXCEEDED" || "INTERNAL_SERVICE_ERROR" || "IAM_SERVICE_ROLE_IS_MISSING" || "MACHINE_ROLE_IS_MISSING" || "STS_DISABLED_IN_REGION" || "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES" || "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION" || "SUBNET_NOT_FOUND" || "IMAGE_NOT_FOUND" || "INVALID_SUBNET_CONFIGURATION" || "SECURITY_GROUPS_NOT_FOUND" || "IGW_NOT_ATTACHED" || "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION" || "FLEET_STOPPED" || "FLEET_INSTANCE_PROVISIONING_FAILURE" || "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND" || "DOMAIN_JOIN_ERROR_ACCESS_DENIED" || "DOMAIN_JOIN_ERROR_LOGON_FAILURE" || "DOMAIN_JOIN_ERROR_INVALID_PARAMETER" || "DOMAIN_JOIN_ERROR_MORE_DATA" || "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN" || "DOMAIN_JOIN_ERROR_NOT_SUPPORTED" || "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME" || "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED" || "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED" || "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED" || "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR",
//           ErrorMessage: "STRING_VALUE",
//           ErrorTimestamp: new Date("TIMESTAMP"),
//         },
//       ],
//       LatestAppstreamAgentVersion: "TRUE" || "FALSE",
//       SupportedInstanceFamilies: [
//         "STRING_VALUE",
//       ],
//       DynamicAppProvidersEnabled: "ENABLED" || "DISABLED",
//       ImageSharedWithOthers: "TRUE" || "FALSE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeImagesCommand Input

See DescribeImagesCommandInput for more details

Parameter
Type
Description
Arns
string[] | undefined

The ARNs of the public, private, and shared images to describe.

MaxResults
number | undefined

The maximum size of each page of results.

Names
string[] | undefined

The names of the public or private images to describe.

NextToken
string | undefined

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Type
VisibilityType | undefined

The type of image (public, private, or shared) to describe.

DescribeImagesCommand Output

See DescribeImagesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Images
Image[] | undefined

Information about the images.

NextToken
string | undefined

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Throws

Name
Fault
Details
InvalidParameterCombinationException
client

Indicates an incorrect combination of parameters, or a missing parameter.

ResourceNotFoundException
client

The specified resource was not found.

AppStreamServiceException
Base exception class for all service exceptions from AppStream service.