Amazonka.SecretsManager.RestoreSecret

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data RestoreSecret

See: newRestoreSecret smart constructor.

Constructors

RestoreSecret'

Fields

• secretId :: Text

  The ARN or name of the secret to restore.

  For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Instances

ToJSON RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

toJSON :: RestoreSecret -> Value

toEncoding :: RestoreSecret -> Encoding

toJSONList :: [RestoreSecret] -> Value

toEncodingList :: [RestoreSecret] -> Encoding

ToHeaders RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

toHeaders :: RestoreSecret -> [Header]

ToPath RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

toPath :: RestoreSecret -> ByteString

ToQuery RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

toQuery :: RestoreSecret -> QueryString

AWSRequest RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Associated Types

type AWSResponse RestoreSecret

Methods

request :: (Service -> Service) -> RestoreSecret -> Request RestoreSecret

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreSecret -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreSecret)))

Generic RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Associated Types

type Rep RestoreSecret :: Type -> Type

Methods

from :: RestoreSecret -> Rep RestoreSecret x

to :: Rep RestoreSecret x -> RestoreSecret

Read RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

readsPrec :: Int -> ReadS RestoreSecret

readList :: ReadS [RestoreSecret]

readPrec :: ReadPrec RestoreSecret

readListPrec :: ReadPrec [RestoreSecret]

Show RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

showsPrec :: Int -> RestoreSecret -> ShowS

show :: RestoreSecret -> String

showList :: [RestoreSecret] -> ShowS

NFData RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

rnf :: RestoreSecret -> ()

Eq RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

(==) :: RestoreSecret -> RestoreSecret -> Bool

(/=) :: RestoreSecret -> RestoreSecret -> Bool

Hashable RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

hashWithSalt :: Int -> RestoreSecret -> Int

hash :: RestoreSecret -> Int

type AWSResponse RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

type AWSResponse RestoreSecret = RestoreSecretResponse

type Rep RestoreSecret

Defined in Amazonka.SecretsManager.RestoreSecret

type Rep RestoreSecret = D1 ('MetaData "RestoreSecret" "Amazonka.SecretsManager.RestoreSecret" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "RestoreSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRestoreSecret

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 - The ARN or name of the secret to restore.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Request Lenses

restoreSecret_secretId :: Lens' RestoreSecret Text

The ARN or name of the secret to restore.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Destructuring the Response

data RestoreSecretResponse

See: newRestoreSecretResponse smart constructor.

Constructors

RestoreSecretResponse'

Fields

• arn :: Maybe Text

  The ARN of the secret that was restored.

• name :: Maybe Text

  The name of the secret that was restored.

• httpStatus :: Int

  The response's http status code.

Instances

Generic RestoreSecretResponse

Defined in Amazonka.SecretsManager.RestoreSecret

Associated Types

type Rep RestoreSecretResponse :: Type -> Type

Methods

from :: RestoreSecretResponse -> Rep RestoreSecretResponse x

to :: Rep RestoreSecretResponse x -> RestoreSecretResponse

Read RestoreSecretResponse

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

readsPrec :: Int -> ReadS RestoreSecretResponse

readList :: ReadS [RestoreSecretResponse]

readPrec :: ReadPrec RestoreSecretResponse

readListPrec :: ReadPrec [RestoreSecretResponse]

Show RestoreSecretResponse

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

showsPrec :: Int -> RestoreSecretResponse -> ShowS

show :: RestoreSecretResponse -> String

showList :: [RestoreSecretResponse] -> ShowS

NFData RestoreSecretResponse

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

rnf :: RestoreSecretResponse -> ()

Eq RestoreSecretResponse

Defined in Amazonka.SecretsManager.RestoreSecret

Methods

(==) :: RestoreSecretResponse -> RestoreSecretResponse -> Bool

(/=) :: RestoreSecretResponse -> RestoreSecretResponse -> Bool

type Rep RestoreSecretResponse

Defined in Amazonka.SecretsManager.RestoreSecret

type Rep RestoreSecretResponse = D1 ('MetaData "RestoreSecretResponse" "Amazonka.SecretsManager.RestoreSecret" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" '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

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:

RestoreSecretResponse, restoreSecretResponse_arn - The ARN of the secret that was restored.

RestoreSecretResponse, restoreSecretResponse_name - The 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)

The ARN of the secret that was restored.

restoreSecretResponse_name :: Lens' RestoreSecretResponse (Maybe Text)

The name of the secret that was restored.

restoreSecretResponse_httpStatus :: Lens' RestoreSecretResponse Int

The response's http status code.