Network.AWS.SageMaker.DescribeNotebookInstance

Returns information about a notebook instance.

Creating a Request

describeNotebookInstance

Arguments

:: Text

dniNotebookInstanceName

-> DescribeNotebookInstance

Creates a value of DescribeNotebookInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dniNotebookInstanceName - The name of the notebook instance that you want information about.

data DescribeNotebookInstance

See: describeNotebookInstance smart constructor.

Instances

Eq DescribeNotebookInstance

Methods

(==) :: DescribeNotebookInstance -> DescribeNotebookInstance -> Bool

(/=) :: DescribeNotebookInstance -> DescribeNotebookInstance -> Bool

Data DescribeNotebookInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeNotebookInstance -> c DescribeNotebookInstance

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeNotebookInstance

toConstr :: DescribeNotebookInstance -> Constr

dataTypeOf :: DescribeNotebookInstance -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeNotebookInstance)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeNotebookInstance)

gmapT :: (forall b. Data b => b -> b) -> DescribeNotebookInstance -> DescribeNotebookInstance

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNotebookInstance -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNotebookInstance -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeNotebookInstance -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeNotebookInstance -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeNotebookInstance -> m DescribeNotebookInstance

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNotebookInstance -> m DescribeNotebookInstance

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNotebookInstance -> m DescribeNotebookInstance

Read DescribeNotebookInstance

Methods

readsPrec :: Int -> ReadS DescribeNotebookInstance

readList :: ReadS [DescribeNotebookInstance]

readPrec :: ReadPrec DescribeNotebookInstance

readListPrec :: ReadPrec [DescribeNotebookInstance]

Show DescribeNotebookInstance

Methods

showsPrec :: Int -> DescribeNotebookInstance -> ShowS

show :: DescribeNotebookInstance -> String

showList :: [DescribeNotebookInstance] -> ShowS

Generic DescribeNotebookInstance

Associated Types

type Rep DescribeNotebookInstance :: * -> *

Methods

from :: DescribeNotebookInstance -> Rep DescribeNotebookInstance x

to :: Rep DescribeNotebookInstance x -> DescribeNotebookInstance

Hashable DescribeNotebookInstance

Methods

hashWithSalt :: Int -> DescribeNotebookInstance -> Int

hash :: DescribeNotebookInstance -> Int

ToJSON DescribeNotebookInstance

Methods

toJSON :: DescribeNotebookInstance -> Value

toEncoding :: DescribeNotebookInstance -> Encoding

toJSONList :: [DescribeNotebookInstance] -> Value

toEncodingList :: [DescribeNotebookInstance] -> Encoding

NFData DescribeNotebookInstance

Methods

rnf :: DescribeNotebookInstance -> ()

AWSRequest DescribeNotebookInstance

Associated Types

type Rs DescribeNotebookInstance :: *

Methods

request :: DescribeNotebookInstance -> Request DescribeNotebookInstance

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeNotebookInstance -> ClientResponse -> m (Response DescribeNotebookInstance)

ToHeaders DescribeNotebookInstance

Methods

toHeaders :: DescribeNotebookInstance -> [Header]

ToPath DescribeNotebookInstance

Methods

toPath :: DescribeNotebookInstance -> ByteString

ToQuery DescribeNotebookInstance

Methods

toQuery :: DescribeNotebookInstance -> QueryString

type Rep DescribeNotebookInstance

type Rep DescribeNotebookInstance = D1 * (MetaData "DescribeNotebookInstance" "Network.AWS.SageMaker.DescribeNotebookInstance" "amazonka-sagemaker-1.6.0-9oNc2IB3ZCo9VZHXZi5zcA" True) (C1 * (MetaCons "DescribeNotebookInstance'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dniNotebookInstanceName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs DescribeNotebookInstance

type Rs DescribeNotebookInstance = DescribeNotebookInstanceResponse

Request Lenses

dniNotebookInstanceName :: Lens' DescribeNotebookInstance Text

The name of the notebook instance that you want information about.

Destructuring the Response

describeNotebookInstanceResponse

Arguments

:: Int

dnirsResponseStatus

-> NotebookInstanceStatus

dnirsNotebookInstanceStatus

-> DescribeNotebookInstanceResponse

Creates a value of DescribeNotebookInstanceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dnirsCreationTime - A timestamp. Use this parameter to return the time when the notebook instance was created
• dnirsFailureReason - If status is failed, the reason it failed.
• dnirsNotebookInstanceName - Name of the Amazon SageMaker notebook instance.
• dnirsSecurityGroups - The IDs of the VPC security groups.
• dnirsURL - The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
• dnirsLastModifiedTime - A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
• dnirsNetworkInterfaceId - Network interface IDs that Amazon SageMaker created at the time of creating the instance.
• dnirsSubnetId - The ID of the VPC subnet.
• dnirsInstanceType - The type of ML compute instance running on the notebook instance.
• dnirsKMSKeyId - AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
• dnirsDirectInternetAccess - Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, he notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services . For more information, see 'appendix-notebook-and-internet-access' .
• dnirsNotebookInstanceARN - The Amazon Resource Name (ARN) of the notebook instance.
• dnirsNotebookInstanceLifecycleConfigName - Returns the name of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see 'notebook-lifecycle-config' .
• dnirsRoleARN - Amazon Resource Name (ARN) of the IAM role associated with the instance.
• dnirsResponseStatus - -- | The response status code.
• dnirsNotebookInstanceStatus - The status of the notebook instance.

data DescribeNotebookInstanceResponse

See: describeNotebookInstanceResponse smart constructor.

Instances

Eq DescribeNotebookInstanceResponse

Methods

(==) :: DescribeNotebookInstanceResponse -> DescribeNotebookInstanceResponse -> Bool

(/=) :: DescribeNotebookInstanceResponse -> DescribeNotebookInstanceResponse -> Bool

Data DescribeNotebookInstanceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeNotebookInstanceResponse -> c DescribeNotebookInstanceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeNotebookInstanceResponse

toConstr :: DescribeNotebookInstanceResponse -> Constr

dataTypeOf :: DescribeNotebookInstanceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeNotebookInstanceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeNotebookInstanceResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeNotebookInstanceResponse -> DescribeNotebookInstanceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNotebookInstanceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNotebookInstanceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeNotebookInstanceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeNotebookInstanceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeNotebookInstanceResponse -> m DescribeNotebookInstanceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNotebookInstanceResponse -> m DescribeNotebookInstanceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNotebookInstanceResponse -> m DescribeNotebookInstanceResponse

Read DescribeNotebookInstanceResponse

Methods

readsPrec :: Int -> ReadS DescribeNotebookInstanceResponse

readList :: ReadS [DescribeNotebookInstanceResponse]

readPrec :: ReadPrec DescribeNotebookInstanceResponse

readListPrec :: ReadPrec [DescribeNotebookInstanceResponse]

Show DescribeNotebookInstanceResponse

Methods

showsPrec :: Int -> DescribeNotebookInstanceResponse -> ShowS

show :: DescribeNotebookInstanceResponse -> String

showList :: [DescribeNotebookInstanceResponse] -> ShowS

Generic DescribeNotebookInstanceResponse

Associated Types

type Rep DescribeNotebookInstanceResponse :: * -> *

Methods

from :: DescribeNotebookInstanceResponse -> Rep DescribeNotebookInstanceResponse x

to :: Rep DescribeNotebookInstanceResponse x -> DescribeNotebookInstanceResponse

NFData DescribeNotebookInstanceResponse

Methods

rnf :: DescribeNotebookInstanceResponse -> ()

type Rep DescribeNotebookInstanceResponse

type Rep DescribeNotebookInstanceResponse = D1 * (MetaData "DescribeNotebookInstanceResponse" "Network.AWS.SageMaker.DescribeNotebookInstance" "amazonka-sagemaker-1.6.0-9oNc2IB3ZCo9VZHXZi5zcA" False) (C1 * (MetaCons "DescribeNotebookInstanceResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsCreationTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_dnirsFailureReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsNotebookInstanceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dnirsSecurityGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dnirsLastModifiedTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsNetworkInterfaceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dnirsSubnetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsInstanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe InstanceType))) (S1 * (MetaSel (Just Symbol "_dnirsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsDirectInternetAccess") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DirectInternetAccess))) (S1 * (MetaSel (Just Symbol "_dnirsNotebookInstanceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsNotebookInstanceLifecycleConfigName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dnirsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dnirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_dnirsNotebookInstanceStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * NotebookInstanceStatus)))))))

Response Lenses

dnirsCreationTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime)

A timestamp. Use this parameter to return the time when the notebook instance was created

dnirsFailureReason :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

If status is failed, the reason it failed.

dnirsNotebookInstanceName :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

Name of the Amazon SageMaker notebook instance.

dnirsSecurityGroups :: Lens' DescribeNotebookInstanceResponse [Text]

The IDs of the VPC security groups.

dnirsURL :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

dnirsLastModifiedTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime)

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

dnirsNetworkInterfaceId :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

Network interface IDs that Amazon SageMaker created at the time of creating the instance.

dnirsSubnetId :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

The ID of the VPC subnet.

dnirsInstanceType :: Lens' DescribeNotebookInstanceResponse (Maybe InstanceType)

The type of ML compute instance running on the notebook instance.

dnirsKMSKeyId :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

dnirsDirectInternetAccess :: Lens' DescribeNotebookInstanceResponse (Maybe DirectInternetAccess)

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, he notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services . For more information, see 'appendix-notebook-and-internet-access' .

dnirsNotebookInstanceARN :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

The Amazon Resource Name (ARN) of the notebook instance.

dnirsNotebookInstanceLifecycleConfigName :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

Returns the name of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see 'notebook-lifecycle-config' .

dnirsRoleARN :: Lens' DescribeNotebookInstanceResponse (Maybe Text)

Amazon Resource Name (ARN) of the IAM role associated with the instance.

dnirsResponseStatus :: Lens' DescribeNotebookInstanceResponse Int

• - | The response status code.

dnirsNotebookInstanceStatus :: Lens' DescribeNotebookInstanceResponse NotebookInstanceStatus

The status of the notebook instance.