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.CloudTrail.StartLogging

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Synopsis

startLogging :: Text -> StartLogging
data StartLogging
sName :: Lens' StartLogging Text
startLoggingResponse :: Int -> StartLoggingResponse
data StartLoggingResponse
srsResponseStatus :: Lens' StartLoggingResponse Int

Creating a Request

startLogging #

Arguments

:: Text	`sName`
-> StartLogging

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

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

sName - Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

data StartLogging #

The request to CloudTrail to start logging AWS API calls for an account.

See: startLogging smart constructor.

Instances

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

Request Lenses

sName :: Lens' StartLogging Text #

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Destructuring the Response

startLoggingResponse #

Arguments

:: Int	`srsResponseStatus`
-> StartLoggingResponse

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

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

srsResponseStatus - -- | The response status code.

data StartLoggingResponse #

Returns the objects or data listed below if successful. Otherwise, returns an error.

See: startLoggingResponse smart constructor.

Instances

Eq StartLoggingResponse #
Instance details Defined in Network.AWS.CloudTrail.StartLogging Methods (==) :: StartLoggingResponse -> StartLoggingResponse -> Bool # (/=) :: StartLoggingResponse -> StartLoggingResponse -> Bool #
Data StartLoggingResponse #
Instance details Defined in Network.AWS.CloudTrail.StartLogging Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartLoggingResponse -> c StartLoggingResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartLoggingResponse # toConstr :: StartLoggingResponse -> Constr # dataTypeOf :: StartLoggingResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartLoggingResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartLoggingResponse) # gmapT :: (forall b. Data b => b -> b) -> StartLoggingResponse -> StartLoggingResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartLoggingResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartLoggingResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> StartLoggingResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartLoggingResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartLoggingResponse -> m StartLoggingResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartLoggingResponse -> m StartLoggingResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartLoggingResponse -> m StartLoggingResponse #
Read StartLoggingResponse #
Instance details Defined in Network.AWS.CloudTrail.StartLogging Methods readsPrec :: Int -> ReadS StartLoggingResponse # readList :: ReadS [StartLoggingResponse] # readPrec :: ReadPrec StartLoggingResponse # readListPrec :: ReadPrec [StartLoggingResponse] #
Show StartLoggingResponse #
Instance details Defined in Network.AWS.CloudTrail.StartLogging Methods showsPrec :: Int -> StartLoggingResponse -> ShowS # show :: StartLoggingResponse -> String # showList :: [StartLoggingResponse] -> ShowS #
Generic StartLoggingResponse #
Instance details Defined in Network.AWS.CloudTrail.StartLogging Associated Types type Rep StartLoggingResponse :: * -> * # Methods from :: StartLoggingResponse -> Rep StartLoggingResponse x # to :: Rep StartLoggingResponse x -> StartLoggingResponse #
NFData StartLoggingResponse #
Instance details Defined in Network.AWS.CloudTrail.StartLogging Methods rnf :: StartLoggingResponse -> () #
type Rep StartLoggingResponse #
Instance details Defined in Network.AWS.CloudTrail.StartLogging type Rep StartLoggingResponse = D1 (MetaData "StartLoggingResponse" "Network.AWS.CloudTrail.StartLogging" "amazonka-cloudtrail-1.6.0-DUpPQNLzTaD9qmm6mzqnGe" True) (C1 (MetaCons "StartLoggingResponse'" PrefixI True) (S1 (MetaSel (Just "_srsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

srsResponseStatus :: Lens' StartLoggingResponse Int #

- | The response status code.