Network.AWS.DirectoryService.EnableSSO

Enables single-sign on for a directory.

Creating a Request

enableSSO

Arguments

:: Text

esDirectoryId

-> EnableSSO

Creates a value of EnableSSO with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esUserName - The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name. If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
• esPassword - The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
• esDirectoryId - The identifier of the directory for which to enable single-sign on.

data EnableSSO

Contains the inputs for the EnableSso operation.

See: enableSSO smart constructor.

Instances

Eq EnableSSO

Methods

(==) :: EnableSSO -> EnableSSO -> Bool

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

Data EnableSSO

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnableSSO -> c EnableSSO

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnableSSO

toConstr :: EnableSSO -> Constr

dataTypeOf :: EnableSSO -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EnableSSO)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnableSSO)

gmapT :: (forall b. Data b => b -> b) -> EnableSSO -> EnableSSO

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnableSSO -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnableSSO -> r

gmapQ :: (forall d. Data d => d -> u) -> EnableSSO -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> EnableSSO -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnableSSO -> m EnableSSO

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnableSSO -> m EnableSSO

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnableSSO -> m EnableSSO

Read EnableSSO

Methods

readsPrec :: Int -> ReadS EnableSSO

readList :: ReadS [EnableSSO]

readPrec :: ReadPrec EnableSSO

readListPrec :: ReadPrec [EnableSSO]

Show EnableSSO

Methods

showsPrec :: Int -> EnableSSO -> ShowS

show :: EnableSSO -> String

showList :: [EnableSSO] -> ShowS

Generic EnableSSO

Associated Types

type Rep EnableSSO :: * -> *

Methods

from :: EnableSSO -> Rep EnableSSO x

to :: Rep EnableSSO x -> EnableSSO

Hashable EnableSSO

Methods

hashWithSalt :: Int -> EnableSSO -> Int

hash :: EnableSSO -> Int

ToJSON EnableSSO

Methods

toJSON :: EnableSSO -> Value

toEncoding :: EnableSSO -> Encoding

toJSONList :: [EnableSSO] -> Value

toEncodingList :: [EnableSSO] -> Encoding

NFData EnableSSO

Methods

rnf :: EnableSSO -> ()

AWSRequest EnableSSO

Associated Types

type Rs EnableSSO :: *

Methods

request :: EnableSSO -> Request EnableSSO

response :: MonadResource m => Logger -> Service -> Proxy * EnableSSO -> ClientResponse -> m (Response EnableSSO)

ToPath EnableSSO

Methods

toPath :: EnableSSO -> ByteString

ToHeaders EnableSSO

Methods

toHeaders :: EnableSSO -> [Header]

ToQuery EnableSSO

Methods

toQuery :: EnableSSO -> QueryString

type Rep EnableSSO

type Rep EnableSSO = D1 (MetaData "EnableSSO" "Network.AWS.DirectoryService.EnableSSO" "amazonka-ds-1.4.5-24h2k11yeH0J6s1sLl4Gzu" False) (C1 (MetaCons "EnableSSO'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_esUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_esPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_esDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs EnableSSO

type Rs EnableSSO = EnableSSOResponse

Request Lenses

esUserName :: Lens' EnableSSO (Maybe Text)

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name. If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

esPassword :: Lens' EnableSSO (Maybe Text)

The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

esDirectoryId :: Lens' EnableSSO Text

The identifier of the directory for which to enable single-sign on.

Destructuring the Response

enableSSOResponse

Arguments

:: Int

esrsResponseStatus

-> EnableSSOResponse

Creates a value of EnableSSOResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esrsResponseStatus - -- | The response status code.

data EnableSSOResponse

Contains the results of the EnableSso operation.

See: enableSSOResponse smart constructor.

Instances

Eq EnableSSOResponse

Methods

(==) :: EnableSSOResponse -> EnableSSOResponse -> Bool

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

Data EnableSSOResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnableSSOResponse -> c EnableSSOResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnableSSOResponse

toConstr :: EnableSSOResponse -> Constr

dataTypeOf :: EnableSSOResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EnableSSOResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnableSSOResponse)

gmapT :: (forall b. Data b => b -> b) -> EnableSSOResponse -> EnableSSOResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnableSSOResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnableSSOResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> EnableSSOResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> EnableSSOResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnableSSOResponse -> m EnableSSOResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnableSSOResponse -> m EnableSSOResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnableSSOResponse -> m EnableSSOResponse

Read EnableSSOResponse

Methods

readsPrec :: Int -> ReadS EnableSSOResponse

readList :: ReadS [EnableSSOResponse]

readPrec :: ReadPrec EnableSSOResponse

readListPrec :: ReadPrec [EnableSSOResponse]

Show EnableSSOResponse

Methods

showsPrec :: Int -> EnableSSOResponse -> ShowS

show :: EnableSSOResponse -> String

showList :: [EnableSSOResponse] -> ShowS

Generic EnableSSOResponse

Associated Types

type Rep EnableSSOResponse :: * -> *

Methods

from :: EnableSSOResponse -> Rep EnableSSOResponse x

to :: Rep EnableSSOResponse x -> EnableSSOResponse

NFData EnableSSOResponse

Methods

rnf :: EnableSSOResponse -> ()

type Rep EnableSSOResponse

type Rep EnableSSOResponse = D1 (MetaData "EnableSSOResponse" "Network.AWS.DirectoryService.EnableSSO" "amazonka-ds-1.4.5-24h2k11yeH0J6s1sLl4Gzu" True) (C1 (MetaCons "EnableSSOResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_esrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

esrsResponseStatus :: Lens' EnableSSOResponse Int

• - | The response status code.