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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata, such as the path and user information about an SMB location.

Synopsis

data DescribeLocationSmb = DescribeLocationSmb' {
- locationArn :: Text
}
newDescribeLocationSmb :: Text -> DescribeLocationSmb
describeLocationSmb_locationArn :: Lens' DescribeLocationSmb Text
data DescribeLocationSmbResponse = DescribeLocationSmbResponse' {
- creationTime :: Maybe POSIX
- agentArns :: Maybe (NonEmpty Text)
- domain :: Maybe Text
- locationUri :: Maybe Text
- user :: Maybe Text
- mountOptions :: Maybe SmbMountOptions
- locationArn :: Maybe Text
- httpStatus :: Int
}
newDescribeLocationSmbResponse :: Int -> DescribeLocationSmbResponse
describeLocationSmbResponse_creationTime :: Lens' DescribeLocationSmbResponse (Maybe UTCTime)
describeLocationSmbResponse_agentArns :: Lens' DescribeLocationSmbResponse (Maybe (NonEmpty Text))
describeLocationSmbResponse_domain :: Lens' DescribeLocationSmbResponse (Maybe Text)
describeLocationSmbResponse_locationUri :: Lens' DescribeLocationSmbResponse (Maybe Text)
describeLocationSmbResponse_user :: Lens' DescribeLocationSmbResponse (Maybe Text)
describeLocationSmbResponse_mountOptions :: Lens' DescribeLocationSmbResponse (Maybe SmbMountOptions)
describeLocationSmbResponse_locationArn :: Lens' DescribeLocationSmbResponse (Maybe Text)
describeLocationSmbResponse_httpStatus :: Lens' DescribeLocationSmbResponse Int

Creating a Request

data DescribeLocationSmb Source #

DescribeLocationSmbRequest

See: newDescribeLocationSmb smart constructor.

Constructors

DescribeLocationSmb'
Fields locationArn :: Text The Amazon Resource Name (ARN) of the SMB location to describe.

Instances

Instances details

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

newDescribeLocationSmb Source #

Arguments

:: Text	`$sel:locationArn:DescribeLocationSmb'`
-> DescribeLocationSmb

Create a value of DescribeLocationSmb 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:locationArn:DescribeLocationSmb', describeLocationSmb_locationArn - The Amazon Resource Name (ARN) of the SMB location to describe.

Request Lenses

describeLocationSmb_locationArn :: Lens' DescribeLocationSmb Text Source #

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

Destructuring the Response

data DescribeLocationSmbResponse Source #

DescribeLocationSmbResponse

See: newDescribeLocationSmbResponse smart constructor.

Constructors

DescribeLocationSmbResponse'

Fields

creationTime :: Maybe POSIX
The time that the SMB location was created.
agentArns :: Maybe (NonEmpty Text)
The Amazon Resource Name (ARN) of the source SMB file system location that is created.
domain :: Maybe Text
The name of the Windows domain that the SMB server belongs to.
locationUri :: Maybe Text
The URL of the source SMB location that was described.
user :: Maybe Text
The user who can mount the share, has the permissions to access files and folders in the SMB share.
mountOptions :: Maybe SmbMountOptions
The mount options that are available for DataSync to use to access an SMB location.
locationArn :: Maybe Text
The Amazon Resource Name (ARN) of the SMB location that was described.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationSmb Methods (==) :: DescribeLocationSmbResponse -> DescribeLocationSmbResponse -> Bool # (/=) :: DescribeLocationSmbResponse -> DescribeLocationSmbResponse -> Bool #
Read DescribeLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationSmb Methods readsPrec :: Int -> ReadS DescribeLocationSmbResponse # readList :: ReadS [DescribeLocationSmbResponse] # readPrec :: ReadPrec DescribeLocationSmbResponse # readListPrec :: ReadPrec [DescribeLocationSmbResponse] #
Show DescribeLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationSmb Methods showsPrec :: Int -> DescribeLocationSmbResponse -> ShowS # show :: DescribeLocationSmbResponse -> String # showList :: [DescribeLocationSmbResponse] -> ShowS #
Generic DescribeLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationSmb Associated Types type Rep DescribeLocationSmbResponse :: Type -> Type # Methods from :: DescribeLocationSmbResponse -> Rep DescribeLocationSmbResponse x # to :: Rep DescribeLocationSmbResponse x -> DescribeLocationSmbResponse #
NFData DescribeLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationSmb Methods rnf :: DescribeLocationSmbResponse -> () #
type Rep DescribeLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationSmb type Rep DescribeLocationSmbResponse = D1 ('MetaData "DescribeLocationSmbResponse" "Amazonka.DataSync.DescribeLocationSmb" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "DescribeLocationSmbResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "locationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SmbMountOptions))) :: (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeLocationSmbResponse Source #

Arguments

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

Create a value of DescribeLocationSmbResponse 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:creationTime:DescribeLocationSmbResponse', describeLocationSmbResponse_creationTime - The time that the SMB location was created.

$sel:agentArns:DescribeLocationSmbResponse', describeLocationSmbResponse_agentArns - The Amazon Resource Name (ARN) of the source SMB file system location that is created.

$sel:domain:DescribeLocationSmbResponse', describeLocationSmbResponse_domain - The name of the Windows domain that the SMB server belongs to.

$sel:locationUri:DescribeLocationSmbResponse', describeLocationSmbResponse_locationUri - The URL of the source SMB location that was described.

$sel:user:DescribeLocationSmbResponse', describeLocationSmbResponse_user - The user who can mount the share, has the permissions to access files and folders in the SMB share.

$sel:mountOptions:DescribeLocationSmbResponse', describeLocationSmbResponse_mountOptions - The mount options that are available for DataSync to use to access an SMB location.

$sel:locationArn:DescribeLocationSmb', describeLocationSmbResponse_locationArn - The Amazon Resource Name (ARN) of the SMB location that was described.

$sel:httpStatus:DescribeLocationSmbResponse', describeLocationSmbResponse_httpStatus - The response's http status code.

Response Lenses

describeLocationSmbResponse_creationTime :: Lens' DescribeLocationSmbResponse (Maybe UTCTime) Source #

The time that the SMB location was created.

describeLocationSmbResponse_agentArns :: Lens' DescribeLocationSmbResponse (Maybe (NonEmpty Text)) Source #

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

describeLocationSmbResponse_domain :: Lens' DescribeLocationSmbResponse (Maybe Text) Source #

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

describeLocationSmbResponse_locationUri :: Lens' DescribeLocationSmbResponse (Maybe Text) Source #

The URL of the source SMB location that was described.

describeLocationSmbResponse_user :: Lens' DescribeLocationSmbResponse (Maybe Text) Source #

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

describeLocationSmbResponse_mountOptions :: Lens' DescribeLocationSmbResponse (Maybe SmbMountOptions) Source #

The mount options that are available for DataSync to use to access an SMB location.

describeLocationSmbResponse_locationArn :: Lens' DescribeLocationSmbResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SMB location that was described.

describeLocationSmbResponse_httpStatus :: Lens' DescribeLocationSmbResponse Int Source #

The response's http status code.