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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

Synopsis

data CreateContext = CreateContext' {
- description :: Maybe Text
- properties :: Maybe (HashMap Text Text)
- tags :: Maybe [Tag]
- contextName :: Text
- source :: ContextSource
- contextType :: Text
}
newCreateContext :: Text -> ContextSource -> Text -> CreateContext
createContext_description :: Lens' CreateContext (Maybe Text)
createContext_properties :: Lens' CreateContext (Maybe (HashMap Text Text))
createContext_tags :: Lens' CreateContext (Maybe [Tag])
createContext_contextName :: Lens' CreateContext Text
createContext_source :: Lens' CreateContext ContextSource
createContext_contextType :: Lens' CreateContext Text
data CreateContextResponse = CreateContextResponse' {
- contextArn :: Maybe Text
- httpStatus :: Int
}
newCreateContextResponse :: Int -> CreateContextResponse
createContextResponse_contextArn :: Lens' CreateContextResponse (Maybe Text)
createContextResponse_httpStatus :: Lens' CreateContextResponse Int

Creating a Request

data CreateContext Source #

See: newCreateContext smart constructor.

Constructors

CreateContext'

Fields

description :: Maybe Text
The description of the context.
properties :: Maybe (HashMap Text Text)
A list of properties to add to the context.
tags :: Maybe [Tag]
A list of tags to apply to the context.
contextName :: Text
The name of the context. Must be unique to your account in an Amazon Web Services Region.
source :: ContextSource
The source type, ID, and URI.
contextType :: Text
The context type.

Instances

Instances details

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

newCreateContext Source #

Arguments

:: Text	`CreateContext`
-> ContextSource	`CreateContext`
-> Text	`CreateContext`
-> CreateContext

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

CreateContext, createContext_description - The description of the context.

CreateContext, createContext_properties - A list of properties to add to the context.

CreateContext, createContext_tags - A list of tags to apply to the context.

CreateContext, createContext_contextName - The name of the context. Must be unique to your account in an Amazon Web Services Region.

CreateContext, createContext_source - The source type, ID, and URI.

CreateContext, createContext_contextType - The context type.

Request Lenses

createContext_description :: Lens' CreateContext (Maybe Text) Source #

The description of the context.

createContext_properties :: Lens' CreateContext (Maybe (HashMap Text Text)) Source #

A list of properties to add to the context.

createContext_tags :: Lens' CreateContext (Maybe [Tag]) Source #

A list of tags to apply to the context.

createContext_contextName :: Lens' CreateContext Text Source #

The name of the context. Must be unique to your account in an Amazon Web Services Region.

createContext_source :: Lens' CreateContext ContextSource Source #

The source type, ID, and URI.

createContext_contextType :: Lens' CreateContext Text Source #

The context type.

Destructuring the Response

data CreateContextResponse Source #

See: newCreateContextResponse smart constructor.

Constructors

CreateContextResponse'
Fields contextArn :: Maybe Text The Amazon Resource Name (ARN) of the context. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateContextResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateContext Associated Types type Rep CreateContextResponse :: Type -> Type # Methods from :: CreateContextResponse -> Rep CreateContextResponse x # to :: Rep CreateContextResponse x -> CreateContextResponse #
Read CreateContextResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateContext Methods readsPrec :: Int -> ReadS CreateContextResponse # readList :: ReadS [CreateContextResponse] # readPrec :: ReadPrec CreateContextResponse # readListPrec :: ReadPrec [CreateContextResponse] #
Show CreateContextResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateContext Methods showsPrec :: Int -> CreateContextResponse -> ShowS # show :: CreateContextResponse -> String # showList :: [CreateContextResponse] -> ShowS #
NFData CreateContextResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateContext Methods rnf :: CreateContextResponse -> () #
Eq CreateContextResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateContext Methods (==) :: CreateContextResponse -> CreateContextResponse -> Bool # (/=) :: CreateContextResponse -> CreateContextResponse -> Bool #
type Rep CreateContextResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateContext type Rep CreateContextResponse = D1 ('MetaData "CreateContextResponse" "Amazonka.SageMaker.CreateContext" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateContextResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contextArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateContextResponse Source #

Arguments

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

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

CreateContextResponse, createContextResponse_contextArn - The Amazon Resource Name (ARN) of the context.

$sel:httpStatus:CreateContextResponse', createContextResponse_httpStatus - The response's http status code.

Response Lenses

createContextResponse_contextArn :: Lens' CreateContextResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the context.

createContextResponse_httpStatus :: Lens' CreateContextResponse Int Source #

The response's http status code.