Amazonka.DataSync.DescribeLocationSmb

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

Creating a Request

data DescribeLocationSmb

DescribeLocationSmbRequest

See: newDescribeLocationSmb smart constructor.

Constructors

DescribeLocationSmb'

Fields

• locationArn :: Text

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

Instances

ToJSON DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

toJSON :: DescribeLocationSmb -> Value

toEncoding :: DescribeLocationSmb -> Encoding

toJSONList :: [DescribeLocationSmb] -> Value

toEncodingList :: [DescribeLocationSmb] -> Encoding

ToHeaders DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

toHeaders :: DescribeLocationSmb -> [Header]

ToPath DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

toPath :: DescribeLocationSmb -> ByteString

ToQuery DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

toQuery :: DescribeLocationSmb -> QueryString

AWSRequest DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Associated Types

type AWSResponse DescribeLocationSmb

Methods

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

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

Generic DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Associated Types

type Rep DescribeLocationSmb :: Type -> Type

Methods

from :: DescribeLocationSmb -> Rep DescribeLocationSmb x

to :: Rep DescribeLocationSmb x -> DescribeLocationSmb

Read DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

readsPrec :: Int -> ReadS DescribeLocationSmb

readList :: ReadS [DescribeLocationSmb]

readPrec :: ReadPrec DescribeLocationSmb

readListPrec :: ReadPrec [DescribeLocationSmb]

Show DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

showsPrec :: Int -> DescribeLocationSmb -> ShowS

show :: DescribeLocationSmb -> String

showList :: [DescribeLocationSmb] -> ShowS

NFData DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

rnf :: DescribeLocationSmb -> ()

Eq DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

(==) :: DescribeLocationSmb -> DescribeLocationSmb -> Bool

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

Hashable DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

hashWithSalt :: Int -> DescribeLocationSmb -> Int

hash :: DescribeLocationSmb -> Int

type AWSResponse DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

type AWSResponse DescribeLocationSmb = DescribeLocationSmbResponse

type Rep DescribeLocationSmb

Defined in Amazonka.DataSync.DescribeLocationSmb

type Rep DescribeLocationSmb = D1 ('MetaData "DescribeLocationSmb" "Amazonka.DataSync.DescribeLocationSmb" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "DescribeLocationSmb'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeLocationSmb

Arguments

:: Text

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:

DescribeLocationSmb, describeLocationSmb_locationArn - The Amazon Resource Name (ARN) of the SMB location to describe.

Request Lenses

describeLocationSmb_locationArn :: Lens' DescribeLocationSmb Text

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

Destructuring the Response

data DescribeLocationSmbResponse

DescribeLocationSmbResponse

See: newDescribeLocationSmbResponse smart constructor.

Constructors

DescribeLocationSmbResponse'

Fields

• agentArns :: Maybe (NonEmpty Text)

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

• creationTime :: Maybe POSIX

  The time that the SMB location was created.

• domain :: Maybe Text

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

• locationArn :: Maybe Text

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

• locationUri :: Maybe Text

  The URL of the source SMB location that was described.

• mountOptions :: Maybe SmbMountOptions

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

• user :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeLocationSmbResponse

Defined in Amazonka.DataSync.DescribeLocationSmb

Associated Types

type Rep DescribeLocationSmbResponse :: Type -> Type

Methods

from :: DescribeLocationSmbResponse -> Rep DescribeLocationSmbResponse x

to :: Rep DescribeLocationSmbResponse x -> DescribeLocationSmbResponse

Read DescribeLocationSmbResponse

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

readsPrec :: Int -> ReadS DescribeLocationSmbResponse

readList :: ReadS [DescribeLocationSmbResponse]

readPrec :: ReadPrec DescribeLocationSmbResponse

readListPrec :: ReadPrec [DescribeLocationSmbResponse]

Show DescribeLocationSmbResponse

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

showsPrec :: Int -> DescribeLocationSmbResponse -> ShowS

show :: DescribeLocationSmbResponse -> String

showList :: [DescribeLocationSmbResponse] -> ShowS

NFData DescribeLocationSmbResponse

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

rnf :: DescribeLocationSmbResponse -> ()

Eq DescribeLocationSmbResponse

Defined in Amazonka.DataSync.DescribeLocationSmb

Methods

(==) :: DescribeLocationSmbResponse -> DescribeLocationSmbResponse -> Bool

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

type Rep DescribeLocationSmbResponse

Defined in Amazonka.DataSync.DescribeLocationSmb

type Rep DescribeLocationSmbResponse = D1 ('MetaData "DescribeLocationSmbResponse" "Amazonka.DataSync.DescribeLocationSmb" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "DescribeLocationSmbResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "locationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SmbMountOptions))) :*: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeLocationSmbResponse

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:

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

$sel:creationTime:DescribeLocationSmbResponse', describeLocationSmbResponse_creationTime - The time that the SMB location was created.

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

DescribeLocationSmb, describeLocationSmbResponse_locationArn - The Amazon Resource Name (ARN) of the SMB location that was described.

DescribeLocationSmbResponse, describeLocationSmbResponse_locationUri - The URL of the source SMB location that was described.

DescribeLocationSmbResponse, describeLocationSmbResponse_mountOptions - The mount options that are available for DataSync to use to access an SMB location.

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

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

Response Lenses

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

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

describeLocationSmbResponse_creationTime :: Lens' DescribeLocationSmbResponse (Maybe UTCTime)

The time that the SMB location was created.

describeLocationSmbResponse_domain :: Lens' DescribeLocationSmbResponse (Maybe Text)

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

describeLocationSmbResponse_locationArn :: Lens' DescribeLocationSmbResponse (Maybe Text)

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

describeLocationSmbResponse_locationUri :: Lens' DescribeLocationSmbResponse (Maybe Text)

The URL of the source SMB location that was described.

describeLocationSmbResponse_mountOptions :: Lens' DescribeLocationSmbResponse (Maybe SmbMountOptions)

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

describeLocationSmbResponse_user :: Lens' DescribeLocationSmbResponse (Maybe Text)

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

describeLocationSmbResponse_httpStatus :: Lens' DescribeLocationSmbResponse Int

The response's http status code.