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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Synopsis

data StartLogging = StartLogging' {
- name :: Text
}
newStartLogging :: Text -> StartLogging
startLogging_name :: Lens' StartLogging Text
data StartLoggingResponse = StartLoggingResponse' {
- httpStatus :: Int
}
newStartLoggingResponse :: Int -> StartLoggingResponse
startLoggingResponse_httpStatus :: Lens' StartLoggingResponse Int

Creating a Request

data StartLogging Source #

The request to CloudTrail to start logging Amazon Web Services API calls for an account.

See: newStartLogging smart constructor.

Constructors

StartLogging'
Fields name :: Text Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Instances

Instances details

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

newStartLogging Source #

Arguments

:: Text	`$sel:name:StartLogging'`
-> StartLogging

Create a value of StartLogging 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:name:StartLogging', startLogging_name - Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Request Lenses

startLogging_name :: Lens' StartLogging Text Source #

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Destructuring the Response

data StartLoggingResponse Source #

Returns the objects or data listed below if successful. Otherwise, returns an error.

See: newStartLoggingResponse smart constructor.

Constructors

StartLoggingResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartLoggingResponse Source #

Arguments

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

Create a value of StartLoggingResponse 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:httpStatus:StartLoggingResponse', startLoggingResponse_httpStatus - The response's http status code.

Response Lenses

startLoggingResponse_httpStatus :: Lens' StartLoggingResponse Int Source #

The response's http status code.