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.SecretsManager.RestoreSecret

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again.

Minimum permissions

To run this command, you must have the following permissions:

secretsmanager:RestoreSecret

Related operations

To delete a secret, use DeleteSecret.

Synopsis

Creating a Request

data RestoreSecret Source #

See: newRestoreSecret smart constructor.

Constructors

RestoreSecret'
Fields secretId :: Text Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Instances

Instances details

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

newRestoreSecret Source #

Arguments

:: Text	`$sel:secretId:RestoreSecret'`
-> RestoreSecret

Create a value of RestoreSecret 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:secretId:RestoreSecret', restoreSecret_secretId - Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Request Lenses

restoreSecret_secretId :: Lens' RestoreSecret Text Source #

Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Destructuring the Response

data RestoreSecretResponse Source #

See: newRestoreSecretResponse smart constructor.

Constructors

RestoreSecretResponse'
Fields arn :: Maybe Text The ARN of the secret that was restored. name :: Maybe Text The friendly name of the secret that was restored. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newRestoreSecretResponse Source #

Arguments

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

Create a value of RestoreSecretResponse 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:arn:RestoreSecretResponse', restoreSecretResponse_arn - The ARN of the secret that was restored.

$sel:name:RestoreSecretResponse', restoreSecretResponse_name - The friendly name of the secret that was restored.

$sel:httpStatus:RestoreSecretResponse', restoreSecretResponse_httpStatus - The response's http status code.

Response Lenses

restoreSecretResponse_arn :: Lens' RestoreSecretResponse (Maybe Text) Source #

The ARN of the secret that was restored.

restoreSecretResponse_name :: Lens' RestoreSecretResponse (Maybe Text) Source #

The friendly name of the secret that was restored.

restoreSecretResponse_httpStatus :: Lens' RestoreSecretResponse Int Source #

The response's http status code.