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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

Synopsis

data GetLegalHold = GetLegalHold' {
- legalHoldId :: Text
}
newGetLegalHold :: Text -> GetLegalHold
getLegalHold_legalHoldId :: Lens' GetLegalHold Text
data GetLegalHoldResponse = GetLegalHoldResponse' {
- cancelDescription :: Maybe Text
- cancellationDate :: Maybe POSIX
- creationDate :: Maybe POSIX
- description :: Maybe Text
- legalHoldArn :: Maybe Text
- legalHoldId :: Maybe Text
- recoveryPointSelection :: Maybe RecoveryPointSelection
- retainRecordUntil :: Maybe POSIX
- status :: Maybe LegalHoldStatus
- title :: Maybe Text
- httpStatus :: Int
}
newGetLegalHoldResponse :: Int -> GetLegalHoldResponse
getLegalHoldResponse_cancelDescription :: Lens' GetLegalHoldResponse (Maybe Text)
getLegalHoldResponse_cancellationDate :: Lens' GetLegalHoldResponse (Maybe UTCTime)
getLegalHoldResponse_creationDate :: Lens' GetLegalHoldResponse (Maybe UTCTime)
getLegalHoldResponse_description :: Lens' GetLegalHoldResponse (Maybe Text)
getLegalHoldResponse_legalHoldArn :: Lens' GetLegalHoldResponse (Maybe Text)
getLegalHoldResponse_legalHoldId :: Lens' GetLegalHoldResponse (Maybe Text)
getLegalHoldResponse_recoveryPointSelection :: Lens' GetLegalHoldResponse (Maybe RecoveryPointSelection)
getLegalHoldResponse_retainRecordUntil :: Lens' GetLegalHoldResponse (Maybe UTCTime)
getLegalHoldResponse_status :: Lens' GetLegalHoldResponse (Maybe LegalHoldStatus)
getLegalHoldResponse_title :: Lens' GetLegalHoldResponse (Maybe Text)
getLegalHoldResponse_httpStatus :: Lens' GetLegalHoldResponse Int

Creating a Request

data GetLegalHold Source #

See: newGetLegalHold smart constructor.

Constructors

GetLegalHold'
Fields legalHoldId :: Text This is the ID required to use `GetLegalHold`. This unique ID is associated with a specific legal hold.

Instances

Instances details

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

newGetLegalHold Source #

Arguments

:: Text	`GetLegalHold`
-> GetLegalHold

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

GetLegalHold, getLegalHold_legalHoldId - This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

Request Lenses

getLegalHold_legalHoldId :: Lens' GetLegalHold Text Source #

This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

Destructuring the Response

data GetLegalHoldResponse Source #

See: newGetLegalHoldResponse smart constructor.

Constructors

GetLegalHoldResponse'

Fields

cancelDescription :: Maybe Text
String describing the reason for removing the legal hold.
cancellationDate :: Maybe POSIX
Time in number when legal hold was cancelled.
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 returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.
legalHoldId :: Maybe Text
This is the returned ID associated with a specified legal hold.
recoveryPointSelection :: Maybe RecoveryPointSelection
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
retainRecordUntil :: Maybe POSIX
This is the date and time until which the legal hold record will be retained.
status :: Maybe LegalHoldStatus
This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
title :: Maybe Text
This is the string title of the legal hold.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.GetLegalHold Associated Types type Rep GetLegalHoldResponse :: Type -> Type # Methods from :: GetLegalHoldResponse -> Rep GetLegalHoldResponse x # to :: Rep GetLegalHoldResponse x -> GetLegalHoldResponse #
Read GetLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.GetLegalHold Methods readsPrec :: Int -> ReadS GetLegalHoldResponse # readList :: ReadS [GetLegalHoldResponse] # readPrec :: ReadPrec GetLegalHoldResponse # readListPrec :: ReadPrec [GetLegalHoldResponse] #
Show GetLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.GetLegalHold Methods showsPrec :: Int -> GetLegalHoldResponse -> ShowS # show :: GetLegalHoldResponse -> String # showList :: [GetLegalHoldResponse] -> ShowS #
NFData GetLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.GetLegalHold Methods rnf :: GetLegalHoldResponse -> () #
Eq GetLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.GetLegalHold Methods (==) :: GetLegalHoldResponse -> GetLegalHoldResponse -> Bool # (/=) :: GetLegalHoldResponse -> GetLegalHoldResponse -> Bool #
type Rep GetLegalHoldResponse Source #
Instance details Defined in Amazonka.Backup.GetLegalHold type Rep GetLegalHoldResponse = D1 ('MetaData "GetLegalHoldResponse" "Amazonka.Backup.GetLegalHold" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "GetLegalHoldResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cancelDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cancellationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (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 "retainRecordUntil") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (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))))))

newGetLegalHoldResponse Source #

Arguments

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

Create a value of GetLegalHoldResponse 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:cancelDescription:GetLegalHoldResponse', getLegalHoldResponse_cancelDescription - String describing the reason for removing the legal hold.

GetLegalHoldResponse, getLegalHoldResponse_cancellationDate - Time in number when legal hold was cancelled.

GetLegalHoldResponse, getLegalHoldResponse_creationDate - Time in number format when legal hold was created.

GetLegalHoldResponse, getLegalHoldResponse_description - This is the returned string description of the legal hold.

GetLegalHoldResponse, getLegalHoldResponse_legalHoldArn - This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

GetLegalHold, getLegalHoldResponse_legalHoldId - This is the returned ID associated with a specified legal hold.

$sel:recoveryPointSelection:GetLegalHoldResponse', getLegalHoldResponse_recoveryPointSelection - This specifies criteria to assign a set of resources, such as resource types or backup vaults.

$sel:retainRecordUntil:GetLegalHoldResponse', getLegalHoldResponse_retainRecordUntil - This is the date and time until which the legal hold record will be retained.

GetLegalHoldResponse, getLegalHoldResponse_status - This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

GetLegalHoldResponse, getLegalHoldResponse_title - This is the string title of the legal hold.

$sel:httpStatus:GetLegalHoldResponse', getLegalHoldResponse_httpStatus - The response's http status code.

Response Lenses

getLegalHoldResponse_cancelDescription :: Lens' GetLegalHoldResponse (Maybe Text) Source #

String describing the reason for removing the legal hold.

getLegalHoldResponse_cancellationDate :: Lens' GetLegalHoldResponse (Maybe UTCTime) Source #

Time in number when legal hold was cancelled.

getLegalHoldResponse_creationDate :: Lens' GetLegalHoldResponse (Maybe UTCTime) Source #

Time in number format when legal hold was created.

getLegalHoldResponse_description :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the returned string description of the legal hold.

getLegalHoldResponse_legalHoldArn :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

getLegalHoldResponse_legalHoldId :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the returned ID associated with a specified legal hold.

getLegalHoldResponse_recoveryPointSelection :: Lens' GetLegalHoldResponse (Maybe RecoveryPointSelection) Source #

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

getLegalHoldResponse_retainRecordUntil :: Lens' GetLegalHoldResponse (Maybe UTCTime) Source #

This is the date and time until which the legal hold record will be retained.

getLegalHoldResponse_status :: Lens' GetLegalHoldResponse (Maybe LegalHoldStatus) Source #

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

getLegalHoldResponse_title :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the string title of the legal hold.

getLegalHoldResponse_httpStatus :: Lens' GetLegalHoldResponse Int Source #

The response's http status code.