Skip to content

DescribeAlgorithmOutput

Source code in docs_src/capo_sagemaker/types/describe_algorithm_output.py
class DescribeAlgorithmOutput(TypedDict, closed=True):
    algorithm_name: NotRequired["capo_sagemaker.types.entity_name.EntityName"]
    """<p>The name of the algorithm being described.</p>"""
    algorithm_arn: NotRequired["capo_sagemaker.types.algorithm_arn.AlgorithmArn"]
    """<p>The Amazon Resource Name (ARN) of the algorithm.</p>"""
    algorithm_description: NotRequired[
        "capo_sagemaker.types.entity_description.EntityDescription"
    ]
    """<p>A brief summary about the algorithm.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>A timestamp specifying when the algorithm was created.</p>"""
    training_specification: NotRequired[
        "capo_sagemaker.types.training_specification.TrainingSpecification"
    ]
    """<p>Details about training jobs run by this algorithm.</p>"""
    inference_specification: NotRequired[
        "capo_sagemaker.types.inference_specification.InferenceSpecification"
    ]
    """<p>Details about inference jobs that the algorithm runs.</p>"""
    validation_specification: NotRequired[
        "capo_sagemaker.types.algorithm_validation_specification.AlgorithmValidationSpecification"
    ]
    """<p>Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.</p>"""
    algorithm_status: NotRequired[
        "capo_sagemaker.types.algorithm_status.AlgorithmStatus"
    ]
    """<p>The current status of the algorithm.</p>"""
    algorithm_status_details: NotRequired[
        "capo_sagemaker.types.algorithm_status_details.AlgorithmStatusDetails"
    ]
    """<p>Details about the current status of the algorithm.</p>"""
    product_id: NotRequired["capo_sagemaker.types.product_id.ProductId"]
    """<p>The product identifier of the algorithm.</p>"""
    certify_for_marketplace: NotRequired[
        "capo_sagemaker.types.certify_for_marketplace.CertifyForMarketplace"
    ]
    """<p>Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.</p>"""

algorithm_arn instance-attribute

algorithm_arn: NotRequired[AlgorithmArn]

The Amazon Resource Name (ARN) of the algorithm.

algorithm_description instance-attribute

algorithm_description: NotRequired[EntityDescription]

A brief summary about the algorithm.

algorithm_name instance-attribute

algorithm_name: NotRequired[EntityName]

The name of the algorithm being described.

algorithm_status instance-attribute

algorithm_status: NotRequired[AlgorithmStatus]

The current status of the algorithm.

algorithm_status_details instance-attribute

algorithm_status_details: NotRequired[AlgorithmStatusDetails]

Details about the current status of the algorithm.

certify_for_marketplace instance-attribute

certify_for_marketplace: NotRequired[CertifyForMarketplace]

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

A timestamp specifying when the algorithm was created.

inference_specification instance-attribute

inference_specification: NotRequired[InferenceSpecification]

Details about inference jobs that the algorithm runs.

product_id instance-attribute

product_id: NotRequired[ProductId]

The product identifier of the algorithm.

training_specification instance-attribute

training_specification: NotRequired[TrainingSpecification]

Details about training jobs run by this algorithm.

validation_specification instance-attribute

validation_specification: NotRequired[AlgorithmValidationSpecification]

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.