Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.StepFunctions.CreateActivity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an activity. An activity is a task which you write in any programming language and host on any machine which has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

Creating a Request

createActivity Source #

Arguments

:: Text	`caName`
-> CreateActivity

Creates a value of CreateActivity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

caName - The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide . A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )

data CreateActivity Source #

See: createActivity smart constructor.

Instances

Eq CreateActivity Source #
Methods (==) :: CreateActivity -> CreateActivity -> Bool # (/=) :: CreateActivity -> CreateActivity -> Bool #
Data CreateActivity Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateActivity -> c CreateActivity # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateActivity # toConstr :: CreateActivity -> Constr # dataTypeOf :: CreateActivity -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CreateActivity) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateActivity) # gmapT :: (forall b. Data b => b -> b) -> CreateActivity -> CreateActivity # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateActivity -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateActivity -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateActivity -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateActivity -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateActivity -> m CreateActivity # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateActivity -> m CreateActivity # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateActivity -> m CreateActivity #
Read CreateActivity Source #
Methods readsPrec :: Int -> ReadS CreateActivity # readList :: ReadS [CreateActivity] # readPrec :: ReadPrec CreateActivity # readListPrec :: ReadPrec [CreateActivity] #
Show CreateActivity Source #
Methods showsPrec :: Int -> CreateActivity -> ShowS # show :: CreateActivity -> String # showList :: [CreateActivity] -> ShowS #
Generic CreateActivity Source #
Associated Types type Rep CreateActivity :: * -> * # Methods from :: CreateActivity -> Rep CreateActivity x # to :: Rep CreateActivity x -> CreateActivity #
Hashable CreateActivity Source #
Methods hashWithSalt :: Int -> CreateActivity -> Int # hash :: CreateActivity -> Int #
ToJSON CreateActivity Source #
Methods toJSON :: CreateActivity -> Value # toEncoding :: CreateActivity -> Encoding # toJSONList :: [CreateActivity] -> Value # toEncodingList :: [CreateActivity] -> Encoding #
NFData CreateActivity Source #
Methods rnf :: CreateActivity -> () #
AWSRequest CreateActivity Source #
Associated Types type Rs CreateActivity :: * # Methods request :: CreateActivity -> Request CreateActivity # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateActivity -> ClientResponse -> m (Response CreateActivity) #
ToHeaders CreateActivity Source #
Methods toHeaders :: CreateActivity -> [Header] #
ToPath CreateActivity Source #
Methods toPath :: CreateActivity -> ByteString #
ToQuery CreateActivity Source #
Methods toQuery :: CreateActivity -> QueryString #
type Rep CreateActivity Source #
type Rep CreateActivity = D1 * (MetaData "CreateActivity" "Network.AWS.StepFunctions.CreateActivity" "amazonka-stepfunctions-1.6.0-9oIncLN4t9xDN3HGh7dGqV" True) (C1 * (MetaCons "CreateActivity'" PrefixI True) (S1 * (MetaSel (Just Symbol "_caName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs CreateActivity Source #
type Rs CreateActivity = CreateActivityResponse

Request Lenses

caName :: Lens' CreateActivity Text Source #

The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide . A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )

Destructuring the Response

createActivityResponse Source #

Arguments

:: Int	`carsResponseStatus`
-> Text	`carsActivityARN`
-> UTCTime	`carsCreationDate`
-> CreateActivityResponse

Creates a value of CreateActivityResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

carsResponseStatus - -- | The response status code.
carsActivityARN - The Amazon Resource Name (ARN) that identifies the created activity.
carsCreationDate - The date the activity is created.

data CreateActivityResponse Source #

See: createActivityResponse smart constructor.

Instances

Eq CreateActivityResponse Source #
Methods (==) :: CreateActivityResponse -> CreateActivityResponse -> Bool # (/=) :: CreateActivityResponse -> CreateActivityResponse -> Bool #
Data CreateActivityResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateActivityResponse -> c CreateActivityResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateActivityResponse # toConstr :: CreateActivityResponse -> Constr # dataTypeOf :: CreateActivityResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CreateActivityResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateActivityResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateActivityResponse -> CreateActivityResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateActivityResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateActivityResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateActivityResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateActivityResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateActivityResponse -> m CreateActivityResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateActivityResponse -> m CreateActivityResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateActivityResponse -> m CreateActivityResponse #
Read CreateActivityResponse Source #
Methods readsPrec :: Int -> ReadS CreateActivityResponse # readList :: ReadS [CreateActivityResponse] # readPrec :: ReadPrec CreateActivityResponse # readListPrec :: ReadPrec [CreateActivityResponse] #
Show CreateActivityResponse Source #
Methods showsPrec :: Int -> CreateActivityResponse -> ShowS # show :: CreateActivityResponse -> String # showList :: [CreateActivityResponse] -> ShowS #
Generic CreateActivityResponse Source #
Associated Types type Rep CreateActivityResponse :: * -> * # Methods from :: CreateActivityResponse -> Rep CreateActivityResponse x # to :: Rep CreateActivityResponse x -> CreateActivityResponse #
NFData CreateActivityResponse Source #
Methods rnf :: CreateActivityResponse -> () #
type Rep CreateActivityResponse Source #
type Rep CreateActivityResponse = D1 * (MetaData "CreateActivityResponse" "Network.AWS.StepFunctions.CreateActivity" "amazonka-stepfunctions-1.6.0-9oIncLN4t9xDN3HGh7dGqV" False) (C1 * (MetaCons "CreateActivityResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_carsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) ((::) (S1 * (MetaSel (Just Symbol "_carsActivityARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_carsCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * POSIX)))))

Response Lenses

carsResponseStatus :: Lens' CreateActivityResponse Int Source #

- | The response status code.

carsActivityARN :: Lens' CreateActivityResponse Text Source #

The Amazon Resource Name (ARN) that identifies the created activity.

carsCreationDate :: Lens' CreateActivityResponse UTCTime Source #

The date the activity is created.