AWS Classic
getPrebuiltEcrImage
Get information about prebuilt Amazon SageMaker Docker images.
NOTE: The AWS provider creates a validly constructed
registry_path
but does not verify that theregistry_path
corresponds to an existing image. For example, using aregistry_path
containing animage_tag
that does not correspond to a Docker image in the ECR repository, will result in an error.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var test = Output.Create(Aws.Sagemaker.GetPrebuiltEcrImage.InvokeAsync(new Aws.Sagemaker.GetPrebuiltEcrImageArgs
{
ImageTag = "2.2-1.0.11.0",
RepositoryName = "sagemaker-scikit-learn",
}));
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.GetPrebuiltEcrImage(ctx, &sagemaker.GetPrebuiltEcrImageArgs{
ImageTag: pulumi.StringRef("2.2-1.0.11.0"),
RepositoryName: "sagemaker-scikit-learn",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var test = Output.of(SagemakerFunctions.getPrebuiltEcrImage(GetPrebuiltEcrImageArgs.builder()
.imageTag("2.2-1.0.11.0")
.repositoryName("sagemaker-scikit-learn")
.build()));
}
}
import pulumi
import pulumi_aws as aws
test = aws.sagemaker.get_prebuilt_ecr_image(image_tag="2.2-1.0.11.0",
repository_name="sagemaker-scikit-learn")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = pulumi.output(aws.sagemaker.getPrebuiltEcrImage({
imageTag: "2.2-1.0.11.0",
repositoryName: "sagemaker-scikit-learn",
}));
variables:
test:
Fn::Invoke:
Function: aws:sagemaker:getPrebuiltEcrImage
Arguments:
imageTag: 2.2-1.0.11.0
repositoryName: sagemaker-scikit-learn
Using getPrebuiltEcrImage
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 getPrebuiltEcrImage(args: GetPrebuiltEcrImageArgs, opts?: InvokeOptions): Promise<GetPrebuiltEcrImageResult>
function getPrebuiltEcrImageOutput(args: GetPrebuiltEcrImageOutputArgs, opts?: InvokeOptions): Output<GetPrebuiltEcrImageResult>
def get_prebuilt_ecr_image(dns_suffix: Optional[str] = None,
image_tag: Optional[str] = None,
region: Optional[str] = None,
repository_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPrebuiltEcrImageResult
def get_prebuilt_ecr_image_output(dns_suffix: Optional[pulumi.Input[str]] = None,
image_tag: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
repository_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPrebuiltEcrImageResult]
func GetPrebuiltEcrImage(ctx *Context, args *GetPrebuiltEcrImageArgs, opts ...InvokeOption) (*GetPrebuiltEcrImageResult, error)
func GetPrebuiltEcrImageOutput(ctx *Context, args *GetPrebuiltEcrImageOutputArgs, opts ...InvokeOption) GetPrebuiltEcrImageResultOutput
> Note: This function is named GetPrebuiltEcrImage
in the Go SDK.
public static class GetPrebuiltEcrImage
{
public static Task<GetPrebuiltEcrImageResult> InvokeAsync(GetPrebuiltEcrImageArgs args, InvokeOptions? opts = null)
public static Output<GetPrebuiltEcrImageResult> Invoke(GetPrebuiltEcrImageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPrebuiltEcrImageResult> getPrebuiltEcrImage(GetPrebuiltEcrImageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws:sagemaker/getPrebuiltEcrImage:getPrebuiltEcrImage
Arguments:
# Arguments dictionary
The following arguments are supported:
- Repository
Name string The name of the repository, which is generally the algorithm or library. Values include
blazingtext
,factorization-machines
,forecasting-deepar
,image-classification
,ipinsights
,kmeans
,knn
,lda
,linear-learner
,mxnet-inference-eia
,mxnet-inference
,mxnet-training
,ntm
,object-detection
,object2vec
,pca
,pytorch-inference-eia
,pytorch-inference
,pytorch-training
,randomcutforest
,sagemaker-scikit-learn
,sagemaker-sparkml-serving
,sagemaker-xgboost
,semantic-segmentation
,seq2seq
,tensorflow-inference-eia
,tensorflow-inference
,tensorflow-training
,huggingface-tensorflow-training
,huggingface-tensorflow-inference
,huggingface-pytorch-training
, andhuggingface-pytorch-inference
.- Dns
Suffix string The DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
- Image
Tag string The image tag for the Docker image. If not specified, the AWS provider sets the value to
1
, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support1
orlatest
and specific version must be used.- Region string
The region to use in the registry path. If not specified, the AWS provider sets it to the current region.
- Repository
Name string The name of the repository, which is generally the algorithm or library. Values include
blazingtext
,factorization-machines
,forecasting-deepar
,image-classification
,ipinsights
,kmeans
,knn
,lda
,linear-learner
,mxnet-inference-eia
,mxnet-inference
,mxnet-training
,ntm
,object-detection
,object2vec
,pca
,pytorch-inference-eia
,pytorch-inference
,pytorch-training
,randomcutforest
,sagemaker-scikit-learn
,sagemaker-sparkml-serving
,sagemaker-xgboost
,semantic-segmentation
,seq2seq
,tensorflow-inference-eia
,tensorflow-inference
,tensorflow-training
,huggingface-tensorflow-training
,huggingface-tensorflow-inference
,huggingface-pytorch-training
, andhuggingface-pytorch-inference
.- Dns
Suffix string The DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
- Image
Tag string The image tag for the Docker image. If not specified, the AWS provider sets the value to
1
, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support1
orlatest
and specific version must be used.- Region string
The region to use in the registry path. If not specified, the AWS provider sets it to the current region.
- repository
Name String The name of the repository, which is generally the algorithm or library. Values include
blazingtext
,factorization-machines
,forecasting-deepar
,image-classification
,ipinsights
,kmeans
,knn
,lda
,linear-learner
,mxnet-inference-eia
,mxnet-inference
,mxnet-training
,ntm
,object-detection
,object2vec
,pca
,pytorch-inference-eia
,pytorch-inference
,pytorch-training
,randomcutforest
,sagemaker-scikit-learn
,sagemaker-sparkml-serving
,sagemaker-xgboost
,semantic-segmentation
,seq2seq
,tensorflow-inference-eia
,tensorflow-inference
,tensorflow-training
,huggingface-tensorflow-training
,huggingface-tensorflow-inference
,huggingface-pytorch-training
, andhuggingface-pytorch-inference
.- dns
Suffix String The DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
- image
Tag String The image tag for the Docker image. If not specified, the AWS provider sets the value to
1
, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support1
orlatest
and specific version must be used.- region String
The region to use in the registry path. If not specified, the AWS provider sets it to the current region.
- repository
Name string The name of the repository, which is generally the algorithm or library. Values include
blazingtext
,factorization-machines
,forecasting-deepar
,image-classification
,ipinsights
,kmeans
,knn
,lda
,linear-learner
,mxnet-inference-eia
,mxnet-inference
,mxnet-training
,ntm
,object-detection
,object2vec
,pca
,pytorch-inference-eia
,pytorch-inference
,pytorch-training
,randomcutforest
,sagemaker-scikit-learn
,sagemaker-sparkml-serving
,sagemaker-xgboost
,semantic-segmentation
,seq2seq
,tensorflow-inference-eia
,tensorflow-inference
,tensorflow-training
,huggingface-tensorflow-training
,huggingface-tensorflow-inference
,huggingface-pytorch-training
, andhuggingface-pytorch-inference
.- dns
Suffix string The DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
- image
Tag string The image tag for the Docker image. If not specified, the AWS provider sets the value to
1
, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support1
orlatest
and specific version must be used.- region string
The region to use in the registry path. If not specified, the AWS provider sets it to the current region.
- repository_
name str The name of the repository, which is generally the algorithm or library. Values include
blazingtext
,factorization-machines
,forecasting-deepar
,image-classification
,ipinsights
,kmeans
,knn
,lda
,linear-learner
,mxnet-inference-eia
,mxnet-inference
,mxnet-training
,ntm
,object-detection
,object2vec
,pca
,pytorch-inference-eia
,pytorch-inference
,pytorch-training
,randomcutforest
,sagemaker-scikit-learn
,sagemaker-sparkml-serving
,sagemaker-xgboost
,semantic-segmentation
,seq2seq
,tensorflow-inference-eia
,tensorflow-inference
,tensorflow-training
,huggingface-tensorflow-training
,huggingface-tensorflow-inference
,huggingface-pytorch-training
, andhuggingface-pytorch-inference
.- dns_
suffix str The DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
- image_
tag str The image tag for the Docker image. If not specified, the AWS provider sets the value to
1
, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support1
orlatest
and specific version must be used.- region str
The region to use in the registry path. If not specified, the AWS provider sets it to the current region.
- repository
Name String The name of the repository, which is generally the algorithm or library. Values include
blazingtext
,factorization-machines
,forecasting-deepar
,image-classification
,ipinsights
,kmeans
,knn
,lda
,linear-learner
,mxnet-inference-eia
,mxnet-inference
,mxnet-training
,ntm
,object-detection
,object2vec
,pca
,pytorch-inference-eia
,pytorch-inference
,pytorch-training
,randomcutforest
,sagemaker-scikit-learn
,sagemaker-sparkml-serving
,sagemaker-xgboost
,semantic-segmentation
,seq2seq
,tensorflow-inference-eia
,tensorflow-inference
,tensorflow-training
,huggingface-tensorflow-training
,huggingface-tensorflow-inference
,huggingface-pytorch-training
, andhuggingface-pytorch-inference
.- dns
Suffix String The DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
- image
Tag String The image tag for the Docker image. If not specified, the AWS provider sets the value to
1
, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support1
orlatest
and specific version must be used.- region String
The region to use in the registry path. If not specified, the AWS provider sets it to the current region.
getPrebuiltEcrImage Result
The following output properties are available:
- Id string
The provider-assigned unique ID for this managed resource.
- Registry
Id string The account ID containing the image. For example,
469771592824
.- Registry
Path string The Docker image URL. For example,
341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4
.- Repository
Name string - Dns
Suffix string - Image
Tag string - Region string
- Id string
The provider-assigned unique ID for this managed resource.
- Registry
Id string The account ID containing the image. For example,
469771592824
.- Registry
Path string The Docker image URL. For example,
341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4
.- Repository
Name string - Dns
Suffix string - Image
Tag string - Region string
- id String
The provider-assigned unique ID for this managed resource.
- registry
Id String The account ID containing the image. For example,
469771592824
.- registry
Path String The Docker image URL. For example,
341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4
.- repository
Name String - dns
Suffix String - image
Tag String - region String
- id string
The provider-assigned unique ID for this managed resource.
- registry
Id string The account ID containing the image. For example,
469771592824
.- registry
Path string The Docker image URL. For example,
341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4
.- repository
Name string - dns
Suffix string - image
Tag string - region string
- id str
The provider-assigned unique ID for this managed resource.
- registry_
id str The account ID containing the image. For example,
469771592824
.- registry_
path str The Docker image URL. For example,
341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4
.- repository_
name str - dns_
suffix str - image_
tag str - region str
- id String
The provider-assigned unique ID for this managed resource.
- registry
Id String The account ID containing the image. For example,
469771592824
.- registry
Path String The Docker image URL. For example,
341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4
.- repository
Name String - dns
Suffix String - image
Tag String - region String
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.