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.StorageGateway.DescribeSMBSettings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

Synopsis

Creating a Request

data DescribeSMBSettings Source #

See: newDescribeSMBSettings smart constructor.

Constructors

DescribeSMBSettings'
Fields gatewayARN :: Text

Instances

Instances details

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

newDescribeSMBSettings Source #

Arguments

:: Text	`$sel:gatewayARN:DescribeSMBSettings'`
-> DescribeSMBSettings

Create a value of DescribeSMBSettings 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:gatewayARN:DescribeSMBSettings', describeSMBSettings_gatewayARN - Undocumented member.

Request Lenses

describeSMBSettings_gatewayARN :: Lens' DescribeSMBSettings Text Source #

Undocumented member.

Destructuring the Response

data DescribeSMBSettingsResponse Source #

See: newDescribeSMBSettingsResponse smart constructor.

Constructors

DescribeSMBSettingsResponse'

Fields

gatewayARN :: Maybe Text
fileSharesVisible :: Maybe Bool
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
activeDirectoryStatus :: Maybe ActiveDirectoryStatus
Indicates the status of a gateway that is a member of the Active Directory domain.
- ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
- DETACHED: Indicates that gateway is not joined to a domain.
- JOINED: Indicates that the gateway has successfully joined a domain.
- JOINING: Indicates that a JoinDomain operation is in progress.
- NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
- TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
- UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.
domainName :: Maybe Text
The name of the domain that the gateway is joined to.
sMBLocalGroups :: Maybe SMBLocalGroups
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
sMBGuestPasswordSet :: Maybe Bool
This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.
Valid Values: true | false
sMBSecurityStrategy :: Maybe SMBSecurityStrategy
The type of security strategy that was specified for file gateway.
- ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.
- MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
- MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeSMBSettingsResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeSMBSettings Methods (==) :: DescribeSMBSettingsResponse -> DescribeSMBSettingsResponse -> Bool # (/=) :: DescribeSMBSettingsResponse -> DescribeSMBSettingsResponse -> Bool #
Read DescribeSMBSettingsResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeSMBSettings Methods readsPrec :: Int -> ReadS DescribeSMBSettingsResponse # readList :: ReadS [DescribeSMBSettingsResponse] # readPrec :: ReadPrec DescribeSMBSettingsResponse # readListPrec :: ReadPrec [DescribeSMBSettingsResponse] #
Show DescribeSMBSettingsResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeSMBSettings Methods showsPrec :: Int -> DescribeSMBSettingsResponse -> ShowS # show :: DescribeSMBSettingsResponse -> String # showList :: [DescribeSMBSettingsResponse] -> ShowS #
Generic DescribeSMBSettingsResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeSMBSettings Associated Types type Rep DescribeSMBSettingsResponse :: Type -> Type # Methods from :: DescribeSMBSettingsResponse -> Rep DescribeSMBSettingsResponse x # to :: Rep DescribeSMBSettingsResponse x -> DescribeSMBSettingsResponse #
NFData DescribeSMBSettingsResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeSMBSettings Methods rnf :: DescribeSMBSettingsResponse -> () #
type Rep DescribeSMBSettingsResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeSMBSettings type Rep DescribeSMBSettingsResponse = D1 ('MetaData "DescribeSMBSettingsResponse" "Amazonka.StorageGateway.DescribeSMBSettings" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DescribeSMBSettingsResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileSharesVisible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "activeDirectoryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActiveDirectoryStatus)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sMBLocalGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SMBLocalGroups)) :: S1 ('MetaSel ('Just "sMBGuestPasswordSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "sMBSecurityStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SMBSecurityStrategy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeSMBSettingsResponse Source #

Arguments

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

Create a value of DescribeSMBSettingsResponse 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:gatewayARN:DescribeSMBSettings', describeSMBSettingsResponse_gatewayARN - Undocumented member.

$sel:fileSharesVisible:DescribeSMBSettingsResponse', describeSMBSettingsResponse_fileSharesVisible - The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

$sel:activeDirectoryStatus:DescribeSMBSettingsResponse', describeSMBSettingsResponse_activeDirectoryStatus - Indicates the status of a gateway that is a member of the Active Directory domain.

ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
DETACHED: Indicates that gateway is not joined to a domain.
JOINED: Indicates that the gateway has successfully joined a domain.
JOINING: Indicates that a JoinDomain operation is in progress.
NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

$sel:domainName:DescribeSMBSettingsResponse', describeSMBSettingsResponse_domainName - The name of the domain that the gateway is joined to.

$sel:sMBLocalGroups:DescribeSMBSettingsResponse', describeSMBSettingsResponse_sMBLocalGroups - A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

$sel:sMBGuestPasswordSet:DescribeSMBSettingsResponse', describeSMBSettingsResponse_sMBGuestPasswordSet - This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

$sel:sMBSecurityStrategy:DescribeSMBSettingsResponse', describeSMBSettingsResponse_sMBSecurityStrategy - The type of security strategy that was specified for file gateway.

ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.
MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

$sel:httpStatus:DescribeSMBSettingsResponse', describeSMBSettingsResponse_httpStatus - The response's http status code.

Response Lenses

describeSMBSettingsResponse_gatewayARN :: Lens' DescribeSMBSettingsResponse (Maybe Text) Source #

Undocumented member.

describeSMBSettingsResponse_fileSharesVisible :: Lens' DescribeSMBSettingsResponse (Maybe Bool) Source #

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

describeSMBSettingsResponse_activeDirectoryStatus :: Lens' DescribeSMBSettingsResponse (Maybe ActiveDirectoryStatus) Source #

Indicates the status of a gateway that is a member of the Active Directory domain.

ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
DETACHED: Indicates that gateway is not joined to a domain.
JOINED: Indicates that the gateway has successfully joined a domain.
JOINING: Indicates that a JoinDomain operation is in progress.
NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

describeSMBSettingsResponse_domainName :: Lens' DescribeSMBSettingsResponse (Maybe Text) Source #

The name of the domain that the gateway is joined to.

describeSMBSettingsResponse_sMBLocalGroups :: Lens' DescribeSMBSettingsResponse (Maybe SMBLocalGroups) Source #

A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

describeSMBSettingsResponse_sMBGuestPasswordSet :: Lens' DescribeSMBSettingsResponse (Maybe Bool) Source #

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

describeSMBSettingsResponse_sMBSecurityStrategy :: Lens' DescribeSMBSettingsResponse (Maybe SMBSecurityStrategy) Source #

The type of security strategy that was specified for file gateway.

ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.
MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

describeSMBSettingsResponse_httpStatus :: Lens' DescribeSMBSettingsResponse Int Source #

The response's http status code.