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
{
"CreationTime": number,
"DataCaptureConfig": {
"CaptureContentTypeHeader": {
"CsvContentTypes": [ "string" ],
"JsonContentTypes": [ "string" ]
},
"CaptureOptions": [
{
"CaptureMode": "string"
}
],
"DestinationS3Uri": "string",
"EnableCapture": boolean,
"InitialSamplingPercentage": number,
"KmsKeyId": "string"
},
"EndpointConfigArn": "string",
"EndpointConfigName": "string",
"KmsKeyId": "string",
"ProductionVariants": [
{
"AcceleratorType": "string",
"InitialInstanceCount": number,
"InitialVariantWeight": number,
"InstanceType": "string",
"ModelName": "string",
"VariantName": "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
-
A timestamp that shows when the endpoint configuration was created.
Type: Timestamp
- DataCaptureConfig
-
Type: DataCaptureConfig object
- 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 Amazon SageMaker endpoint configuration.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - KmsKeyId
-
AWS 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:
.* - ProductionVariants
-
An array of
ProductionVariantobjects, 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.
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 AWS SDKs, see the following:
