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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves settings for the trail associated with the current region for your account.

Creating a Request

describeTrails :: DescribeTrails #

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

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

dtIncludeShadowTrails - Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region. The default is true.
dtTrailNameList - Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail If an empty list is specified, information for the trail in the current region is returned. * If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned. * If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.

data DescribeTrails #

Returns information about the trail.

See: describeTrails smart constructor.

Instances

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

Request Lenses

dtIncludeShadowTrails :: Lens' DescribeTrails (Maybe Bool) #

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region. The default is true.

dtTrailNameList :: Lens' DescribeTrails [Text] #

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail If an empty list is specified, information for the trail in the current region is returned. * If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned. * If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.

Destructuring the Response

describeTrailsResponse #

Arguments

:: Int	`dtrsResponseStatus`
-> DescribeTrailsResponse

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

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

dtrsTrailList - The list of trail objects.
dtrsResponseStatus - -- | The response status code.

data DescribeTrailsResponse #

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

See: describeTrailsResponse smart constructor.

Instances

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

Response Lenses

dtrsTrailList :: Lens' DescribeTrailsResponse [Trail] #

The list of trail objects.

dtrsResponseStatus :: Lens' DescribeTrailsResponse Int #

- | The response status code.