| Copyright | (c) 2013-2021 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 |
Amazonka.CloudTrail.DescribeTrails
Description
Retrieves settings for one or more trails associated with the current region for your account.
Synopsis
- data DescribeTrails = DescribeTrails' {}
- newDescribeTrails :: DescribeTrails
- describeTrails_includeShadowTrails :: Lens' DescribeTrails (Maybe Bool)
- describeTrails_trailNameList :: Lens' DescribeTrails (Maybe [Text])
- data DescribeTrailsResponse = DescribeTrailsResponse' {
- trailList :: Maybe [Trail]
- httpStatus :: Int
- newDescribeTrailsResponse :: Int -> DescribeTrailsResponse
- describeTrailsResponse_trailList :: Lens' DescribeTrailsResponse (Maybe [Trail])
- describeTrailsResponse_httpStatus :: Lens' DescribeTrailsResponse Int
Creating a Request
data DescribeTrails Source #
Returns information about the trail.
See: newDescribeTrails smart constructor.
Constructors
| DescribeTrails' | |
Fields
| |
Instances
newDescribeTrails :: DescribeTrails Source #
Create a value of DescribeTrails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeShadowTrails:DescribeTrails', describeTrails_includeShadowTrails - 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, or in the case of an organization trail, the
replication of an organization trail in member accounts. If you do not
include shadow trails, organization trails in a member account and
region replication trails will not be returned. The default is true.
$sel:trailNameList:DescribeTrails', describeTrails_trailNameList - 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-2: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.
Request Lenses
describeTrails_includeShadowTrails :: 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, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.
describeTrails_trailNameList :: Lens' DescribeTrails (Maybe [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-2: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
data DescribeTrailsResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newDescribeTrailsResponse smart constructor.
Constructors
| DescribeTrailsResponse' | |
Fields
| |
Instances
newDescribeTrailsResponse Source #
Create a value of DescribeTrailsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trailList:DescribeTrailsResponse', describeTrailsResponse_trailList - The list of trail objects. Trail objects with string values are only
returned if values for the objects exist in a trail's configuration.
For example, SNSTopicName and SNSTopicARN are only returned in
results if a trail is configured to send SNS notifications. Similarly,
KMSKeyId only appears in results if a trail's log files are encrypted
with KMS customer managed keys.
$sel:httpStatus:DescribeTrailsResponse', describeTrailsResponse_httpStatus - The response's http status code.
Response Lenses
describeTrailsResponse_trailList :: Lens' DescribeTrailsResponse (Maybe [Trail]) Source #
The list of trail objects. Trail objects with string values are only
returned if values for the objects exist in a trail's configuration.
For example, SNSTopicName and SNSTopicARN are only returned in
results if a trail is configured to send SNS notifications. Similarly,
KMSKeyId only appears in results if a trail's log files are encrypted
with KMS customer managed keys.
describeTrailsResponse_httpStatus :: Lens' DescribeTrailsResponse Int Source #
The response's http status code.