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.RedshiftServerLess.RestoreFromSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Restores a namespace from a snapshot.

Synopsis

data RestoreFromSnapshot = RestoreFromSnapshot' {
- ownerAccount :: Maybe Text
- snapshotArn :: Maybe Text
- snapshotName :: Maybe Text
- namespaceName :: Text
- workgroupName :: Text
}
newRestoreFromSnapshot :: Text -> Text -> RestoreFromSnapshot
restoreFromSnapshot_ownerAccount :: Lens' RestoreFromSnapshot (Maybe Text)
restoreFromSnapshot_snapshotArn :: Lens' RestoreFromSnapshot (Maybe Text)
restoreFromSnapshot_snapshotName :: Lens' RestoreFromSnapshot (Maybe Text)
restoreFromSnapshot_namespaceName :: Lens' RestoreFromSnapshot Text
restoreFromSnapshot_workgroupName :: Lens' RestoreFromSnapshot Text
data RestoreFromSnapshotResponse = RestoreFromSnapshotResponse' {
- namespace :: Maybe Namespace
- ownerAccount :: Maybe Text
- snapshotName :: Maybe Text
- httpStatus :: Int
}
newRestoreFromSnapshotResponse :: Int -> RestoreFromSnapshotResponse
restoreFromSnapshotResponse_namespace :: Lens' RestoreFromSnapshotResponse (Maybe Namespace)
restoreFromSnapshotResponse_ownerAccount :: Lens' RestoreFromSnapshotResponse (Maybe Text)
restoreFromSnapshotResponse_snapshotName :: Lens' RestoreFromSnapshotResponse (Maybe Text)
restoreFromSnapshotResponse_httpStatus :: Lens' RestoreFromSnapshotResponse Int

Creating a Request

data RestoreFromSnapshot Source #

See: newRestoreFromSnapshot smart constructor.

Constructors

RestoreFromSnapshot'

Fields

ownerAccount :: Maybe Text
The Amazon Web Services account that owns the snapshot.
snapshotArn :: Maybe Text
The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.
The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
snapshotName :: Maybe Text
The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
namespaceName :: Text
The name of the namespace to restore the snapshot to.
workgroupName :: Text
The name of the workgroup used to restore the snapshot.

Instances

Instances details

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

newRestoreFromSnapshot Source #

Arguments

:: Text	`RestoreFromSnapshot`
-> Text	`RestoreFromSnapshot`
-> RestoreFromSnapshot

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

RestoreFromSnapshot, restoreFromSnapshot_ownerAccount - The Amazon Web Services account that owns the snapshot.

RestoreFromSnapshot, restoreFromSnapshot_snapshotArn - The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

RestoreFromSnapshot, restoreFromSnapshot_snapshotName - The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

RestoreFromSnapshot, restoreFromSnapshot_namespaceName - The name of the namespace to restore the snapshot to.

RestoreFromSnapshot, restoreFromSnapshot_workgroupName - The name of the workgroup used to restore the snapshot.

Request Lenses

restoreFromSnapshot_ownerAccount :: Lens' RestoreFromSnapshot (Maybe Text) Source #

The Amazon Web Services account that owns the snapshot.

restoreFromSnapshot_snapshotArn :: Lens' RestoreFromSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

restoreFromSnapshot_snapshotName :: Lens' RestoreFromSnapshot (Maybe Text) Source #

The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

restoreFromSnapshot_namespaceName :: Lens' RestoreFromSnapshot Text Source #

The name of the namespace to restore the snapshot to.

restoreFromSnapshot_workgroupName :: Lens' RestoreFromSnapshot Text Source #

The name of the workgroup used to restore the snapshot.

Destructuring the Response

data RestoreFromSnapshotResponse Source #

See: newRestoreFromSnapshotResponse smart constructor.

Constructors

RestoreFromSnapshotResponse'
Fields namespace :: Maybe Namespace ownerAccount :: Maybe Text The owner Amazon Web Services; account of the snapshot that was restored. snapshotName :: Maybe Text The name of the snapshot used to restore the namespace. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RestoreFromSnapshotResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.RestoreFromSnapshot Associated Types type Rep RestoreFromSnapshotResponse :: Type -> Type # Methods from :: RestoreFromSnapshotResponse -> Rep RestoreFromSnapshotResponse x # to :: Rep RestoreFromSnapshotResponse x -> RestoreFromSnapshotResponse #
Show RestoreFromSnapshotResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.RestoreFromSnapshot Methods showsPrec :: Int -> RestoreFromSnapshotResponse -> ShowS # show :: RestoreFromSnapshotResponse -> String # showList :: [RestoreFromSnapshotResponse] -> ShowS #
NFData RestoreFromSnapshotResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.RestoreFromSnapshot Methods rnf :: RestoreFromSnapshotResponse -> () #
Eq RestoreFromSnapshotResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.RestoreFromSnapshot Methods (==) :: RestoreFromSnapshotResponse -> RestoreFromSnapshotResponse -> Bool # (/=) :: RestoreFromSnapshotResponse -> RestoreFromSnapshotResponse -> Bool #
type Rep RestoreFromSnapshotResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.RestoreFromSnapshot type Rep RestoreFromSnapshotResponse = D1 ('MetaData "RestoreFromSnapshotResponse" "Amazonka.RedshiftServerLess.RestoreFromSnapshot" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "RestoreFromSnapshotResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Namespace)) :: S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRestoreFromSnapshotResponse Source #

Arguments

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

Create a value of RestoreFromSnapshotResponse 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:namespace:RestoreFromSnapshotResponse', restoreFromSnapshotResponse_namespace - Undocumented member.

RestoreFromSnapshot, restoreFromSnapshotResponse_ownerAccount - The owner Amazon Web Services; account of the snapshot that was restored.

RestoreFromSnapshot, restoreFromSnapshotResponse_snapshotName - The name of the snapshot used to restore the namespace.

$sel:httpStatus:RestoreFromSnapshotResponse', restoreFromSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

restoreFromSnapshotResponse_namespace :: Lens' RestoreFromSnapshotResponse (Maybe Namespace) Source #

Undocumented member.

restoreFromSnapshotResponse_ownerAccount :: Lens' RestoreFromSnapshotResponse (Maybe Text) Source #

The owner Amazon Web Services; account of the snapshot that was restored.

restoreFromSnapshotResponse_snapshotName :: Lens' RestoreFromSnapshotResponse (Maybe Text) Source #

The name of the snapshot used to restore the namespace.

restoreFromSnapshotResponse_httpStatus :: Lens' RestoreFromSnapshotResponse Int Source #

The response's http status code.