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.DataBrew.SendProjectSessionAction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Performs a recipe step within an interactive DataBrew session that's currently open.

Synopsis

data SendProjectSessionAction = SendProjectSessionAction' {
- clientSessionId :: Maybe (Sensitive Text)
- preview :: Maybe Bool
- recipeStep :: Maybe RecipeStep
- stepIndex :: Maybe Natural
- viewFrame :: Maybe ViewFrame
- name :: Text
}
newSendProjectSessionAction :: Text -> SendProjectSessionAction
sendProjectSessionAction_clientSessionId :: Lens' SendProjectSessionAction (Maybe Text)
sendProjectSessionAction_preview :: Lens' SendProjectSessionAction (Maybe Bool)
sendProjectSessionAction_recipeStep :: Lens' SendProjectSessionAction (Maybe RecipeStep)
sendProjectSessionAction_stepIndex :: Lens' SendProjectSessionAction (Maybe Natural)
sendProjectSessionAction_viewFrame :: Lens' SendProjectSessionAction (Maybe ViewFrame)
sendProjectSessionAction_name :: Lens' SendProjectSessionAction Text
data SendProjectSessionActionResponse = SendProjectSessionActionResponse' {
- actionId :: Maybe Int
- result :: Maybe Text
- httpStatus :: Int
- name :: Text
}
newSendProjectSessionActionResponse :: Int -> Text -> SendProjectSessionActionResponse
sendProjectSessionActionResponse_actionId :: Lens' SendProjectSessionActionResponse (Maybe Int)
sendProjectSessionActionResponse_result :: Lens' SendProjectSessionActionResponse (Maybe Text)
sendProjectSessionActionResponse_httpStatus :: Lens' SendProjectSessionActionResponse Int
sendProjectSessionActionResponse_name :: Lens' SendProjectSessionActionResponse Text

Creating a Request

data SendProjectSessionAction Source #

See: newSendProjectSessionAction smart constructor.

Constructors

SendProjectSessionAction'

Fields

clientSessionId :: Maybe (Sensitive Text)
A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.
preview :: Maybe Bool
If true, the result of the recipe step will be returned, but not applied.
recipeStep :: Maybe RecipeStep
stepIndex :: Maybe Natural
The index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack.
viewFrame :: Maybe ViewFrame
name :: Text
The name of the project to apply the action to.

Instances

Instances details

ToJSON SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods toJSON :: SendProjectSessionAction -> Value # toEncoding :: SendProjectSessionAction -> Encoding # toJSONList :: [SendProjectSessionAction] -> Value # toEncodingList :: [SendProjectSessionAction] -> Encoding #
ToHeaders SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods toHeaders :: SendProjectSessionAction -> [Header] #
ToPath SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods toPath :: SendProjectSessionAction -> ByteString #
ToQuery SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods toQuery :: SendProjectSessionAction -> QueryString #
AWSRequest SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Associated Types type AWSResponse SendProjectSessionAction # Methods request :: (Service -> Service) -> SendProjectSessionAction -> Request SendProjectSessionAction # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendProjectSessionAction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendProjectSessionAction))) #
Generic SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Associated Types type Rep SendProjectSessionAction :: Type -> Type # Methods from :: SendProjectSessionAction -> Rep SendProjectSessionAction x # to :: Rep SendProjectSessionAction x -> SendProjectSessionAction #
Show SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods showsPrec :: Int -> SendProjectSessionAction -> ShowS # show :: SendProjectSessionAction -> String # showList :: [SendProjectSessionAction] -> ShowS #
NFData SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods rnf :: SendProjectSessionAction -> () #
Eq SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods (==) :: SendProjectSessionAction -> SendProjectSessionAction -> Bool # (/=) :: SendProjectSessionAction -> SendProjectSessionAction -> Bool #
Hashable SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction Methods hashWithSalt :: Int -> SendProjectSessionAction -> Int # hash :: SendProjectSessionAction -> Int #
type AWSResponse SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction type AWSResponse SendProjectSessionAction = SendProjectSessionActionResponse
type Rep SendProjectSessionAction Source #
Instance details Defined in Amazonka.DataBrew.SendProjectSessionAction type Rep SendProjectSessionAction = D1 ('MetaData "SendProjectSessionAction" "Amazonka.DataBrew.SendProjectSessionAction" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "SendProjectSessionAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "preview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "recipeStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecipeStep)))) :: (S1 ('MetaSel ('Just "stepIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "viewFrame") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ViewFrame)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSendProjectSessionAction Source #

Arguments

:: Text	`SendProjectSessionAction`
-> SendProjectSessionAction

Create a value of SendProjectSessionAction 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:clientSessionId:SendProjectSessionAction', sendProjectSessionAction_clientSessionId - A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.

$sel:preview:SendProjectSessionAction', sendProjectSessionAction_preview - If true, the result of the recipe step will be returned, but not applied.

$sel:recipeStep:SendProjectSessionAction', sendProjectSessionAction_recipeStep - Undocumented member.

$sel:stepIndex:SendProjectSessionAction', sendProjectSessionAction_stepIndex - The index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack.

$sel:viewFrame:SendProjectSessionAction', sendProjectSessionAction_viewFrame - Undocumented member.

SendProjectSessionAction, sendProjectSessionAction_name - The name of the project to apply the action to.

Request Lenses

sendProjectSessionAction_clientSessionId :: Lens' SendProjectSessionAction (Maybe Text) Source #

A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.

sendProjectSessionAction_preview :: Lens' SendProjectSessionAction (Maybe Bool) Source #

If true, the result of the recipe step will be returned, but not applied.

sendProjectSessionAction_recipeStep :: Lens' SendProjectSessionAction (Maybe RecipeStep) Source #

Undocumented member.

sendProjectSessionAction_stepIndex :: Lens' SendProjectSessionAction (Maybe Natural) Source #

The index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack.

sendProjectSessionAction_viewFrame :: Lens' SendProjectSessionAction (Maybe ViewFrame) Source #

Undocumented member.

sendProjectSessionAction_name :: Lens' SendProjectSessionAction Text Source #

The name of the project to apply the action to.

Destructuring the Response

data SendProjectSessionActionResponse Source #

See: newSendProjectSessionActionResponse smart constructor.

Constructors

SendProjectSessionActionResponse'
Fields actionId :: Maybe Int A unique identifier for the action that was performed. result :: Maybe Text A message indicating the result of performing the action. httpStatus :: Int The response's http status code. name :: Text The name of the project that was affected by the action.

Instances

Instances details

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

newSendProjectSessionActionResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendProjectSessionActionResponse'`
-> Text	`SendProjectSessionAction`
-> SendProjectSessionActionResponse

Create a value of SendProjectSessionActionResponse 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:actionId:SendProjectSessionActionResponse', sendProjectSessionActionResponse_actionId - A unique identifier for the action that was performed.

$sel:result:SendProjectSessionActionResponse', sendProjectSessionActionResponse_result - A message indicating the result of performing the action.

$sel:httpStatus:SendProjectSessionActionResponse', sendProjectSessionActionResponse_httpStatus - The response's http status code.

SendProjectSessionAction, sendProjectSessionActionResponse_name - The name of the project that was affected by the action.

Response Lenses

sendProjectSessionActionResponse_actionId :: Lens' SendProjectSessionActionResponse (Maybe Int) Source #

A unique identifier for the action that was performed.

sendProjectSessionActionResponse_result :: Lens' SendProjectSessionActionResponse (Maybe Text) Source #

A message indicating the result of performing the action.

sendProjectSessionActionResponse_httpStatus :: Lens' SendProjectSessionActionResponse Int Source #

The response's http status code.

sendProjectSessionActionResponse_name :: Lens' SendProjectSessionActionResponse Text Source #

The name of the project that was affected by the action.