1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. sagemaker
  6. getExtension

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::SageMaker::Extension. An extension is a versioned software package that Amazon SageMaker HyperPod installs and manages on the nodes of a HyperPod cluster. For example, the sagemaker-observability extension collects metrics from your cluster.

    Using getExtension

    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 getExtension(args: GetExtensionArgs, opts?: InvokeOptions): Promise<GetExtensionResult>
    function getExtensionOutput(args: GetExtensionOutputArgs, opts?: InvokeOutputOptions): Output<GetExtensionResult>
    def get_extension(extension_arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetExtensionResult
    def get_extension_output(extension_arn: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetExtensionResult]
    func LookupExtension(ctx *Context, args *LookupExtensionArgs, opts ...InvokeOption) (*LookupExtensionResult, error)
    func LookupExtensionOutput(ctx *Context, args *LookupExtensionOutputArgs, opts ...InvokeOption) LookupExtensionResultOutput

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

    public static class GetExtension 
    {
        public static Task<GetExtensionResult> InvokeAsync(GetExtensionArgs args, InvokeOptions? opts = null)
        public static Output<GetExtensionResult> Invoke(GetExtensionInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetExtensionResult> Invoke(GetExtensionInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOptions options)
    public static Output<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOptions options)
    public static Output<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:sagemaker:getExtension
      arguments:
        # arguments dictionary
    data "aws-native_sagemaker_get_extension" "name" {
        # arguments
    }

    The following arguments are supported:

    ExtensionArn string
    The Amazon Resource Name (ARN) of the extension.
    ExtensionArn string
    The Amazon Resource Name (ARN) of the extension.
    extension_arn string
    The Amazon Resource Name (ARN) of the extension.
    extensionArn String
    The Amazon Resource Name (ARN) of the extension.
    extensionArn string
    The Amazon Resource Name (ARN) of the extension.
    extension_arn str
    The Amazon Resource Name (ARN) of the extension.
    extensionArn String
    The Amazon Resource Name (ARN) of the extension.

    getExtension Result

    The following output properties are available:

    ConfigurationValues string
    The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
    CreationTime string
    The date and time that you created the extension.
    ExtensionArn string
    The Amazon Resource Name (ARN) of the extension.
    ExtensionVersion string
    The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
    LastModifiedTime string
    The date and time of the most recent change to the extension.
    NodeSummary Pulumi.AwsNative.SageMaker.Outputs.ExtensionNodeSummary
    Status Pulumi.AwsNative.SageMaker.ExtensionStatus
    The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to add to the extension. You can add up to 50 tags.
    ConfigurationValues string
    The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
    CreationTime string
    The date and time that you created the extension.
    ExtensionArn string
    The Amazon Resource Name (ARN) of the extension.
    ExtensionVersion string
    The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
    LastModifiedTime string
    The date and time of the most recent change to the extension.
    NodeSummary ExtensionNodeSummary
    Status ExtensionStatus
    The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
    Tags Tag
    The tags to add to the extension. You can add up to 50 tags.
    configuration_values string
    The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
    creation_time string
    The date and time that you created the extension.
    extension_arn string
    The Amazon Resource Name (ARN) of the extension.
    extension_version string
    The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
    last_modified_time string
    The date and time of the most recent change to the extension.
    node_summary object
    status "Creating" | "Active" | "CreateFailed" | "Updating" | "Deleting" | "DeleteFailed" | "Degraded" | "UpdateFailed"
    The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
    tags list(object)
    The tags to add to the extension. You can add up to 50 tags.
    configurationValues String
    The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
    creationTime String
    The date and time that you created the extension.
    extensionArn String
    The Amazon Resource Name (ARN) of the extension.
    extensionVersion String
    The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
    lastModifiedTime String
    The date and time of the most recent change to the extension.
    nodeSummary ExtensionNodeSummary
    status ExtensionStatus
    The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
    tags List<Tag>
    The tags to add to the extension. You can add up to 50 tags.
    configurationValues string
    The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
    creationTime string
    The date and time that you created the extension.
    extensionArn string
    The Amazon Resource Name (ARN) of the extension.
    extensionVersion string
    The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
    lastModifiedTime string
    The date and time of the most recent change to the extension.
    nodeSummary ExtensionNodeSummary
    status ExtensionStatus
    The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
    tags Tag[]
    The tags to add to the extension. You can add up to 50 tags.
    configuration_values str
    The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
    creation_time str
    The date and time that you created the extension.
    extension_arn str
    The Amazon Resource Name (ARN) of the extension.
    extension_version str
    The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
    last_modified_time str
    The date and time of the most recent change to the extension.
    node_summary ExtensionNodeSummary
    status ExtensionStatus
    The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
    tags Sequence[root_Tag]
    The tags to add to the extension. You can add up to 50 tags.
    configurationValues String
    The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
    creationTime String
    The date and time that you created the extension.
    extensionArn String
    The Amazon Resource Name (ARN) of the extension.
    extensionVersion String
    The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
    lastModifiedTime String
    The date and time of the most recent change to the extension.
    nodeSummary Property Map
    status "Creating" | "Active" | "CreateFailed" | "Updating" | "Deleting" | "DeleteFailed" | "Degraded" | "UpdateFailed"
    The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
    tags List<Property Map>
    The tags to add to the extension. You can add up to 50 tags.

    Supporting Types

    ExtensionNodeSummary

    ActiveCount int
    The number of cluster nodes that run the requested extension version.
    TotalCount int
    The number of cluster nodes that the extension applies to.
    ActiveCount int
    The number of cluster nodes that run the requested extension version.
    TotalCount int
    The number of cluster nodes that the extension applies to.
    active_count number
    The number of cluster nodes that run the requested extension version.
    total_count number
    The number of cluster nodes that the extension applies to.
    activeCount Integer
    The number of cluster nodes that run the requested extension version.
    totalCount Integer
    The number of cluster nodes that the extension applies to.
    activeCount number
    The number of cluster nodes that run the requested extension version.
    totalCount number
    The number of cluster nodes that the extension applies to.
    active_count int
    The number of cluster nodes that run the requested extension version.
    total_count int
    The number of cluster nodes that the extension applies to.
    activeCount Number
    The number of cluster nodes that run the requested extension version.
    totalCount Number
    The number of cluster nodes that the extension applies to.

    ExtensionStatus

    NameValue
    CreatingCreating
    ActiveActive
    CreateFailedCreateFailed
    UpdatingUpdating
    DeletingDeleting
    DeleteFailedDeleteFailed
    DegradedDegraded
    UpdateFailedUpdateFailed
    NameValue
    ExtensionStatusCreatingCreating
    ExtensionStatusActiveActive
    ExtensionStatusCreateFailedCreateFailed
    ExtensionStatusUpdatingUpdating
    ExtensionStatusDeletingDeleting
    ExtensionStatusDeleteFailedDeleteFailed
    ExtensionStatusDegradedDegraded
    ExtensionStatusUpdateFailedUpdateFailed
    Value
    Creating
    Active
    CreateFailed
    Updating
    Deleting
    DeleteFailed
    Degraded
    UpdateFailed
    NameValue
    CreatingCreating
    ActiveActive
    CreateFailedCreateFailed
    UpdatingUpdating
    DeletingDeleting
    DeleteFailedDeleteFailed
    DegradedDegraded
    UpdateFailedUpdateFailed
    NameValue
    CreatingCreating
    ActiveActive
    CreateFailedCreateFailed
    UpdatingUpdating
    DeletingDeleting
    DeleteFailedDeleteFailed
    DegradedDegraded
    UpdateFailedUpdateFailed
    NameValue
    CREATINGCreating
    ACTIVEActive
    CREATE_FAILEDCreateFailed
    UPDATINGUpdating
    DELETINGDeleting
    DELETE_FAILEDDeleteFailed
    DEGRADEDDegraded
    UPDATE_FAILEDUpdateFailed
    Value
    Creating
    Active
    CreateFailed
    Updating
    Deleting
    DeleteFailed
    Degraded
    UpdateFailed

    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 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 aws-native logo AWS Cloud Control

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial