DescribeAlgorithm
Returns a description of the specified algorithm that is in your account.
Request Syntax
{
"AlgorithmName": "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.
- AlgorithmName
-
The name of the algorithm to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 170.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?<!-)$Required: Yes
Response Syntax
{
"AlgorithmArn": "string",
"AlgorithmDescription": "string",
"AlgorithmName": "string",
"AlgorithmStatus": "string",
"AlgorithmStatusDetails": {
"ImageScanStatuses": [
{
"FailureReason": "string",
"Name": "string",
"Status": "string"
}
],
"ValidationStatuses": [
{
"FailureReason": "string",
"Name": "string",
"Status": "string"
}
]
},
"CertifyForMarketplace": boolean,
"CreationTime": number,
"InferenceSpecification": {
"Containers": [
{
"AdditionalS3DataSource": {
"CompressionType": "string",
"S3DataType": "string",
"S3Uri": "string"
},
"ContainerHostname": "string",
"Environment": {
"string" : "string"
},
"Framework": "string",
"FrameworkVersion": "string",
"Image": "string",
"ImageDigest": "string",
"ModelDataSource": {
"S3DataSource": {
"CompressionType": "string",
"HubAccessConfig": {
"HubContentArn": "string"
},
"ManifestS3Uri": "string",
"ModelAccessConfig": {
"AcceptEula": boolean
},
"S3DataType": "string",
"S3Uri": "string"
}
},
"ModelDataUrl": "string",
"ModelInput": {
"DataInputConfig": "string"
},
"NearestModelName": "string",
"ProductId": "string"
}
],
"SupportedContentTypes": [ "string" ],
"SupportedRealtimeInferenceInstanceTypes": [ "string" ],
"SupportedResponseMIMETypes": [ "string" ],
"SupportedTransformInstanceTypes": [ "string" ]
},
"ProductId": "string",
"TrainingSpecification": {
"AdditionalS3DataSource": {
"CompressionType": "string",
"S3DataType": "string",
"S3Uri": "string"
},
"MetricDefinitions": [
{
"Name": "string",
"Regex": "string"
}
],
"SupportedHyperParameters": [
{
"DefaultValue": "string",
"Description": "string",
"IsRequired": boolean,
"IsTunable": boolean,
"Name": "string",
"Range": {
"CategoricalParameterRangeSpecification": {
"Values": [ "string" ]
},
"ContinuousParameterRangeSpecification": {
"MaxValue": "string",
"MinValue": "string"
},
"IntegerParameterRangeSpecification": {
"MaxValue": "string",
"MinValue": "string"
}
},
"Type": "string"
}
],
"SupportedTrainingInstanceTypes": [ "string" ],
"SupportedTuningJobObjectiveMetrics": [
{
"MetricName": "string",
"Type": "string"
}
],
"SupportsDistributedTraining": boolean,
"TrainingChannels": [
{
"Description": "string",
"IsRequired": boolean,
"Name": "string",
"SupportedCompressionTypes": [ "string" ],
"SupportedContentTypes": [ "string" ],
"SupportedInputModes": [ "string" ]
}
],
"TrainingImage": "string",
"TrainingImageDigest": "string"
},
"ValidationSpecification": {
"ValidationProfiles": [
{
"ProfileName": "string",
"TrainingJobDefinition": {
"HyperParameters": {
"string" : "string"
},
"InputDataConfig": [
{
"ChannelName": "string",
"CompressionType": "string",
"ContentType": "string",
"DataSource": {
"FileSystemDataSource": {
"DirectoryPath": "string",
"FileSystemAccessMode": "string",
"FileSystemId": "string",
"FileSystemType": "string"
},
"S3DataSource": {
"AttributeNames": [ "string" ],
"InstanceGroupNames": [ "string" ],
"S3DataDistributionType": "string",
"S3DataType": "string",
"S3Uri": "string"
}
},
"InputMode": "string",
"RecordWrapperType": "string",
"ShuffleConfig": {
"Seed": number
}
}
],
"OutputDataConfig": {
"CompressionType": "string",
"KmsKeyId": "string",
"S3OutputPath": "string"
},
"ResourceConfig": {
"InstanceCount": number,
"InstanceGroups": [
{
"InstanceCount": number,
"InstanceGroupName": "string",
"InstanceType": "string"
}
],
"InstanceType": "string",
"KeepAlivePeriodInSeconds": number,
"TrainingPlanArn": "string",
"VolumeKmsKeyId": "string",
"VolumeSizeInGB": number
},
"StoppingCondition": {
"MaxPendingTimeInSeconds": number,
"MaxRuntimeInSeconds": number,
"MaxWaitTimeInSeconds": number
},
"TrainingInputMode": "string"
},
"TransformJobDefinition": {
"BatchStrategy": "string",
"Environment": {
"string" : "string"
},
"MaxConcurrentTransforms": number,
"MaxPayloadInMB": number,
"TransformInput": {
"CompressionType": "string",
"ContentType": "string",
"DataSource": {
"S3DataSource": {
"S3DataType": "string",
"S3Uri": "string"
}
},
"SplitType": "string"
},
"TransformOutput": {
"Accept": "string",
"AssembleWith": "string",
"KmsKeyId": "string",
"S3OutputPath": "string"
},
"TransformResources": {
"InstanceCount": number,
"InstanceType": "string",
"VolumeKmsKeyId": "string"
}
}
}
],
"ValidationRole": "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.
- AlgorithmArn
-
The Amazon Resource Name (ARN) of the algorithm.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:algorithm/[\S]{1,2048}$ - AlgorithmDescription
-
A brief summary about the algorithm.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]* - AlgorithmName
-
The name of the algorithm being described.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ - AlgorithmStatus
-
The current status of the algorithm.
Type: String
Valid Values:
Pending | InProgress | Completed | Failed | Deleting - AlgorithmStatusDetails
-
Details about the current status of the algorithm.
Type: AlgorithmStatusDetails object
- CertifyForMarketplace
-
Whether the algorithm is certified to be listed in AWS Marketplace.
Type: Boolean
- CreationTime
-
A timestamp specifying when the algorithm was created.
Type: Timestamp
- InferenceSpecification
-
Details about inference jobs that the algorithm runs.
Type: InferenceSpecification object
- ProductId
-
The product identifier of the algorithm.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ - TrainingSpecification
-
Details about training jobs run by this algorithm.
Type: TrainingSpecification object
- ValidationSpecification
-
Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.
Type: AlgorithmValidationSpecification 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 AWS SDKs, see the following:
