DescribeEndpointConfig
Returns the description of an endpoint configuration created using the
CreateEndpointConfig
API.
Request Syntax
{
"EndpointConfigName": "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.
- EndpointConfigName
-
The name of the endpoint configuration.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Required: Yes
Response Syntax
{
"AsyncInferenceConfig": {
"ClientConfig": {
"MaxConcurrentInvocationsPerInstance": number
},
"OutputConfig": {
"KmsKeyId": "string",
"NotificationConfig": {
"ErrorTopic": "string",
"IncludeInferenceResponseIn": [ "string" ],
"SuccessTopic": "string"
},
"S3FailurePath": "string",
"S3OutputPath": "string"
}
},
"CreationTime": number,
"DataCaptureConfig": {
"CaptureContentTypeHeader": {
"CsvContentTypes": [ "string" ],
"JsonContentTypes": [ "string" ]
},
"CaptureOptions": [
{
"CaptureMode": "string"
}
],
"DestinationS3Uri": "string",
"EnableCapture": boolean,
"InitialSamplingPercentage": number,
"KmsKeyId": "string"
},
"EnableNetworkIsolation": boolean,
"EndpointConfigArn": "string",
"EndpointConfigName": "string",
"ExecutionRoleArn": "string",
"ExplainerConfig": {
"ClarifyExplainerConfig": {
"EnableExplanations": "string",
"InferenceConfig": {
"ContentTemplate": "string",
"FeatureHeaders": [ "string" ],
"FeaturesAttribute": "string",
"FeatureTypes": [ "string" ],
"LabelAttribute": "string",
"LabelHeaders": [ "string" ],
"LabelIndex": number,
"MaxPayloadInMB": number,
"MaxRecordCount": number,
"ProbabilityAttribute": "string",
"ProbabilityIndex": number
},
"ShapConfig": {
"NumberOfSamples": number,
"Seed": number,
"ShapBaselineConfig": {
"MimeType": "string",
"ShapBaseline": "string",
"ShapBaselineUri": "string"
},
"TextConfig": {
"Granularity": "string",
"Language": "string"
},
"UseLogit": boolean
}
}
},
"KmsKeyId": "string",
"ProductionVariants": [
{
"AcceleratorType": "string",
"ContainerStartupHealthCheckTimeoutInSeconds": number,
"CoreDumpConfig": {
"DestinationS3Uri": "string",
"KmsKeyId": "string"
},
"EnableSSMAccess": boolean,
"InferenceAmiVersion": "string",
"InitialInstanceCount": number,
"InitialVariantWeight": number,
"InstanceType": "string",
"ManagedInstanceScaling": {
"MaxInstanceCount": number,
"MinInstanceCount": number,
"Status": "string"
},
"ModelDataDownloadTimeoutInSeconds": number,
"ModelName": "string",
"RoutingConfig": {
"RoutingStrategy": "string"
},
"ServerlessConfig": {
"MaxConcurrency": number,
"MemorySizeInMB": number,
"ProvisionedConcurrency": number
},
"VariantName": "string",
"VolumeSizeInGB": number
}
],
"ShadowProductionVariants": [
{
"AcceleratorType": "string",
"ContainerStartupHealthCheckTimeoutInSeconds": number,
"CoreDumpConfig": {
"DestinationS3Uri": "string",
"KmsKeyId": "string"
},
"EnableSSMAccess": boolean,
"InferenceAmiVersion": "string",
"InitialInstanceCount": number,
"InitialVariantWeight": number,
"InstanceType": "string",
"ManagedInstanceScaling": {
"MaxInstanceCount": number,
"MinInstanceCount": number,
"Status": "string"
},
"ModelDataDownloadTimeoutInSeconds": number,
"ModelName": "string",
"RoutingConfig": {
"RoutingStrategy": "string"
},
"ServerlessConfig": {
"MaxConcurrency": number,
"MemorySizeInMB": number,
"ProvisionedConcurrency": number
},
"VariantName": "string",
"VolumeSizeInGB": number
}
],
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "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.
- AsyncInferenceConfig
-
Returns the description of an endpoint configuration created using the
CreateEndpointConfig
API.Type: AsyncInferenceConfig object
- CreationTime
-
A timestamp that shows when the endpoint configuration was created.
Type: Timestamp
- DataCaptureConfig
-
Configuration to control how SageMaker captures inference data.
Type: DataCaptureConfig object
- EnableNetworkIsolation
-
Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
Type: Boolean
- EndpointConfigArn
-
The Amazon Resource Name (ARN) of the endpoint configuration.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint-config/.*
- EndpointConfigName
-
Name of the SageMaker endpoint configuration.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
- ExecutionRoleArn
-
The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
- ExplainerConfig
-
The configuration parameters for an explainer.
Type: ExplainerConfig object
- KmsKeyId
-
Amazon KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[a-zA-Z0-9:/_-]*$
- ProductionVariants
-
An array of
ProductionVariant
objects, one for each model that you want to host at this endpoint.Type: Array of ProductionVariant objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
- ShadowProductionVariants
-
An array of
ProductionVariant
objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified onProductionVariants
.Type: Array of ProductionVariant objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
- VpcConfig
-
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
Type: VpcConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: