Amazonka.CloudTrail.ListTrails

Lists trails that are in the current account.

This operation returns paginated results.

Creating a Request

data ListTrails

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

ToJSON ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

toJSON :: ListTrails -> Value

toEncoding :: ListTrails -> Encoding

toJSONList :: [ListTrails] -> Value

toEncodingList :: [ListTrails] -> Encoding

ToHeaders ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

toHeaders :: ListTrails -> [Header]

ToPath ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

toPath :: ListTrails -> ByteString

ToQuery ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

toQuery :: ListTrails -> QueryString

AWSPager ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

page :: ListTrails -> AWSResponse ListTrails -> Maybe ListTrails

AWSRequest ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Associated Types

type AWSResponse ListTrails

Methods

request :: (Service -> Service) -> ListTrails -> Request ListTrails

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTrails -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTrails)))

Generic ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Associated Types

type Rep ListTrails :: Type -> Type

Methods

from :: ListTrails -> Rep ListTrails x

to :: Rep ListTrails x -> ListTrails

Read ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

readsPrec :: Int -> ReadS ListTrails

readList :: ReadS [ListTrails]

readPrec :: ReadPrec ListTrails

readListPrec :: ReadPrec [ListTrails]

Show ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

showsPrec :: Int -> ListTrails -> ShowS

show :: ListTrails -> String

showList :: [ListTrails] -> ShowS

NFData ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

rnf :: ListTrails -> ()

Eq ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

(==) :: ListTrails -> ListTrails -> Bool

(/=) :: ListTrails -> ListTrails -> Bool

Hashable ListTrails

Defined in Amazonka.CloudTrail.ListTrails

Methods

hashWithSalt :: Int -> ListTrails -> Int

hash :: ListTrails -> Int

type AWSResponse ListTrails

Defined in Amazonka.CloudTrail.ListTrails

type AWSResponse ListTrails = ListTrailsResponse

type Rep ListTrails

Defined in Amazonka.CloudTrail.ListTrails

type Rep ListTrails = D1 ('MetaData "ListTrails" "Amazonka.CloudTrail.ListTrails" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListTrails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListTrails :: ListTrails

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:

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 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)

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

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

Generic ListTrailsResponse

Defined in Amazonka.CloudTrail.ListTrails

Associated Types

type Rep ListTrailsResponse :: Type -> Type

Methods

from :: ListTrailsResponse -> Rep ListTrailsResponse x

to :: Rep ListTrailsResponse x -> ListTrailsResponse

Read ListTrailsResponse

Defined in Amazonka.CloudTrail.ListTrails

Methods

readsPrec :: Int -> ReadS ListTrailsResponse

readList :: ReadS [ListTrailsResponse]

readPrec :: ReadPrec ListTrailsResponse

readListPrec :: ReadPrec [ListTrailsResponse]

Show ListTrailsResponse

Defined in Amazonka.CloudTrail.ListTrails

Methods

showsPrec :: Int -> ListTrailsResponse -> ShowS

show :: ListTrailsResponse -> String

showList :: [ListTrailsResponse] -> ShowS

NFData ListTrailsResponse

Defined in Amazonka.CloudTrail.ListTrails

Methods

rnf :: ListTrailsResponse -> ()

Eq ListTrailsResponse

Defined in Amazonka.CloudTrail.ListTrails

Methods

(==) :: ListTrailsResponse -> ListTrailsResponse -> Bool

(/=) :: ListTrailsResponse -> ListTrailsResponse -> Bool

type Rep ListTrailsResponse

Defined in Amazonka.CloudTrail.ListTrails

type Rep ListTrailsResponse = D1 ('MetaData "ListTrailsResponse" "Amazonka.CloudTrail.ListTrails" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" '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

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:

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)

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])

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

listTrailsResponse_httpStatus :: Lens' ListTrailsResponse Int

The response's http status code.