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.DataSync.UpdateLocationSmb

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.

Synopsis

data UpdateLocationSmb = UpdateLocationSmb' {
- agentArns :: Maybe (NonEmpty Text)
- domain :: Maybe Text
- mountOptions :: Maybe SmbMountOptions
- password :: Maybe (Sensitive Text)
- subdirectory :: Maybe Text
- user :: Maybe Text
- locationArn :: Text
}
newUpdateLocationSmb :: Text -> UpdateLocationSmb
updateLocationSmb_agentArns :: Lens' UpdateLocationSmb (Maybe (NonEmpty Text))
updateLocationSmb_domain :: Lens' UpdateLocationSmb (Maybe Text)
updateLocationSmb_mountOptions :: Lens' UpdateLocationSmb (Maybe SmbMountOptions)
updateLocationSmb_password :: Lens' UpdateLocationSmb (Maybe Text)
updateLocationSmb_subdirectory :: Lens' UpdateLocationSmb (Maybe Text)
updateLocationSmb_user :: Lens' UpdateLocationSmb (Maybe Text)
updateLocationSmb_locationArn :: Lens' UpdateLocationSmb Text
data UpdateLocationSmbResponse = UpdateLocationSmbResponse' {
- httpStatus :: Int
}
newUpdateLocationSmbResponse :: Int -> UpdateLocationSmbResponse
updateLocationSmbResponse_httpStatus :: Lens' UpdateLocationSmbResponse Int

Creating a Request

data UpdateLocationSmb Source #

See: newUpdateLocationSmb smart constructor.

Constructors

UpdateLocationSmb'

Fields

agentArns :: Maybe (NonEmpty Text)
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
domain :: Maybe Text
The name of the Windows domain that the SMB server belongs to.
mountOptions :: Maybe SmbMountOptions
password :: Maybe (Sensitive Text)
The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
subdirectory :: Maybe Text
The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.
Subdirectory must be specified with forward slashes. For example, /path/to/folder.
To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:
- Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.
- Use credentials of a member of the Backup Operators group to mount the share.
Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.
user :: Maybe Text
The user who can mount the share has the permissions to access files and folders in the SMB share.
locationArn :: Text
The Amazon Resource Name (ARN) of the SMB location to update.

Instances

Instances details

ToJSON UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods toJSON :: UpdateLocationSmb -> Value # toEncoding :: UpdateLocationSmb -> Encoding # toJSONList :: [UpdateLocationSmb] -> Value # toEncodingList :: [UpdateLocationSmb] -> Encoding #
ToHeaders UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods toHeaders :: UpdateLocationSmb -> [Header] #
ToPath UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods toPath :: UpdateLocationSmb -> ByteString #
ToQuery UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods toQuery :: UpdateLocationSmb -> QueryString #
AWSRequest UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Associated Types type AWSResponse UpdateLocationSmb # Methods request :: (Service -> Service) -> UpdateLocationSmb -> Request UpdateLocationSmb # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateLocationSmb -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateLocationSmb))) #
Generic UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Associated Types type Rep UpdateLocationSmb :: Type -> Type # Methods from :: UpdateLocationSmb -> Rep UpdateLocationSmb x # to :: Rep UpdateLocationSmb x -> UpdateLocationSmb #
Show UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods showsPrec :: Int -> UpdateLocationSmb -> ShowS # show :: UpdateLocationSmb -> String # showList :: [UpdateLocationSmb] -> ShowS #
NFData UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods rnf :: UpdateLocationSmb -> () #
Eq UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods (==) :: UpdateLocationSmb -> UpdateLocationSmb -> Bool # (/=) :: UpdateLocationSmb -> UpdateLocationSmb -> Bool #
Hashable UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods hashWithSalt :: Int -> UpdateLocationSmb -> Int # hash :: UpdateLocationSmb -> Int #
type AWSResponse UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb type AWSResponse UpdateLocationSmb = UpdateLocationSmbResponse
type Rep UpdateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb type Rep UpdateLocationSmb = D1 ('MetaData "UpdateLocationSmb" "Amazonka.DataSync.UpdateLocationSmb" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateLocationSmb'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SmbMountOptions)))) :: ((S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateLocationSmb Source #

Arguments

:: Text	`UpdateLocationSmb`
-> UpdateLocationSmb

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

UpdateLocationSmb, updateLocationSmb_agentArns - The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

UpdateLocationSmb, updateLocationSmb_domain - The name of the Windows domain that the SMB server belongs to.

UpdateLocationSmb, updateLocationSmb_mountOptions - Undocumented member.

UpdateLocationSmb, updateLocationSmb_password - The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

$sel:subdirectory:UpdateLocationSmb', updateLocationSmb_subdirectory - The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.
Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

UpdateLocationSmb, updateLocationSmb_user - The user who can mount the share has the permissions to access files and folders in the SMB share.

UpdateLocationSmb, updateLocationSmb_locationArn - The Amazon Resource Name (ARN) of the SMB location to update.

Request Lenses

updateLocationSmb_agentArns :: Lens' UpdateLocationSmb (Maybe (NonEmpty Text)) Source #

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

updateLocationSmb_domain :: Lens' UpdateLocationSmb (Maybe Text) Source #

The name of the Windows domain that the SMB server belongs to.

updateLocationSmb_mountOptions :: Lens' UpdateLocationSmb (Maybe SmbMountOptions) Source #

Undocumented member.

updateLocationSmb_password :: Lens' UpdateLocationSmb (Maybe Text) Source #

The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

updateLocationSmb_subdirectory :: Lens' UpdateLocationSmb (Maybe Text) Source #

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.
Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

updateLocationSmb_user :: Lens' UpdateLocationSmb (Maybe Text) Source #

The user who can mount the share has the permissions to access files and folders in the SMB share.

updateLocationSmb_locationArn :: Lens' UpdateLocationSmb Text Source #

The Amazon Resource Name (ARN) of the SMB location to update.

Destructuring the Response

data UpdateLocationSmbResponse Source #

See: newUpdateLocationSmbResponse smart constructor.

Constructors

UpdateLocationSmbResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Associated Types type Rep UpdateLocationSmbResponse :: Type -> Type # Methods from :: UpdateLocationSmbResponse -> Rep UpdateLocationSmbResponse x # to :: Rep UpdateLocationSmbResponse x -> UpdateLocationSmbResponse #
Read UpdateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods readsPrec :: Int -> ReadS UpdateLocationSmbResponse # readList :: ReadS [UpdateLocationSmbResponse] # readPrec :: ReadPrec UpdateLocationSmbResponse # readListPrec :: ReadPrec [UpdateLocationSmbResponse] #
Show UpdateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods showsPrec :: Int -> UpdateLocationSmbResponse -> ShowS # show :: UpdateLocationSmbResponse -> String # showList :: [UpdateLocationSmbResponse] -> ShowS #
NFData UpdateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods rnf :: UpdateLocationSmbResponse -> () #
Eq UpdateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb Methods (==) :: UpdateLocationSmbResponse -> UpdateLocationSmbResponse -> Bool # (/=) :: UpdateLocationSmbResponse -> UpdateLocationSmbResponse -> Bool #
type Rep UpdateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateLocationSmb type Rep UpdateLocationSmbResponse = D1 ('MetaData "UpdateLocationSmbResponse" "Amazonka.DataSync.UpdateLocationSmb" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateLocationSmbResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateLocationSmbResponse Source #

Arguments

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

Create a value of UpdateLocationSmbResponse 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:httpStatus:UpdateLocationSmbResponse', updateLocationSmbResponse_httpStatus - The response's http status code.

Response Lenses

updateLocationSmbResponse_httpStatus :: Lens' UpdateLocationSmbResponse Int Source #

The response's http status code.