amazonka-cloudtrail-2.0: Amazon CloudTrail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudTrail.ListChannels

Description

Lists the channels in the current account, and their source names. Amazon Web Services services create service-linked channels get information about CloudTrail events on your behalf. For more information about service-linked channels, see Viewing service-linked channels for CloudTrail by using the CLI.

Synopsis

Creating a Request

data ListChannels Source #

See: newListChannels smart constructor.

Constructors

ListChannels' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of CloudTrail channels to display on a single page.

  • 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

Instances details
ToJSON ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

ToHeaders ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

ToPath ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

ToQuery ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

AWSRequest ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Associated Types

type AWSResponse ListChannels #

Generic ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Associated Types

type Rep ListChannels :: Type -> Type #

Read ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Show ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

NFData ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Methods

rnf :: ListChannels -> () #

Eq ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Hashable ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

type AWSResponse ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

type Rep ListChannels Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

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

newListChannels :: ListChannels Source #

Create a value of ListChannels 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:maxResults:ListChannels', listChannels_maxResults - The maximum number of CloudTrail channels to display on a single page.

ListChannels, listChannels_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

listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #

The maximum number of CloudTrail channels to display on a single page.

listChannels_nextToken :: Lens' ListChannels (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 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 ListChannelsResponse Source #

See: newListChannelsResponse smart constructor.

Constructors

ListChannelsResponse' 

Fields

Instances

Instances details
Generic ListChannelsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Associated Types

type Rep ListChannelsResponse :: Type -> Type #

Read ListChannelsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Show ListChannelsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

NFData ListChannelsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

Methods

rnf :: ListChannelsResponse -> () #

Eq ListChannelsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

type Rep ListChannelsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListChannels

type Rep ListChannelsResponse = D1 ('MetaData "ListChannelsResponse" "Amazonka.CloudTrail.ListChannels" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListChannelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Channel])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListChannelsResponse Source #

Create a value of ListChannelsResponse 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:channels:ListChannelsResponse', listChannelsResponse_channels - The list of channels in the account.

ListChannels, listChannelsResponse_nextToken - The token to use to get the next page of results after a previous API call.

$sel:httpStatus:ListChannelsResponse', listChannelsResponse_httpStatus - The response's http status code.

Response Lenses

listChannelsResponse_channels :: Lens' ListChannelsResponse (Maybe [Channel]) Source #

The list of channels in the account.

listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #

The token to use to get the next page of results after a previous API call.