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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the app.

Synopsis

data DescribeApp = DescribeApp' {
- spaceName :: Maybe Text
- userProfileName :: Maybe Text
- domainId :: Text
- appType :: AppType
- appName :: Text
}
newDescribeApp :: Text -> AppType -> Text -> DescribeApp
describeApp_spaceName :: Lens' DescribeApp (Maybe Text)
describeApp_userProfileName :: Lens' DescribeApp (Maybe Text)
describeApp_domainId :: Lens' DescribeApp Text
describeApp_appType :: Lens' DescribeApp AppType
describeApp_appName :: Lens' DescribeApp Text
data DescribeAppResponse = DescribeAppResponse' {
- appArn :: Maybe Text
- appName :: Maybe Text
- appType :: Maybe AppType
- creationTime :: Maybe POSIX
- domainId :: Maybe Text
- failureReason :: Maybe Text
- lastHealthCheckTimestamp :: Maybe POSIX
- lastUserActivityTimestamp :: Maybe POSIX
- resourceSpec :: Maybe ResourceSpec
- spaceName :: Maybe Text
- status :: Maybe AppStatus
- userProfileName :: Maybe Text
- httpStatus :: Int
}
newDescribeAppResponse :: Int -> DescribeAppResponse
describeAppResponse_appArn :: Lens' DescribeAppResponse (Maybe Text)
describeAppResponse_appName :: Lens' DescribeAppResponse (Maybe Text)
describeAppResponse_appType :: Lens' DescribeAppResponse (Maybe AppType)
describeAppResponse_creationTime :: Lens' DescribeAppResponse (Maybe UTCTime)
describeAppResponse_domainId :: Lens' DescribeAppResponse (Maybe Text)
describeAppResponse_failureReason :: Lens' DescribeAppResponse (Maybe Text)
describeAppResponse_lastHealthCheckTimestamp :: Lens' DescribeAppResponse (Maybe UTCTime)
describeAppResponse_lastUserActivityTimestamp :: Lens' DescribeAppResponse (Maybe UTCTime)
describeAppResponse_resourceSpec :: Lens' DescribeAppResponse (Maybe ResourceSpec)
describeAppResponse_spaceName :: Lens' DescribeAppResponse (Maybe Text)
describeAppResponse_status :: Lens' DescribeAppResponse (Maybe AppStatus)
describeAppResponse_userProfileName :: Lens' DescribeAppResponse (Maybe Text)
describeAppResponse_httpStatus :: Lens' DescribeAppResponse Int

Creating a Request

data DescribeApp Source #

See: newDescribeApp smart constructor.

Constructors

DescribeApp'
Fields spaceName :: Maybe Text The name of the space. userProfileName :: Maybe Text The user profile name. If this value is not set, then `SpaceName` must be set. domainId :: Text The domain ID. appType :: AppType The type of app. appName :: Text The name of the app.

Instances

Instances details

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

newDescribeApp Source #

Arguments

:: Text	`DescribeApp`
-> AppType	`DescribeApp`
-> Text	`DescribeApp`
-> DescribeApp

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

DescribeApp, describeApp_spaceName - The name of the space.

DescribeApp, describeApp_userProfileName - The user profile name. If this value is not set, then SpaceName must be set.

DescribeApp, describeApp_domainId - The domain ID.

DescribeApp, describeApp_appType - The type of app.

DescribeApp, describeApp_appName - The name of the app.

Request Lenses

describeApp_spaceName :: Lens' DescribeApp (Maybe Text) Source #

The name of the space.

describeApp_userProfileName :: Lens' DescribeApp (Maybe Text) Source #

The user profile name. If this value is not set, then SpaceName must be set.

describeApp_domainId :: Lens' DescribeApp Text Source #

The domain ID.

describeApp_appType :: Lens' DescribeApp AppType Source #

The type of app.

describeApp_appName :: Lens' DescribeApp Text Source #

The name of the app.

Destructuring the Response

data DescribeAppResponse Source #

See: newDescribeAppResponse smart constructor.

Constructors

DescribeAppResponse'

Fields

appArn :: Maybe Text
The Amazon Resource Name (ARN) of the app.
appName :: Maybe Text
The name of the app.
appType :: Maybe AppType
The type of app.
creationTime :: Maybe POSIX
The creation time.
domainId :: Maybe Text
The domain ID.
failureReason :: Maybe Text
The failure reason.
lastHealthCheckTimestamp :: Maybe POSIX
The timestamp of the last health check.
lastUserActivityTimestamp :: Maybe POSIX
The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.
resourceSpec :: Maybe ResourceSpec
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
spaceName :: Maybe Text
The name of the space. If this value is not set, then UserProfileName must be set.
status :: Maybe AppStatus
The status.
userProfileName :: Maybe Text
The user profile name.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeAppResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeApp Associated Types type Rep DescribeAppResponse :: Type -> Type # Methods from :: DescribeAppResponse -> Rep DescribeAppResponse x # to :: Rep DescribeAppResponse x -> DescribeAppResponse #
Read DescribeAppResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeApp Methods readsPrec :: Int -> ReadS DescribeAppResponse # readList :: ReadS [DescribeAppResponse] # readPrec :: ReadPrec DescribeAppResponse # readListPrec :: ReadPrec [DescribeAppResponse] #
Show DescribeAppResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeApp Methods showsPrec :: Int -> DescribeAppResponse -> ShowS # show :: DescribeAppResponse -> String # showList :: [DescribeAppResponse] -> ShowS #
NFData DescribeAppResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeApp Methods rnf :: DescribeAppResponse -> () #
Eq DescribeAppResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeApp Methods (==) :: DescribeAppResponse -> DescribeAppResponse -> Bool # (/=) :: DescribeAppResponse -> DescribeAppResponse -> Bool #
type Rep DescribeAppResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeApp type Rep DescribeAppResponse = D1 ('MetaData "DescribeAppResponse" "Amazonka.SageMaker.DescribeApp" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeAppResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "appType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppType)))) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastHealthCheckTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "lastUserActivityTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "resourceSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceSpec)))) :: ((S1 ('MetaSel ('Just "spaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppStatus))) :: (S1 ('MetaSel ('Just "userProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeAppResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAppResponse'`
-> DescribeAppResponse

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

$sel:appArn:DescribeAppResponse', describeAppResponse_appArn - The Amazon Resource Name (ARN) of the app.

DescribeApp, describeAppResponse_appName - The name of the app.

DescribeApp, describeAppResponse_appType - The type of app.

DescribeAppResponse, describeAppResponse_creationTime - The creation time.

DescribeApp, describeAppResponse_domainId - The domain ID.

DescribeAppResponse, describeAppResponse_failureReason - The failure reason.

$sel:lastHealthCheckTimestamp:DescribeAppResponse', describeAppResponse_lastHealthCheckTimestamp - The timestamp of the last health check.

$sel:lastUserActivityTimestamp:DescribeAppResponse', describeAppResponse_lastUserActivityTimestamp - The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

$sel:resourceSpec:DescribeAppResponse', describeAppResponse_resourceSpec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

DescribeApp, describeAppResponse_spaceName - The name of the space. If this value is not set, then UserProfileName must be set.

DescribeAppResponse, describeAppResponse_status - The status.

DescribeApp, describeAppResponse_userProfileName - The user profile name.

$sel:httpStatus:DescribeAppResponse', describeAppResponse_httpStatus - The response's http status code.

Response Lenses

describeAppResponse_appArn :: Lens' DescribeAppResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the app.

describeAppResponse_appName :: Lens' DescribeAppResponse (Maybe Text) Source #

The name of the app.

describeAppResponse_appType :: Lens' DescribeAppResponse (Maybe AppType) Source #

The type of app.

describeAppResponse_creationTime :: Lens' DescribeAppResponse (Maybe UTCTime) Source #

The creation time.

describeAppResponse_domainId :: Lens' DescribeAppResponse (Maybe Text) Source #

The domain ID.

describeAppResponse_failureReason :: Lens' DescribeAppResponse (Maybe Text) Source #

The failure reason.

describeAppResponse_lastHealthCheckTimestamp :: Lens' DescribeAppResponse (Maybe UTCTime) Source #

The timestamp of the last health check.

describeAppResponse_lastUserActivityTimestamp :: Lens' DescribeAppResponse (Maybe UTCTime) Source #

The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

describeAppResponse_resourceSpec :: Lens' DescribeAppResponse (Maybe ResourceSpec) Source #

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

describeAppResponse_spaceName :: Lens' DescribeAppResponse (Maybe Text) Source #

The name of the space. If this value is not set, then UserProfileName must be set.

describeAppResponse_status :: Lens' DescribeAppResponse (Maybe AppStatus) Source #

The status.

describeAppResponse_userProfileName :: Lens' DescribeAppResponse (Maybe Text) Source #

The user profile name.

describeAppResponse_httpStatus :: Lens' DescribeAppResponse Int Source #

The response's http status code.