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.Backup.CreateLegalHold

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

Synopsis

data CreateLegalHold = CreateLegalHold' {
- idempotencyToken :: Maybe Text
- recoveryPointSelection :: Maybe RecoveryPointSelection
- tags :: Maybe (Sensitive (HashMap Text Text))
- title :: Text
- description :: Text
}
newCreateLegalHold :: Text -> Text -> CreateLegalHold
createLegalHold_idempotencyToken :: Lens' CreateLegalHold (Maybe Text)
createLegalHold_recoveryPointSelection :: Lens' CreateLegalHold (Maybe RecoveryPointSelection)
createLegalHold_tags :: Lens' CreateLegalHold (Maybe (HashMap Text Text))
createLegalHold_title :: Lens' CreateLegalHold Text
createLegalHold_description :: Lens' CreateLegalHold Text
data CreateLegalHoldResponse = CreateLegalHoldResponse' {
- creationDate :: Maybe POSIX
- description :: Maybe Text
- legalHoldArn :: Maybe Text
- legalHoldId :: Maybe Text
- recoveryPointSelection :: Maybe RecoveryPointSelection
- status :: Maybe LegalHoldStatus
- title :: Maybe Text
- httpStatus :: Int
}
newCreateLegalHoldResponse :: Int -> CreateLegalHoldResponse
createLegalHoldResponse_creationDate :: Lens' CreateLegalHoldResponse (Maybe UTCTime)
createLegalHoldResponse_description :: Lens' CreateLegalHoldResponse (Maybe Text)
createLegalHoldResponse_legalHoldArn :: Lens' CreateLegalHoldResponse (Maybe Text)
createLegalHoldResponse_legalHoldId :: Lens' CreateLegalHoldResponse (Maybe Text)
createLegalHoldResponse_recoveryPointSelection :: Lens' CreateLegalHoldResponse (Maybe RecoveryPointSelection)
createLegalHoldResponse_status :: Lens' CreateLegalHoldResponse (Maybe LegalHoldStatus)
createLegalHoldResponse_title :: Lens' CreateLegalHoldResponse (Maybe Text)
createLegalHoldResponse_httpStatus :: Lens' CreateLegalHoldResponse Int

Creating a Request

data CreateLegalHold Source #

See: newCreateLegalHold smart constructor.

Constructors

CreateLegalHold'

Fields

idempotencyToken :: Maybe Text
This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
recoveryPointSelection :: Maybe RecoveryPointSelection
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
tags :: Maybe (Sensitive (HashMap Text Text))
Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
title :: Text
This is the string title of the legal hold.
description :: Text
This is the string description of the legal hold.

Instances

Instances details

ToJSON CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods toJSON :: CreateLegalHold -> Value # toEncoding :: CreateLegalHold -> Encoding # toJSONList :: [CreateLegalHold] -> Value # toEncodingList :: [CreateLegalHold] -> Encoding #
ToHeaders CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods toHeaders :: CreateLegalHold -> [Header] #
ToPath CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods toPath :: CreateLegalHold -> ByteString #
ToQuery CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods toQuery :: CreateLegalHold -> QueryString #
AWSRequest CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Associated Types type AWSResponse CreateLegalHold # Methods request :: (Service -> Service) -> CreateLegalHold -> Request CreateLegalHold # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateLegalHold -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLegalHold))) #
Generic CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Associated Types type Rep CreateLegalHold :: Type -> Type # Methods from :: CreateLegalHold -> Rep CreateLegalHold x # to :: Rep CreateLegalHold x -> CreateLegalHold #
Show CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods showsPrec :: Int -> CreateLegalHold -> ShowS # show :: CreateLegalHold -> String # showList :: [CreateLegalHold] -> ShowS #
NFData CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods rnf :: CreateLegalHold -> () #
Eq CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods (==) :: CreateLegalHold -> CreateLegalHold -> Bool # (/=) :: CreateLegalHold -> CreateLegalHold -> Bool #
Hashable CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods hashWithSalt :: Int -> CreateLegalHold -> Int # hash :: CreateLegalHold -> Int #
type AWSResponse CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold type AWSResponse CreateLegalHold = CreateLegalHoldResponse
type Rep CreateLegalHold Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold type Rep CreateLegalHold = D1 ('MetaData "CreateLegalHold" "Amazonka.Backup.CreateLegalHold" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "CreateLegalHold'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recoveryPointSelection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecoveryPointSelection))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateLegalHold Source #

Arguments

:: Text	`CreateLegalHold`
-> Text	`CreateLegalHold`
-> CreateLegalHold

Create a value of CreateLegalHold 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:idempotencyToken:CreateLegalHold', createLegalHold_idempotencyToken - This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

CreateLegalHold, createLegalHold_recoveryPointSelection - This specifies criteria to assign a set of resources, such as resource types or backup vaults.

CreateLegalHold, createLegalHold_tags - Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

CreateLegalHold, createLegalHold_title - This is the string title of the legal hold.

CreateLegalHold, createLegalHold_description - This is the string description of the legal hold.

Request Lenses

createLegalHold_idempotencyToken :: Lens' CreateLegalHold (Maybe Text) Source #

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

createLegalHold_recoveryPointSelection :: Lens' CreateLegalHold (Maybe RecoveryPointSelection) Source #

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

createLegalHold_tags :: Lens' CreateLegalHold (Maybe (HashMap Text Text)) Source #

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

createLegalHold_title :: Lens' CreateLegalHold Text Source #

This is the string title of the legal hold.

createLegalHold_description :: Lens' CreateLegalHold Text Source #

This is the string description of the legal hold.

Destructuring the Response

data CreateLegalHoldResponse Source #

See: newCreateLegalHoldResponse smart constructor.

Constructors

CreateLegalHoldResponse'

Fields

creationDate :: Maybe POSIX
Time in number format when legal hold was created.
description :: Maybe Text
This is the returned string description of the legal hold.
legalHoldArn :: Maybe Text
This is the ARN (Amazon Resource Number) of the created legal hold.
legalHoldId :: Maybe Text
Legal hold ID returned for the specified legal hold on a recovery point.
recoveryPointSelection :: Maybe RecoveryPointSelection
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
status :: Maybe LegalHoldStatus
This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.
title :: Maybe Text
This is the string title of the legal hold returned after creating the legal hold.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Associated Types type Rep CreateLegalHoldResponse :: Type -> Type # Methods from :: CreateLegalHoldResponse -> Rep CreateLegalHoldResponse x # to :: Rep CreateLegalHoldResponse x -> CreateLegalHoldResponse #
Read CreateLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods readsPrec :: Int -> ReadS CreateLegalHoldResponse # readList :: ReadS [CreateLegalHoldResponse] # readPrec :: ReadPrec CreateLegalHoldResponse # readListPrec :: ReadPrec [CreateLegalHoldResponse] #
Show CreateLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods showsPrec :: Int -> CreateLegalHoldResponse -> ShowS # show :: CreateLegalHoldResponse -> String # showList :: [CreateLegalHoldResponse] -> ShowS #
NFData CreateLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods rnf :: CreateLegalHoldResponse -> () #
Eq CreateLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold Methods (==) :: CreateLegalHoldResponse -> CreateLegalHoldResponse -> Bool # (/=) :: CreateLegalHoldResponse -> CreateLegalHoldResponse -> Bool #
type Rep CreateLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.CreateLegalHold type Rep CreateLegalHoldResponse = D1 ('MetaData "CreateLegalHoldResponse" "Amazonka.Backup.CreateLegalHold" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "CreateLegalHoldResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "legalHoldArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "legalHoldId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "recoveryPointSelection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecoveryPointSelection)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LegalHoldStatus))) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateLegalHoldResponse Source #

Arguments

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

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

CreateLegalHoldResponse, createLegalHoldResponse_creationDate - Time in number format when legal hold was created.

CreateLegalHold, createLegalHoldResponse_description - This is the returned string description of the legal hold.

CreateLegalHoldResponse, createLegalHoldResponse_legalHoldArn - This is the ARN (Amazon Resource Number) of the created legal hold.

CreateLegalHoldResponse, createLegalHoldResponse_legalHoldId - Legal hold ID returned for the specified legal hold on a recovery point.

CreateLegalHold, createLegalHoldResponse_recoveryPointSelection - This specifies criteria to assign a set of resources, such as resource types or backup vaults.

CreateLegalHoldResponse, createLegalHoldResponse_status - This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

CreateLegalHold, createLegalHoldResponse_title - This is the string title of the legal hold returned after creating the legal hold.

$sel:httpStatus:CreateLegalHoldResponse', createLegalHoldResponse_httpStatus - The response's http status code.

Response Lenses

createLegalHoldResponse_creationDate :: Lens' CreateLegalHoldResponse (Maybe UTCTime) Source #

Time in number format when legal hold was created.

createLegalHoldResponse_description :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

This is the returned string description of the legal hold.

createLegalHoldResponse_legalHoldArn :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

This is the ARN (Amazon Resource Number) of the created legal hold.

createLegalHoldResponse_legalHoldId :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

Legal hold ID returned for the specified legal hold on a recovery point.

createLegalHoldResponse_recoveryPointSelection :: Lens' CreateLegalHoldResponse (Maybe RecoveryPointSelection) Source #

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

createLegalHoldResponse_status :: Lens' CreateLegalHoldResponse (Maybe LegalHoldStatus) Source #

This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

createLegalHoldResponse_title :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

This is the string title of the legal hold returned after creating the legal hold.

createLegalHoldResponse_httpStatus :: Lens' CreateLegalHoldResponse Int Source #

The response's http status code.