| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CloudTrail.DescribeTrails
Description
Retrieves settings for the trail associated with the current region for your account.
See: AWS API Reference for DescribeTrails.
- describeTrails :: DescribeTrails
- data DescribeTrails
- dtIncludeShadowTrails :: Lens' DescribeTrails (Maybe Bool)
- dtTrailNameList :: Lens' DescribeTrails [Text]
- describeTrailsResponse :: Int -> DescribeTrailsResponse
- data DescribeTrailsResponse
- dtrsTrailList :: Lens' DescribeTrailsResponse [Trail]
- dtrsResponseStatus :: Lens' DescribeTrailsResponse Int
Creating a Request
describeTrails :: DescribeTrails Source
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:
data DescribeTrails Source
Returns information about the trail.
See: describeTrails smart constructor.
Instances
Request Lenses
dtIncludeShadowTrails :: Lens' DescribeTrails (Maybe Bool) Source
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] Source
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
IncludeShadowTrailsis 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.
If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.
Destructuring the Response
Arguments
| :: Int | |
| -> 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 Source
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: describeTrailsResponse smart constructor.
Response Lenses
dtrsTrailList :: Lens' DescribeTrailsResponse [Trail] Source
The list of trail objects.
dtrsResponseStatus :: Lens' DescribeTrailsResponse Int Source
The response status code.