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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

Synopsis

data CreateArtifact = CreateArtifact' {
- artifactName :: Maybe Text
- metadataProperties :: Maybe MetadataProperties
- properties :: Maybe (HashMap Text Text)
- tags :: Maybe [Tag]
- source :: ArtifactSource
- artifactType :: Text
}
newCreateArtifact :: ArtifactSource -> Text -> CreateArtifact
createArtifact_artifactName :: Lens' CreateArtifact (Maybe Text)
createArtifact_metadataProperties :: Lens' CreateArtifact (Maybe MetadataProperties)
createArtifact_properties :: Lens' CreateArtifact (Maybe (HashMap Text Text))
createArtifact_tags :: Lens' CreateArtifact (Maybe [Tag])
createArtifact_source :: Lens' CreateArtifact ArtifactSource
createArtifact_artifactType :: Lens' CreateArtifact Text
data CreateArtifactResponse = CreateArtifactResponse' {
- artifactArn :: Maybe Text
- httpStatus :: Int
}
newCreateArtifactResponse :: Int -> CreateArtifactResponse
createArtifactResponse_artifactArn :: Lens' CreateArtifactResponse (Maybe Text)
createArtifactResponse_httpStatus :: Lens' CreateArtifactResponse Int

Creating a Request

data CreateArtifact Source #

See: newCreateArtifact smart constructor.

Constructors

CreateArtifact'

Fields

artifactName :: Maybe Text
The name of the artifact. Must be unique to your account in an Amazon Web Services Region.
metadataProperties :: Maybe MetadataProperties
properties :: Maybe (HashMap Text Text)
A list of properties to add to the artifact.
tags :: Maybe [Tag]
A list of tags to apply to the artifact.
source :: ArtifactSource
The ID, ID type, and URI of the source.
artifactType :: Text
The artifact type.

Instances

Instances details

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

newCreateArtifact Source #

Arguments

:: ArtifactSource	`CreateArtifact`
-> Text	`CreateArtifact`
-> CreateArtifact

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

CreateArtifact, createArtifact_artifactName - The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

CreateArtifact, createArtifact_metadataProperties - Undocumented member.

CreateArtifact, createArtifact_properties - A list of properties to add to the artifact.

CreateArtifact, createArtifact_tags - A list of tags to apply to the artifact.

CreateArtifact, createArtifact_source - The ID, ID type, and URI of the source.

CreateArtifact, createArtifact_artifactType - The artifact type.

Request Lenses

createArtifact_artifactName :: Lens' CreateArtifact (Maybe Text) Source #

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

createArtifact_metadataProperties :: Lens' CreateArtifact (Maybe MetadataProperties) Source #

Undocumented member.

createArtifact_properties :: Lens' CreateArtifact (Maybe (HashMap Text Text)) Source #

A list of properties to add to the artifact.

createArtifact_tags :: Lens' CreateArtifact (Maybe [Tag]) Source #

A list of tags to apply to the artifact.

createArtifact_source :: Lens' CreateArtifact ArtifactSource Source #

The ID, ID type, and URI of the source.

createArtifact_artifactType :: Lens' CreateArtifact Text Source #

The artifact type.

Destructuring the Response

data CreateArtifactResponse Source #

See: newCreateArtifactResponse smart constructor.

Constructors

CreateArtifactResponse'
Fields artifactArn :: Maybe Text The Amazon Resource Name (ARN) of the artifact. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateArtifactResponse Source #

Arguments

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

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

CreateArtifactResponse, createArtifactResponse_artifactArn - The Amazon Resource Name (ARN) of the artifact.

$sel:httpStatus:CreateArtifactResponse', createArtifactResponse_httpStatus - The response's http status code.

Response Lenses

createArtifactResponse_artifactArn :: Lens' CreateArtifactResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the artifact.

createArtifactResponse_httpStatus :: Lens' CreateArtifactResponse Int Source #

The response's http status code.