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.Chime.PutRetentionSettings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Synopsis

Creating a Request

data PutRetentionSettings Source #

See: newPutRetentionSettings smart constructor.

Constructors

PutRetentionSettings'
Fields accountId :: Text The Amazon Chime account ID. retentionSettings :: RetentionSettings The retention settings.

Instances

Instances details

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

newPutRetentionSettings Source #

Arguments

:: Text	`PutRetentionSettings`
-> RetentionSettings	`PutRetentionSettings`
-> PutRetentionSettings

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

PutRetentionSettings, putRetentionSettings_accountId - The Amazon Chime account ID.

PutRetentionSettings, putRetentionSettings_retentionSettings - The retention settings.

Request Lenses

putRetentionSettings_accountId :: Lens' PutRetentionSettings Text Source #

The Amazon Chime account ID.

putRetentionSettings_retentionSettings :: Lens' PutRetentionSettings RetentionSettings Source #

The retention settings.

Destructuring the Response

data PutRetentionSettingsResponse Source #

See: newPutRetentionSettingsResponse smart constructor.

Constructors

PutRetentionSettingsResponse'
Fields initiateDeletionTimestamp :: Maybe ISO8601 The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format. retentionSettings :: Maybe RetentionSettings The retention settings. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutRetentionSettingsResponse Source #
Instance details Defined in Amazonka.Chime.PutRetentionSettings Associated Types type Rep PutRetentionSettingsResponse :: Type -> Type # Methods from :: PutRetentionSettingsResponse -> Rep PutRetentionSettingsResponse x # to :: Rep PutRetentionSettingsResponse x -> PutRetentionSettingsResponse #
Read PutRetentionSettingsResponse Source #
Instance details Defined in Amazonka.Chime.PutRetentionSettings Methods readsPrec :: Int -> ReadS PutRetentionSettingsResponse # readList :: ReadS [PutRetentionSettingsResponse] # readPrec :: ReadPrec PutRetentionSettingsResponse # readListPrec :: ReadPrec [PutRetentionSettingsResponse] #
Show PutRetentionSettingsResponse Source #
Instance details Defined in Amazonka.Chime.PutRetentionSettings Methods showsPrec :: Int -> PutRetentionSettingsResponse -> ShowS # show :: PutRetentionSettingsResponse -> String # showList :: [PutRetentionSettingsResponse] -> ShowS #
NFData PutRetentionSettingsResponse Source #
Instance details Defined in Amazonka.Chime.PutRetentionSettings Methods rnf :: PutRetentionSettingsResponse -> () #
Eq PutRetentionSettingsResponse Source #
Instance details Defined in Amazonka.Chime.PutRetentionSettings Methods (==) :: PutRetentionSettingsResponse -> PutRetentionSettingsResponse -> Bool # (/=) :: PutRetentionSettingsResponse -> PutRetentionSettingsResponse -> Bool #
type Rep PutRetentionSettingsResponse Source #
Instance details Defined in Amazonka.Chime.PutRetentionSettings type Rep PutRetentionSettingsResponse = D1 ('MetaData "PutRetentionSettingsResponse" "Amazonka.Chime.PutRetentionSettings" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "PutRetentionSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "initiateDeletionTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "retentionSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionSettings)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutRetentionSettingsResponse Source #

Arguments

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

Create a value of PutRetentionSettingsResponse 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:initiateDeletionTimestamp:PutRetentionSettingsResponse', putRetentionSettingsResponse_initiateDeletionTimestamp - The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

PutRetentionSettings, putRetentionSettingsResponse_retentionSettings - The retention settings.

$sel:httpStatus:PutRetentionSettingsResponse', putRetentionSettingsResponse_httpStatus - The response's http status code.

Response Lenses

putRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' PutRetentionSettingsResponse (Maybe UTCTime) Source #

The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

putRetentionSettingsResponse_retentionSettings :: Lens' PutRetentionSettingsResponse (Maybe RetentionSettings) Source #

The retention settings.

putRetentionSettingsResponse_httpStatus :: Lens' PutRetentionSettingsResponse Int Source #

The response's http status code.