amazonka-cloudtrail-1.4.5: Amazon CloudTrail SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudTrail.DescribeTrails

Contents

Description

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

Synopsis

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 # 
Data 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 # 
Show DescribeTrails # 
Generic DescribeTrails # 

Associated Types

type Rep DescribeTrails :: * -> * #

Hashable DescribeTrails # 
ToJSON DescribeTrails # 
NFData DescribeTrails # 

Methods

rnf :: DescribeTrails -> () #

AWSRequest DescribeTrails # 
ToQuery DescribeTrails # 
ToPath DescribeTrails # 
ToHeaders DescribeTrails # 
type Rep DescribeTrails # 
type Rep DescribeTrails = D1 (MetaData "DescribeTrails" "Network.AWS.CloudTrail.DescribeTrails" "amazonka-cloudtrail-1.4.5-G6tTUvTzOJJEaWPMBOp3on" False) (C1 (MetaCons "DescribeTrails'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dtIncludeShadowTrails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_dtTrailNameList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))
type Rs DescribeTrails # 

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 #

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:

data DescribeTrailsResponse #

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

See: describeTrailsResponse smart constructor.

Instances

Eq DescribeTrailsResponse # 
Data DescribeTrailsResponse # 

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 # 
Show DescribeTrailsResponse # 
Generic DescribeTrailsResponse # 
NFData DescribeTrailsResponse # 

Methods

rnf :: DescribeTrailsResponse -> () #

type Rep DescribeTrailsResponse # 
type Rep DescribeTrailsResponse = D1 (MetaData "DescribeTrailsResponse" "Network.AWS.CloudTrail.DescribeTrails" "amazonka-cloudtrail-1.4.5-G6tTUvTzOJJEaWPMBOp3on" False) (C1 (MetaCons "DescribeTrailsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dtrsTrailList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Trail]))) (S1 (MetaSel (Just Symbol "_dtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

dtrsTrailList :: Lens' DescribeTrailsResponse [Trail] #

The list of trail objects.

dtrsResponseStatus :: Lens' DescribeTrailsResponse Int #

  • - | The response status code.