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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

Synopsis

data CreateAction = CreateAction' {
- description :: Maybe Text
- metadataProperties :: Maybe MetadataProperties
- properties :: Maybe (HashMap Text Text)
- status :: Maybe ActionStatus
- tags :: Maybe [Tag]
- actionName :: Text
- source :: ActionSource
- actionType :: Text
}
newCreateAction :: Text -> ActionSource -> Text -> CreateAction
createAction_description :: Lens' CreateAction (Maybe Text)
createAction_metadataProperties :: Lens' CreateAction (Maybe MetadataProperties)
createAction_properties :: Lens' CreateAction (Maybe (HashMap Text Text))
createAction_status :: Lens' CreateAction (Maybe ActionStatus)
createAction_tags :: Lens' CreateAction (Maybe [Tag])
createAction_actionName :: Lens' CreateAction Text
createAction_source :: Lens' CreateAction ActionSource
createAction_actionType :: Lens' CreateAction Text
data CreateActionResponse = CreateActionResponse' {
- actionArn :: Maybe Text
- httpStatus :: Int
}
newCreateActionResponse :: Int -> CreateActionResponse
createActionResponse_actionArn :: Lens' CreateActionResponse (Maybe Text)
createActionResponse_httpStatus :: Lens' CreateActionResponse Int

Creating a Request

data CreateAction Source #

See: newCreateAction smart constructor.

Constructors

CreateAction'

Fields

description :: Maybe Text
The description of the action.
metadataProperties :: Maybe MetadataProperties
properties :: Maybe (HashMap Text Text)
A list of properties to add to the action.
status :: Maybe ActionStatus
The status of the action.
tags :: Maybe [Tag]
A list of tags to apply to the action.
actionName :: Text
The name of the action. Must be unique to your account in an Amazon Web Services Region.
source :: ActionSource
The source type, ID, and URI.
actionType :: Text
The action type.

Instances

Instances details

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

newCreateAction Source #

Arguments

:: Text	`CreateAction`
-> ActionSource	`CreateAction`
-> Text	`CreateAction`
-> CreateAction

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

CreateAction, createAction_description - The description of the action.

CreateAction, createAction_metadataProperties - Undocumented member.

CreateAction, createAction_properties - A list of properties to add to the action.

CreateAction, createAction_status - The status of the action.

CreateAction, createAction_tags - A list of tags to apply to the action.

CreateAction, createAction_actionName - The name of the action. Must be unique to your account in an Amazon Web Services Region.

CreateAction, createAction_source - The source type, ID, and URI.

CreateAction, createAction_actionType - The action type.

Request Lenses

createAction_description :: Lens' CreateAction (Maybe Text) Source #

The description of the action.

createAction_metadataProperties :: Lens' CreateAction (Maybe MetadataProperties) Source #

Undocumented member.

createAction_properties :: Lens' CreateAction (Maybe (HashMap Text Text)) Source #

A list of properties to add to the action.

createAction_status :: Lens' CreateAction (Maybe ActionStatus) Source #

The status of the action.

createAction_tags :: Lens' CreateAction (Maybe [Tag]) Source #

A list of tags to apply to the action.

createAction_actionName :: Lens' CreateAction Text Source #

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

createAction_source :: Lens' CreateAction ActionSource Source #

The source type, ID, and URI.

createAction_actionType :: Lens' CreateAction Text Source #

The action type.

Destructuring the Response

data CreateActionResponse Source #

See: newCreateActionResponse smart constructor.

Constructors

CreateActionResponse'
Fields actionArn :: Maybe Text The Amazon Resource Name (ARN) of the action. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateActionResponse Source #

Arguments

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

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

CreateActionResponse, createActionResponse_actionArn - The Amazon Resource Name (ARN) of the action.

$sel:httpStatus:CreateActionResponse', createActionResponse_httpStatus - The response's http status code.

Response Lenses

createActionResponse_actionArn :: Lens' CreateActionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the action.

createActionResponse_httpStatus :: Lens' CreateActionResponse Int Source #

The response's http status code.