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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

Synopsis

data StopLogging = StopLogging' {
- name :: Text
}
newStopLogging :: Text -> StopLogging
stopLogging_name :: Lens' StopLogging Text
data StopLoggingResponse = StopLoggingResponse' {
- httpStatus :: Int
}
newStopLoggingResponse :: Int -> StopLoggingResponse
stopLoggingResponse_httpStatus :: Lens' StopLoggingResponse Int

Creating a Request

data StopLogging Source #

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.

See: newStopLogging smart constructor.

Constructors

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

newStopLogging Source #

Arguments

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

Create a value of StopLogging 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:StopLogging', stopLogging_name - Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging 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

stopLogging_name :: Lens' StopLogging Text Source #

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging 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 StopLoggingResponse Source #

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

See: newStopLoggingResponse smart constructor.

Constructors

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

Instances

Instances details

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

newStopLoggingResponse Source #

Arguments

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

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

Response Lenses

stopLoggingResponse_httpStatus :: Lens' StopLoggingResponse Int Source #

The response's http status code.