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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists trails that are in the current account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListTrails Source #

See: newListTrails smart constructor.

Constructors

ListTrails'
Fields nextToken :: Maybe Text The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Instances

Instances details

Eq ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods (==) :: ListTrails -> ListTrails -> Bool # (/=) :: ListTrails -> ListTrails -> Bool #
Read ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods readsPrec :: Int -> ReadS ListTrails # readList :: ReadS [ListTrails] # readPrec :: ReadPrec ListTrails # readListPrec :: ReadPrec [ListTrails] #
Show ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods showsPrec :: Int -> ListTrails -> ShowS # show :: ListTrails -> String # showList :: [ListTrails] -> ShowS #
Generic ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Associated Types type Rep ListTrails :: Type -> Type # Methods from :: ListTrails -> Rep ListTrails x # to :: Rep ListTrails x -> ListTrails #
NFData ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods rnf :: ListTrails -> () #
Hashable ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods hashWithSalt :: Int -> ListTrails -> Int # hash :: ListTrails -> Int #
ToJSON ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods toJSON :: ListTrails -> Value # toEncoding :: ListTrails -> Encoding # toJSONList :: [ListTrails] -> Value # toEncodingList :: [ListTrails] -> Encoding #
AWSPager ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods page :: ListTrails -> AWSResponse ListTrails -> Maybe ListTrails #
AWSRequest ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Associated Types type AWSResponse ListTrails # Methods request :: ListTrails -> Request ListTrails # response :: MonadResource m => Logger -> Service -> Proxy ListTrails -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTrails))) #
ToHeaders ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods toHeaders :: ListTrails -> [Header] #
ToPath ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods toPath :: ListTrails -> ByteString #
ToQuery ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods toQuery :: ListTrails -> QueryString #
type Rep ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails type Rep ListTrails = D1 ('MetaData "ListTrails" "Amazonka.CloudTrail.ListTrails" "libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail" 'False) (C1 ('MetaCons "ListTrails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse ListTrails Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails type AWSResponse ListTrails = ListTrailsResponse

newListTrails :: ListTrails Source #

Create a value of ListTrails 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:nextToken:ListTrails', listTrails_nextToken - The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Request Lenses

listTrails_nextToken :: Lens' ListTrails (Maybe Text) Source #

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Destructuring the Response

data ListTrailsResponse Source #

See: newListTrailsResponse smart constructor.

Constructors

ListTrailsResponse'

Fields

nextToken :: Maybe Text
The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
trails :: Maybe [TrailInfo]
Returns the name, ARN, and home region of trails in the current account.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListTrailsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods (==) :: ListTrailsResponse -> ListTrailsResponse -> Bool # (/=) :: ListTrailsResponse -> ListTrailsResponse -> Bool #
Read ListTrailsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods readsPrec :: Int -> ReadS ListTrailsResponse # readList :: ReadS [ListTrailsResponse] # readPrec :: ReadPrec ListTrailsResponse # readListPrec :: ReadPrec [ListTrailsResponse] #
Show ListTrailsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods showsPrec :: Int -> ListTrailsResponse -> ShowS # show :: ListTrailsResponse -> String # showList :: [ListTrailsResponse] -> ShowS #
Generic ListTrailsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Associated Types type Rep ListTrailsResponse :: Type -> Type # Methods from :: ListTrailsResponse -> Rep ListTrailsResponse x # to :: Rep ListTrailsResponse x -> ListTrailsResponse #
NFData ListTrailsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails Methods rnf :: ListTrailsResponse -> () #
type Rep ListTrailsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTrails type Rep ListTrailsResponse = D1 ('MetaData "ListTrailsResponse" "Amazonka.CloudTrail.ListTrails" "libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail" 'False) (C1 ('MetaCons "ListTrailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "trails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrailInfo])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTrailsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTrailsResponse'`
-> ListTrailsResponse

Create a value of ListTrailsResponse 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:nextToken:ListTrails', listTrailsResponse_nextToken - The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

$sel:trails:ListTrailsResponse', listTrailsResponse_trails - Returns the name, ARN, and home region of trails in the current account.

$sel:httpStatus:ListTrailsResponse', listTrailsResponse_httpStatus - The response's http status code.

Response Lenses

listTrailsResponse_nextToken :: Lens' ListTrailsResponse (Maybe Text) Source #

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

listTrailsResponse_trails :: Lens' ListTrailsResponse (Maybe [TrailInfo]) Source #

Returns the name, ARN, and home region of trails in the current account.

listTrailsResponse_httpStatus :: Lens' ListTrailsResponse Int Source #

The response's http status code.