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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.getEndpoint

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::Endpoint

    Using getEndpoint

    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 getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>
    def get_endpoint(endpoint_arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(endpoint_arn: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]
    func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

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

    public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:sagemaker:getEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EndpointArn string
    The Amazon Resource Name (ARN) of the endpoint.
    EndpointArn string
    The Amazon Resource Name (ARN) of the endpoint.
    endpointArn String
    The Amazon Resource Name (ARN) of the endpoint.
    endpointArn string
    The Amazon Resource Name (ARN) of the endpoint.
    endpoint_arn str
    The Amazon Resource Name (ARN) of the endpoint.
    endpointArn String
    The Amazon Resource Name (ARN) of the endpoint.

    getEndpoint Result

    The following output properties are available:

    DeploymentConfig Pulumi.AwsNative.SageMaker.Outputs.EndpointDeploymentConfig
    Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
    EndpointArn string
    The Amazon Resource Name (ARN) of the endpoint.
    EndpointConfigName string
    The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    DeploymentConfig EndpointDeploymentConfig
    Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
    EndpointArn string
    The Amazon Resource Name (ARN) of the endpoint.
    EndpointConfigName string
    The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    deploymentConfig EndpointDeploymentConfig
    Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
    endpointArn String
    The Amazon Resource Name (ARN) of the endpoint.
    endpointConfigName String
    The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    deploymentConfig EndpointDeploymentConfig
    Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
    endpointArn string
    The Amazon Resource Name (ARN) of the endpoint.
    endpointConfigName string
    The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    deployment_config EndpointDeploymentConfig
    Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
    endpoint_arn str
    The Amazon Resource Name (ARN) of the endpoint.
    endpoint_config_name str
    The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    deploymentConfig Property Map
    Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
    endpointArn String
    The Amazon Resource Name (ARN) of the endpoint.
    endpointConfigName String
    The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    EndpointAlarm

    AlarmName string
    The name of the CloudWatch alarm.
    AlarmName string
    The name of the CloudWatch alarm.
    alarmName String
    The name of the CloudWatch alarm.
    alarmName string
    The name of the CloudWatch alarm.
    alarm_name str
    The name of the CloudWatch alarm.
    alarmName String
    The name of the CloudWatch alarm.

    EndpointAutoRollbackConfig

    Alarms List<Pulumi.AwsNative.SageMaker.Inputs.EndpointAlarm>
    List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
    Alarms []EndpointAlarm
    List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
    alarms List<EndpointAlarm>
    List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
    alarms EndpointAlarm[]
    List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
    alarms Sequence[EndpointAlarm]
    List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
    alarms List<Property Map>
    List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.

    EndpointBlueGreenUpdatePolicy

    TrafficRoutingConfiguration Pulumi.AwsNative.SageMaker.Inputs.EndpointTrafficRoutingConfig
    The traffic routing configuration for the blue/green deployment.
    MaximumExecutionTimeoutInSeconds int
    The maximum time allowed for the blue/green update, in seconds.
    TerminationWaitInSeconds int
    The wait time before terminating the old endpoint during a blue/green deployment.
    TrafficRoutingConfiguration EndpointTrafficRoutingConfig
    The traffic routing configuration for the blue/green deployment.
    MaximumExecutionTimeoutInSeconds int
    The maximum time allowed for the blue/green update, in seconds.
    TerminationWaitInSeconds int
    The wait time before terminating the old endpoint during a blue/green deployment.
    trafficRoutingConfiguration EndpointTrafficRoutingConfig
    The traffic routing configuration for the blue/green deployment.
    maximumExecutionTimeoutInSeconds Integer
    The maximum time allowed for the blue/green update, in seconds.
    terminationWaitInSeconds Integer
    The wait time before terminating the old endpoint during a blue/green deployment.
    trafficRoutingConfiguration EndpointTrafficRoutingConfig
    The traffic routing configuration for the blue/green deployment.
    maximumExecutionTimeoutInSeconds number
    The maximum time allowed for the blue/green update, in seconds.
    terminationWaitInSeconds number
    The wait time before terminating the old endpoint during a blue/green deployment.
    traffic_routing_configuration EndpointTrafficRoutingConfig
    The traffic routing configuration for the blue/green deployment.
    maximum_execution_timeout_in_seconds int
    The maximum time allowed for the blue/green update, in seconds.
    termination_wait_in_seconds int
    The wait time before terminating the old endpoint during a blue/green deployment.
    trafficRoutingConfiguration Property Map
    The traffic routing configuration for the blue/green deployment.
    maximumExecutionTimeoutInSeconds Number
    The maximum time allowed for the blue/green update, in seconds.
    terminationWaitInSeconds Number
    The wait time before terminating the old endpoint during a blue/green deployment.

    EndpointCapacitySize

    Type string
    Specifies whether the Value is an instance count or a capacity unit.
    Value int
    The value representing either the number of instances or the number of capacity units.
    Type string
    Specifies whether the Value is an instance count or a capacity unit.
    Value int
    The value representing either the number of instances or the number of capacity units.
    type String
    Specifies whether the Value is an instance count or a capacity unit.
    value Integer
    The value representing either the number of instances or the number of capacity units.
    type string
    Specifies whether the Value is an instance count or a capacity unit.
    value number
    The value representing either the number of instances or the number of capacity units.
    type str
    Specifies whether the Value is an instance count or a capacity unit.
    value int
    The value representing either the number of instances or the number of capacity units.
    type String
    Specifies whether the Value is an instance count or a capacity unit.
    value Number
    The value representing either the number of instances or the number of capacity units.

    EndpointDeploymentConfig

    AutoRollbackConfiguration Pulumi.AwsNative.SageMaker.Inputs.EndpointAutoRollbackConfig
    Configuration for automatic rollback if an error occurs during deployment.
    BlueGreenUpdatePolicy Pulumi.AwsNative.SageMaker.Inputs.EndpointBlueGreenUpdatePolicy
    Configuration for blue-green update deployment policies.
    RollingUpdatePolicy Pulumi.AwsNative.SageMaker.Inputs.EndpointRollingUpdatePolicy
    Configuration for rolling update deployment policies.
    AutoRollbackConfiguration EndpointAutoRollbackConfig
    Configuration for automatic rollback if an error occurs during deployment.
    BlueGreenUpdatePolicy EndpointBlueGreenUpdatePolicy
    Configuration for blue-green update deployment policies.
    RollingUpdatePolicy EndpointRollingUpdatePolicy
    Configuration for rolling update deployment policies.
    autoRollbackConfiguration EndpointAutoRollbackConfig
    Configuration for automatic rollback if an error occurs during deployment.
    blueGreenUpdatePolicy EndpointBlueGreenUpdatePolicy
    Configuration for blue-green update deployment policies.
    rollingUpdatePolicy EndpointRollingUpdatePolicy
    Configuration for rolling update deployment policies.
    autoRollbackConfiguration EndpointAutoRollbackConfig
    Configuration for automatic rollback if an error occurs during deployment.
    blueGreenUpdatePolicy EndpointBlueGreenUpdatePolicy
    Configuration for blue-green update deployment policies.
    rollingUpdatePolicy EndpointRollingUpdatePolicy
    Configuration for rolling update deployment policies.
    auto_rollback_configuration EndpointAutoRollbackConfig
    Configuration for automatic rollback if an error occurs during deployment.
    blue_green_update_policy EndpointBlueGreenUpdatePolicy
    Configuration for blue-green update deployment policies.
    rolling_update_policy EndpointRollingUpdatePolicy
    Configuration for rolling update deployment policies.
    autoRollbackConfiguration Property Map
    Configuration for automatic rollback if an error occurs during deployment.
    blueGreenUpdatePolicy Property Map
    Configuration for blue-green update deployment policies.
    rollingUpdatePolicy Property Map
    Configuration for rolling update deployment policies.

    EndpointRollingUpdatePolicy

    MaximumBatchSize Pulumi.AwsNative.SageMaker.Inputs.EndpointCapacitySize
    Specifies the maximum batch size for each rolling update.
    WaitIntervalInSeconds int
    The time to wait between steps during the rolling update, in seconds.
    MaximumExecutionTimeoutInSeconds int
    The maximum time allowed for the rolling update, in seconds.
    RollbackMaximumBatchSize Pulumi.AwsNative.SageMaker.Inputs.EndpointCapacitySize
    The maximum batch size for rollback during an update failure.
    MaximumBatchSize EndpointCapacitySize
    Specifies the maximum batch size for each rolling update.
    WaitIntervalInSeconds int
    The time to wait between steps during the rolling update, in seconds.
    MaximumExecutionTimeoutInSeconds int
    The maximum time allowed for the rolling update, in seconds.
    RollbackMaximumBatchSize EndpointCapacitySize
    The maximum batch size for rollback during an update failure.
    maximumBatchSize EndpointCapacitySize
    Specifies the maximum batch size for each rolling update.
    waitIntervalInSeconds Integer
    The time to wait between steps during the rolling update, in seconds.
    maximumExecutionTimeoutInSeconds Integer
    The maximum time allowed for the rolling update, in seconds.
    rollbackMaximumBatchSize EndpointCapacitySize
    The maximum batch size for rollback during an update failure.
    maximumBatchSize EndpointCapacitySize
    Specifies the maximum batch size for each rolling update.
    waitIntervalInSeconds number
    The time to wait between steps during the rolling update, in seconds.
    maximumExecutionTimeoutInSeconds number
    The maximum time allowed for the rolling update, in seconds.
    rollbackMaximumBatchSize EndpointCapacitySize
    The maximum batch size for rollback during an update failure.
    maximum_batch_size EndpointCapacitySize
    Specifies the maximum batch size for each rolling update.
    wait_interval_in_seconds int
    The time to wait between steps during the rolling update, in seconds.
    maximum_execution_timeout_in_seconds int
    The maximum time allowed for the rolling update, in seconds.
    rollback_maximum_batch_size EndpointCapacitySize
    The maximum batch size for rollback during an update failure.
    maximumBatchSize Property Map
    Specifies the maximum batch size for each rolling update.
    waitIntervalInSeconds Number
    The time to wait between steps during the rolling update, in seconds.
    maximumExecutionTimeoutInSeconds Number
    The maximum time allowed for the rolling update, in seconds.
    rollbackMaximumBatchSize Property Map
    The maximum batch size for rollback during an update failure.

    EndpointTrafficRoutingConfig

    Type string
    Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear').
    CanarySize Pulumi.AwsNative.SageMaker.Inputs.EndpointCapacitySize
    Specifies the size of the canary traffic in a canary deployment.
    LinearStepSize Pulumi.AwsNative.SageMaker.Inputs.EndpointCapacitySize
    Specifies the step size for linear traffic routing.
    WaitIntervalInSeconds int
    Specifies the wait interval between traffic shifts, in seconds.
    Type string
    Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear').
    CanarySize EndpointCapacitySize
    Specifies the size of the canary traffic in a canary deployment.
    LinearStepSize EndpointCapacitySize
    Specifies the step size for linear traffic routing.
    WaitIntervalInSeconds int
    Specifies the wait interval between traffic shifts, in seconds.
    type String
    Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear').
    canarySize EndpointCapacitySize
    Specifies the size of the canary traffic in a canary deployment.
    linearStepSize EndpointCapacitySize
    Specifies the step size for linear traffic routing.
    waitIntervalInSeconds Integer
    Specifies the wait interval between traffic shifts, in seconds.
    type string
    Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear').
    canarySize EndpointCapacitySize
    Specifies the size of the canary traffic in a canary deployment.
    linearStepSize EndpointCapacitySize
    Specifies the step size for linear traffic routing.
    waitIntervalInSeconds number
    Specifies the wait interval between traffic shifts, in seconds.
    type str
    Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear').
    canary_size EndpointCapacitySize
    Specifies the size of the canary traffic in a canary deployment.
    linear_step_size EndpointCapacitySize
    Specifies the step size for linear traffic routing.
    wait_interval_in_seconds int
    Specifies the wait interval between traffic shifts, in seconds.
    type String
    Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear').
    canarySize Property Map
    Specifies the size of the canary traffic in a canary deployment.
    linearStepSize Property Map
    Specifies the step size for linear traffic routing.
    waitIntervalInSeconds Number
    Specifies the wait interval between traffic shifts, in seconds.

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native