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 #

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 #

See: createActivity smart constructor.

Instances

Eq CreateActivity #
Methods (==) :: CreateActivity -> CreateActivity -> Bool # (/=) :: CreateActivity -> CreateActivity -> Bool #
Data CreateActivity #
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 #
Methods readsPrec :: Int -> ReadS CreateActivity # readList :: ReadS [CreateActivity] # readPrec :: ReadPrec CreateActivity # readListPrec :: ReadPrec [CreateActivity] #
Show CreateActivity #
Methods showsPrec :: Int -> CreateActivity -> ShowS # show :: CreateActivity -> String # showList :: [CreateActivity] -> ShowS #
Generic CreateActivity #
Associated Types type Rep CreateActivity :: * -> * # Methods from :: CreateActivity -> Rep CreateActivity x # to :: Rep CreateActivity x -> CreateActivity #
Hashable CreateActivity #
Methods hashWithSalt :: Int -> CreateActivity -> Int # hash :: CreateActivity -> Int #
ToJSON CreateActivity #
Methods toJSON :: CreateActivity -> Value # toEncoding :: CreateActivity -> Encoding # toJSONList :: [CreateActivity] -> Value # toEncodingList :: [CreateActivity] -> Encoding #
NFData CreateActivity #
Methods rnf :: CreateActivity -> () #
AWSRequest CreateActivity #
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 #
Methods toHeaders :: CreateActivity -> [Header] #
ToPath CreateActivity #
Methods toPath :: CreateActivity -> ByteString #
ToQuery CreateActivity #
Methods toQuery :: CreateActivity -> QueryString #
type Rep CreateActivity #
type Rep CreateActivity = D1 * (MetaData "CreateActivity" "Network.AWS.StepFunctions.CreateActivity" "amazonka-stepfunctions-1.6.0-4gWbMk0pA5yIMB3HeIXWOM" True) (C1 * (MetaCons "CreateActivity'" PrefixI True) (S1 * (MetaSel (Just Symbol "_caName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs CreateActivity #
type Rs CreateActivity = CreateActivityResponse

Request Lenses

caName :: Lens' CreateActivity Text #

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 #

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 #

See: createActivityResponse smart constructor.

Instances

Eq CreateActivityResponse #
Methods (==) :: CreateActivityResponse -> CreateActivityResponse -> Bool # (/=) :: CreateActivityResponse -> CreateActivityResponse -> Bool #
Data CreateActivityResponse #
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 #
Methods readsPrec :: Int -> ReadS CreateActivityResponse # readList :: ReadS [CreateActivityResponse] # readPrec :: ReadPrec CreateActivityResponse # readListPrec :: ReadPrec [CreateActivityResponse] #
Show CreateActivityResponse #
Methods showsPrec :: Int -> CreateActivityResponse -> ShowS # show :: CreateActivityResponse -> String # showList :: [CreateActivityResponse] -> ShowS #
Generic CreateActivityResponse #
Associated Types type Rep CreateActivityResponse :: * -> * # Methods from :: CreateActivityResponse -> Rep CreateActivityResponse x # to :: Rep CreateActivityResponse x -> CreateActivityResponse #
NFData CreateActivityResponse #
Methods rnf :: CreateActivityResponse -> () #
type Rep CreateActivityResponse #
type Rep CreateActivityResponse = D1 * (MetaData "CreateActivityResponse" "Network.AWS.StepFunctions.CreateActivity" "amazonka-stepfunctions-1.6.0-4gWbMk0pA5yIMB3HeIXWOM" 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 #

- | The response status code.

carsActivityARN :: Lens' CreateActivityResponse Text #

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

carsCreationDate :: Lens' CreateActivityResponse UTCTime #

The date the activity is created.