Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. appstream
  5. getImage
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.appstream.getImage

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Data source for managing an AWS AppStream 2.0 Image.

    Using getImage

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>
    def get_image(arn: Optional[str] = None,
              most_recent: Optional[bool] = None,
              name: Optional[str] = None,
              name_regex: Optional[str] = None,
              type: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(arn: Optional[pulumi.Input[str]] = None,
              most_recent: Optional[pulumi.Input[bool]] = None,
              name: Optional[pulumi.Input[str]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              type: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
    func GetImage(ctx *Context, args *GetImageArgs, opts ...InvokeOption) (*GetImageResult, error)
func GetImageOutput(ctx *Context, args *GetImageOutputArgs, opts ...InvokeOption) GetImageResultOutput

    > Note: This function is named GetImage in the Go SDK.

    public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
public static Output<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:appstream/getImage:getImage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Arn of the image being searched for. Cannot be used with name_regex or name.
    MostRecent bool
    Boolean that if it is set to true and there are multiple images returned the most recent will be returned. If it is set to false and there are multiple images return the datasource will error.
    Name string
    Name of the image being searched for. Cannot be used with name_regex or arn.
    NameRegex string
    Regular expression name of the image being searched for. Cannot be used with arn or name.
    Type string
    The type of image which must be (PUBLIC, PRIVATE, or SHARED).
    Arn string
    Arn of the image being searched for. Cannot be used with name_regex or name.
    MostRecent bool
    Boolean that if it is set to true and there are multiple images returned the most recent will be returned. If it is set to false and there are multiple images return the datasource will error.
    Name string
    Name of the image being searched for. Cannot be used with name_regex or arn.
    NameRegex string
    Regular expression name of the image being searched for. Cannot be used with arn or name.
    Type string
    The type of image which must be (PUBLIC, PRIVATE, or SHARED).
    arn String
    Arn of the image being searched for. Cannot be used with name_regex or name.
    mostRecent Boolean
    Boolean that if it is set to true and there are multiple images returned the most recent will be returned. If it is set to false and there are multiple images return the datasource will error.
    name String
    Name of the image being searched for. Cannot be used with name_regex or arn.
    nameRegex String
    Regular expression name of the image being searched for. Cannot be used with arn or name.
    type String
    The type of image which must be (PUBLIC, PRIVATE, or SHARED).
    arn string
    Arn of the image being searched for. Cannot be used with name_regex or name.
    mostRecent boolean
    Boolean that if it is set to true and there are multiple images returned the most recent will be returned. If it is set to false and there are multiple images return the datasource will error.
    name string
    Name of the image being searched for. Cannot be used with name_regex or arn.
    nameRegex string
    Regular expression name of the image being searched for. Cannot be used with arn or name.
    type string
    The type of image which must be (PUBLIC, PRIVATE, or SHARED).
    arn str
    Arn of the image being searched for. Cannot be used with name_regex or name.
    most_recent bool
    Boolean that if it is set to true and there are multiple images returned the most recent will be returned. If it is set to false and there are multiple images return the datasource will error.
    name str
    Name of the image being searched for. Cannot be used with name_regex or arn.
    name_regex str
    Regular expression name of the image being searched for. Cannot be used with arn or name.
    type str
    The type of image which must be (PUBLIC, PRIVATE, or SHARED).
    arn String
    Arn of the image being searched for. Cannot be used with name_regex or name.
    mostRecent Boolean
    Boolean that if it is set to true and there are multiple images returned the most recent will be returned. If it is set to false and there are multiple images return the datasource will error.
    name String
    Name of the image being searched for. Cannot be used with name_regex or arn.
    nameRegex String
    Regular expression name of the image being searched for. Cannot be used with arn or name.
    type String
    The type of image which must be (PUBLIC, PRIVATE, or SHARED).

    getImage Result

    The following output properties are available:

    Applications List<GetImageApplication>
    AppstreamAgentVersion string
    Version of the AppStream 2.0 agent to use for instances that are launched from this image. Has a maximum length of 100 characters.
    Arn string
    ARN of the image.
    BaseImageArn string
    ARN of the image from which the image was created.
    CreatedTime string
    Time at which this image was created.
    Description string
    Description of image.
    DisplayName string
    Image name to display.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageBuilderName string
    The name of the image builder that was used to created the private image. If the image is sharedthen the value is null.
    ImageBuilderSupported bool
    Boolean to indicate whether an image builder can be launched from this image.

    • image error - Resource error object that describes the error containing the following:
    ImagePermissions List<GetImageImagePermission>
    List of strings describing the image permissions containing the following:
    Name string
    Platform string
    Operating system platform of the image. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    PublicBaseImageReleasedDate string
    State string
    Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING.
    StateChangeReasons List<GetImageStateChangeReason>
    MostRecent bool
    NameRegex string
    Type string
    Applications []GetImageApplication
    AppstreamAgentVersion string
    Version of the AppStream 2.0 agent to use for instances that are launched from this image. Has a maximum length of 100 characters.
    Arn string
    ARN of the image.
    BaseImageArn string
    ARN of the image from which the image was created.
    CreatedTime string
    Time at which this image was created.
    Description string
    Description of image.
    DisplayName string
    Image name to display.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageBuilderName string
    The name of the image builder that was used to created the private image. If the image is sharedthen the value is null.
    ImageBuilderSupported bool
    Boolean to indicate whether an image builder can be launched from this image.

    • image error - Resource error object that describes the error containing the following:
    ImagePermissions []GetImageImagePermission
    List of strings describing the image permissions containing the following:
    Name string
    Platform string
    Operating system platform of the image. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    PublicBaseImageReleasedDate string
    State string
    Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING.
    StateChangeReasons []GetImageStateChangeReason
    MostRecent bool
    NameRegex string
    Type string
    applications List<GetImageApplication>
    appstreamAgentVersion String
    Version of the AppStream 2.0 agent to use for instances that are launched from this image. Has a maximum length of 100 characters.
    arn String
    ARN of the image.
    baseImageArn String
    ARN of the image from which the image was created.
    createdTime String
    Time at which this image was created.
    description String
    Description of image.
    displayName String
    Image name to display.
    id String
    The provider-assigned unique ID for this managed resource.
    imageBuilderName String
    The name of the image builder that was used to created the private image. If the image is sharedthen the value is null.
    imageBuilderSupported Boolean
    Boolean to indicate whether an image builder can be launched from this image.

    • image error - Resource error object that describes the error containing the following:
    imagePermissions List<GetImageImagePermission>
    List of strings describing the image permissions containing the following:
    name String
    platform String
    Operating system platform of the image. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    publicBaseImageReleasedDate String
    state String
    Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING.
    stateChangeReasons List<GetImageStateChangeReason>
    mostRecent Boolean
    nameRegex String
    type String
    applications GetImageApplication[]
    appstreamAgentVersion string
    Version of the AppStream 2.0 agent to use for instances that are launched from this image. Has a maximum length of 100 characters.
    arn string
    ARN of the image.
    baseImageArn string
    ARN of the image from which the image was created.
    createdTime string
    Time at which this image was created.
    description string
    Description of image.
    displayName string
    Image name to display.
    id string
    The provider-assigned unique ID for this managed resource.
    imageBuilderName string
    The name of the image builder that was used to created the private image. If the image is sharedthen the value is null.
    imageBuilderSupported boolean
    Boolean to indicate whether an image builder can be launched from this image.

    • image error - Resource error object that describes the error containing the following:
    imagePermissions GetImageImagePermission[]
    List of strings describing the image permissions containing the following:
    name string
    platform string
    Operating system platform of the image. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    publicBaseImageReleasedDate string
    state string
    Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING.
    stateChangeReasons GetImageStateChangeReason[]
    mostRecent boolean
    nameRegex string
    type string
    applications Sequence[GetImageApplication]
    appstream_agent_version str
    Version of the AppStream 2.0 agent to use for instances that are launched from this image. Has a maximum length of 100 characters.
    arn str
    ARN of the image.
    base_image_arn str
    ARN of the image from which the image was created.
    created_time str
    Time at which this image was created.
    description str
    Description of image.
    display_name str
    Image name to display.
    id str
    The provider-assigned unique ID for this managed resource.
    image_builder_name str
    The name of the image builder that was used to created the private image. If the image is sharedthen the value is null.
    image_builder_supported bool
    Boolean to indicate whether an image builder can be launched from this image.

    • image error - Resource error object that describes the error containing the following:
    image_permissions Sequence[GetImageImagePermission]
    List of strings describing the image permissions containing the following:
    name str
    platform str
    Operating system platform of the image. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    public_base_image_released_date str
    state str
    Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING.
    state_change_reasons Sequence[GetImageStateChangeReason]
    most_recent bool
    name_regex str
    type str
    applications List<Property Map>
    appstreamAgentVersion String
    Version of the AppStream 2.0 agent to use for instances that are launched from this image. Has a maximum length of 100 characters.
    arn String
    ARN of the image.
    baseImageArn String
    ARN of the image from which the image was created.
    createdTime String
    Time at which this image was created.
    description String
    Description of image.
    displayName String
    Image name to display.
    id String
    The provider-assigned unique ID for this managed resource.
    imageBuilderName String
    The name of the image builder that was used to created the private image. If the image is sharedthen the value is null.
    imageBuilderSupported Boolean
    Boolean to indicate whether an image builder can be launched from this image.

    • image error - Resource error object that describes the error containing the following:
    imagePermissions List<Property Map>
    List of strings describing the image permissions containing the following:
    name String
    platform String
    Operating system platform of the image. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    publicBaseImageReleasedDate String
    state String
    Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING.
    stateChangeReasons List<Property Map>
    mostRecent Boolean
    nameRegex String
    type String

    Supporting Types

    GetImageApplication

    AppBlockArn string
    The app block ARN of the application.
    Arn string
    Arn of the image being searched for. Cannot be used with name_regex or name.
    CreatedTime string
    Time at which this image was created.
    Description string
    Description of image.
    DisplayName string
    Image name to display.
    Enabled bool
    Bool based on if the application is enabled.
    IconS3Locations List<GetImageApplicationIconS3Location>
    A list named icon_s3_location that contains the following:
    IconUrl string
    URL of the application icon. This URL may be time-limited.
    InstanceFamilies List<string>
    List of the instance families of the application.
    LaunchParameters string
    Arguments that are passed to the application at it's launch.
    LaunchPath string
    Path to the application's excecutable in the instance.
    Metadata Dictionary<string, string>
    String to string map that contains additional attributes used to describe the application.

    • Name - Name of the application.
    Name string
    Name of the image being searched for. Cannot be used with name_regex or arn.
    Platforms List<string>
    Array of strings describing the platforms on which the application can run. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    WorkingDirectory string
    Working directory for the application.
    AppBlockArn string
    The app block ARN of the application.
    Arn string
    Arn of the image being searched for. Cannot be used with name_regex or name.
    CreatedTime string
    Time at which this image was created.
    Description string
    Description of image.
    DisplayName string
    Image name to display.
    Enabled bool
    Bool based on if the application is enabled.
    IconS3Locations []GetImageApplicationIconS3Location
    A list named icon_s3_location that contains the following:
    IconUrl string
    URL of the application icon. This URL may be time-limited.
    InstanceFamilies []string
    List of the instance families of the application.
    LaunchParameters string
    Arguments that are passed to the application at it's launch.
    LaunchPath string
    Path to the application's excecutable in the instance.
    Metadata map[string]string
    String to string map that contains additional attributes used to describe the application.

    • Name - Name of the application.
    Name string
    Name of the image being searched for. Cannot be used with name_regex or arn.
    Platforms []string
    Array of strings describing the platforms on which the application can run. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    WorkingDirectory string
    Working directory for the application.
    appBlockArn String
    The app block ARN of the application.
    arn String
    Arn of the image being searched for. Cannot be used with name_regex or name.
    createdTime String
    Time at which this image was created.
    description String
    Description of image.
    displayName String
    Image name to display.
    enabled Boolean
    Bool based on if the application is enabled.
    iconS3Locations List<GetImageApplicationIconS3Location>
    A list named icon_s3_location that contains the following:
    iconUrl String
    URL of the application icon. This URL may be time-limited.
    instanceFamilies List<String>
    List of the instance families of the application.
    launchParameters String
    Arguments that are passed to the application at it's launch.
    launchPath String
    Path to the application's excecutable in the instance.
    metadata Map<String,String>
    String to string map that contains additional attributes used to describe the application.

    • Name - Name of the application.
    name String
    Name of the image being searched for. Cannot be used with name_regex or arn.
    platforms List<String>
    Array of strings describing the platforms on which the application can run. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    workingDirectory String
    Working directory for the application.
    appBlockArn string
    The app block ARN of the application.
    arn string
    Arn of the image being searched for. Cannot be used with name_regex or name.
    createdTime string
    Time at which this image was created.
    description string
    Description of image.
    displayName string
    Image name to display.
    enabled boolean
    Bool based on if the application is enabled.
    iconS3Locations GetImageApplicationIconS3Location[]
    A list named icon_s3_location that contains the following:
    iconUrl string
    URL of the application icon. This URL may be time-limited.
    instanceFamilies string[]
    List of the instance families of the application.
    launchParameters string
    Arguments that are passed to the application at it's launch.
    launchPath string
    Path to the application's excecutable in the instance.
    metadata {[key: string]: string}
    String to string map that contains additional attributes used to describe the application.

    • Name - Name of the application.
    name string
    Name of the image being searched for. Cannot be used with name_regex or arn.
    platforms string[]
    Array of strings describing the platforms on which the application can run. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    workingDirectory string
    Working directory for the application.
    app_block_arn str
    The app block ARN of the application.
    arn str
    Arn of the image being searched for. Cannot be used with name_regex or name.
    created_time str
    Time at which this image was created.
    description str
    Description of image.
    display_name str
    Image name to display.
    enabled bool
    Bool based on if the application is enabled.
    icon_s3_locations Sequence[GetImageApplicationIconS3Location]
    A list named icon_s3_location that contains the following:
    icon_url str
    URL of the application icon. This URL may be time-limited.
    instance_families Sequence[str]
    List of the instance families of the application.
    launch_parameters str
    Arguments that are passed to the application at it's launch.
    launch_path str
    Path to the application's excecutable in the instance.
    metadata Mapping[str, str]
    String to string map that contains additional attributes used to describe the application.

    • Name - Name of the application.
    name str
    Name of the image being searched for. Cannot be used with name_regex or arn.
    platforms Sequence[str]
    Array of strings describing the platforms on which the application can run. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    working_directory str
    Working directory for the application.
    appBlockArn String
    The app block ARN of the application.
    arn String
    Arn of the image being searched for. Cannot be used with name_regex or name.
    createdTime String
    Time at which this image was created.
    description String
    Description of image.
    displayName String
    Image name to display.
    enabled Boolean
    Bool based on if the application is enabled.
    iconS3Locations List<Property Map>
    A list named icon_s3_location that contains the following:
    iconUrl String
    URL of the application icon. This URL may be time-limited.
    instanceFamilies List<String>
    List of the instance families of the application.
    launchParameters String
    Arguments that are passed to the application at it's launch.
    launchPath String
    Path to the application's excecutable in the instance.
    metadata Map<String>
    String to string map that contains additional attributes used to describe the application.

    • Name - Name of the application.
    name String
    Name of the image being searched for. Cannot be used with name_regex or arn.
    platforms List<String>
    Array of strings describing the platforms on which the application can run. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
    workingDirectory String
    Working directory for the application.

    GetImageApplicationIconS3Location

    S3Bucket string
    S3 bucket of the S3 object.
    S3Key string
    S3 key of the S3 object.
    S3Bucket string
    S3 bucket of the S3 object.
    S3Key string
    S3 key of the S3 object.
    s3Bucket String
    S3 bucket of the S3 object.
    s3Key String
    S3 key of the S3 object.
    s3Bucket string
    S3 bucket of the S3 object.
    s3Key string
    S3 key of the S3 object.
    s3_bucket str
    S3 bucket of the S3 object.
    s3_key str
    S3 key of the S3 object.
    s3Bucket String
    S3 bucket of the S3 object.
    s3Key String
    S3 key of the S3 object.

    GetImageImagePermission

    AllowFleet bool
    Boolean indicating if the image can be used for a fleet.
    AllowImageBuilder bool
    indicated whether the image can be used for an image builder.
    AllowFleet bool
    Boolean indicating if the image can be used for a fleet.
    AllowImageBuilder bool
    indicated whether the image can be used for an image builder.
    allowFleet Boolean
    Boolean indicating if the image can be used for a fleet.
    allowImageBuilder Boolean
    indicated whether the image can be used for an image builder.
    allowFleet boolean
    Boolean indicating if the image can be used for a fleet.
    allowImageBuilder boolean
    indicated whether the image can be used for an image builder.
    allow_fleet bool
    Boolean indicating if the image can be used for a fleet.
    allow_image_builder bool
    indicated whether the image can be used for an image builder.
    allowFleet Boolean
    Boolean indicating if the image can be used for a fleet.
    allowImageBuilder Boolean
    indicated whether the image can be used for an image builder.

    GetImageStateChangeReason

    Code string
    Message string
    Code string
    Message string
    code String
    message String
    code string
    message string
    code str
    message str
    code String
    message String

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws