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.DescribeModel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a model that you created using the CreateModel API.

Synopsis

data DescribeModel = DescribeModel' {
- modelName :: Text
}
newDescribeModel :: Text -> DescribeModel
describeModel_modelName :: Lens' DescribeModel Text
data DescribeModelResponse = DescribeModelResponse' {
- containers :: Maybe [ContainerDefinition]
- enableNetworkIsolation :: Maybe Bool
- inferenceExecutionConfig :: Maybe InferenceExecutionConfig
- primaryContainer :: Maybe ContainerDefinition
- vpcConfig :: Maybe VpcConfig
- httpStatus :: Int
- modelName :: Text
- executionRoleArn :: Text
- creationTime :: POSIX
- modelArn :: Text
}
newDescribeModelResponse :: Int -> Text -> Text -> UTCTime -> Text -> DescribeModelResponse
describeModelResponse_containers :: Lens' DescribeModelResponse (Maybe [ContainerDefinition])
describeModelResponse_enableNetworkIsolation :: Lens' DescribeModelResponse (Maybe Bool)
describeModelResponse_inferenceExecutionConfig :: Lens' DescribeModelResponse (Maybe InferenceExecutionConfig)
describeModelResponse_primaryContainer :: Lens' DescribeModelResponse (Maybe ContainerDefinition)
describeModelResponse_vpcConfig :: Lens' DescribeModelResponse (Maybe VpcConfig)
describeModelResponse_httpStatus :: Lens' DescribeModelResponse Int
describeModelResponse_modelName :: Lens' DescribeModelResponse Text
describeModelResponse_executionRoleArn :: Lens' DescribeModelResponse Text
describeModelResponse_creationTime :: Lens' DescribeModelResponse UTCTime
describeModelResponse_modelArn :: Lens' DescribeModelResponse Text

Creating a Request

data DescribeModel Source #

See: newDescribeModel smart constructor.

Constructors

DescribeModel'
Fields modelName :: Text The name of the model.

Instances

Instances details

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

newDescribeModel Source #

Arguments

:: Text	`DescribeModel`
-> DescribeModel

Create a value of DescribeModel 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:

DescribeModel, describeModel_modelName - The name of the model.

Request Lenses

describeModel_modelName :: Lens' DescribeModel Text Source #

The name of the model.

Destructuring the Response

data DescribeModelResponse Source #

See: newDescribeModelResponse smart constructor.

Constructors

DescribeModelResponse'

Fields

containers :: Maybe [ContainerDefinition]
The containers in the inference pipeline.
enableNetworkIsolation :: Maybe Bool
If True, no inbound or outbound network calls can be made to or from the model container.
inferenceExecutionConfig :: Maybe InferenceExecutionConfig
Specifies details of how containers in a multi-container endpoint are called.
primaryContainer :: Maybe ContainerDefinition
The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
vpcConfig :: Maybe VpcConfig
A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud
httpStatus :: Int
The response's http status code.
modelName :: Text
Name of the SageMaker model.
executionRoleArn :: Text
The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
creationTime :: POSIX
A timestamp that shows when the model was created.
modelArn :: Text
The Amazon Resource Name (ARN) of the model.

Instances

Instances details

Generic DescribeModelResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModel Associated Types type Rep DescribeModelResponse :: Type -> Type # Methods from :: DescribeModelResponse -> Rep DescribeModelResponse x # to :: Rep DescribeModelResponse x -> DescribeModelResponse #
Read DescribeModelResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModel Methods readsPrec :: Int -> ReadS DescribeModelResponse # readList :: ReadS [DescribeModelResponse] # readPrec :: ReadPrec DescribeModelResponse # readListPrec :: ReadPrec [DescribeModelResponse] #
Show DescribeModelResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModel Methods showsPrec :: Int -> DescribeModelResponse -> ShowS # show :: DescribeModelResponse -> String # showList :: [DescribeModelResponse] -> ShowS #
NFData DescribeModelResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModel Methods rnf :: DescribeModelResponse -> () #
Eq DescribeModelResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModel Methods (==) :: DescribeModelResponse -> DescribeModelResponse -> Bool # (/=) :: DescribeModelResponse -> DescribeModelResponse -> Bool #
type Rep DescribeModelResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModel type Rep DescribeModelResponse = D1 ('MetaData "DescribeModelResponse" "Amazonka.SageMaker.DescribeModel" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeModelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContainerDefinition])) :: S1 ('MetaSel ('Just "enableNetworkIsolation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "inferenceExecutionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceExecutionConfig)) :: (S1 ('MetaSel ('Just "primaryContainer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerDefinition)) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribeModelResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeModelResponse'`
-> Text	`DescribeModel`
-> Text	`DescribeModelResponse`
-> UTCTime	`DescribeModelResponse`
-> Text	`DescribeModelResponse`
-> DescribeModelResponse

Create a value of DescribeModelResponse 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:

DescribeModelResponse, describeModelResponse_containers - The containers in the inference pipeline.

DescribeModelResponse, describeModelResponse_enableNetworkIsolation - If True, no inbound or outbound network calls can be made to or from the model container.

DescribeModelResponse, describeModelResponse_inferenceExecutionConfig - Specifies details of how containers in a multi-container endpoint are called.

DescribeModelResponse, describeModelResponse_primaryContainer - The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

DescribeModelResponse, describeModelResponse_vpcConfig - A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

$sel:httpStatus:DescribeModelResponse', describeModelResponse_httpStatus - The response's http status code.

DescribeModel, describeModelResponse_modelName - Name of the SageMaker model.

DescribeModelResponse, describeModelResponse_executionRoleArn - The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

DescribeModelResponse, describeModelResponse_creationTime - A timestamp that shows when the model was created.

DescribeModelResponse, describeModelResponse_modelArn - The Amazon Resource Name (ARN) of the model.

Response Lenses

describeModelResponse_containers :: Lens' DescribeModelResponse (Maybe [ContainerDefinition]) Source #

The containers in the inference pipeline.

describeModelResponse_enableNetworkIsolation :: Lens' DescribeModelResponse (Maybe Bool) Source #

If True, no inbound or outbound network calls can be made to or from the model container.

describeModelResponse_inferenceExecutionConfig :: Lens' DescribeModelResponse (Maybe InferenceExecutionConfig) Source #

Specifies details of how containers in a multi-container endpoint are called.

describeModelResponse_primaryContainer :: Lens' DescribeModelResponse (Maybe ContainerDefinition) Source #

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

describeModelResponse_vpcConfig :: Lens' DescribeModelResponse (Maybe VpcConfig) Source #

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

describeModelResponse_httpStatus :: Lens' DescribeModelResponse Int Source #

The response's http status code.

describeModelResponse_modelName :: Lens' DescribeModelResponse Text Source #

Name of the SageMaker model.

describeModelResponse_executionRoleArn :: Lens' DescribeModelResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

describeModelResponse_creationTime :: Lens' DescribeModelResponse UTCTime Source #

A timestamp that shows when the model was created.

describeModelResponse_modelArn :: Lens' DescribeModelResponse Text Source #

The Amazon Resource Name (ARN) of the model.