Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. sagemaker
  5. getImage

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.getImage

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::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(image_arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(image_arn: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
    func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput

    > Note: This function is named LookupImage 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-native:sagemaker:getImage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ImageArn string

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    ImageArn string

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    imageArn String

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    imageArn string

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    image_arn str

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    imageArn String

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    getImage Result

    The following output properties are available:

    ImageArn string

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    ImageDescription string
    The description of the image.
    ImageDisplayName string

    The display name of the image.

    Length Constraints : Minimum length of 1. Maximum length of 128.

    Pattern : ^\S(.*\S)?$

    ImageRoleArn string

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Length Constraints : Minimum length of 20. Maximum length of 2048.

    Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    ImageArn string

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    ImageDescription string
    The description of the image.
    ImageDisplayName string

    The display name of the image.

    Length Constraints : Minimum length of 1. Maximum length of 128.

    Pattern : ^\S(.*\S)?$

    ImageRoleArn string

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Length Constraints : Minimum length of 20. Maximum length of 2048.

    Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

    Tags Tag
    An array of key-value pairs to apply to this resource.
    imageArn String

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    imageDescription String
    The description of the image.
    imageDisplayName String

    The display name of the image.

    Length Constraints : Minimum length of 1. Maximum length of 128.

    Pattern : ^\S(.*\S)?$

    imageRoleArn String

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Length Constraints : Minimum length of 20. Maximum length of 2048.

    Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    imageArn string

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    imageDescription string
    The description of the image.
    imageDisplayName string

    The display name of the image.

    Length Constraints : Minimum length of 1. Maximum length of 128.

    Pattern : ^\S(.*\S)?$

    imageRoleArn string

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Length Constraints : Minimum length of 20. Maximum length of 2048.

    Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    image_arn str

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    image_description str
    The description of the image.
    image_display_name str

    The display name of the image.

    Length Constraints : Minimum length of 1. Maximum length of 128.

    Pattern : ^\S(.*\S)?$

    image_role_arn str

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Length Constraints : Minimum length of 20. Maximum length of 2048.

    Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    imageArn String

    The Amazon Resource Name (ARN) of the image.

    Type : String

    Length Constraints : Maximum length of 256.

    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    imageDescription String
    The description of the image.
    imageDisplayName String

    The display name of the image.

    Length Constraints : Minimum length of 1. Maximum length of 128.

    Pattern : ^\S(.*\S)?$

    imageRoleArn String

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Length Constraints : Minimum length of 20. Maximum length of 2048.

    Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native