Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.DescribeAlgorithm

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of the specified algorithm that is in your account.

Synopsis

Creating a Request

data DescribeAlgorithm Source #

See: newDescribeAlgorithm smart constructor.

Constructors

DescribeAlgorithm'
Fields algorithmName :: Text The name of the algorithm to describe.

Instances

Instances details

ToJSON DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods toJSON :: DescribeAlgorithm -> Value # toEncoding :: DescribeAlgorithm -> Encoding # toJSONList :: [DescribeAlgorithm] -> Value # toEncodingList :: [DescribeAlgorithm] -> Encoding #
ToHeaders DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods toHeaders :: DescribeAlgorithm -> [Header] #
ToPath DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods toPath :: DescribeAlgorithm -> ByteString #
ToQuery DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods toQuery :: DescribeAlgorithm -> QueryString #
AWSRequest DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Associated Types type AWSResponse DescribeAlgorithm # Methods request :: (Service -> Service) -> DescribeAlgorithm -> Request DescribeAlgorithm # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAlgorithm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAlgorithm))) #
Generic DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Associated Types type Rep DescribeAlgorithm :: Type -> Type # Methods from :: DescribeAlgorithm -> Rep DescribeAlgorithm x # to :: Rep DescribeAlgorithm x -> DescribeAlgorithm #
Read DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods readsPrec :: Int -> ReadS DescribeAlgorithm # readList :: ReadS [DescribeAlgorithm] # readPrec :: ReadPrec DescribeAlgorithm # readListPrec :: ReadPrec [DescribeAlgorithm] #
Show DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods showsPrec :: Int -> DescribeAlgorithm -> ShowS # show :: DescribeAlgorithm -> String # showList :: [DescribeAlgorithm] -> ShowS #
NFData DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods rnf :: DescribeAlgorithm -> () #
Eq DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods (==) :: DescribeAlgorithm -> DescribeAlgorithm -> Bool # (/=) :: DescribeAlgorithm -> DescribeAlgorithm -> Bool #
Hashable DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods hashWithSalt :: Int -> DescribeAlgorithm -> Int # hash :: DescribeAlgorithm -> Int #
type AWSResponse DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm type AWSResponse DescribeAlgorithm = DescribeAlgorithmResponse
type Rep DescribeAlgorithm Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm type Rep DescribeAlgorithm = D1 ('MetaData "DescribeAlgorithm" "Amazonka.SageMaker.DescribeAlgorithm" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeAlgorithm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "algorithmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAlgorithm Source #

Arguments

:: Text	`DescribeAlgorithm`
-> DescribeAlgorithm

Create a value of DescribeAlgorithm with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeAlgorithm, describeAlgorithm_algorithmName - The name of the algorithm to describe.

Request Lenses

describeAlgorithm_algorithmName :: Lens' DescribeAlgorithm Text Source #

The name of the algorithm to describe.

Destructuring the Response

data DescribeAlgorithmResponse Source #

See: newDescribeAlgorithmResponse smart constructor.

Constructors

DescribeAlgorithmResponse'

Fields

algorithmDescription :: Maybe Text
A brief summary about the algorithm.
certifyForMarketplace :: Maybe Bool
Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
inferenceSpecification :: Maybe InferenceSpecification
Details about inference jobs that the algorithm runs.
productId :: Maybe Text
The product identifier of the algorithm.
validationSpecification :: Maybe AlgorithmValidationSpecification
Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.
httpStatus :: Int
The response's http status code.
algorithmName :: Text
The name of the algorithm being described.
algorithmArn :: Text
The Amazon Resource Name (ARN) of the algorithm.
creationTime :: POSIX
A timestamp specifying when the algorithm was created.
trainingSpecification :: TrainingSpecification
Details about training jobs run by this algorithm.
algorithmStatus :: AlgorithmStatus
The current status of the algorithm.
algorithmStatusDetails :: AlgorithmStatusDetails
Details about the current status of the algorithm.

Instances

Instances details

Generic DescribeAlgorithmResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Associated Types type Rep DescribeAlgorithmResponse :: Type -> Type # Methods from :: DescribeAlgorithmResponse -> Rep DescribeAlgorithmResponse x # to :: Rep DescribeAlgorithmResponse x -> DescribeAlgorithmResponse #
Read DescribeAlgorithmResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods readsPrec :: Int -> ReadS DescribeAlgorithmResponse # readList :: ReadS [DescribeAlgorithmResponse] # readPrec :: ReadPrec DescribeAlgorithmResponse # readListPrec :: ReadPrec [DescribeAlgorithmResponse] #
Show DescribeAlgorithmResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods showsPrec :: Int -> DescribeAlgorithmResponse -> ShowS # show :: DescribeAlgorithmResponse -> String # showList :: [DescribeAlgorithmResponse] -> ShowS #
NFData DescribeAlgorithmResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods rnf :: DescribeAlgorithmResponse -> () #
Eq DescribeAlgorithmResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm Methods (==) :: DescribeAlgorithmResponse -> DescribeAlgorithmResponse -> Bool # (/=) :: DescribeAlgorithmResponse -> DescribeAlgorithmResponse -> Bool #
type Rep DescribeAlgorithmResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeAlgorithm type Rep DescribeAlgorithmResponse = D1 ('MetaData "DescribeAlgorithmResponse" "Amazonka.SageMaker.DescribeAlgorithm" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeAlgorithmResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "algorithmDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certifyForMarketplace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "inferenceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceSpecification)))) :: (S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "validationSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlgorithmValidationSpecification)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :: ((S1 ('MetaSel ('Just "algorithmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "algorithmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :: (S1 ('MetaSel ('Just "trainingSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrainingSpecification) :: (S1 ('MetaSel ('Just "algorithmStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlgorithmStatus) :*: S1 ('MetaSel ('Just "algorithmStatusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlgorithmStatusDetails))))))

newDescribeAlgorithmResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAlgorithmResponse'`
-> Text	`DescribeAlgorithm`
-> Text	`DescribeAlgorithmResponse`
-> UTCTime	`DescribeAlgorithmResponse`
-> TrainingSpecification	`$sel:trainingSpecification:DescribeAlgorithmResponse'`
-> AlgorithmStatus	`DescribeAlgorithmResponse`
-> AlgorithmStatusDetails	`$sel:algorithmStatusDetails:DescribeAlgorithmResponse'`
-> DescribeAlgorithmResponse

Create a value of DescribeAlgorithmResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeAlgorithmResponse, describeAlgorithmResponse_algorithmDescription - A brief summary about the algorithm.

DescribeAlgorithmResponse, describeAlgorithmResponse_certifyForMarketplace - Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

DescribeAlgorithmResponse, describeAlgorithmResponse_inferenceSpecification - Details about inference jobs that the algorithm runs.

DescribeAlgorithmResponse, describeAlgorithmResponse_productId - The product identifier of the algorithm.

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

$sel:httpStatus:DescribeAlgorithmResponse', describeAlgorithmResponse_httpStatus - The response's http status code.

DescribeAlgorithm, describeAlgorithmResponse_algorithmName - The name of the algorithm being described.

DescribeAlgorithmResponse, describeAlgorithmResponse_algorithmArn - The Amazon Resource Name (ARN) of the algorithm.

DescribeAlgorithmResponse, describeAlgorithmResponse_creationTime - A timestamp specifying when the algorithm was created.

$sel:trainingSpecification:DescribeAlgorithmResponse', describeAlgorithmResponse_trainingSpecification - Details about training jobs run by this algorithm.

DescribeAlgorithmResponse, describeAlgorithmResponse_algorithmStatus - The current status of the algorithm.

$sel:algorithmStatusDetails:DescribeAlgorithmResponse', describeAlgorithmResponse_algorithmStatusDetails - Details about the current status of the algorithm.

Response Lenses

describeAlgorithmResponse_algorithmDescription :: Lens' DescribeAlgorithmResponse (Maybe Text) Source #

A brief summary about the algorithm.

describeAlgorithmResponse_certifyForMarketplace :: Lens' DescribeAlgorithmResponse (Maybe Bool) Source #

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

describeAlgorithmResponse_inferenceSpecification :: Lens' DescribeAlgorithmResponse (Maybe InferenceSpecification) Source #

Details about inference jobs that the algorithm runs.

describeAlgorithmResponse_productId :: Lens' DescribeAlgorithmResponse (Maybe Text) Source #

The product identifier of the algorithm.

describeAlgorithmResponse_validationSpecification :: Lens' DescribeAlgorithmResponse (Maybe AlgorithmValidationSpecification) Source #

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

describeAlgorithmResponse_httpStatus :: Lens' DescribeAlgorithmResponse Int Source #

The response's http status code.

describeAlgorithmResponse_algorithmName :: Lens' DescribeAlgorithmResponse Text Source #

The name of the algorithm being described.

describeAlgorithmResponse_algorithmArn :: Lens' DescribeAlgorithmResponse Text Source #

The Amazon Resource Name (ARN) of the algorithm.

describeAlgorithmResponse_creationTime :: Lens' DescribeAlgorithmResponse UTCTime Source #

A timestamp specifying when the algorithm was created.

describeAlgorithmResponse_trainingSpecification :: Lens' DescribeAlgorithmResponse TrainingSpecification Source #

Details about training jobs run by this algorithm.

describeAlgorithmResponse_algorithmStatus :: Lens' DescribeAlgorithmResponse AlgorithmStatus Source #

The current status of the algorithm.

describeAlgorithmResponse_algorithmStatusDetails :: Lens' DescribeAlgorithmResponse AlgorithmStatusDetails Source #

Details about the current status of the algorithm.