Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudTrail.GetChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specific channel. Amazon Web Services services create service-linked channels to 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.

Creating a Request

data GetChannel Source #

See: newGetChannel smart constructor.

Constructors

GetChannel'
Fields channel :: Text The ARN or `UUID` of a channel.

Instances

Instances details

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

newGetChannel Source #

Arguments

:: Text	`$sel:channel:GetChannel'`
-> GetChannel

Create a value of GetChannel 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:channel:GetChannel', getChannel_channel - The ARN or UUID of a channel.

Request Lenses

getChannel_channel :: Lens' GetChannel Text Source #

The ARN or UUID of a channel.

Destructuring the Response

data GetChannelResponse Source #

See: newGetChannelResponse smart constructor.

Constructors

GetChannelResponse'

Fields

channelArn :: Maybe Text
The ARN of an channel returned by a GetChannel request.
destinations :: Maybe (NonEmpty Destination)
The Amazon Web Services service that created the service-linked channel.
name :: Maybe Text
The name of the CloudTrail channel. For service-linked channels, the value is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.
source :: Maybe Text
The event source for the CloudTrail channel.
sourceConfig :: Maybe SourceConfig
Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all regions or a single region.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetChannelResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetChannel Associated Types type Rep GetChannelResponse :: Type -> Type # Methods from :: GetChannelResponse -> Rep GetChannelResponse x # to :: Rep GetChannelResponse x -> GetChannelResponse #
Read GetChannelResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetChannel Methods readsPrec :: Int -> ReadS GetChannelResponse # readList :: ReadS [GetChannelResponse] # readPrec :: ReadPrec GetChannelResponse # readListPrec :: ReadPrec [GetChannelResponse] #
Show GetChannelResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetChannel Methods showsPrec :: Int -> GetChannelResponse -> ShowS # show :: GetChannelResponse -> String # showList :: [GetChannelResponse] -> ShowS #
NFData GetChannelResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetChannel Methods rnf :: GetChannelResponse -> () #
Eq GetChannelResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetChannel Methods (==) :: GetChannelResponse -> GetChannelResponse -> Bool # (/=) :: GetChannelResponse -> GetChannelResponse -> Bool #
type Rep GetChannelResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetChannel type Rep GetChannelResponse = D1 ('MetaData "GetChannelResponse" "Amazonka.CloudTrail.GetChannel" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "GetChannelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Destination))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sourceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceConfig)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetChannelResponse Source #

Arguments

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

Create a value of GetChannelResponse 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:

GetChannelResponse, getChannelResponse_channelArn - The ARN of an channel returned by a GetChannel request.

GetChannelResponse, getChannelResponse_destinations - The Amazon Web Services service that created the service-linked channel.

GetChannelResponse, getChannelResponse_name - The name of the CloudTrail channel. For service-linked channels, the value is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.

$sel:source:GetChannelResponse', getChannelResponse_source - The event source for the CloudTrail channel.

$sel:sourceConfig:GetChannelResponse', getChannelResponse_sourceConfig - Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all regions or a single region.

$sel:httpStatus:GetChannelResponse', getChannelResponse_httpStatus - The response's http status code.

Response Lenses

getChannelResponse_channelArn :: Lens' GetChannelResponse (Maybe Text) Source #

The ARN of an channel returned by a GetChannel request.

getChannelResponse_destinations :: Lens' GetChannelResponse (Maybe (NonEmpty Destination)) Source #

The Amazon Web Services service that created the service-linked channel.

getChannelResponse_name :: Lens' GetChannelResponse (Maybe Text) Source #

The name of the CloudTrail channel. For service-linked channels, the value is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.

getChannelResponse_source :: Lens' GetChannelResponse (Maybe Text) Source #

The event source for the CloudTrail channel.

getChannelResponse_sourceConfig :: Lens' GetChannelResponse (Maybe SourceConfig) Source #

Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all regions or a single region.

getChannelResponse_httpStatus :: Lens' GetChannelResponse Int Source #

The response's http status code.