DescribeInferenceRouter
Returns information about an inference router, including the routing status of each destination.
SageMaker AI checks each destination with your permissions when you call this
operation, so callers with different permissions can see a different
RoutingStatus. To get the router's tags, use ListTags.
Request Syntax
{
"InferenceRouterName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- InferenceRouterName
-
The name of the inference router to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{
"CreationTime": number,
"InferenceRouterArn": "string",
"InferenceRouterName": "string",
"LastModifiedTime": number,
"RoutingTargets": [
{
"AsyncInferenceConfig": {
"ClientConfig": {
"MaxTimeInBacklogSeconds": number
},
"OutputConfig": {
"KmsKeyId": "string",
"NotificationConfig": {
"ErrorTopic": "string",
"SuccessTopic": "string"
},
"S3FailurePath": "string",
"S3OutputPath": "string"
}
},
"Destinations": [
{
"ResourceArn": "string",
"RoutingStatus": "string"
}
],
"Name": "string",
"RoutingPreference": "string"
}
],
"Status": "string",
"StatusReason": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreationTime
-
The date and time that the inference router was created.
Type: Timestamp
- InferenceRouterArn
-
The Amazon Resource Name (ARN) of the inference router.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z-]*:sagemaker:[a-z0-9-]+:[0-9]{12}:inference-router/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - InferenceRouterName
-
The name of the inference router.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - LastModifiedTime
-
The date and time that the inference router was last updated.
Type: Timestamp
- RoutingTargets
-
The routing targets of the inference router. Each destination includes its
RoutingStatus. You can send these routing targets back in anUpdateInferenceRouterrequest without changes.Type: Array of RoutingTarget objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
- Status
-
The status of the inference router.
Type: String
Valid Values:
InService | Creating | Updating | Failed | Deleting - StatusReason
-
If the status is
Failed, the reason that the inference router failed.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: