Docs Home Pulumi IaC Pulumi ESC Pulumi Insights 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

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>
Copy
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]
Copy
func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:sagemaker:getEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EndpointArn This property is required. string
The Amazon Resource Name (ARN) of the endpoint.
EndpointArn This property is required. string
The Amazon Resource Name (ARN) of the endpoint.
endpointArn This property is required. String
The Amazon Resource Name (ARN) of the endpoint.
endpointArn This property is required. string
The Amazon Resource Name (ARN) of the endpoint.
endpoint_arn This property is required. str
The Amazon Resource Name (ARN) of the endpoint.
endpointArn This property is required. 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 This property is required. string
The name of the CloudWatch alarm.
AlarmName This property is required. string
The name of the CloudWatch alarm.
alarmName This property is required. String
The name of the CloudWatch alarm.
alarmName This property is required. string
The name of the CloudWatch alarm.
alarm_name This property is required. str
The name of the CloudWatch alarm.
alarmName This property is required. String
The name of the CloudWatch alarm.

EndpointAutoRollbackConfig

Alarms This property is required. 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 This property is required. []EndpointAlarm
List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
alarms This property is required. List<EndpointAlarm>
List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
alarms This property is required. EndpointAlarm[]
List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
alarms This property is required. Sequence[EndpointAlarm]
List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
alarms This property is required. List<Property Map>
List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.

EndpointBlueGreenUpdatePolicy

TrafficRoutingConfiguration This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Specifies whether the Value is an instance count or a capacity unit.
Value This property is required. int
The value representing either the number of instances or the number of capacity units.
Type This property is required. string
Specifies whether the Value is an instance count or a capacity unit.
Value This property is required. int
The value representing either the number of instances or the number of capacity units.
type This property is required. String
Specifies whether the Value is an instance count or a capacity unit.
value This property is required. Integer
The value representing either the number of instances or the number of capacity units.
type This property is required. string
Specifies whether the Value is an instance count or a capacity unit.
value This property is required. number
The value representing either the number of instances or the number of capacity units.
type This property is required. str
Specifies whether the Value is an instance count or a capacity unit.
value This property is required. int
The value representing either the number of instances or the number of capacity units.
type This property is required. String
Specifies whether the Value is an instance count or a capacity unit.
value This property is required. 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 This property is required. Pulumi.AwsNative.SageMaker.Inputs.EndpointCapacitySize
Specifies the maximum batch size for each rolling update.
WaitIntervalInSeconds This property is required. 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 This property is required. EndpointCapacitySize
Specifies the maximum batch size for each rolling update.
WaitIntervalInSeconds This property is required. 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 This property is required. EndpointCapacitySize
Specifies the maximum batch size for each rolling update.
waitIntervalInSeconds This property is required. 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 This property is required. EndpointCapacitySize
Specifies the maximum batch size for each rolling update.
waitIntervalInSeconds This property is required. 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 This property is required. EndpointCapacitySize
Specifies the maximum batch size for each rolling update.
wait_interval_in_seconds This property is required. 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 This property is required. Property Map
Specifies the maximum batch size for each rolling update.
waitIntervalInSeconds This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

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