aws-sdk-sagemaker 1.415.0 → 1.416.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11310,6 +11310,20 @@ module Aws::SageMaker
11310
11310
  # The configuration parameters for utilization metrics.
11311
11311
  # @return [Types::MetricsConfig]
11312
11312
  #
11313
+ # @!attribute [rw] cross_region_traffic_config
11314
+ # The cross-Region traffic cap for the endpoint. The cap limits the
11315
+ # requests per second that the endpoint accepts from inference routers
11316
+ # in other Amazon Web Services Regions. If you don't specify it,
11317
+ # these requests aren't limited. You can't specify it with
11318
+ # serverless variants or with `AsyncInferenceConfig`. For information
11319
+ # about the cross-Region traffic cap, see [Limit requests from other
11320
+ # Regions][1].
11321
+ #
11322
+ #
11323
+ #
11324
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/inference-router.html#inference-router-cross-region-limit
11325
+ # @return [Types::CrossRegionTrafficConfig]
11326
+ #
11313
11327
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateEndpointConfigInput AWS API Documentation
11314
11328
  #
11315
11329
  class CreateEndpointConfigInput < Struct.new(
@@ -11324,7 +11338,8 @@ module Aws::SageMaker
11324
11338
  :execution_role_arn,
11325
11339
  :vpc_config,
11326
11340
  :enable_network_isolation,
11327
- :metrics_config)
11341
+ :metrics_config,
11342
+ :cross_region_traffic_config)
11328
11343
  SENSITIVE = []
11329
11344
  include Aws::Structure
11330
11345
  end
@@ -12485,6 +12500,60 @@ module Aws::SageMaker
12485
12500
  include Aws::Structure
12486
12501
  end
12487
12502
 
12503
+ # @!attribute [rw] inference_router_name
12504
+ # The name of the inference router. The name must be unique within
12505
+ # your account in the current Amazon Web Services Region. The name is
12506
+ # case sensitive.
12507
+ # @return [String]
12508
+ #
12509
+ # @!attribute [rw] routing_targets
12510
+ # The routing targets of the inference router. Each routing target is
12511
+ # a model that callers name when they invoke the router, and the
12512
+ # destinations that serve it.
12513
+ # @return [Array<Types::RoutingTarget>]
12514
+ #
12515
+ # @!attribute [rw] client_token
12516
+ # A unique, case-sensitive identifier that you provide to ensure the
12517
+ # idempotency of the request. If you reuse a client token, use the
12518
+ # same request parameters. Otherwise, the request fails.
12519
+ #
12520
+ # **A suitable default value is auto-generated.** You should normally
12521
+ # not need to pass this option.
12522
+ # @return [String]
12523
+ #
12524
+ # @!attribute [rw] tags
12525
+ # A list of key-value pairs to apply to the inference router. For
12526
+ # information about tagging, see [Tagging Amazon Web Services
12527
+ # resources][1] in the *Amazon Web Services General Reference*.
12528
+ #
12529
+ #
12530
+ #
12531
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
12532
+ # @return [Array<Types::Tag>]
12533
+ #
12534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateInferenceRouterInput AWS API Documentation
12535
+ #
12536
+ class CreateInferenceRouterInput < Struct.new(
12537
+ :inference_router_name,
12538
+ :routing_targets,
12539
+ :client_token,
12540
+ :tags)
12541
+ SENSITIVE = []
12542
+ include Aws::Structure
12543
+ end
12544
+
12545
+ # @!attribute [rw] inference_router_arn
12546
+ # The Amazon Resource Name (ARN) of the inference router.
12547
+ # @return [String]
12548
+ #
12549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateInferenceRouterOutput AWS API Documentation
12550
+ #
12551
+ class CreateInferenceRouterOutput < Struct.new(
12552
+ :inference_router_arn)
12553
+ SENSITIVE = []
12554
+ include Aws::Structure
12555
+ end
12556
+
12488
12557
  # @!attribute [rw] job_name
12489
12558
  # The name of the job. The name must be unique within your account and
12490
12559
  # Amazon Web Services Region.
@@ -15773,6 +15842,36 @@ module Aws::SageMaker
15773
15842
  include Aws::Structure
15774
15843
  end
15775
15844
 
15845
+ # The cross-Region traffic cap for an endpoint. The cap limits the
15846
+ # requests per second that the endpoint accepts from inference routers
15847
+ # in other Amazon Web Services Regions. The cap is
15848
+ # `MaxCrossRegionPercentPerEndpoint` percent of
15849
+ # `MaxInvocationsPerSecondPerInstance` multiplied by the number of
15850
+ # `InService` instances, rounded up. All production variants and
15851
+ # inference components of the endpoint share it. Requests that you send
15852
+ # to the endpoint directly aren't counted. A request over the cap fails
15853
+ # with a `ThrottlingException`.
15854
+ #
15855
+ # @!attribute [rw] max_invocations_per_second_per_instance
15856
+ # The number of invocations per second that you expect one `InService`
15857
+ # instance to serve. One value applies to every production variant,
15858
+ # whatever its instance type.
15859
+ # @return [Integer]
15860
+ #
15861
+ # @!attribute [rw] max_cross_region_percent_per_endpoint
15862
+ # The percentage of the endpoint's capacity that requests from
15863
+ # inference routers in other Amazon Web Services Regions can use.
15864
+ # @return [Integer]
15865
+ #
15866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CrossRegionTrafficConfig AWS API Documentation
15867
+ #
15868
+ class CrossRegionTrafficConfig < Struct.new(
15869
+ :max_invocations_per_second_per_instance,
15870
+ :max_cross_region_percent_per_endpoint)
15871
+ SENSITIVE = []
15872
+ include Aws::Structure
15873
+ end
15874
+
15776
15875
  # A file system, created by you, that you assign to a user profile or
15777
15876
  # space for an Amazon SageMaker AI Domain. Permitted users can access
15778
15877
  # this file system in Amazon SageMaker AI Studio.
@@ -17011,6 +17110,23 @@ module Aws::SageMaker
17011
17110
  include Aws::Structure
17012
17111
  end
17013
17112
 
17113
+ # @!attribute [rw] endpoint_name
17114
+ # The name of the endpoint. The endpoint must be in your account and
17115
+ # in the current Amazon Web Services Region.
17116
+ # @return [String]
17117
+ #
17118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteEndpointPolicyRequest AWS API Documentation
17119
+ #
17120
+ class DeleteEndpointPolicyRequest < Struct.new(
17121
+ :endpoint_name)
17122
+ SENSITIVE = []
17123
+ include Aws::Structure
17124
+ end
17125
+
17126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteEndpointPolicyResponse AWS API Documentation
17127
+ #
17128
+ class DeleteEndpointPolicyResponse < Aws::EmptyStructure; end
17129
+
17014
17130
  # @!attribute [rw] experiment_name
17015
17131
  # The name of the experiment to delete.
17016
17132
  # @return [String]
@@ -17235,6 +17351,18 @@ module Aws::SageMaker
17235
17351
  include Aws::Structure
17236
17352
  end
17237
17353
 
17354
+ # @!attribute [rw] inference_router_name
17355
+ # The name of the inference router to delete.
17356
+ # @return [String]
17357
+ #
17358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteInferenceRouterInput AWS API Documentation
17359
+ #
17360
+ class DeleteInferenceRouterInput < Struct.new(
17361
+ :inference_router_name)
17362
+ SENSITIVE = []
17363
+ include Aws::Structure
17364
+ end
17365
+
17238
17366
  # @!attribute [rw] job_name
17239
17367
  # The name of the job to delete.
17240
17368
  # @return [String]
@@ -20337,6 +20465,11 @@ module Aws::SageMaker
20337
20465
  # The configuration parameters for utilization metrics.
20338
20466
  # @return [Types::MetricsConfig]
20339
20467
  #
20468
+ # @!attribute [rw] cross_region_traffic_config
20469
+ # The cross-Region traffic cap, if the endpoint configuration sets
20470
+ # one.
20471
+ # @return [Types::CrossRegionTrafficConfig]
20472
+ #
20340
20473
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeEndpointConfigOutput AWS API Documentation
20341
20474
  #
20342
20475
  class DescribeEndpointConfigOutput < Struct.new(
@@ -20352,7 +20485,8 @@ module Aws::SageMaker
20352
20485
  :execution_role_arn,
20353
20486
  :vpc_config,
20354
20487
  :enable_network_isolation,
20355
- :metrics_config)
20488
+ :metrics_config,
20489
+ :cross_region_traffic_config)
20356
20490
  SENSITIVE = []
20357
20491
  include Aws::Structure
20358
20492
  end
@@ -20498,6 +20632,11 @@ module Aws::SageMaker
20498
20632
  # The configuration parameters for utilization metrics.
20499
20633
  # @return [Types::MetricsConfig]
20500
20634
  #
20635
+ # @!attribute [rw] cross_region_traffic_config
20636
+ # The cross-Region traffic cap, if the endpoint configuration sets
20637
+ # one.
20638
+ # @return [Types::CrossRegionTrafficConfig]
20639
+ #
20501
20640
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeEndpointOutput AWS API Documentation
20502
20641
  #
20503
20642
  class DescribeEndpointOutput < Struct.new(
@@ -20515,7 +20654,8 @@ module Aws::SageMaker
20515
20654
  :pending_deployment_summary,
20516
20655
  :explainer_config,
20517
20656
  :shadow_production_variants,
20518
- :metrics_config)
20657
+ :metrics_config,
20658
+ :cross_region_traffic_config)
20519
20659
  SENSITIVE = []
20520
20660
  include Aws::Structure
20521
20661
  end
@@ -21868,6 +22008,63 @@ module Aws::SageMaker
21868
22008
  include Aws::Structure
21869
22009
  end
21870
22010
 
22011
+ # @!attribute [rw] inference_router_name
22012
+ # The name of the inference router to describe.
22013
+ # @return [String]
22014
+ #
22015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeInferenceRouterInput AWS API Documentation
22016
+ #
22017
+ class DescribeInferenceRouterInput < Struct.new(
22018
+ :inference_router_name)
22019
+ SENSITIVE = []
22020
+ include Aws::Structure
22021
+ end
22022
+
22023
+ # @!attribute [rw] inference_router_name
22024
+ # The name of the inference router.
22025
+ # @return [String]
22026
+ #
22027
+ # @!attribute [rw] inference_router_arn
22028
+ # The Amazon Resource Name (ARN) of the inference router.
22029
+ # @return [String]
22030
+ #
22031
+ # @!attribute [rw] routing_targets
22032
+ # The routing targets of the inference router. Each destination
22033
+ # includes its `RoutingStatus`. You can send these routing targets
22034
+ # back in an `UpdateInferenceRouter` request without changes.
22035
+ # @return [Array<Types::RoutingTarget>]
22036
+ #
22037
+ # @!attribute [rw] status
22038
+ # The status of the inference router.
22039
+ # @return [String]
22040
+ #
22041
+ # @!attribute [rw] status_reason
22042
+ # If the status is `Failed`, the reason that the inference router
22043
+ # failed.
22044
+ # @return [String]
22045
+ #
22046
+ # @!attribute [rw] creation_time
22047
+ # The date and time that the inference router was created.
22048
+ # @return [Time]
22049
+ #
22050
+ # @!attribute [rw] last_modified_time
22051
+ # The date and time that the inference router was last updated.
22052
+ # @return [Time]
22053
+ #
22054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeInferenceRouterOutput AWS API Documentation
22055
+ #
22056
+ class DescribeInferenceRouterOutput < Struct.new(
22057
+ :inference_router_name,
22058
+ :inference_router_arn,
22059
+ :routing_targets,
22060
+ :status,
22061
+ :status_reason,
22062
+ :creation_time,
22063
+ :last_modified_time)
22064
+ SENSITIVE = []
22065
+ include Aws::Structure
22066
+ end
22067
+
21871
22068
  # @!attribute [rw] job_name
21872
22069
  # The name of the job to describe.
21873
22070
  # @return [String]
@@ -25921,6 +26118,51 @@ module Aws::SageMaker
25921
26118
  include Aws::Structure
25922
26119
  end
25923
26120
 
26121
+ # An endpoint or inference component that serves a routing target.
26122
+ #
26123
+ # @!attribute [rw] resource_arn
26124
+ # The Amazon Resource Name (ARN) of the endpoint or inference
26125
+ # component. The destination can be in any account, and in any Amazon
26126
+ # Web Services Region in the same partition as the inference router.
26127
+ # To use a destination in another account, its owner must allow your
26128
+ # account to invoke it through your router, in an endpoint policy.
26129
+ # @return [String]
26130
+ #
26131
+ # @!attribute [rw] routing_status
26132
+ # Whether the inference router can send requests to the destination,
26133
+ # as checked when you called `DescribeInferenceRouter`. This value
26134
+ # isn't the destination's own status. SageMaker AI ignores this
26135
+ # field in `CreateInferenceRouter` and `UpdateInferenceRouter`
26136
+ # requests.
26137
+ #
26138
+ # Routable
26139
+ #
26140
+ # : The destination is serving and the router can send it requests. A
26141
+ # routable destination can still be overloaded.
26142
+ #
26143
+ # Unroutable
26144
+ #
26145
+ # : The destination can't serve requests. For example, it's being
26146
+ # created or has failed, or it has no capacity and no way to get
26147
+ # any. A destination in your account that doesn't exist is also
26148
+ # `Unroutable`.
26149
+ #
26150
+ # Unknown
26151
+ #
26152
+ # : SageMaker AI couldn't check the destination, for example because
26153
+ # you aren't allowed to describe it or the check timed out. The
26154
+ # destination might still be serving.
26155
+ # @return [String]
26156
+ #
26157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/Destination AWS API Documentation
26158
+ #
26159
+ class Destination < Struct.new(
26160
+ :resource_arn,
26161
+ :routing_status)
26162
+ SENSITIVE = []
26163
+ include Aws::Structure
26164
+ end
26165
+
25924
26166
  # @!attribute [rw] cluster_arn
25925
26167
  # The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster
25926
26168
  # containing the target node. Your cluster must use EKS as the
@@ -29261,6 +29503,41 @@ module Aws::SageMaker
29261
29503
  include Aws::Structure
29262
29504
  end
29263
29505
 
29506
+ # @!attribute [rw] endpoint_name
29507
+ # The name of the endpoint. The endpoint must be in your account and
29508
+ # in the current Amazon Web Services Region.
29509
+ # @return [String]
29510
+ #
29511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/GetEndpointPolicyRequest AWS API Documentation
29512
+ #
29513
+ class GetEndpointPolicyRequest < Struct.new(
29514
+ :endpoint_name)
29515
+ SENSITIVE = []
29516
+ include Aws::Structure
29517
+ end
29518
+
29519
+ # @!attribute [rw] endpoint_name
29520
+ # The name of the endpoint.
29521
+ # @return [String]
29522
+ #
29523
+ # @!attribute [rw] endpoint_arn
29524
+ # The Amazon Resource Name (ARN) of the endpoint.
29525
+ # @return [String]
29526
+ #
29527
+ # @!attribute [rw] resource_policy
29528
+ # The endpoint policy, as a JSON policy document.
29529
+ # @return [String]
29530
+ #
29531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/GetEndpointPolicyResponse AWS API Documentation
29532
+ #
29533
+ class GetEndpointPolicyResponse < Struct.new(
29534
+ :endpoint_name,
29535
+ :endpoint_arn,
29536
+ :resource_policy)
29537
+ SENSITIVE = []
29538
+ include Aws::Structure
29539
+ end
29540
+
29264
29541
  # @!attribute [rw] lineage_group_name
29265
29542
  # The name or Amazon Resource Name (ARN) of the lineage group.
29266
29543
  # @return [String]
@@ -33544,6 +33821,35 @@ module Aws::SageMaker
33544
33821
  include Aws::Structure
33545
33822
  end
33546
33823
 
33824
+ # A summary of an inference router.
33825
+ #
33826
+ # @!attribute [rw] inference_router_name
33827
+ # The name of the inference router.
33828
+ # @return [String]
33829
+ #
33830
+ # @!attribute [rw] inference_router_arn
33831
+ # The Amazon Resource Name (ARN) of the inference router.
33832
+ # @return [String]
33833
+ #
33834
+ # @!attribute [rw] creation_time
33835
+ # The date and time that the inference router was created.
33836
+ # @return [Time]
33837
+ #
33838
+ # @!attribute [rw] last_modified_time
33839
+ # The date and time that the inference router was last updated.
33840
+ # @return [Time]
33841
+ #
33842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/InferenceRouterSummary AWS API Documentation
33843
+ #
33844
+ class InferenceRouterSummary < Struct.new(
33845
+ :inference_router_name,
33846
+ :inference_router_arn,
33847
+ :creation_time,
33848
+ :last_modified_time)
33849
+ SENSITIVE = []
33850
+ include Aws::Structure
33851
+ end
33852
+
33547
33853
  # Defines how to perform inference generation after a training job is
33548
33854
  # run.
33549
33855
  #
@@ -38702,6 +39008,42 @@ module Aws::SageMaker
38702
39008
  include Aws::Structure
38703
39009
  end
38704
39010
 
39011
+ # @!attribute [rw] max_results
39012
+ # The maximum number of inference routers to return in the response.
39013
+ # @return [Integer]
39014
+ #
39015
+ # @!attribute [rw] next_token
39016
+ # If the previous response was truncated, you receive this token. To
39017
+ # get the next set of inference routers, use it in your next request.
39018
+ # @return [String]
39019
+ #
39020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListInferenceRoutersInput AWS API Documentation
39021
+ #
39022
+ class ListInferenceRoutersInput < Struct.new(
39023
+ :max_results,
39024
+ :next_token)
39025
+ SENSITIVE = []
39026
+ include Aws::Structure
39027
+ end
39028
+
39029
+ # @!attribute [rw] inference_routers
39030
+ # A list of summaries of the inference routers.
39031
+ # @return [Array<Types::InferenceRouterSummary>]
39032
+ #
39033
+ # @!attribute [rw] next_token
39034
+ # If the response is truncated, SageMaker AI returns this token. To
39035
+ # get the next set of inference routers, use it in your next request.
39036
+ # @return [String]
39037
+ #
39038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListInferenceRoutersOutput AWS API Documentation
39039
+ #
39040
+ class ListInferenceRoutersOutput < Struct.new(
39041
+ :inference_routers,
39042
+ :next_token)
39043
+ SENSITIVE = []
39044
+ include Aws::Structure
39045
+ end
39046
+
38705
39047
  # @!attribute [rw] job_category
38706
39048
  # The category of job schemas to list.
38707
39049
  # @return [String]
@@ -49274,6 +49616,17 @@ module Aws::SageMaker
49274
49616
  # endpoint routes the request to another copy on that instance or to
49275
49617
  # another instance. The endpoint applies prefix-aware routing only
49276
49618
  # when two or more instances can serve the request.
49619
+ #
49620
+ # * `KV_AWARE`: The endpoint routes each request to an instance that
49621
+ # already holds the start of the request's prompt in its key-value
49622
+ # (KV) cache, and weighs the length of that match against how busy
49623
+ # each instance is. On an endpoint with inference components, the
49624
+ # endpoint chooses among the copies of the invoked inference
49625
+ # component in the same way. When the endpoint can't find an
49626
+ # instance or copy that holds the start of the prompt and isn't too
49627
+ # busy, it chooses an instance as it does with
49628
+ # `LEAST_OUTSTANDING_REQUESTS`. `KV_AWARE` works only with supported
49629
+ # containers, such as the SageMaker AI vLLM Deep Learning Container.
49277
49630
  # @return [String]
49278
49631
  #
49279
49632
  # @!attribute [rw] prefix_aware_routing_config
@@ -50070,6 +50423,42 @@ module Aws::SageMaker
50070
50423
  include Aws::Structure
50071
50424
  end
50072
50425
 
50426
+ # @!attribute [rw] endpoint_name
50427
+ # The name of the endpoint. The endpoint must be in your account and
50428
+ # in the current Amazon Web Services Region.
50429
+ # @return [String]
50430
+ #
50431
+ # @!attribute [rw] resource_policy
50432
+ # The endpoint policy, as a JSON policy document. The policy can
50433
+ # contain only ASCII characters. For information about the policy
50434
+ # rules, see [Use destinations in other accounts][1].
50435
+ #
50436
+ #
50437
+ #
50438
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/inference-router-cross-account.html
50439
+ # @return [String]
50440
+ #
50441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/PutEndpointPolicyRequest AWS API Documentation
50442
+ #
50443
+ class PutEndpointPolicyRequest < Struct.new(
50444
+ :endpoint_name,
50445
+ :resource_policy)
50446
+ SENSITIVE = []
50447
+ include Aws::Structure
50448
+ end
50449
+
50450
+ # @!attribute [rw] endpoint_arn
50451
+ # The Amazon Resource Name (ARN) of the endpoint.
50452
+ # @return [String]
50453
+ #
50454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/PutEndpointPolicyResponse AWS API Documentation
50455
+ #
50456
+ class PutEndpointPolicyResponse < Struct.new(
50457
+ :endpoint_arn)
50458
+ SENSITIVE = []
50459
+ include Aws::Structure
50460
+ end
50461
+
50073
50462
  # @!attribute [rw] model_package_group_name
50074
50463
  # The name of the model group to add a resource policy to.
50075
50464
  # @return [String]
@@ -51414,6 +51803,21 @@ module Aws::SageMaker
51414
51803
  include Aws::Structure
51415
51804
  end
51416
51805
 
51806
+ # The resource that you are trying to create already exists. Use a
51807
+ # different resource name, or delete the existing resource before
51808
+ # retrying.
51809
+ #
51810
+ # @!attribute [rw] message
51811
+ # @return [String]
51812
+ #
51813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ResourceAlreadyExists AWS API Documentation
51814
+ #
51815
+ class ResourceAlreadyExists < Struct.new(
51816
+ :message)
51817
+ SENSITIVE = []
51818
+ include Aws::Structure
51819
+ end
51820
+
51417
51821
  # A resource catalog containing all of the resources of a specific
51418
51822
  # resource type within a resource owner account. For an example on
51419
51823
  # sharing the Amazon SageMaker Feature Store
@@ -51963,6 +52367,194 @@ module Aws::SageMaker
51963
52367
  include Aws::Structure
51964
52368
  end
51965
52369
 
52370
+ # A model that an inference router serves, and the destinations that can
52371
+ # serve it. When you invoke the router, you name the routing target, and
52372
+ # the router sends the request to one of its destinations.
52373
+ #
52374
+ # Every destination in a routing target must serve the same model, with
52375
+ # the same request and response format.
52376
+ #
52377
+ # @!attribute [rw] name
52378
+ # The name of the routing target. Callers specify this name in the
52379
+ # `RoutingTargetName` parameter when they invoke the inference router.
52380
+ # The name must be unique within the router.
52381
+ # @return [String]
52382
+ #
52383
+ # @!attribute [rw] destinations
52384
+ # The endpoints and inference components that serve the routing
52385
+ # target. Each destination can appear only once in a routing target.
52386
+ #
52387
+ # In an asynchronous routing target, every destination must be an
52388
+ # asynchronous inference endpoint. In a real-time routing target, no
52389
+ # destination can be one. SageMaker AI checks an endpoint in another
52390
+ # account with your credentials, so both your IAM policy and the
52391
+ # endpoint policy must allow `sagemaker:DescribeEndpoint`. If an
52392
+ # endpoint can't be checked, for example because it isn't found or
52393
+ # can't be read in time, it's accepted, and requests to it fail if
52394
+ # it's the wrong mode.
52395
+ # @return [Array<Types::Destination>]
52396
+ #
52397
+ # @!attribute [rw] async_inference_config
52398
+ # The asynchronous inference settings of the routing target. Specify
52399
+ # this setting to make the routing target asynchronous. If you omit
52400
+ # it, the routing target serves real-time requests.
52401
+ #
52402
+ # Asynchronous routing targets aren't available in all Amazon Web
52403
+ # Services Regions. For information about asynchronous routing targets
52404
+ # and Region availability, see [Send asynchronous requests through an
52405
+ # inference router][1].
52406
+ #
52407
+ # Because `UpdateInferenceRouter` replaces all routing targets,
52408
+ # include this setting in every update of an asynchronous routing
52409
+ # target.
52410
+ #
52411
+ # For information about asynchronous routing targets, see [Send
52412
+ # asynchronous requests through an inference router][1].
52413
+ #
52414
+ #
52415
+ #
52416
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/inference-router-async.html
52417
+ # @return [Types::RoutingTargetAsyncInferenceConfig]
52418
+ #
52419
+ # @!attribute [rw] routing_preference
52420
+ # How the inference router chooses among the routing target's
52421
+ # destinations. The default is `LocalRegionFirst`.
52422
+ #
52423
+ # LocalRegionFirst
52424
+ #
52425
+ # : The router uses destinations in its own Region first. When the
52426
+ # request leaves the Region, the router spreads it across healthy
52427
+ # destinations in other Regions.
52428
+ #
52429
+ # InstancePoolOrder
52430
+ #
52431
+ # : The router prefers destinations by instance type first and by
52432
+ # Region second. Every destination must be an endpoint that lists
52433
+ # the same two or more instance types, each with a different
52434
+ # priority, in the same priority order. This value is supported only
52435
+ # for asynchronous routing targets.
52436
+ #
52437
+ # With either value, the router uses destinations whose health or
52438
+ # capacity is reduced after the others, but doesn't exclude them.
52439
+ # @return [String]
52440
+ #
52441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RoutingTarget AWS API Documentation
52442
+ #
52443
+ class RoutingTarget < Struct.new(
52444
+ :name,
52445
+ :destinations,
52446
+ :async_inference_config,
52447
+ :routing_preference)
52448
+ SENSITIVE = []
52449
+ include Aws::Structure
52450
+ end
52451
+
52452
+ # How the inference router submits asynchronous requests to the
52453
+ # destinations of a routing target.
52454
+ #
52455
+ # @!attribute [rw] max_time_in_backlog_seconds
52456
+ # The maximum time, in seconds, that a request can wait at a
52457
+ # destination before the inference router moves it to another
52458
+ # destination. The default is 900 seconds.
52459
+ # @return [Integer]
52460
+ #
52461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RoutingTargetAsyncInferenceClientConfig AWS API Documentation
52462
+ #
52463
+ class RoutingTargetAsyncInferenceClientConfig < Struct.new(
52464
+ :max_time_in_backlog_seconds)
52465
+ SENSITIVE = []
52466
+ include Aws::Structure
52467
+ end
52468
+
52469
+ # The asynchronous inference settings of a routing target.
52470
+ #
52471
+ # @!attribute [rw] output_config
52472
+ # The Amazon S3 locations for the results of asynchronous requests,
52473
+ # and the notification settings.
52474
+ # @return [Types::RoutingTargetAsyncInferenceOutputConfig]
52475
+ #
52476
+ # @!attribute [rw] client_config
52477
+ # How the inference router submits requests to destinations.
52478
+ # @return [Types::RoutingTargetAsyncInferenceClientConfig]
52479
+ #
52480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RoutingTargetAsyncInferenceConfig AWS API Documentation
52481
+ #
52482
+ class RoutingTargetAsyncInferenceConfig < Struct.new(
52483
+ :output_config,
52484
+ :client_config)
52485
+ SENSITIVE = []
52486
+ include Aws::Structure
52487
+ end
52488
+
52489
+ # The Amazon SNS topics that the inference router publishes to. The
52490
+ # router publishes one notification for each request. The notification
52491
+ # contains the location of the result, not the result itself. The
52492
+ # destination endpoints also send their own notifications, if they're
52493
+ # configured to.
52494
+ #
52495
+ # @!attribute [rw] success_topic
52496
+ # The ARN of the Amazon SNS topic to publish to when a request
52497
+ # completes. The topic must be a standard topic, and can be in any
52498
+ # Amazon Web Services Region.
52499
+ # @return [String]
52500
+ #
52501
+ # @!attribute [rw] error_topic
52502
+ # The ARN of the Amazon SNS topic to publish to when a request fails,
52503
+ # or when the router can't place it on any destination. The topic
52504
+ # must be a standard topic, and can be in any Amazon Web Services
52505
+ # Region.
52506
+ # @return [String]
52507
+ #
52508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RoutingTargetAsyncInferenceNotificationConfig AWS API Documentation
52509
+ #
52510
+ class RoutingTargetAsyncInferenceNotificationConfig < Struct.new(
52511
+ :success_topic,
52512
+ :error_topic)
52513
+ SENSITIVE = []
52514
+ include Aws::Structure
52515
+ end
52516
+
52517
+ # The output settings for the asynchronous requests of a routing target.
52518
+ # Every destination writes to the same locations.
52519
+ # `CreateInferenceRouter` and `UpdateInferenceRouter` don't check who
52520
+ # owns the buckets. If another account owns the output bucket, requests
52521
+ # fail.
52522
+ #
52523
+ # @!attribute [rw] s3_output_path
52524
+ # The Amazon S3 location for the results of successful requests. The
52525
+ # bucket must be in the inference router's Amazon Web Services Region
52526
+ # and owned by the router's account.
52527
+ # @return [String]
52528
+ #
52529
+ # @!attribute [rw] s3_failure_path
52530
+ # The Amazon S3 location for the failure details of failed requests.
52531
+ # The bucket must be in the inference router's Amazon Web Services
52532
+ # Region and owned by the router's account.
52533
+ # @return [String]
52534
+ #
52535
+ # @!attribute [rw] kms_key_id
52536
+ # The KMS key that encrypts the results in Amazon S3. You can specify
52537
+ # a key ID, key ARN, alias name, or alias ARN. If any destination is
52538
+ # in a different account or Amazon Web Services Region from the
52539
+ # inference router, specify a key ARN or an alias ARN.
52540
+ # @return [String]
52541
+ #
52542
+ # @!attribute [rw] notification_config
52543
+ # The Amazon SNS topics that the inference router publishes to when a
52544
+ # request completes or fails.
52545
+ # @return [Types::RoutingTargetAsyncInferenceNotificationConfig]
52546
+ #
52547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RoutingTargetAsyncInferenceOutputConfig AWS API Documentation
52548
+ #
52549
+ class RoutingTargetAsyncInferenceOutputConfig < Struct.new(
52550
+ :s3_output_path,
52551
+ :s3_failure_path,
52552
+ :kms_key_id,
52553
+ :notification_config)
52554
+ SENSITIVE = []
52555
+ include Aws::Structure
52556
+ end
52557
+
51966
52558
  # Describes the S3 data source.
51967
52559
  #
51968
52560
  # Your input bucket must be in the same Amazon Web Services region as
@@ -60045,6 +60637,36 @@ module Aws::SageMaker
60045
60637
  include Aws::Structure
60046
60638
  end
60047
60639
 
60640
+ # @!attribute [rw] inference_router_name
60641
+ # The name of the inference router to update.
60642
+ # @return [String]
60643
+ #
60644
+ # @!attribute [rw] routing_targets
60645
+ # The complete list of routing targets for the inference router. To
60646
+ # remove the last routing target, delete the router.
60647
+ # @return [Array<Types::RoutingTarget>]
60648
+ #
60649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateInferenceRouterInput AWS API Documentation
60650
+ #
60651
+ class UpdateInferenceRouterInput < Struct.new(
60652
+ :inference_router_name,
60653
+ :routing_targets)
60654
+ SENSITIVE = []
60655
+ include Aws::Structure
60656
+ end
60657
+
60658
+ # @!attribute [rw] inference_router_arn
60659
+ # The Amazon Resource Name (ARN) of the inference router.
60660
+ # @return [String]
60661
+ #
60662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateInferenceRouterOutput AWS API Documentation
60663
+ #
60664
+ class UpdateInferenceRouterOutput < Struct.new(
60665
+ :inference_router_arn)
60666
+ SENSITIVE = []
60667
+ include Aws::Structure
60668
+ end
60669
+
60048
60670
  # @!attribute [rw] arn
60049
60671
  # The ARN of the MLflow App to update.
60050
60672
  # @return [String]