diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,26 +8,27 @@ ## Version -`1.4.4` +`1.4.5` ## Description -AWS Directory Service - -This is the /AWS Directory Service API Reference/. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. - Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-ds) and the [AWS API Reference](https://aws.amazon.com/documentation/). The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka), -which provides mechanisms for specifying AuthN/AuthZ information and sending requests. +which provides mechanisms for specifying AuthN/AuthZ information, sending requests, +and receiving responses. -Use of lenses is required for constructing and manipulating types. -This is due to the amount of nesting of AWS types and transparency regarding +Lenses are used for constructing and manipulating types, +due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries [lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core). + +See [Network.AWS.DirectoryService](http://hackage.haskell.org/package/amazonka-ds/docs/Network-AWS-DirectoryService.html) +or [the AWS documentation](https://aws.amazon.com/documentation/) to get started. + ## Contribute diff --git a/amazonka-ds.cabal b/amazonka-ds.cabal --- a/amazonka-ds.cabal +++ b/amazonka-ds.cabal @@ -1,5 +1,5 @@ name: amazonka-ds -version: 1.4.4 +version: 1.4.5 synopsis: Amazon Directory Service SDK. homepage: https://github.com/brendanhay/amazonka bug-reports: https://github.com/brendanhay/amazonka/issues @@ -13,22 +13,19 @@ cabal-version: >= 1.10 extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep description: - AWS Directory Service - - This is the /AWS Directory Service API Reference/. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. - . The types from this library are intended to be used with , which provides - mechanisms for specifying AuthN/AuthZ information and sending requests. + mechanisms for specifying AuthN/AuthZ information, sending requests, + and receiving responses. . - Use of lenses is required for constructing and manipulating types. - This is due to the amount of nesting of AWS types and transparency regarding + Lenses are used for constructing and manipulating types, + due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries such as or . . - See "Network.AWS.DirectoryService" or + See "Network.AWS.DirectoryService" or to get started. source-repository head @@ -45,6 +42,7 @@ Network.AWS.DirectoryService , Network.AWS.DirectoryService.AddIPRoutes , Network.AWS.DirectoryService.AddTagsToResource + , Network.AWS.DirectoryService.CancelSchemaExtension , Network.AWS.DirectoryService.ConnectDirectory , Network.AWS.DirectoryService.CreateAlias , Network.AWS.DirectoryService.CreateComputer @@ -70,11 +68,13 @@ , Network.AWS.DirectoryService.GetDirectoryLimits , Network.AWS.DirectoryService.GetSnapshotLimits , Network.AWS.DirectoryService.ListIPRoutes + , Network.AWS.DirectoryService.ListSchemaExtensions , Network.AWS.DirectoryService.ListTagsForResource , Network.AWS.DirectoryService.RegisterEventTopic , Network.AWS.DirectoryService.RemoveIPRoutes , Network.AWS.DirectoryService.RemoveTagsFromResource , Network.AWS.DirectoryService.RestoreFromSnapshot + , Network.AWS.DirectoryService.StartSchemaExtension , Network.AWS.DirectoryService.Types , Network.AWS.DirectoryService.UpdateConditionalForwarder , Network.AWS.DirectoryService.UpdateRadius @@ -86,7 +86,7 @@ , Network.AWS.DirectoryService.Types.Sum build-depends: - amazonka-core == 1.4.4.* + amazonka-core == 1.4.5.* , base >= 4.7 && < 5 test-suite amazonka-ds-test @@ -106,9 +106,9 @@ , Test.AWS.DirectoryService.Internal build-depends: - amazonka-core == 1.4.4.* - , amazonka-test == 1.4.4.* - , amazonka-ds == 1.4.4.* + amazonka-core == 1.4.5.* + , amazonka-test == 1.4.5.* + , amazonka-ds == 1.4.5.* , base , bytestring , tasty diff --git a/fixture/CancelSchemaExtension.yaml b/fixture/CancelSchemaExtension.yaml new file mode 100644 --- /dev/null +++ b/fixture/CancelSchemaExtension.yaml diff --git a/fixture/CancelSchemaExtensionResponse.proto b/fixture/CancelSchemaExtensionResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/CancelSchemaExtensionResponse.proto diff --git a/fixture/ListSchemaExtensions.yaml b/fixture/ListSchemaExtensions.yaml new file mode 100644 --- /dev/null +++ b/fixture/ListSchemaExtensions.yaml diff --git a/fixture/ListSchemaExtensionsResponse.proto b/fixture/ListSchemaExtensionsResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/ListSchemaExtensionsResponse.proto diff --git a/fixture/StartSchemaExtension.yaml b/fixture/StartSchemaExtension.yaml new file mode 100644 --- /dev/null +++ b/fixture/StartSchemaExtension.yaml diff --git a/fixture/StartSchemaExtensionResponse.proto b/fixture/StartSchemaExtensionResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/StartSchemaExtensionResponse.proto diff --git a/gen/Network/AWS/DirectoryService.hs b/gen/Network/AWS/DirectoryService.hs --- a/gen/Network/AWS/DirectoryService.hs +++ b/gen/Network/AWS/DirectoryService.hs @@ -11,9 +11,10 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- AWS Directory Service +-- __AWS Directory Service__ -- --- This is the /AWS Directory Service API Reference/. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. +-- This is the /AWS Directory Service API Reference/ . This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. +-- module Network.AWS.DirectoryService ( -- * Service Configuration @@ -124,6 +125,9 @@ -- ** EnableSSO , module Network.AWS.DirectoryService.EnableSSO + -- ** CancelSchemaExtension + , module Network.AWS.DirectoryService.CancelSchemaExtension + -- ** EnableRadius , module Network.AWS.DirectoryService.EnableRadius @@ -133,6 +137,9 @@ -- ** AddTagsToResource , module Network.AWS.DirectoryService.AddTagsToResource + -- ** ListSchemaExtensions + , module Network.AWS.DirectoryService.ListSchemaExtensions + -- ** DisableRadius , module Network.AWS.DirectoryService.DisableRadius @@ -148,6 +155,9 @@ -- ** DeleteSnapshot , module Network.AWS.DirectoryService.DeleteSnapshot + -- ** StartSchemaExtension + , module Network.AWS.DirectoryService.StartSchemaExtension + -- ** CreateTrust , module Network.AWS.DirectoryService.CreateTrust @@ -198,6 +208,9 @@ -- ** ReplicationScope , ReplicationScope (..) + -- ** SchemaExtensionStatus + , SchemaExtensionStatus (..) + -- ** SnapshotStatus , SnapshotStatus (..) @@ -315,7 +328,7 @@ -- ** IPRoute , IPRoute , ipRoute - , irCIdRIP + , irCidrIP , irDescription -- ** IPRouteInfo @@ -324,7 +337,7 @@ , iriDirectoryId , iriIPRouteStatusReason , iriAddedDateTime - , iriCIdRIP + , iriCidrIP , iriIPRouteStatusMsg , iriDescription @@ -340,6 +353,17 @@ , rsRadiusTimeout , rsRadiusPort + -- ** SchemaExtensionInfo + , SchemaExtensionInfo + , schemaExtensionInfo + , seiDirectoryId + , seiSchemaExtensionId + , seiSchemaExtensionStatusReason + , seiSchemaExtensionStatus + , seiDescription + , seiEndDateTime + , seiStartDateTime + -- ** Snapshot , Snapshot , snapshot @@ -380,6 +404,7 @@ import Network.AWS.DirectoryService.AddIPRoutes import Network.AWS.DirectoryService.AddTagsToResource +import Network.AWS.DirectoryService.CancelSchemaExtension import Network.AWS.DirectoryService.ConnectDirectory import Network.AWS.DirectoryService.CreateAlias import Network.AWS.DirectoryService.CreateComputer @@ -405,11 +430,13 @@ import Network.AWS.DirectoryService.GetDirectoryLimits import Network.AWS.DirectoryService.GetSnapshotLimits import Network.AWS.DirectoryService.ListIPRoutes +import Network.AWS.DirectoryService.ListSchemaExtensions import Network.AWS.DirectoryService.ListTagsForResource import Network.AWS.DirectoryService.RegisterEventTopic import Network.AWS.DirectoryService.RemoveIPRoutes import Network.AWS.DirectoryService.RemoveTagsFromResource import Network.AWS.DirectoryService.RestoreFromSnapshot +import Network.AWS.DirectoryService.StartSchemaExtension import Network.AWS.DirectoryService.Types import Network.AWS.DirectoryService.UpdateConditionalForwarder import Network.AWS.DirectoryService.UpdateRadius diff --git a/gen/Network/AWS/DirectoryService/AddIPRoutes.hs b/gen/Network/AWS/DirectoryService/AddIPRoutes.hs --- a/gen/Network/AWS/DirectoryService/AddIPRoutes.hs +++ b/gen/Network/AWS/DirectoryService/AddIPRoutes.hs @@ -19,6 +19,10 @@ -- Portability : non-portable (GHC extensions) -- -- If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. /AddIpRoutes/ adds this address block. You can also use /AddIpRoutes/ to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. +-- +-- +-- Before you call /AddIpRoutes/ , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the /AddIpRoutes/ operation, see . +-- module Network.AWS.DirectoryService.AddIPRoutes ( -- * Creating a Request @@ -54,11 +58,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'airUpdateSecurityGroupForDirectoryControllers' +-- * 'airUpdateSecurityGroupForDirectoryControllers' - If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for /directory ID/ directory controllers." Following are the new rules: Inbound: * Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0 * Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0 * Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0 * Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0 * Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0 Outbound: * Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0 These security rules impact an internal network interface that is not exposed publicly. -- --- * 'airDirectoryId' +-- * 'airDirectoryId' - Identifier (ID) of the directory to which to add the address block. -- --- * 'airIPRoutes' +-- * 'airIPRoutes' - IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain. addIPRoutes :: Text -- ^ 'airDirectoryId' -> AddIPRoutes @@ -69,49 +73,7 @@ , _airIPRoutes = mempty } --- | If set to true, updates the inbound and outbound rules of the security group that has the description: \"AWS created security group for /directory ID/ directory controllers.\" Following are the new rules: --- --- Inbound: --- --- - Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0\/0 --- --- - Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0\/0 --- --- - Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0\/0 --- --- - Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0\/0 --- --- - Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0\/0 --- --- - Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0\/0 --- --- - Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0\/0 --- --- - Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0\/0 --- --- - Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0\/0 --- --- - Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0\/0 --- --- - Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0\/0 --- --- - Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0\/0 --- --- - Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0\/0 --- --- - Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0\/0 --- --- - Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0\/0 --- --- - Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0\/0 --- --- - Type: All ICMP, Protocol: All, Range: N\/A, Source: 0.0.0.0\/0 --- --- Outbound: --- --- - Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0\/0 --- --- These security rules impact an internal network interface that is not exposed publicly. +-- | If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for /directory ID/ directory controllers." Following are the new rules: Inbound: * Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0 * Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0 * Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0 * Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0 * Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0 * Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0 * Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0 Outbound: * Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0 These security rules impact an internal network interface that is not exposed publicly. airUpdateSecurityGroupForDirectoryControllers :: Lens' AddIPRoutes (Maybe Bool) airUpdateSecurityGroupForDirectoryControllers = lens _airUpdateSecurityGroupForDirectoryControllers (\ s a -> s{_airUpdateSecurityGroupForDirectoryControllers = a}); @@ -169,7 +131,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'airrsResponseStatus' +-- * 'airrsResponseStatus' - -- | The response status code. addIPRoutesResponse :: Int -- ^ 'airrsResponseStatus' -> AddIPRoutesResponse @@ -178,7 +140,7 @@ { _airrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. airrsResponseStatus :: Lens' AddIPRoutesResponse Int airrsResponseStatus = lens _airrsResponseStatus (\ s a -> s{_airrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/AddTagsToResource.hs b/gen/Network/AWS/DirectoryService/AddTagsToResource.hs --- a/gen/Network/AWS/DirectoryService/AddTagsToResource.hs +++ b/gen/Network/AWS/DirectoryService/AddTagsToResource.hs @@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- Adds or overwrites one or more tags for the specified Amazon Directory Services directory. Each directory can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource. +-- Adds or overwrites one or more tags for the specified Amazon Directory Services directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource. +-- +-- module Network.AWS.DirectoryService.AddTagsToResource ( -- * Creating a Request @@ -52,9 +54,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'attrResourceId' +-- * 'attrResourceId' - Identifier (ID) for the directory to which to add the tag. -- --- * 'attrTags' +-- * 'attrTags' - The tags to be assigned to the Amazon Directory Services directory. addTagsToResource :: Text -- ^ 'attrResourceId' -> AddTagsToResource @@ -116,7 +118,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'attrrsResponseStatus' +-- * 'attrrsResponseStatus' - -- | The response status code. addTagsToResourceResponse :: Int -- ^ 'attrrsResponseStatus' -> AddTagsToResourceResponse @@ -125,7 +127,7 @@ { _attrrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. attrrsResponseStatus :: Lens' AddTagsToResourceResponse Int attrrsResponseStatus = lens _attrrsResponseStatus (\ s a -> s{_attrrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CancelSchemaExtension.hs b/gen/Network/AWS/DirectoryService/CancelSchemaExtension.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DirectoryService/CancelSchemaExtension.hs @@ -0,0 +1,137 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DirectoryService.CancelSchemaExtension +-- Copyright : (c) 2013-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; @Initializing@ , @CreatingSnapshot@ , and @UpdatingSchema@ . +-- +-- +module Network.AWS.DirectoryService.CancelSchemaExtension + ( + -- * Creating a Request + cancelSchemaExtension + , CancelSchemaExtension + -- * Request Lenses + , cseDirectoryId + , cseSchemaExtensionId + + -- * Destructuring the Response + , cancelSchemaExtensionResponse + , CancelSchemaExtensionResponse + -- * Response Lenses + , csersResponseStatus + ) where + +import Network.AWS.DirectoryService.Types +import Network.AWS.DirectoryService.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'cancelSchemaExtension' smart constructor. +data CancelSchemaExtension = CancelSchemaExtension' + { _cseDirectoryId :: !Text + , _cseSchemaExtensionId :: !Text + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'CancelSchemaExtension' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cseDirectoryId' - The identifier of the directory whose schema extension will be canceled. +-- +-- * 'cseSchemaExtensionId' - The identifier of the schema extension that will be canceled. +cancelSchemaExtension + :: Text -- ^ 'cseDirectoryId' + -> Text -- ^ 'cseSchemaExtensionId' + -> CancelSchemaExtension +cancelSchemaExtension pDirectoryId_ pSchemaExtensionId_ = + CancelSchemaExtension' + { _cseDirectoryId = pDirectoryId_ + , _cseSchemaExtensionId = pSchemaExtensionId_ + } + +-- | The identifier of the directory whose schema extension will be canceled. +cseDirectoryId :: Lens' CancelSchemaExtension Text +cseDirectoryId = lens _cseDirectoryId (\ s a -> s{_cseDirectoryId = a}); + +-- | The identifier of the schema extension that will be canceled. +cseSchemaExtensionId :: Lens' CancelSchemaExtension Text +cseSchemaExtensionId = lens _cseSchemaExtensionId (\ s a -> s{_cseSchemaExtensionId = a}); + +instance AWSRequest CancelSchemaExtension where + type Rs CancelSchemaExtension = + CancelSchemaExtensionResponse + request = postJSON directoryService + response + = receiveEmpty + (\ s h x -> + CancelSchemaExtensionResponse' <$> + (pure (fromEnum s))) + +instance Hashable CancelSchemaExtension + +instance NFData CancelSchemaExtension + +instance ToHeaders CancelSchemaExtension where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DirectoryService_20150416.CancelSchemaExtension" :: + ByteString), + "Content-Type" =# + ("application/x-amz-json-1.1" :: ByteString)]) + +instance ToJSON CancelSchemaExtension where + toJSON CancelSchemaExtension'{..} + = object + (catMaybes + [Just ("DirectoryId" .= _cseDirectoryId), + Just ("SchemaExtensionId" .= _cseSchemaExtensionId)]) + +instance ToPath CancelSchemaExtension where + toPath = const "/" + +instance ToQuery CancelSchemaExtension where + toQuery = const mempty + +-- | /See:/ 'cancelSchemaExtensionResponse' smart constructor. +newtype CancelSchemaExtensionResponse = CancelSchemaExtensionResponse' + { _csersResponseStatus :: Int + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'CancelSchemaExtensionResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'csersResponseStatus' - -- | The response status code. +cancelSchemaExtensionResponse + :: Int -- ^ 'csersResponseStatus' + -> CancelSchemaExtensionResponse +cancelSchemaExtensionResponse pResponseStatus_ = + CancelSchemaExtensionResponse' + { _csersResponseStatus = pResponseStatus_ + } + +-- | -- | The response status code. +csersResponseStatus :: Lens' CancelSchemaExtensionResponse Int +csersResponseStatus = lens _csersResponseStatus (\ s a -> s{_csersResponseStatus = a}); + +instance NFData CancelSchemaExtensionResponse diff --git a/gen/Network/AWS/DirectoryService/ConnectDirectory.hs b/gen/Network/AWS/DirectoryService/ConnectDirectory.hs --- a/gen/Network/AWS/DirectoryService/ConnectDirectory.hs +++ b/gen/Network/AWS/DirectoryService/ConnectDirectory.hs @@ -19,6 +19,10 @@ -- Portability : non-portable (GHC extensions) -- -- Creates an AD Connector to connect to an on-premises directory. +-- +-- +-- Before you call /ConnectDirectory/ , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the /ConnectDirectory/ operation, see . +-- module Network.AWS.DirectoryService.ConnectDirectory ( -- * Creating a Request @@ -47,8 +51,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < ConnectDirectory> operation. +-- | Contains the inputs for the 'ConnectDirectory' operation. -- +-- +-- -- /See:/ 'connectDirectory' smart constructor. data ConnectDirectory = ConnectDirectory' { _cdShortName :: !(Maybe Text) @@ -63,17 +69,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cdShortName' +-- * 'cdShortName' - The NetBIOS name of the on-premises directory, such as @CORP@ . -- --- * 'cdDescription' +-- * 'cdDescription' - A textual description for the directory. -- --- * 'cdName' +-- * 'cdName' - The fully-qualified name of the on-premises directory, such as @corp.example.com@ . -- --- * 'cdPassword' +-- * 'cdPassword' - The password for the on-premises user account. -- --- * 'cdSize' +-- * 'cdSize' - The size of the directory. -- --- * 'cdConnectSettings' +-- * 'cdConnectSettings' - A 'DirectoryConnectSettings' object that contains additional information for the operation. connectDirectory :: Text -- ^ 'cdName' -> Text -- ^ 'cdPassword' @@ -90,7 +96,7 @@ , _cdConnectSettings = pConnectSettings_ } --- | The NetBIOS name of the on-premises directory, such as 'CORP'. +-- | The NetBIOS name of the on-premises directory, such as @CORP@ . cdShortName :: Lens' ConnectDirectory (Maybe Text) cdShortName = lens _cdShortName (\ s a -> s{_cdShortName = a}); @@ -98,7 +104,7 @@ cdDescription :: Lens' ConnectDirectory (Maybe Text) cdDescription = lens _cdDescription (\ s a -> s{_cdDescription = a}); --- | The fully-qualified name of the on-premises directory, such as 'corp.example.com'. +-- | The fully-qualified name of the on-premises directory, such as @corp.example.com@ . cdName :: Lens' ConnectDirectory Text cdName = lens _cdName (\ s a -> s{_cdName = a}); @@ -110,7 +116,7 @@ cdSize :: Lens' ConnectDirectory DirectorySize cdSize = lens _cdSize (\ s a -> s{_cdSize = a}); --- | A < DirectoryConnectSettings> object that contains additional information for the operation. +-- | A 'DirectoryConnectSettings' object that contains additional information for the operation. cdConnectSettings :: Lens' ConnectDirectory DirectoryConnectSettings cdConnectSettings = lens _cdConnectSettings (\ s a -> s{_cdConnectSettings = a}); @@ -154,8 +160,10 @@ instance ToQuery ConnectDirectory where toQuery = const mempty --- | Contains the results of the < ConnectDirectory> operation. +-- | Contains the results of the 'ConnectDirectory' operation. -- +-- +-- -- /See:/ 'connectDirectoryResponse' smart constructor. data ConnectDirectoryResponse = ConnectDirectoryResponse' { _cdrsDirectoryId :: !(Maybe Text) @@ -166,9 +174,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cdrsDirectoryId' +-- * 'cdrsDirectoryId' - The identifier of the new directory. -- --- * 'cdrsResponseStatus' +-- * 'cdrsResponseStatus' - -- | The response status code. connectDirectoryResponse :: Int -- ^ 'cdrsResponseStatus' -> ConnectDirectoryResponse @@ -182,7 +190,7 @@ cdrsDirectoryId :: Lens' ConnectDirectoryResponse (Maybe Text) cdrsDirectoryId = lens _cdrsDirectoryId (\ s a -> s{_cdrsDirectoryId = a}); --- | The response status code. +-- | -- | The response status code. cdrsResponseStatus :: Lens' ConnectDirectoryResponse Int cdrsResponseStatus = lens _cdrsResponseStatus (\ s a -> s{_cdrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CreateAlias.hs b/gen/Network/AWS/DirectoryService/CreateAlias.hs --- a/gen/Network/AWS/DirectoryService/CreateAlias.hs +++ b/gen/Network/AWS/DirectoryService/CreateAlias.hs @@ -18,9 +18,11 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as 'http:\/\/\.awsapps.com'. +-- Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as @http://.awsapps.com@ . -- --- After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. +-- +-- /Important:/ After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. +-- module Network.AWS.DirectoryService.CreateAlias ( -- * Creating a Request @@ -46,8 +48,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < CreateAlias> operation. +-- | Contains the inputs for the 'CreateAlias' operation. -- +-- +-- -- /See:/ 'createAlias' smart constructor. data CreateAlias = CreateAlias' { _caDirectoryId :: !Text @@ -58,9 +62,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'caDirectoryId' +-- * 'caDirectoryId' - The identifier of the directory for which to create the alias. -- --- * 'caAlias' +-- * 'caAlias' - The requested alias. The alias must be unique amongst all aliases in AWS. This operation throws an @EntityAlreadyExistsException@ error if the alias already exists. createAlias :: Text -- ^ 'caDirectoryId' -> Text -- ^ 'caAlias' @@ -75,9 +79,7 @@ caDirectoryId :: Lens' CreateAlias Text caDirectoryId = lens _caDirectoryId (\ s a -> s{_caDirectoryId = a}); --- | The requested alias. --- --- The alias must be unique amongst all aliases in AWS. This operation throws an 'EntityAlreadyExistsException' error if the alias already exists. +-- | The requested alias. The alias must be unique amongst all aliases in AWS. This operation throws an @EntityAlreadyExistsException@ error if the alias already exists. caAlias :: Lens' CreateAlias Text caAlias = lens _caAlias (\ s a -> s{_caAlias = a}); @@ -118,8 +120,10 @@ instance ToQuery CreateAlias where toQuery = const mempty --- | Contains the results of the < CreateAlias> operation. +-- | Contains the results of the 'CreateAlias' operation. -- +-- +-- -- /See:/ 'createAliasResponse' smart constructor. data CreateAliasResponse = CreateAliasResponse' { _carsDirectoryId :: !(Maybe Text) @@ -131,11 +135,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'carsDirectoryId' +-- * 'carsDirectoryId' - The identifier of the directory. -- --- * 'carsAlias' +-- * 'carsAlias' - The alias for the directory. -- --- * 'carsResponseStatus' +-- * 'carsResponseStatus' - -- | The response status code. createAliasResponse :: Int -- ^ 'carsResponseStatus' -> CreateAliasResponse @@ -154,7 +158,7 @@ carsAlias :: Lens' CreateAliasResponse (Maybe Text) carsAlias = lens _carsAlias (\ s a -> s{_carsAlias = a}); --- | The response status code. +-- | -- | The response status code. carsResponseStatus :: Lens' CreateAliasResponse Int carsResponseStatus = lens _carsResponseStatus (\ s a -> s{_carsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CreateComputer.hs b/gen/Network/AWS/DirectoryService/CreateComputer.hs --- a/gen/Network/AWS/DirectoryService/CreateComputer.hs +++ b/gen/Network/AWS/DirectoryService/CreateComputer.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Creates a computer account in the specified directory, and joins the computer to the directory. +-- +-- module Network.AWS.DirectoryService.CreateComputer ( -- * Creating a Request @@ -46,8 +48,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < CreateComputer> operation. +-- | Contains the inputs for the 'CreateComputer' operation. -- +-- +-- -- /See:/ 'createComputer' smart constructor. data CreateComputer = CreateComputer' { _ccComputerAttributes :: !(Maybe [Attribute]) @@ -61,15 +65,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ccComputerAttributes' +-- * 'ccComputerAttributes' - An array of 'Attribute' objects that contain any LDAP attributes to apply to the computer account. -- --- * 'ccOrganizationalUnitDistinguishedName' +-- * 'ccOrganizationalUnitDistinguishedName' - The fully-qualified distinguished name of the organizational unit to place the computer account in. -- --- * 'ccDirectoryId' +-- * 'ccDirectoryId' - The identifier of the directory in which to create the computer account. -- --- * 'ccComputerName' +-- * 'ccComputerName' - The name of the computer account. -- --- * 'ccPassword' +-- * 'ccPassword' - A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter. createComputer :: Text -- ^ 'ccDirectoryId' -> Text -- ^ 'ccComputerName' @@ -84,7 +88,7 @@ , _ccPassword = _Sensitive # pPassword_ } --- | An array of < Attribute> objects that contain any LDAP attributes to apply to the computer account. +-- | An array of 'Attribute' objects that contain any LDAP attributes to apply to the computer account. ccComputerAttributes :: Lens' CreateComputer [Attribute] ccComputerAttributes = lens _ccComputerAttributes (\ s a -> s{_ccComputerAttributes = a}) . _Default . _Coerce; @@ -144,8 +148,10 @@ instance ToQuery CreateComputer where toQuery = const mempty --- | Contains the results for the < CreateComputer> operation. +-- | Contains the results for the 'CreateComputer' operation. -- +-- +-- -- /See:/ 'createComputerResponse' smart constructor. data CreateComputerResponse = CreateComputerResponse' { _ccrsComputer :: !(Maybe Computer) @@ -156,9 +162,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ccrsComputer' +-- * 'ccrsComputer' - A 'Computer' object that represents the computer account. -- --- * 'ccrsResponseStatus' +-- * 'ccrsResponseStatus' - -- | The response status code. createComputerResponse :: Int -- ^ 'ccrsResponseStatus' -> CreateComputerResponse @@ -168,11 +174,11 @@ , _ccrsResponseStatus = pResponseStatus_ } --- | A < Computer> object that represents the computer account. +-- | A 'Computer' object that represents the computer account. ccrsComputer :: Lens' CreateComputerResponse (Maybe Computer) ccrsComputer = lens _ccrsComputer (\ s a -> s{_ccrsComputer = a}); --- | The response status code. +-- | -- | The response status code. ccrsResponseStatus :: Lens' CreateComputerResponse Int ccrsResponseStatus = lens _ccrsResponseStatus (\ s a -> s{_ccrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CreateConditionalForwarder.hs b/gen/Network/AWS/DirectoryService/CreateConditionalForwarder.hs --- a/gen/Network/AWS/DirectoryService/CreateConditionalForwarder.hs +++ b/gen/Network/AWS/DirectoryService/CreateConditionalForwarder.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain. +-- +-- module Network.AWS.DirectoryService.CreateConditionalForwarder ( -- * Creating a Request @@ -45,6 +47,8 @@ -- | Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain. -- +-- +-- -- /See:/ 'createConditionalForwarder' smart constructor. data CreateConditionalForwarder = CreateConditionalForwarder' { _ccfDirectoryId :: !Text @@ -56,11 +60,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ccfDirectoryId' +-- * 'ccfDirectoryId' - The directory ID of the AWS directory for which you are creating the conditional forwarder. -- --- * 'ccfRemoteDomainName' +-- * 'ccfRemoteDomainName' - The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship. -- --- * 'ccfDNSIPAddrs' +-- * 'ccfDNSIPAddrs' - The IP addresses of the remote DNS server associated with RemoteDomainName. createConditionalForwarder :: Text -- ^ 'ccfDirectoryId' -> Text -- ^ 'ccfRemoteDomainName' @@ -124,6 +128,8 @@ -- | The result of a CreateConditinalForwarder request. -- +-- +-- -- /See:/ 'createConditionalForwarderResponse' smart constructor. newtype CreateConditionalForwarderResponse = CreateConditionalForwarderResponse' { _ccfrsResponseStatus :: Int @@ -133,7 +139,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ccfrsResponseStatus' +-- * 'ccfrsResponseStatus' - -- | The response status code. createConditionalForwarderResponse :: Int -- ^ 'ccfrsResponseStatus' -> CreateConditionalForwarderResponse @@ -142,7 +148,7 @@ { _ccfrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. ccfrsResponseStatus :: Lens' CreateConditionalForwarderResponse Int ccfrsResponseStatus = lens _ccfrsResponseStatus (\ s a -> s{_ccfrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CreateDirectory.hs b/gen/Network/AWS/DirectoryService/CreateDirectory.hs --- a/gen/Network/AWS/DirectoryService/CreateDirectory.hs +++ b/gen/Network/AWS/DirectoryService/CreateDirectory.hs @@ -19,6 +19,10 @@ -- Portability : non-portable (GHC extensions) -- -- Creates a Simple AD directory. +-- +-- +-- Before you call /CreateDirectory/ , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the /CreateDirectory/ operation, see . +-- module Network.AWS.DirectoryService.CreateDirectory ( -- * Creating a Request @@ -47,8 +51,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < CreateDirectory> operation. +-- | Contains the inputs for the 'CreateDirectory' operation. -- +-- +-- -- /See:/ 'createDirectory' smart constructor. data CreateDirectory = CreateDirectory' { _cShortName :: !(Maybe Text) @@ -63,17 +69,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cShortName' +-- * 'cShortName' - The short name of the directory, such as @CORP@ . -- --- * 'cVPCSettings' +-- * 'cVPCSettings' - A 'DirectoryVpcSettings' object that contains additional information for the operation. -- --- * 'cDescription' +-- * 'cDescription' - A textual description for the directory. -- --- * 'cName' +-- * 'cName' - The fully qualified name for the directory, such as @corp.example.com@ . -- --- * 'cPassword' +-- * 'cPassword' - The password for the directory administrator. The directory creation process creates a directory administrator account with the username @Administrator@ and this password. -- --- * 'cSize' +-- * 'cSize' - The size of the directory. createDirectory :: Text -- ^ 'cName' -> Text -- ^ 'cPassword' @@ -89,11 +95,11 @@ , _cSize = pSize_ } --- | The short name of the directory, such as 'CORP'. +-- | The short name of the directory, such as @CORP@ . cShortName :: Lens' CreateDirectory (Maybe Text) cShortName = lens _cShortName (\ s a -> s{_cShortName = a}); --- | A < DirectoryVpcSettings> object that contains additional information for the operation. +-- | A 'DirectoryVpcSettings' object that contains additional information for the operation. cVPCSettings :: Lens' CreateDirectory (Maybe DirectoryVPCSettings) cVPCSettings = lens _cVPCSettings (\ s a -> s{_cVPCSettings = a}); @@ -101,11 +107,11 @@ cDescription :: Lens' CreateDirectory (Maybe Text) cDescription = lens _cDescription (\ s a -> s{_cDescription = a}); --- | The fully qualified name for the directory, such as 'corp.example.com'. +-- | The fully qualified name for the directory, such as @corp.example.com@ . cName :: Lens' CreateDirectory Text cName = lens _cName (\ s a -> s{_cName = a}); --- | The password for the directory administrator. The directory creation process creates a directory administrator account with the username 'Administrator' and this password. +-- | The password for the directory administrator. The directory creation process creates a directory administrator account with the username @Administrator@ and this password. cPassword :: Lens' CreateDirectory Text cPassword = lens _cPassword (\ s a -> s{_cPassword = a}) . _Sensitive; @@ -153,8 +159,10 @@ instance ToQuery CreateDirectory where toQuery = const mempty --- | Contains the results of the < CreateDirectory> operation. +-- | Contains the results of the 'CreateDirectory' operation. -- +-- +-- -- /See:/ 'createDirectoryResponse' smart constructor. data CreateDirectoryResponse = CreateDirectoryResponse' { _crsDirectoryId :: !(Maybe Text) @@ -165,9 +173,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'crsDirectoryId' +-- * 'crsDirectoryId' - The identifier of the directory that was created. -- --- * 'crsResponseStatus' +-- * 'crsResponseStatus' - -- | The response status code. createDirectoryResponse :: Int -- ^ 'crsResponseStatus' -> CreateDirectoryResponse @@ -181,7 +189,7 @@ crsDirectoryId :: Lens' CreateDirectoryResponse (Maybe Text) crsDirectoryId = lens _crsDirectoryId (\ s a -> s{_crsDirectoryId = a}); --- | The response status code. +-- | -- | The response status code. crsResponseStatus :: Lens' CreateDirectoryResponse Int crsResponseStatus = lens _crsResponseStatus (\ s a -> s{_crsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CreateMicrosoftAD.hs b/gen/Network/AWS/DirectoryService/CreateMicrosoftAD.hs --- a/gen/Network/AWS/DirectoryService/CreateMicrosoftAD.hs +++ b/gen/Network/AWS/DirectoryService/CreateMicrosoftAD.hs @@ -19,6 +19,10 @@ -- Portability : non-portable (GHC extensions) -- -- Creates a Microsoft AD in the AWS cloud. +-- +-- +-- Before you call /CreateMicrosoftAD/ , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the /CreateMicrosoftAD/ operation, see . +-- module Network.AWS.DirectoryService.CreateMicrosoftAD ( -- * Creating a Request @@ -48,6 +52,8 @@ -- | Creates a Microsoft AD in the AWS cloud. -- +-- +-- -- /See:/ 'createMicrosoftAD' smart constructor. data CreateMicrosoftAD = CreateMicrosoftAD' { _cmadShortName :: !(Maybe Text) @@ -61,15 +67,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cmadShortName' +-- * 'cmadShortName' - The NetBIOS name for your domain. A short identifier for your domain, such as @CORP@ . If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, @CORP@ for the directory DNS @corp.example.com@ . -- --- * 'cmadDescription' +-- * 'cmadDescription' - A textual description for the directory. This label will appear on the AWS console @Directory Details@ page after the directory is created. -- --- * 'cmadName' +-- * 'cmadName' - The fully qualified domain name for the directory, such as @corp.example.com@ . This name will resolve inside your VPC only. It does not need to be publicly resolvable. -- --- * 'cmadPassword' +-- * 'cmadPassword' - The password for the default administrative user named @Admin@ . -- --- * 'cmadVPCSettings' +-- * 'cmadVPCSettings' - Undocumented member. createMicrosoftAD :: Text -- ^ 'cmadName' -> Text -- ^ 'cmadPassword' @@ -84,19 +90,19 @@ , _cmadVPCSettings = pVPCSettings_ } --- | The NetBIOS name for your domain. A short identifier for your domain, such as 'CORP'. If you don\'t specify a NetBIOS name, it will default to the first part of your directory DNS. For example, 'CORP' for the directory DNS 'corp.example.com'. +-- | The NetBIOS name for your domain. A short identifier for your domain, such as @CORP@ . If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, @CORP@ for the directory DNS @corp.example.com@ . cmadShortName :: Lens' CreateMicrosoftAD (Maybe Text) cmadShortName = lens _cmadShortName (\ s a -> s{_cmadShortName = a}); --- | A textual description for the directory. This label will appear on the AWS console 'Directory Details' page after the directory is created. +-- | A textual description for the directory. This label will appear on the AWS console @Directory Details@ page after the directory is created. cmadDescription :: Lens' CreateMicrosoftAD (Maybe Text) cmadDescription = lens _cmadDescription (\ s a -> s{_cmadDescription = a}); --- | The fully qualified domain name for the directory, such as 'corp.example.com'. This name will resolve inside your VPC only. It does not need to be publicly resolvable. +-- | The fully qualified domain name for the directory, such as @corp.example.com@ . This name will resolve inside your VPC only. It does not need to be publicly resolvable. cmadName :: Lens' CreateMicrosoftAD Text cmadName = lens _cmadName (\ s a -> s{_cmadName = a}); --- | The password for the default administrative user named 'Admin'. +-- | The password for the default administrative user named @Admin@ . cmadPassword :: Lens' CreateMicrosoftAD Text cmadPassword = lens _cmadPassword (\ s a -> s{_cmadPassword = a}) . _Sensitive; @@ -145,6 +151,8 @@ -- | Result of a CreateMicrosoftAD request. -- +-- +-- -- /See:/ 'createMicrosoftADResponse' smart constructor. data CreateMicrosoftADResponse = CreateMicrosoftADResponse' { _cmadrsDirectoryId :: !(Maybe Text) @@ -155,9 +163,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cmadrsDirectoryId' +-- * 'cmadrsDirectoryId' - The identifier of the directory that was created. -- --- * 'cmadrsResponseStatus' +-- * 'cmadrsResponseStatus' - -- | The response status code. createMicrosoftADResponse :: Int -- ^ 'cmadrsResponseStatus' -> CreateMicrosoftADResponse @@ -171,7 +179,7 @@ cmadrsDirectoryId :: Lens' CreateMicrosoftADResponse (Maybe Text) cmadrsDirectoryId = lens _cmadrsDirectoryId (\ s a -> s{_cmadrsDirectoryId = a}); --- | The response status code. +-- | -- | The response status code. cmadrsResponseStatus :: Lens' CreateMicrosoftADResponse Int cmadrsResponseStatus = lens _cmadrsResponseStatus (\ s a -> s{_cmadrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CreateSnapshot.hs b/gen/Network/AWS/DirectoryService/CreateSnapshot.hs --- a/gen/Network/AWS/DirectoryService/CreateSnapshot.hs +++ b/gen/Network/AWS/DirectoryService/CreateSnapshot.hs @@ -20,7 +20,7 @@ -- -- Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. -- --- You cannot take snapshots of AD Connector directories. +-- module Network.AWS.DirectoryService.CreateSnapshot ( -- * Creating a Request @@ -45,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < CreateSnapshot> operation. +-- | Contains the inputs for the 'CreateSnapshot' operation. -- +-- +-- -- /See:/ 'createSnapshot' smart constructor. data CreateSnapshot = CreateSnapshot' { _csName :: !(Maybe Text) @@ -57,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'csName' +-- * 'csName' - The descriptive name to apply to the snapshot. -- --- * 'csDirectoryId' +-- * 'csDirectoryId' - The identifier of the directory of which to take a snapshot. createSnapshot :: Text -- ^ 'csDirectoryId' -> CreateSnapshot @@ -113,8 +115,10 @@ instance ToQuery CreateSnapshot where toQuery = const mempty --- | Contains the results of the < CreateSnapshot> operation. +-- | Contains the results of the 'CreateSnapshot' operation. -- +-- +-- -- /See:/ 'createSnapshotResponse' smart constructor. data CreateSnapshotResponse = CreateSnapshotResponse' { _csrsSnapshotId :: !(Maybe Text) @@ -125,9 +129,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'csrsSnapshotId' +-- * 'csrsSnapshotId' - The identifier of the snapshot that was created. -- --- * 'csrsResponseStatus' +-- * 'csrsResponseStatus' - -- | The response status code. createSnapshotResponse :: Int -- ^ 'csrsResponseStatus' -> CreateSnapshotResponse @@ -141,7 +145,7 @@ csrsSnapshotId :: Lens' CreateSnapshotResponse (Maybe Text) csrsSnapshotId = lens _csrsSnapshotId (\ s a -> s{_csrsSnapshotId = a}); --- | The response status code. +-- | -- | The response status code. csrsResponseStatus :: Lens' CreateSnapshotResponse Int csrsResponseStatus = lens _csrsResponseStatus (\ s a -> s{_csrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/CreateTrust.hs b/gen/Network/AWS/DirectoryService/CreateTrust.hs --- a/gen/Network/AWS/DirectoryService/CreateTrust.hs +++ b/gen/Network/AWS/DirectoryService/CreateTrust.hs @@ -20,7 +20,9 @@ -- -- AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. -- +-- -- This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain. +-- module Network.AWS.DirectoryService.CreateTrust ( -- * Creating a Request @@ -51,8 +53,10 @@ -- | AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. -- +-- -- This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain. -- +-- -- /See:/ 'createTrust' smart constructor. data CreateTrust = CreateTrust' { _ctConditionalForwarderIPAddrs :: !(Maybe [Text]) @@ -67,17 +71,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ctConditionalForwarderIPAddrs' +-- * 'ctConditionalForwarderIPAddrs' - The IP addresses of the remote DNS server associated with RemoteDomainName. -- --- * 'ctTrustType' +-- * 'ctTrustType' - The trust relationship type. -- --- * 'ctDirectoryId' +-- * 'ctDirectoryId' - The Directory ID of the Microsoft AD in the AWS cloud for which to establish the trust relationship. -- --- * 'ctRemoteDomainName' +-- * 'ctRemoteDomainName' - The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship. -- --- * 'ctTrustPassword' +-- * 'ctTrustPassword' - The trust password. The must be the same password that was used when creating the trust relationship on the external domain. -- --- * 'ctTrustDirection' +-- * 'ctTrustDirection' - The direction of the trust relationship. createTrust :: Text -- ^ 'ctDirectoryId' -> Text -- ^ 'ctRemoteDomainName' @@ -161,6 +165,8 @@ -- | The result of a CreateTrust request. -- +-- +-- -- /See:/ 'createTrustResponse' smart constructor. data CreateTrustResponse = CreateTrustResponse' { _ctrsTrustId :: !(Maybe Text) @@ -171,9 +177,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ctrsTrustId' +-- * 'ctrsTrustId' - A unique identifier for the trust relationship that was created. -- --- * 'ctrsResponseStatus' +-- * 'ctrsResponseStatus' - -- | The response status code. createTrustResponse :: Int -- ^ 'ctrsResponseStatus' -> CreateTrustResponse @@ -187,7 +193,7 @@ ctrsTrustId :: Lens' CreateTrustResponse (Maybe Text) ctrsTrustId = lens _ctrsTrustId (\ s a -> s{_ctrsTrustId = a}); --- | The response status code. +-- | -- | The response status code. ctrsResponseStatus :: Lens' CreateTrustResponse Int ctrsResponseStatus = lens _ctrsResponseStatus (\ s a -> s{_ctrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DeleteConditionalForwarder.hs b/gen/Network/AWS/DirectoryService/DeleteConditionalForwarder.hs --- a/gen/Network/AWS/DirectoryService/DeleteConditionalForwarder.hs +++ b/gen/Network/AWS/DirectoryService/DeleteConditionalForwarder.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Deletes a conditional forwarder that has been set up for your AWS directory. +-- +-- module Network.AWS.DirectoryService.DeleteConditionalForwarder ( -- * Creating a Request @@ -44,6 +46,8 @@ -- | Deletes a conditional forwarder. -- +-- +-- -- /See:/ 'deleteConditionalForwarder' smart constructor. data DeleteConditionalForwarder = DeleteConditionalForwarder' { _delDirectoryId :: !Text @@ -54,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'delDirectoryId' +-- * 'delDirectoryId' - The directory ID for which you are deleting the conditional forwarder. -- --- * 'delRemoteDomainName' +-- * 'delRemoteDomainName' - The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder. deleteConditionalForwarder :: Text -- ^ 'delDirectoryId' -> Text -- ^ 'delRemoteDomainName' @@ -114,6 +118,8 @@ -- | The result of a DeleteConditionalForwarder request. -- +-- +-- -- /See:/ 'deleteConditionalForwarderResponse' smart constructor. newtype DeleteConditionalForwarderResponse = DeleteConditionalForwarderResponse' { _drsResponseStatus :: Int @@ -123,7 +129,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'drsResponseStatus' +-- * 'drsResponseStatus' - -- | The response status code. deleteConditionalForwarderResponse :: Int -- ^ 'drsResponseStatus' -> DeleteConditionalForwarderResponse @@ -132,7 +138,7 @@ { _drsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. drsResponseStatus :: Lens' DeleteConditionalForwarderResponse Int drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DeleteDirectory.hs b/gen/Network/AWS/DirectoryService/DeleteDirectory.hs --- a/gen/Network/AWS/DirectoryService/DeleteDirectory.hs +++ b/gen/Network/AWS/DirectoryService/DeleteDirectory.hs @@ -19,6 +19,10 @@ -- Portability : non-portable (GHC extensions) -- -- Deletes an AWS Directory Service directory. +-- +-- +-- Before you call /DeleteDirectory/ , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the /DeleteDirectory/ operation, see . +-- module Network.AWS.DirectoryService.DeleteDirectory ( -- * Creating a Request @@ -42,8 +46,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < DeleteDirectory> operation. +-- | Contains the inputs for the 'DeleteDirectory' operation. -- +-- +-- -- /See:/ 'deleteDirectory' smart constructor. newtype DeleteDirectory = DeleteDirectory' { _dddDirectoryId :: Text @@ -53,7 +59,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dddDirectoryId' +-- * 'dddDirectoryId' - The identifier of the directory to delete. deleteDirectory :: Text -- ^ 'dddDirectoryId' -> DeleteDirectory @@ -100,8 +106,10 @@ instance ToQuery DeleteDirectory where toQuery = const mempty --- | Contains the results of the < DeleteDirectory> operation. +-- | Contains the results of the 'DeleteDirectory' operation. -- +-- +-- -- /See:/ 'deleteDirectoryResponse' smart constructor. data DeleteDirectoryResponse = DeleteDirectoryResponse' { _delrsDirectoryId :: !(Maybe Text) @@ -112,9 +120,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'delrsDirectoryId' +-- * 'delrsDirectoryId' - The directory identifier. -- --- * 'delrsResponseStatus' +-- * 'delrsResponseStatus' - -- | The response status code. deleteDirectoryResponse :: Int -- ^ 'delrsResponseStatus' -> DeleteDirectoryResponse @@ -128,7 +136,7 @@ delrsDirectoryId :: Lens' DeleteDirectoryResponse (Maybe Text) delrsDirectoryId = lens _delrsDirectoryId (\ s a -> s{_delrsDirectoryId = a}); --- | The response status code. +-- | -- | The response status code. delrsResponseStatus :: Lens' DeleteDirectoryResponse Int delrsResponseStatus = lens _delrsResponseStatus (\ s a -> s{_delrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DeleteSnapshot.hs b/gen/Network/AWS/DirectoryService/DeleteSnapshot.hs --- a/gen/Network/AWS/DirectoryService/DeleteSnapshot.hs +++ b/gen/Network/AWS/DirectoryService/DeleteSnapshot.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Deletes a directory snapshot. +-- +-- module Network.AWS.DirectoryService.DeleteSnapshot ( -- * Creating a Request @@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < DeleteSnapshot> operation. +-- | Contains the inputs for the 'DeleteSnapshot' operation. -- +-- +-- -- /See:/ 'deleteSnapshot' smart constructor. newtype DeleteSnapshot = DeleteSnapshot' { _dsSnapshotId :: Text @@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dsSnapshotId' +-- * 'dsSnapshotId' - The identifier of the directory snapshot to be deleted. deleteSnapshot :: Text -- ^ 'dsSnapshotId' -> DeleteSnapshot @@ -100,8 +104,10 @@ instance ToQuery DeleteSnapshot where toQuery = const mempty --- | Contains the results of the < DeleteSnapshot> operation. +-- | Contains the results of the 'DeleteSnapshot' operation. -- +-- +-- -- /See:/ 'deleteSnapshotResponse' smart constructor. data DeleteSnapshotResponse = DeleteSnapshotResponse' { _dsrsSnapshotId :: !(Maybe Text) @@ -112,9 +118,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dsrsSnapshotId' +-- * 'dsrsSnapshotId' - The identifier of the directory snapshot that was deleted. -- --- * 'dsrsResponseStatus' +-- * 'dsrsResponseStatus' - -- | The response status code. deleteSnapshotResponse :: Int -- ^ 'dsrsResponseStatus' -> DeleteSnapshotResponse @@ -128,7 +134,7 @@ dsrsSnapshotId :: Lens' DeleteSnapshotResponse (Maybe Text) dsrsSnapshotId = lens _dsrsSnapshotId (\ s a -> s{_dsrsSnapshotId = a}); --- | The response status code. +-- | -- | The response status code. dsrsResponseStatus :: Lens' DeleteSnapshotResponse Int dsrsResponseStatus = lens _dsrsResponseStatus (\ s a -> s{_dsrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DeleteTrust.hs b/gen/Network/AWS/DirectoryService/DeleteTrust.hs --- a/gen/Network/AWS/DirectoryService/DeleteTrust.hs +++ b/gen/Network/AWS/DirectoryService/DeleteTrust.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain. +-- +-- module Network.AWS.DirectoryService.DeleteTrust ( -- * Creating a Request @@ -45,6 +47,8 @@ -- | Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain. -- +-- +-- -- /See:/ 'deleteTrust' smart constructor. data DeleteTrust = DeleteTrust' { _dtDeleteAssociatedConditionalForwarder :: !(Maybe Bool) @@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dtDeleteAssociatedConditionalForwarder' +-- * 'dtDeleteAssociatedConditionalForwarder' - Delete a conditional forwarder as part of a DeleteTrustRequest. -- --- * 'dtTrustId' +-- * 'dtTrustId' - The Trust ID of the trust relationship to be deleted. deleteTrust :: Text -- ^ 'dtTrustId' -> DeleteTrust @@ -114,6 +118,8 @@ -- | The result of a DeleteTrust request. -- +-- +-- -- /See:/ 'deleteTrustResponse' smart constructor. data DeleteTrustResponse = DeleteTrustResponse' { _dttrsTrustId :: !(Maybe Text) @@ -124,9 +130,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dttrsTrustId' +-- * 'dttrsTrustId' - The Trust ID of the trust relationship that was deleted. -- --- * 'dttrsResponseStatus' +-- * 'dttrsResponseStatus' - -- | The response status code. deleteTrustResponse :: Int -- ^ 'dttrsResponseStatus' -> DeleteTrustResponse @@ -140,7 +146,7 @@ dttrsTrustId :: Lens' DeleteTrustResponse (Maybe Text) dttrsTrustId = lens _dttrsTrustId (\ s a -> s{_dttrsTrustId = a}); --- | The response status code. +-- | -- | The response status code. dttrsResponseStatus :: Lens' DeleteTrustResponse Int dttrsResponseStatus = lens _dttrsResponseStatus (\ s a -> s{_dttrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DeregisterEventTopic.hs b/gen/Network/AWS/DirectoryService/DeregisterEventTopic.hs --- a/gen/Network/AWS/DirectoryService/DeregisterEventTopic.hs +++ b/gen/Network/AWS/DirectoryService/DeregisterEventTopic.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Removes the specified directory as a publisher to the specified SNS topic. +-- +-- module Network.AWS.DirectoryService.DeregisterEventTopic ( -- * Creating a Request @@ -44,6 +46,8 @@ -- | Removes the specified directory as a publisher to the specified SNS topic. -- +-- +-- -- /See:/ 'deregisterEventTopic' smart constructor. data DeregisterEventTopic = DeregisterEventTopic' { _detDirectoryId :: !Text @@ -54,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'detDirectoryId' +-- * 'detDirectoryId' - The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic. -- --- * 'detTopicName' +-- * 'detTopicName' - The name of the SNS topic from which to remove the directory as a publisher. deregisterEventTopic :: Text -- ^ 'detDirectoryId' -> Text -- ^ 'detTopicName' @@ -114,6 +118,8 @@ -- | The result of a DeregisterEventTopic request. -- +-- +-- -- /See:/ 'deregisterEventTopicResponse' smart constructor. newtype DeregisterEventTopicResponse = DeregisterEventTopicResponse' { _derrsResponseStatus :: Int @@ -123,7 +129,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'derrsResponseStatus' +-- * 'derrsResponseStatus' - -- | The response status code. deregisterEventTopicResponse :: Int -- ^ 'derrsResponseStatus' -> DeregisterEventTopicResponse @@ -132,7 +138,7 @@ { _derrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. derrsResponseStatus :: Lens' DeregisterEventTopicResponse Int derrsResponseStatus = lens _derrsResponseStatus (\ s a -> s{_derrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DescribeConditionalForwarders.hs b/gen/Network/AWS/DirectoryService/DescribeConditionalForwarders.hs --- a/gen/Network/AWS/DirectoryService/DescribeConditionalForwarders.hs +++ b/gen/Network/AWS/DirectoryService/DescribeConditionalForwarders.hs @@ -20,7 +20,9 @@ -- -- Obtains information about the conditional forwarders for this account. -- +-- -- If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID. +-- module Network.AWS.DirectoryService.DescribeConditionalForwarders ( -- * Creating a Request @@ -47,6 +49,8 @@ -- | Describes a conditional forwarder. -- +-- +-- -- /See:/ 'describeConditionalForwarders' smart constructor. data DescribeConditionalForwarders = DescribeConditionalForwarders' { _dcfRemoteDomainNames :: !(Maybe [Text]) @@ -57,9 +61,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dcfRemoteDomainNames' +-- * 'dcfRemoteDomainNames' - The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned. -- --- * 'dcfDirectoryId' +-- * 'dcfDirectoryId' - The directory ID for which to get the list of associated conditional forwarders. describeConditionalForwarders :: Text -- ^ 'dcfDirectoryId' -> DescribeConditionalForwarders @@ -119,6 +123,8 @@ -- | The result of a DescribeConditionalForwarder request. -- +-- +-- -- /See:/ 'describeConditionalForwardersResponse' smart constructor. data DescribeConditionalForwardersResponse = DescribeConditionalForwardersResponse' { _dcfrsConditionalForwarders :: !(Maybe [ConditionalForwarder]) @@ -129,9 +135,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dcfrsConditionalForwarders' +-- * 'dcfrsConditionalForwarders' - The list of conditional forwarders that have been created. -- --- * 'dcfrsResponseStatus' +-- * 'dcfrsResponseStatus' - -- | The response status code. describeConditionalForwardersResponse :: Int -- ^ 'dcfrsResponseStatus' -> DescribeConditionalForwardersResponse @@ -145,7 +151,7 @@ dcfrsConditionalForwarders :: Lens' DescribeConditionalForwardersResponse [ConditionalForwarder] dcfrsConditionalForwarders = lens _dcfrsConditionalForwarders (\ s a -> s{_dcfrsConditionalForwarders = a}) . _Default . _Coerce; --- | The response status code. +-- | -- | The response status code. dcfrsResponseStatus :: Lens' DescribeConditionalForwardersResponse Int dcfrsResponseStatus = lens _dcfrsResponseStatus (\ s a -> s{_dcfrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DescribeDirectories.hs b/gen/Network/AWS/DirectoryService/DescribeDirectories.hs --- a/gen/Network/AWS/DirectoryService/DescribeDirectories.hs +++ b/gen/Network/AWS/DirectoryService/DescribeDirectories.hs @@ -20,11 +20,13 @@ -- -- Obtains information about the directories that belong to this account. -- +-- -- You can retrieve information about specific directories by passing the directory identifiers in the /DirectoryIds/ parameter. Otherwise, all directories that belong to the current account are returned. -- --- This operation supports pagination with the use of the /NextToken/ request and response parameters. If more results are available, the /DescribeDirectoriesResult.NextToken/ member contains a token that you pass in the next call to < DescribeDirectories> to retrieve the next set of items. +-- This operation supports pagination with the use of the /NextToken/ request and response parameters. If more results are available, the /DescribeDirectoriesResult.NextToken/ member contains a token that you pass in the next call to 'DescribeDirectories' to retrieve the next set of items. -- -- You can also specify a maximum number of return results with the /Limit/ parameter. +-- module Network.AWS.DirectoryService.DescribeDirectories ( -- * Creating a Request @@ -51,8 +53,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < DescribeDirectories> operation. +-- | Contains the inputs for the 'DescribeDirectories' operation. -- +-- +-- -- /See:/ 'describeDirectories' smart constructor. data DescribeDirectories = DescribeDirectories' { _ddNextToken :: !(Maybe Text) @@ -64,11 +68,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ddNextToken' +-- * 'ddNextToken' - The /DescribeDirectoriesResult.NextToken/ value from a previous call to 'DescribeDirectories' . Pass null if this is the first call. -- --- * 'ddDirectoryIds' +-- * 'ddDirectoryIds' - A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned. An empty list results in an @InvalidParameterException@ being thrown. -- --- * 'ddLimit' +-- * 'ddLimit' - The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. describeDirectories :: DescribeDirectories describeDirectories = @@ -78,13 +82,11 @@ , _ddLimit = Nothing } --- | The /DescribeDirectoriesResult.NextToken/ value from a previous call to < DescribeDirectories>. Pass null if this is the first call. +-- | The /DescribeDirectoriesResult.NextToken/ value from a previous call to 'DescribeDirectories' . Pass null if this is the first call. ddNextToken :: Lens' DescribeDirectories (Maybe Text) ddNextToken = lens _ddNextToken (\ s a -> s{_ddNextToken = a}); --- | A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned. --- --- An empty list results in an 'InvalidParameterException' being thrown. +-- | A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned. An empty list results in an @InvalidParameterException@ being thrown. ddDirectoryIds :: Lens' DescribeDirectories [Text] ddDirectoryIds = lens _ddDirectoryIds (\ s a -> s{_ddDirectoryIds = a}) . _Default . _Coerce; @@ -132,8 +134,10 @@ instance ToQuery DescribeDirectories where toQuery = const mempty --- | Contains the results of the < DescribeDirectories> operation. +-- | Contains the results of the 'DescribeDirectories' operation. -- +-- +-- -- /See:/ 'describeDirectoriesResponse' smart constructor. data DescribeDirectoriesResponse = DescribeDirectoriesResponse' { _ddrsDirectoryDescriptions :: !(Maybe [DirectoryDescription]) @@ -145,11 +149,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ddrsDirectoryDescriptions' +-- * 'ddrsDirectoryDescriptions' - The list of 'DirectoryDescription' objects that were retrieved. It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. -- --- * 'ddrsNextToken' +-- * 'ddrsNextToken' - If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to 'DescribeDirectories' to retrieve the next set of items. -- --- * 'ddrsResponseStatus' +-- * 'ddrsResponseStatus' - -- | The response status code. describeDirectoriesResponse :: Int -- ^ 'ddrsResponseStatus' -> DescribeDirectoriesResponse @@ -160,17 +164,15 @@ , _ddrsResponseStatus = pResponseStatus_ } --- | The list of < DirectoryDescription> objects that were retrieved. --- --- It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. +-- | The list of 'DirectoryDescription' objects that were retrieved. It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. ddrsDirectoryDescriptions :: Lens' DescribeDirectoriesResponse [DirectoryDescription] ddrsDirectoryDescriptions = lens _ddrsDirectoryDescriptions (\ s a -> s{_ddrsDirectoryDescriptions = a}) . _Default . _Coerce; --- | If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to < DescribeDirectories> to retrieve the next set of items. +-- | If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to 'DescribeDirectories' to retrieve the next set of items. ddrsNextToken :: Lens' DescribeDirectoriesResponse (Maybe Text) ddrsNextToken = lens _ddrsNextToken (\ s a -> s{_ddrsNextToken = a}); --- | The response status code. +-- | -- | The response status code. ddrsResponseStatus :: Lens' DescribeDirectoriesResponse Int ddrsResponseStatus = lens _ddrsResponseStatus (\ s a -> s{_ddrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DescribeEventTopics.hs b/gen/Network/AWS/DirectoryService/DescribeEventTopics.hs --- a/gen/Network/AWS/DirectoryService/DescribeEventTopics.hs +++ b/gen/Network/AWS/DirectoryService/DescribeEventTopics.hs @@ -20,7 +20,9 @@ -- -- Obtains information about which SNS topics receive status messages from the specified directory. -- +-- -- If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. +-- module Network.AWS.DirectoryService.DescribeEventTopics ( -- * Creating a Request @@ -47,6 +49,8 @@ -- | Describes event topics. -- +-- +-- -- /See:/ 'describeEventTopics' smart constructor. data DescribeEventTopics = DescribeEventTopics' { _dDirectoryId :: !(Maybe Text) @@ -57,9 +61,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dDirectoryId' +-- * 'dDirectoryId' - The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned. -- --- * 'dTopicNames' +-- * 'dTopicNames' - A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned. An empty list results in an @InvalidParameterException@ being thrown. describeEventTopics :: DescribeEventTopics describeEventTopics = @@ -72,9 +76,7 @@ dDirectoryId :: Lens' DescribeEventTopics (Maybe Text) dDirectoryId = lens _dDirectoryId (\ s a -> s{_dDirectoryId = a}); --- | A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned. --- --- An empty list results in an 'InvalidParameterException' being thrown. +-- | A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned. An empty list results in an @InvalidParameterException@ being thrown. dTopicNames :: Lens' DescribeEventTopics [Text] dTopicNames = lens _dTopicNames (\ s a -> s{_dTopicNames = a}) . _Default . _Coerce; @@ -118,6 +120,8 @@ -- | The result of a DescribeEventTopic request. -- +-- +-- -- /See:/ 'describeEventTopicsResponse' smart constructor. data DescribeEventTopicsResponse = DescribeEventTopicsResponse' { _detrsEventTopics :: !(Maybe [EventTopic]) @@ -128,9 +132,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'detrsEventTopics' +-- * 'detrsEventTopics' - A list of SNS topic names that receive status messages from the specified Directory ID. -- --- * 'detrsResponseStatus' +-- * 'detrsResponseStatus' - -- | The response status code. describeEventTopicsResponse :: Int -- ^ 'detrsResponseStatus' -> DescribeEventTopicsResponse @@ -144,7 +148,7 @@ detrsEventTopics :: Lens' DescribeEventTopicsResponse [EventTopic] detrsEventTopics = lens _detrsEventTopics (\ s a -> s{_detrsEventTopics = a}) . _Default . _Coerce; --- | The response status code. +-- | -- | The response status code. detrsResponseStatus :: Lens' DescribeEventTopicsResponse Int detrsResponseStatus = lens _detrsResponseStatus (\ s a -> s{_detrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DescribeSnapshots.hs b/gen/Network/AWS/DirectoryService/DescribeSnapshots.hs --- a/gen/Network/AWS/DirectoryService/DescribeSnapshots.hs +++ b/gen/Network/AWS/DirectoryService/DescribeSnapshots.hs @@ -20,9 +20,11 @@ -- -- Obtains information about the directory snapshots that belong to this account. -- --- This operation supports pagination with the use of the /NextToken/ request and response parameters. If more results are available, the /DescribeSnapshots.NextToken/ member contains a token that you pass in the next call to < DescribeSnapshots> to retrieve the next set of items. -- +-- This operation supports pagination with the use of the /NextToken/ request and response parameters. If more results are available, the /DescribeSnapshots.NextToken/ member contains a token that you pass in the next call to 'DescribeSnapshots' to retrieve the next set of items. +-- -- You can also specify a maximum number of return results with the /Limit/ parameter. +-- module Network.AWS.DirectoryService.DescribeSnapshots ( -- * Creating a Request @@ -50,8 +52,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < DescribeSnapshots> operation. +-- | Contains the inputs for the 'DescribeSnapshots' operation. -- +-- +-- -- /See:/ 'describeSnapshots' smart constructor. data DescribeSnapshots = DescribeSnapshots' { _dsDirectoryId :: !(Maybe Text) @@ -64,13 +68,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dsDirectoryId' +-- * 'dsDirectoryId' - The identifier of the directory for which to retrieve snapshot information. -- --- * 'dsNextToken' +-- * 'dsNextToken' - The /DescribeSnapshotsResult.NextToken/ value from a previous call to 'DescribeSnapshots' . Pass null if this is the first call. -- --- * 'dsSnapshotIds' +-- * 'dsSnapshotIds' - A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the /Limit/ and /NextToken/ members. -- --- * 'dsLimit' +-- * 'dsLimit' - The maximum number of objects to return. describeSnapshots :: DescribeSnapshots describeSnapshots = @@ -85,7 +89,7 @@ dsDirectoryId :: Lens' DescribeSnapshots (Maybe Text) dsDirectoryId = lens _dsDirectoryId (\ s a -> s{_dsDirectoryId = a}); --- | The /DescribeSnapshotsResult.NextToken/ value from a previous call to < DescribeSnapshots>. Pass null if this is the first call. +-- | The /DescribeSnapshotsResult.NextToken/ value from a previous call to 'DescribeSnapshots' . Pass null if this is the first call. dsNextToken :: Lens' DescribeSnapshots (Maybe Text) dsNextToken = lens _dsNextToken (\ s a -> s{_dsNextToken = a}); @@ -137,8 +141,10 @@ instance ToQuery DescribeSnapshots where toQuery = const mempty --- | Contains the results of the < DescribeSnapshots> operation. +-- | Contains the results of the 'DescribeSnapshots' operation. -- +-- +-- -- /See:/ 'describeSnapshotsResponse' smart constructor. data DescribeSnapshotsResponse = DescribeSnapshotsResponse' { _dssrsNextToken :: !(Maybe Text) @@ -150,11 +156,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dssrsNextToken' +-- * 'dssrsNextToken' - If not null, more results are available. Pass this value in the /NextToken/ member of a subsequent call to 'DescribeSnapshots' . -- --- * 'dssrsSnapshots' +-- * 'dssrsSnapshots' - The list of 'Snapshot' objects that were retrieved. It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. -- --- * 'dssrsResponseStatus' +-- * 'dssrsResponseStatus' - -- | The response status code. describeSnapshotsResponse :: Int -- ^ 'dssrsResponseStatus' -> DescribeSnapshotsResponse @@ -165,17 +171,15 @@ , _dssrsResponseStatus = pResponseStatus_ } --- | If not null, more results are available. Pass this value in the /NextToken/ member of a subsequent call to < DescribeSnapshots>. +-- | If not null, more results are available. Pass this value in the /NextToken/ member of a subsequent call to 'DescribeSnapshots' . dssrsNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) dssrsNextToken = lens _dssrsNextToken (\ s a -> s{_dssrsNextToken = a}); --- | The list of < Snapshot> objects that were retrieved. --- --- It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. +-- | The list of 'Snapshot' objects that were retrieved. It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot] dssrsSnapshots = lens _dssrsSnapshots (\ s a -> s{_dssrsSnapshots = a}) . _Default . _Coerce; --- | The response status code. +-- | -- | The response status code. dssrsResponseStatus :: Lens' DescribeSnapshotsResponse Int dssrsResponseStatus = lens _dssrsResponseStatus (\ s a -> s{_dssrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DescribeTrusts.hs b/gen/Network/AWS/DirectoryService/DescribeTrusts.hs --- a/gen/Network/AWS/DirectoryService/DescribeTrusts.hs +++ b/gen/Network/AWS/DirectoryService/DescribeTrusts.hs @@ -20,7 +20,9 @@ -- -- Obtains information about the trust relationships for this account. -- +-- -- If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. +-- module Network.AWS.DirectoryService.DescribeTrusts ( -- * Creating a Request @@ -50,6 +52,8 @@ -- | Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships. -- +-- +-- -- /See:/ 'describeTrusts' smart constructor. data DescribeTrusts = DescribeTrusts' { _dtDirectoryId :: !(Maybe Text) @@ -62,13 +66,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dtDirectoryId' +-- * 'dtDirectoryId' - The Directory ID of the AWS directory that is a part of the requested trust relationship. -- --- * 'dtNextToken' +-- * 'dtNextToken' - The /DescribeTrustsResult.NextToken/ value from a previous call to 'DescribeTrusts' . Pass null if this is the first call. -- --- * 'dtTrustIds' +-- * 'dtTrustIds' - A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. An empty list results in an @InvalidParameterException@ being thrown. -- --- * 'dtLimit' +-- * 'dtLimit' - The maximum number of objects to return. describeTrusts :: DescribeTrusts describeTrusts = @@ -83,13 +87,11 @@ dtDirectoryId :: Lens' DescribeTrusts (Maybe Text) dtDirectoryId = lens _dtDirectoryId (\ s a -> s{_dtDirectoryId = a}); --- | The /DescribeTrustsResult.NextToken/ value from a previous call to < DescribeTrusts>. Pass null if this is the first call. +-- | The /DescribeTrustsResult.NextToken/ value from a previous call to 'DescribeTrusts' . Pass null if this is the first call. dtNextToken :: Lens' DescribeTrusts (Maybe Text) dtNextToken = lens _dtNextToken (\ s a -> s{_dtNextToken = a}); --- | A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. --- --- An empty list results in an 'InvalidParameterException' being thrown. +-- | A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. An empty list results in an @InvalidParameterException@ being thrown. dtTrustIds :: Lens' DescribeTrusts [Text] dtTrustIds = lens _dtTrustIds (\ s a -> s{_dtTrustIds = a}) . _Default . _Coerce; @@ -138,6 +140,8 @@ -- | The result of a DescribeTrust request. -- +-- +-- -- /See:/ 'describeTrustsResponse' smart constructor. data DescribeTrustsResponse = DescribeTrustsResponse' { _dtrsNextToken :: !(Maybe Text) @@ -149,11 +153,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dtrsNextToken' +-- * 'dtrsNextToken' - If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to 'DescribeTrusts' to retrieve the next set of items. -- --- * 'dtrsTrusts' +-- * 'dtrsTrusts' - The list of Trust objects that were retrieved. It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. -- --- * 'dtrsResponseStatus' +-- * 'dtrsResponseStatus' - -- | The response status code. describeTrustsResponse :: Int -- ^ 'dtrsResponseStatus' -> DescribeTrustsResponse @@ -164,17 +168,15 @@ , _dtrsResponseStatus = pResponseStatus_ } --- | If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to < DescribeTrusts> to retrieve the next set of items. +-- | If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to 'DescribeTrusts' to retrieve the next set of items. dtrsNextToken :: Lens' DescribeTrustsResponse (Maybe Text) dtrsNextToken = lens _dtrsNextToken (\ s a -> s{_dtrsNextToken = a}); --- | The list of Trust objects that were retrieved. --- --- It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. +-- | The list of Trust objects that were retrieved. It is possible that this list contains less than the number of items specified in the /Limit/ member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. dtrsTrusts :: Lens' DescribeTrustsResponse [Trust] dtrsTrusts = lens _dtrsTrusts (\ s a -> s{_dtrsTrusts = a}) . _Default . _Coerce; --- | The response status code. +-- | -- | The response status code. dtrsResponseStatus :: Lens' DescribeTrustsResponse Int dtrsResponseStatus = lens _dtrsResponseStatus (\ s a -> s{_dtrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DisableRadius.hs b/gen/Network/AWS/DirectoryService/DisableRadius.hs --- a/gen/Network/AWS/DirectoryService/DisableRadius.hs +++ b/gen/Network/AWS/DirectoryService/DisableRadius.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. +-- +-- module Network.AWS.DirectoryService.DisableRadius ( -- * Creating a Request @@ -41,8 +43,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < DisableRadius> operation. +-- | Contains the inputs for the 'DisableRadius' operation. -- +-- +-- -- /See:/ 'disableRadius' smart constructor. newtype DisableRadius = DisableRadius' { _drDirectoryId :: Text @@ -52,7 +56,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'drDirectoryId' +-- * 'drDirectoryId' - The identifier of the directory for which to disable MFA. disableRadius :: Text -- ^ 'drDirectoryId' -> DisableRadius @@ -98,8 +102,10 @@ instance ToQuery DisableRadius where toQuery = const mempty --- | Contains the results of the < DisableRadius> operation. +-- | Contains the results of the 'DisableRadius' operation. -- +-- +-- -- /See:/ 'disableRadiusResponse' smart constructor. newtype DisableRadiusResponse = DisableRadiusResponse' { _drrsResponseStatus :: Int @@ -109,7 +115,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'drrsResponseStatus' +-- * 'drrsResponseStatus' - -- | The response status code. disableRadiusResponse :: Int -- ^ 'drrsResponseStatus' -> DisableRadiusResponse @@ -118,7 +124,7 @@ { _drrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. drrsResponseStatus :: Lens' DisableRadiusResponse Int drrsResponseStatus = lens _drrsResponseStatus (\ s a -> s{_drrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/DisableSSO.hs b/gen/Network/AWS/DirectoryService/DisableSSO.hs --- a/gen/Network/AWS/DirectoryService/DisableSSO.hs +++ b/gen/Network/AWS/DirectoryService/DisableSSO.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Disables single-sign on for a directory. +-- +-- module Network.AWS.DirectoryService.DisableSSO ( -- * Creating a Request @@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < DisableSso> operation. +-- | Contains the inputs for the 'DisableSso' operation. -- +-- +-- -- /See:/ 'disableSSO' smart constructor. data DisableSSO = DisableSSO' { _dssoUserName :: !(Maybe Text) @@ -56,11 +60,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dssoUserName' +-- * 'dssoUserName' - The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name. If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the /UserName/ and /Password/ parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed. -- --- * 'dssoPassword' +-- * 'dssoPassword' - The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the /UserName/ parameter. -- --- * 'dssoDirectoryId' +-- * 'dssoDirectoryId' - The identifier of the directory for which to disable single-sign on. disableSSO :: Text -- ^ 'dssoDirectoryId' -> DisableSSO @@ -71,9 +75,7 @@ , _dssoDirectoryId = pDirectoryId_ } --- | The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name. --- --- If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the /UserName/ and /Password/ parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed. +-- | The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name. If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the /UserName/ and /Password/ parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed. dssoUserName :: Lens' DisableSSO (Maybe Text) dssoUserName = lens _dssoUserName (\ s a -> s{_dssoUserName = a}); @@ -121,8 +123,10 @@ instance ToQuery DisableSSO where toQuery = const mempty --- | Contains the results of the < DisableSso> operation. +-- | Contains the results of the 'DisableSso' operation. -- +-- +-- -- /See:/ 'disableSSOResponse' smart constructor. newtype DisableSSOResponse = DisableSSOResponse' { _dssorsResponseStatus :: Int @@ -132,7 +136,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dssorsResponseStatus' +-- * 'dssorsResponseStatus' - -- | The response status code. disableSSOResponse :: Int -- ^ 'dssorsResponseStatus' -> DisableSSOResponse @@ -141,7 +145,7 @@ { _dssorsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. dssorsResponseStatus :: Lens' DisableSSOResponse Int dssorsResponseStatus = lens _dssorsResponseStatus (\ s a -> s{_dssorsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/EnableRadius.hs b/gen/Network/AWS/DirectoryService/EnableRadius.hs --- a/gen/Network/AWS/DirectoryService/EnableRadius.hs +++ b/gen/Network/AWS/DirectoryService/EnableRadius.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. +-- +-- module Network.AWS.DirectoryService.EnableRadius ( -- * Creating a Request @@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < EnableRadius> operation. +-- | Contains the inputs for the 'EnableRadius' operation. -- +-- +-- -- /See:/ 'enableRadius' smart constructor. data EnableRadius = EnableRadius' { _erDirectoryId :: !Text @@ -54,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'erDirectoryId' +-- * 'erDirectoryId' - The identifier of the directory for which to enable MFA. -- --- * 'erRadiusSettings' +-- * 'erRadiusSettings' - A 'RadiusSettings' object that contains information about the RADIUS server. enableRadius :: Text -- ^ 'erDirectoryId' -> RadiusSettings -- ^ 'erRadiusSettings' @@ -71,7 +75,7 @@ erDirectoryId :: Lens' EnableRadius Text erDirectoryId = lens _erDirectoryId (\ s a -> s{_erDirectoryId = a}); --- | A < RadiusSettings> object that contains information about the RADIUS server. +-- | A 'RadiusSettings' object that contains information about the RADIUS server. erRadiusSettings :: Lens' EnableRadius RadiusSettings erRadiusSettings = lens _erRadiusSettings (\ s a -> s{_erRadiusSettings = a}); @@ -110,8 +114,10 @@ instance ToQuery EnableRadius where toQuery = const mempty --- | Contains the results of the < EnableRadius> operation. +-- | Contains the results of the 'EnableRadius' operation. -- +-- +-- -- /See:/ 'enableRadiusResponse' smart constructor. newtype EnableRadiusResponse = EnableRadiusResponse' { _errsResponseStatus :: Int @@ -121,7 +127,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'errsResponseStatus' +-- * 'errsResponseStatus' - -- | The response status code. enableRadiusResponse :: Int -- ^ 'errsResponseStatus' -> EnableRadiusResponse @@ -130,7 +136,7 @@ { _errsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. errsResponseStatus :: Lens' EnableRadiusResponse Int errsResponseStatus = lens _errsResponseStatus (\ s a -> s{_errsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/EnableSSO.hs b/gen/Network/AWS/DirectoryService/EnableSSO.hs --- a/gen/Network/AWS/DirectoryService/EnableSSO.hs +++ b/gen/Network/AWS/DirectoryService/EnableSSO.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Enables single-sign on for a directory. +-- +-- module Network.AWS.DirectoryService.EnableSSO ( -- * Creating a Request @@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < EnableSso> operation. +-- | Contains the inputs for the 'EnableSso' operation. -- +-- +-- -- /See:/ 'enableSSO' smart constructor. data EnableSSO = EnableSSO' { _esUserName :: !(Maybe Text) @@ -56,11 +60,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'esUserName' +-- * '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' +-- * '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' +-- * 'esDirectoryId' - The identifier of the directory for which to enable single-sign on. enableSSO :: Text -- ^ 'esDirectoryId' -> EnableSSO @@ -71,9 +75,7 @@ , _esDirectoryId = pDirectoryId_ } --- | 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. +-- | 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. esUserName :: Lens' EnableSSO (Maybe Text) esUserName = lens _esUserName (\ s a -> s{_esUserName = a}); @@ -121,8 +123,10 @@ instance ToQuery EnableSSO where toQuery = const mempty --- | Contains the results of the < EnableSso> operation. +-- | Contains the results of the 'EnableSso' operation. -- +-- +-- -- /See:/ 'enableSSOResponse' smart constructor. newtype EnableSSOResponse = EnableSSOResponse' { _esrsResponseStatus :: Int @@ -132,7 +136,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'esrsResponseStatus' +-- * 'esrsResponseStatus' - -- | The response status code. enableSSOResponse :: Int -- ^ 'esrsResponseStatus' -> EnableSSOResponse @@ -141,7 +145,7 @@ { _esrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. esrsResponseStatus :: Lens' EnableSSOResponse Int esrsResponseStatus = lens _esrsResponseStatus (\ s a -> s{_esrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/GetDirectoryLimits.hs b/gen/Network/AWS/DirectoryService/GetDirectoryLimits.hs --- a/gen/Network/AWS/DirectoryService/GetDirectoryLimits.hs +++ b/gen/Network/AWS/DirectoryService/GetDirectoryLimits.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Obtains directory limit information for the current region. +-- +-- module Network.AWS.DirectoryService.GetDirectoryLimits ( -- * Creating a Request @@ -40,8 +42,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < GetDirectoryLimits> operation. +-- | Contains the inputs for the 'GetDirectoryLimits' operation. -- +-- +-- -- /See:/ 'getDirectoryLimits' smart constructor. data GetDirectoryLimits = GetDirectoryLimits' @@ -86,8 +90,10 @@ instance ToQuery GetDirectoryLimits where toQuery = const mempty --- | Contains the results of the < GetDirectoryLimits> operation. +-- | Contains the results of the 'GetDirectoryLimits' operation. -- +-- +-- -- /See:/ 'getDirectoryLimitsResponse' smart constructor. data GetDirectoryLimitsResponse = GetDirectoryLimitsResponse' { _gdlrsDirectoryLimits :: !(Maybe DirectoryLimits) @@ -98,9 +104,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gdlrsDirectoryLimits' +-- * 'gdlrsDirectoryLimits' - A 'DirectoryLimits' object that contains the directory limits for the current region. -- --- * 'gdlrsResponseStatus' +-- * 'gdlrsResponseStatus' - -- | The response status code. getDirectoryLimitsResponse :: Int -- ^ 'gdlrsResponseStatus' -> GetDirectoryLimitsResponse @@ -110,11 +116,11 @@ , _gdlrsResponseStatus = pResponseStatus_ } --- | A < DirectoryLimits> object that contains the directory limits for the current region. +-- | A 'DirectoryLimits' object that contains the directory limits for the current region. gdlrsDirectoryLimits :: Lens' GetDirectoryLimitsResponse (Maybe DirectoryLimits) gdlrsDirectoryLimits = lens _gdlrsDirectoryLimits (\ s a -> s{_gdlrsDirectoryLimits = a}); --- | The response status code. +-- | -- | The response status code. gdlrsResponseStatus :: Lens' GetDirectoryLimitsResponse Int gdlrsResponseStatus = lens _gdlrsResponseStatus (\ s a -> s{_gdlrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/GetSnapshotLimits.hs b/gen/Network/AWS/DirectoryService/GetSnapshotLimits.hs --- a/gen/Network/AWS/DirectoryService/GetSnapshotLimits.hs +++ b/gen/Network/AWS/DirectoryService/GetSnapshotLimits.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Obtains the manual snapshot limits for a directory. +-- +-- module Network.AWS.DirectoryService.GetSnapshotLimits ( -- * Creating a Request @@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < GetSnapshotLimits> operation. +-- | Contains the inputs for the 'GetSnapshotLimits' operation. -- +-- +-- -- /See:/ 'getSnapshotLimits' smart constructor. newtype GetSnapshotLimits = GetSnapshotLimits' { _gslDirectoryId :: Text @@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gslDirectoryId' +-- * 'gslDirectoryId' - Contains the identifier of the directory to obtain the limits for. getSnapshotLimits :: Text -- ^ 'gslDirectoryId' -> GetSnapshotLimits @@ -100,8 +104,10 @@ instance ToQuery GetSnapshotLimits where toQuery = const mempty --- | Contains the results of the < GetSnapshotLimits> operation. +-- | Contains the results of the 'GetSnapshotLimits' operation. -- +-- +-- -- /See:/ 'getSnapshotLimitsResponse' smart constructor. data GetSnapshotLimitsResponse = GetSnapshotLimitsResponse' { _gslrsSnapshotLimits :: !(Maybe SnapshotLimits) @@ -112,9 +118,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gslrsSnapshotLimits' +-- * 'gslrsSnapshotLimits' - A 'SnapshotLimits' object that contains the manual snapshot limits for the specified directory. -- --- * 'gslrsResponseStatus' +-- * 'gslrsResponseStatus' - -- | The response status code. getSnapshotLimitsResponse :: Int -- ^ 'gslrsResponseStatus' -> GetSnapshotLimitsResponse @@ -124,11 +130,11 @@ , _gslrsResponseStatus = pResponseStatus_ } --- | A < SnapshotLimits> object that contains the manual snapshot limits for the specified directory. +-- | A 'SnapshotLimits' object that contains the manual snapshot limits for the specified directory. gslrsSnapshotLimits :: Lens' GetSnapshotLimitsResponse (Maybe SnapshotLimits) gslrsSnapshotLimits = lens _gslrsSnapshotLimits (\ s a -> s{_gslrsSnapshotLimits = a}); --- | The response status code. +-- | -- | The response status code. gslrsResponseStatus :: Lens' GetSnapshotLimitsResponse Int gslrsResponseStatus = lens _gslrsResponseStatus (\ s a -> s{_gslrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/ListIPRoutes.hs b/gen/Network/AWS/DirectoryService/ListIPRoutes.hs --- a/gen/Network/AWS/DirectoryService/ListIPRoutes.hs +++ b/gen/Network/AWS/DirectoryService/ListIPRoutes.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Lists the address blocks that you have added to a directory. +-- +-- module Network.AWS.DirectoryService.ListIPRoutes ( -- * Creating a Request @@ -56,11 +58,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lirNextToken' +-- * 'lirNextToken' - The /ListIpRoutes.NextToken/ value from a previous call to 'ListIpRoutes' . Pass null if this is the first call. -- --- * 'lirLimit' +-- * 'lirLimit' - Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. -- --- * 'lirDirectoryId' +-- * 'lirDirectoryId' - Identifier (ID) of the directory for which you want to retrieve the IP addresses. listIPRoutes :: Text -- ^ 'lirDirectoryId' -> ListIPRoutes @@ -71,7 +73,7 @@ , _lirDirectoryId = pDirectoryId_ } --- | The /ListIpRoutes.NextToken/ value from a previous call to < ListIpRoutes>. Pass null if this is the first call. +-- | The /ListIpRoutes.NextToken/ value from a previous call to 'ListIpRoutes' . Pass null if this is the first call. lirNextToken :: Lens' ListIPRoutes (Maybe Text) lirNextToken = lens _lirNextToken (\ s a -> s{_lirNextToken = a}); @@ -133,11 +135,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lirrsIPRoutesInfo' +-- * 'lirrsIPRoutesInfo' - A list of 'IpRoute' s. -- --- * 'lirrsNextToken' +-- * 'lirrsNextToken' - If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to 'ListIpRoutes' to retrieve the next set of items. -- --- * 'lirrsResponseStatus' +-- * 'lirrsResponseStatus' - -- | The response status code. listIPRoutesResponse :: Int -- ^ 'lirrsResponseStatus' -> ListIPRoutesResponse @@ -148,15 +150,15 @@ , _lirrsResponseStatus = pResponseStatus_ } --- | A list of < IpRoute>s. +-- | A list of 'IpRoute' s. lirrsIPRoutesInfo :: Lens' ListIPRoutesResponse [IPRouteInfo] lirrsIPRoutesInfo = lens _lirrsIPRoutesInfo (\ s a -> s{_lirrsIPRoutesInfo = a}) . _Default . _Coerce; --- | If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to < ListIpRoutes> to retrieve the next set of items. +-- | If not null, more results are available. Pass this value for the /NextToken/ parameter in a subsequent call to 'ListIpRoutes' to retrieve the next set of items. lirrsNextToken :: Lens' ListIPRoutesResponse (Maybe Text) lirrsNextToken = lens _lirrsNextToken (\ s a -> s{_lirrsNextToken = a}); --- | The response status code. +-- | -- | The response status code. lirrsResponseStatus :: Lens' ListIPRoutesResponse Int lirrsResponseStatus = lens _lirrsResponseStatus (\ s a -> s{_lirrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/ListSchemaExtensions.hs b/gen/Network/AWS/DirectoryService/ListSchemaExtensions.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DirectoryService/ListSchemaExtensions.hs @@ -0,0 +1,166 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DirectoryService.ListSchemaExtensions +-- Copyright : (c) 2013-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Lists all schema extensions applied to a Microsoft AD Directory. +-- +-- +module Network.AWS.DirectoryService.ListSchemaExtensions + ( + -- * Creating a Request + listSchemaExtensions + , ListSchemaExtensions + -- * Request Lenses + , lseNextToken + , lseLimit + , lseDirectoryId + + -- * Destructuring the Response + , listSchemaExtensionsResponse + , ListSchemaExtensionsResponse + -- * Response Lenses + , lsersSchemaExtensionsInfo + , lsersNextToken + , lsersResponseStatus + ) where + +import Network.AWS.DirectoryService.Types +import Network.AWS.DirectoryService.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'listSchemaExtensions' smart constructor. +data ListSchemaExtensions = ListSchemaExtensions' + { _lseNextToken :: !(Maybe Text) + , _lseLimit :: !(Maybe Nat) + , _lseDirectoryId :: !Text + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ListSchemaExtensions' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lseNextToken' - The @ListSchemaExtensions.NextToken@ value from a previous call to @ListSchemaExtensions@ . Pass null if this is the first call. +-- +-- * 'lseLimit' - The maximum number of items to return. +-- +-- * 'lseDirectoryId' - The identifier of the directory from which to retrieve the schema extension information. +listSchemaExtensions + :: Text -- ^ 'lseDirectoryId' + -> ListSchemaExtensions +listSchemaExtensions pDirectoryId_ = + ListSchemaExtensions' + { _lseNextToken = Nothing + , _lseLimit = Nothing + , _lseDirectoryId = pDirectoryId_ + } + +-- | The @ListSchemaExtensions.NextToken@ value from a previous call to @ListSchemaExtensions@ . Pass null if this is the first call. +lseNextToken :: Lens' ListSchemaExtensions (Maybe Text) +lseNextToken = lens _lseNextToken (\ s a -> s{_lseNextToken = a}); + +-- | The maximum number of items to return. +lseLimit :: Lens' ListSchemaExtensions (Maybe Natural) +lseLimit = lens _lseLimit (\ s a -> s{_lseLimit = a}) . mapping _Nat; + +-- | The identifier of the directory from which to retrieve the schema extension information. +lseDirectoryId :: Lens' ListSchemaExtensions Text +lseDirectoryId = lens _lseDirectoryId (\ s a -> s{_lseDirectoryId = a}); + +instance AWSRequest ListSchemaExtensions where + type Rs ListSchemaExtensions = + ListSchemaExtensionsResponse + request = postJSON directoryService + response + = receiveJSON + (\ s h x -> + ListSchemaExtensionsResponse' <$> + (x .?> "SchemaExtensionsInfo" .!@ mempty) <*> + (x .?> "NextToken") + <*> (pure (fromEnum s))) + +instance Hashable ListSchemaExtensions + +instance NFData ListSchemaExtensions + +instance ToHeaders ListSchemaExtensions where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DirectoryService_20150416.ListSchemaExtensions" :: + ByteString), + "Content-Type" =# + ("application/x-amz-json-1.1" :: ByteString)]) + +instance ToJSON ListSchemaExtensions where + toJSON ListSchemaExtensions'{..} + = object + (catMaybes + [("NextToken" .=) <$> _lseNextToken, + ("Limit" .=) <$> _lseLimit, + Just ("DirectoryId" .= _lseDirectoryId)]) + +instance ToPath ListSchemaExtensions where + toPath = const "/" + +instance ToQuery ListSchemaExtensions where + toQuery = const mempty + +-- | /See:/ 'listSchemaExtensionsResponse' smart constructor. +data ListSchemaExtensionsResponse = ListSchemaExtensionsResponse' + { _lsersSchemaExtensionsInfo :: !(Maybe [SchemaExtensionInfo]) + , _lsersNextToken :: !(Maybe Text) + , _lsersResponseStatus :: !Int + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ListSchemaExtensionsResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lsersSchemaExtensionsInfo' - Information about the schema extensions applied to the directory. +-- +-- * 'lsersNextToken' - If not null, more results are available. Pass this value for the @NextToken@ parameter in a subsequent call to @ListSchemaExtensions@ to retrieve the next set of items. +-- +-- * 'lsersResponseStatus' - -- | The response status code. +listSchemaExtensionsResponse + :: Int -- ^ 'lsersResponseStatus' + -> ListSchemaExtensionsResponse +listSchemaExtensionsResponse pResponseStatus_ = + ListSchemaExtensionsResponse' + { _lsersSchemaExtensionsInfo = Nothing + , _lsersNextToken = Nothing + , _lsersResponseStatus = pResponseStatus_ + } + +-- | Information about the schema extensions applied to the directory. +lsersSchemaExtensionsInfo :: Lens' ListSchemaExtensionsResponse [SchemaExtensionInfo] +lsersSchemaExtensionsInfo = lens _lsersSchemaExtensionsInfo (\ s a -> s{_lsersSchemaExtensionsInfo = a}) . _Default . _Coerce; + +-- | If not null, more results are available. Pass this value for the @NextToken@ parameter in a subsequent call to @ListSchemaExtensions@ to retrieve the next set of items. +lsersNextToken :: Lens' ListSchemaExtensionsResponse (Maybe Text) +lsersNextToken = lens _lsersNextToken (\ s a -> s{_lsersNextToken = a}); + +-- | -- | The response status code. +lsersResponseStatus :: Lens' ListSchemaExtensionsResponse Int +lsersResponseStatus = lens _lsersResponseStatus (\ s a -> s{_lsersResponseStatus = a}); + +instance NFData ListSchemaExtensionsResponse diff --git a/gen/Network/AWS/DirectoryService/ListTagsForResource.hs b/gen/Network/AWS/DirectoryService/ListTagsForResource.hs --- a/gen/Network/AWS/DirectoryService/ListTagsForResource.hs +++ b/gen/Network/AWS/DirectoryService/ListTagsForResource.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Lists all tags on an Amazon Directory Services directory. +-- +-- module Network.AWS.DirectoryService.ListTagsForResource ( -- * Creating a Request @@ -56,11 +58,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ltfrNextToken' +-- * 'ltfrNextToken' - Reserved for future use. -- --- * 'ltfrLimit' +-- * 'ltfrLimit' - Reserved for future use. -- --- * 'ltfrResourceId' +-- * 'ltfrResourceId' - Identifier (ID) of the directory for which you want to retrieve tags. listTagsForResource :: Text -- ^ 'ltfrResourceId' -> ListTagsForResource @@ -133,11 +135,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ltfrrsNextToken' +-- * 'ltfrrsNextToken' - Reserved for future use. -- --- * 'ltfrrsTags' +-- * 'ltfrrsTags' - List of tags returned by the ListTagsForResource operation. -- --- * 'ltfrrsResponseStatus' +-- * 'ltfrrsResponseStatus' - -- | The response status code. listTagsForResourceResponse :: Int -- ^ 'ltfrrsResponseStatus' -> ListTagsForResourceResponse @@ -156,7 +158,7 @@ ltfrrsTags :: Lens' ListTagsForResourceResponse [Tag] ltfrrsTags = lens _ltfrrsTags (\ s a -> s{_ltfrrsTags = a}) . _Default . _Coerce; --- | The response status code. +-- | -- | The response status code. ltfrrsResponseStatus :: Lens' ListTagsForResourceResponse Int ltfrrsResponseStatus = lens _ltfrrsResponseStatus (\ s a -> s{_ltfrrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/RegisterEventTopic.hs b/gen/Network/AWS/DirectoryService/RegisterEventTopic.hs --- a/gen/Network/AWS/DirectoryService/RegisterEventTopic.hs +++ b/gen/Network/AWS/DirectoryService/RegisterEventTopic.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. +-- +-- module Network.AWS.DirectoryService.RegisterEventTopic ( -- * Creating a Request @@ -44,6 +46,8 @@ -- | Registers a new event topic. -- +-- +-- -- /See:/ 'registerEventTopic' smart constructor. data RegisterEventTopic = RegisterEventTopic' { _retDirectoryId :: !Text @@ -54,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'retDirectoryId' +-- * 'retDirectoryId' - The Directory ID that will publish status messages to the SNS topic. -- --- * 'retTopicName' +-- * 'retTopicName' - The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID. registerEventTopic :: Text -- ^ 'retDirectoryId' -> Text -- ^ 'retTopicName' @@ -113,6 +117,8 @@ -- | The result of a RegisterEventTopic request. -- +-- +-- -- /See:/ 'registerEventTopicResponse' smart constructor. newtype RegisterEventTopicResponse = RegisterEventTopicResponse' { _retrsResponseStatus :: Int @@ -122,7 +128,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'retrsResponseStatus' +-- * 'retrsResponseStatus' - -- | The response status code. registerEventTopicResponse :: Int -- ^ 'retrsResponseStatus' -> RegisterEventTopicResponse @@ -131,7 +137,7 @@ { _retrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. retrsResponseStatus :: Lens' RegisterEventTopicResponse Int retrsResponseStatus = lens _retrsResponseStatus (\ s a -> s{_retrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/RemoveIPRoutes.hs b/gen/Network/AWS/DirectoryService/RemoveIPRoutes.hs --- a/gen/Network/AWS/DirectoryService/RemoveIPRoutes.hs +++ b/gen/Network/AWS/DirectoryService/RemoveIPRoutes.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Removes IP address blocks from a directory. +-- +-- module Network.AWS.DirectoryService.RemoveIPRoutes ( -- * Creating a Request @@ -26,7 +28,7 @@ , RemoveIPRoutes -- * Request Lenses , rirDirectoryId - , rirCIdRIPs + , rirCidrIPs -- * Destructuring the Response , removeIPRoutesResponse @@ -45,23 +47,23 @@ -- | /See:/ 'removeIPRoutes' smart constructor. data RemoveIPRoutes = RemoveIPRoutes' { _rirDirectoryId :: !Text - , _rirCIdRIPs :: ![Text] + , _rirCidrIPs :: ![Text] } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | Creates a value of 'RemoveIPRoutes' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rirDirectoryId' +-- * 'rirDirectoryId' - Identifier (ID) of the directory from which you want to remove the IP addresses. -- --- * 'rirCIdRIPs' +-- * 'rirCidrIPs' - IP address blocks that you want to remove. removeIPRoutes :: Text -- ^ 'rirDirectoryId' -> RemoveIPRoutes removeIPRoutes pDirectoryId_ = RemoveIPRoutes' { _rirDirectoryId = pDirectoryId_ - , _rirCIdRIPs = mempty + , _rirCidrIPs = mempty } -- | Identifier (ID) of the directory from which you want to remove the IP addresses. @@ -69,8 +71,8 @@ rirDirectoryId = lens _rirDirectoryId (\ s a -> s{_rirDirectoryId = a}); -- | IP address blocks that you want to remove. -rirCIdRIPs :: Lens' RemoveIPRoutes [Text] -rirCIdRIPs = lens _rirCIdRIPs (\ s a -> s{_rirCIdRIPs = a}) . _Coerce; +rirCidrIPs :: Lens' RemoveIPRoutes [Text] +rirCidrIPs = lens _rirCidrIPs (\ s a -> s{_rirCidrIPs = a}) . _Coerce; instance AWSRequest RemoveIPRoutes where type Rs RemoveIPRoutes = RemoveIPRoutesResponse @@ -99,7 +101,7 @@ = object (catMaybes [Just ("DirectoryId" .= _rirDirectoryId), - Just ("CidrIps" .= _rirCIdRIPs)]) + Just ("CidrIps" .= _rirCidrIPs)]) instance ToPath RemoveIPRoutes where toPath = const "/" @@ -116,7 +118,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rirrsResponseStatus' +-- * 'rirrsResponseStatus' - -- | The response status code. removeIPRoutesResponse :: Int -- ^ 'rirrsResponseStatus' -> RemoveIPRoutesResponse @@ -125,7 +127,7 @@ { _rirrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. rirrsResponseStatus :: Lens' RemoveIPRoutesResponse Int rirrsResponseStatus = lens _rirrsResponseStatus (\ s a -> s{_rirrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/RemoveTagsFromResource.hs b/gen/Network/AWS/DirectoryService/RemoveTagsFromResource.hs --- a/gen/Network/AWS/DirectoryService/RemoveTagsFromResource.hs +++ b/gen/Network/AWS/DirectoryService/RemoveTagsFromResource.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Removes tags from an Amazon Directory Services directory. +-- +-- module Network.AWS.DirectoryService.RemoveTagsFromResource ( -- * Creating a Request @@ -52,9 +54,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rtfrResourceId' +-- * 'rtfrResourceId' - Identifier (ID) of the directory from which to remove the tag. -- --- * 'rtfrTagKeys' +-- * 'rtfrTagKeys' - The tag key (name) of the tag to be removed. removeTagsFromResource :: Text -- ^ 'rtfrResourceId' -> RemoveTagsFromResource @@ -118,7 +120,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rtfrrsResponseStatus' +-- * 'rtfrrsResponseStatus' - -- | The response status code. removeTagsFromResourceResponse :: Int -- ^ 'rtfrrsResponseStatus' -> RemoveTagsFromResourceResponse @@ -127,7 +129,7 @@ { _rtfrrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. rtfrrsResponseStatus :: Lens' RemoveTagsFromResourceResponse Int rtfrrsResponseStatus = lens _rtfrrsResponseStatus (\ s a -> s{_rtfrrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/RestoreFromSnapshot.hs b/gen/Network/AWS/DirectoryService/RestoreFromSnapshot.hs --- a/gen/Network/AWS/DirectoryService/RestoreFromSnapshot.hs +++ b/gen/Network/AWS/DirectoryService/RestoreFromSnapshot.hs @@ -20,9 +20,11 @@ -- -- Restores a directory using an existing directory snapshot. -- +-- -- When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. -- --- This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the < DescribeDirectories> operation with the directory identifier. When the __DirectoryDescription.Stage__ value changes to 'Active', the restore operation is complete. +-- This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the 'DescribeDirectories' operation with the directory identifier. When the __DirectoryDescription.Stage__ value changes to @Active@ , the restore operation is complete. +-- module Network.AWS.DirectoryService.RestoreFromSnapshot ( -- * Creating a Request @@ -45,8 +47,10 @@ import Network.AWS.Request import Network.AWS.Response --- | An object representing the inputs for the < RestoreFromSnapshot> operation. +-- | An object representing the inputs for the 'RestoreFromSnapshot' operation. -- +-- +-- -- /See:/ 'restoreFromSnapshot' smart constructor. newtype RestoreFromSnapshot = RestoreFromSnapshot' { _rfsSnapshotId :: Text @@ -56,7 +60,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rfsSnapshotId' +-- * 'rfsSnapshotId' - The identifier of the snapshot to restore from. restoreFromSnapshot :: Text -- ^ 'rfsSnapshotId' -> RestoreFromSnapshot @@ -103,8 +107,10 @@ instance ToQuery RestoreFromSnapshot where toQuery = const mempty --- | Contains the results of the < RestoreFromSnapshot> operation. +-- | Contains the results of the 'RestoreFromSnapshot' operation. -- +-- +-- -- /See:/ 'restoreFromSnapshotResponse' smart constructor. newtype RestoreFromSnapshotResponse = RestoreFromSnapshotResponse' { _rfsrsResponseStatus :: Int @@ -114,7 +120,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rfsrsResponseStatus' +-- * 'rfsrsResponseStatus' - -- | The response status code. restoreFromSnapshotResponse :: Int -- ^ 'rfsrsResponseStatus' -> RestoreFromSnapshotResponse @@ -123,7 +129,7 @@ { _rfsrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. rfsrsResponseStatus :: Lens' RestoreFromSnapshotResponse Int rfsrsResponseStatus = lens _rfsrsResponseStatus (\ s a -> s{_rfsrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/StartSchemaExtension.hs b/gen/Network/AWS/DirectoryService/StartSchemaExtension.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DirectoryService/StartSchemaExtension.hs @@ -0,0 +1,170 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DirectoryService.StartSchemaExtension +-- Copyright : (c) 2013-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Applies a schema extension to a Microsoft AD directory. +-- +-- +module Network.AWS.DirectoryService.StartSchemaExtension + ( + -- * Creating a Request + startSchemaExtension + , StartSchemaExtension + -- * Request Lenses + , sseDirectoryId + , sseCreateSnapshotBeforeSchemaExtension + , sseLdifContent + , sseDescription + + -- * Destructuring the Response + , startSchemaExtensionResponse + , StartSchemaExtensionResponse + -- * Response Lenses + , ssersSchemaExtensionId + , ssersResponseStatus + ) where + +import Network.AWS.DirectoryService.Types +import Network.AWS.DirectoryService.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'startSchemaExtension' smart constructor. +data StartSchemaExtension = StartSchemaExtension' + { _sseDirectoryId :: !Text + , _sseCreateSnapshotBeforeSchemaExtension :: !Bool + , _sseLdifContent :: !Text + , _sseDescription :: !Text + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'StartSchemaExtension' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sseDirectoryId' - The identifier of the directory for which the schema extension will be applied to. +-- +-- * 'sseCreateSnapshotBeforeSchemaExtension' - If true, creates a snapshot of the directory before applying the schema extension. +-- +-- * 'sseLdifContent' - The LDIF file represented as a string. The file size can be no larger than 1MB. +-- +-- * 'sseDescription' - A description of the schema extension. +startSchemaExtension + :: Text -- ^ 'sseDirectoryId' + -> Bool -- ^ 'sseCreateSnapshotBeforeSchemaExtension' + -> Text -- ^ 'sseLdifContent' + -> Text -- ^ 'sseDescription' + -> StartSchemaExtension +startSchemaExtension pDirectoryId_ pCreateSnapshotBeforeSchemaExtension_ pLdifContent_ pDescription_ = + StartSchemaExtension' + { _sseDirectoryId = pDirectoryId_ + , _sseCreateSnapshotBeforeSchemaExtension = pCreateSnapshotBeforeSchemaExtension_ + , _sseLdifContent = pLdifContent_ + , _sseDescription = pDescription_ + } + +-- | The identifier of the directory for which the schema extension will be applied to. +sseDirectoryId :: Lens' StartSchemaExtension Text +sseDirectoryId = lens _sseDirectoryId (\ s a -> s{_sseDirectoryId = a}); + +-- | If true, creates a snapshot of the directory before applying the schema extension. +sseCreateSnapshotBeforeSchemaExtension :: Lens' StartSchemaExtension Bool +sseCreateSnapshotBeforeSchemaExtension = lens _sseCreateSnapshotBeforeSchemaExtension (\ s a -> s{_sseCreateSnapshotBeforeSchemaExtension = a}); + +-- | The LDIF file represented as a string. The file size can be no larger than 1MB. +sseLdifContent :: Lens' StartSchemaExtension Text +sseLdifContent = lens _sseLdifContent (\ s a -> s{_sseLdifContent = a}); + +-- | A description of the schema extension. +sseDescription :: Lens' StartSchemaExtension Text +sseDescription = lens _sseDescription (\ s a -> s{_sseDescription = a}); + +instance AWSRequest StartSchemaExtension where + type Rs StartSchemaExtension = + StartSchemaExtensionResponse + request = postJSON directoryService + response + = receiveJSON + (\ s h x -> + StartSchemaExtensionResponse' <$> + (x .?> "SchemaExtensionId") <*> (pure (fromEnum s))) + +instance Hashable StartSchemaExtension + +instance NFData StartSchemaExtension + +instance ToHeaders StartSchemaExtension where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DirectoryService_20150416.StartSchemaExtension" :: + ByteString), + "Content-Type" =# + ("application/x-amz-json-1.1" :: ByteString)]) + +instance ToJSON StartSchemaExtension where + toJSON StartSchemaExtension'{..} + = object + (catMaybes + [Just ("DirectoryId" .= _sseDirectoryId), + Just + ("CreateSnapshotBeforeSchemaExtension" .= + _sseCreateSnapshotBeforeSchemaExtension), + Just ("LdifContent" .= _sseLdifContent), + Just ("Description" .= _sseDescription)]) + +instance ToPath StartSchemaExtension where + toPath = const "/" + +instance ToQuery StartSchemaExtension where + toQuery = const mempty + +-- | /See:/ 'startSchemaExtensionResponse' smart constructor. +data StartSchemaExtensionResponse = StartSchemaExtensionResponse' + { _ssersSchemaExtensionId :: !(Maybe Text) + , _ssersResponseStatus :: !Int + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'StartSchemaExtensionResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ssersSchemaExtensionId' - The identifier of the schema extension that will be applied. +-- +-- * 'ssersResponseStatus' - -- | The response status code. +startSchemaExtensionResponse + :: Int -- ^ 'ssersResponseStatus' + -> StartSchemaExtensionResponse +startSchemaExtensionResponse pResponseStatus_ = + StartSchemaExtensionResponse' + { _ssersSchemaExtensionId = Nothing + , _ssersResponseStatus = pResponseStatus_ + } + +-- | The identifier of the schema extension that will be applied. +ssersSchemaExtensionId :: Lens' StartSchemaExtensionResponse (Maybe Text) +ssersSchemaExtensionId = lens _ssersSchemaExtensionId (\ s a -> s{_ssersSchemaExtensionId = a}); + +-- | -- | The response status code. +ssersResponseStatus :: Lens' StartSchemaExtensionResponse Int +ssersResponseStatus = lens _ssersResponseStatus (\ s a -> s{_ssersResponseStatus = a}); + +instance NFData StartSchemaExtensionResponse diff --git a/gen/Network/AWS/DirectoryService/Types.hs b/gen/Network/AWS/DirectoryService/Types.hs --- a/gen/Network/AWS/DirectoryService/Types.hs +++ b/gen/Network/AWS/DirectoryService/Types.hs @@ -52,6 +52,9 @@ -- * ReplicationScope , ReplicationScope (..) + -- * SchemaExtensionStatus + , SchemaExtensionStatus (..) + -- * SnapshotStatus , SnapshotStatus (..) @@ -169,7 +172,7 @@ -- * IPRoute , IPRoute , ipRoute - , irCIdRIP + , irCidrIP , irDescription -- * IPRouteInfo @@ -178,7 +181,7 @@ , iriDirectoryId , iriIPRouteStatusReason , iriAddedDateTime - , iriCIdRIP + , iriCidrIP , iriIPRouteStatusMsg , iriDescription @@ -194,6 +197,17 @@ , rsRadiusTimeout , rsRadiusPort + -- * SchemaExtensionInfo + , SchemaExtensionInfo + , schemaExtensionInfo + , seiDirectoryId + , seiSchemaExtensionId + , seiSchemaExtensionStatusReason + , seiSchemaExtensionStatus + , seiDescription + , seiEndDateTime + , seiStartDateTime + -- * Snapshot , Snapshot , snapshot @@ -238,7 +252,7 @@ import Network.AWS.Prelude import Network.AWS.Sign.V4 --- | API version '2015-04-16' of the Amazon Directory Service SDK configuration. +-- | API version @2015-04-16@ of the Amazon Directory Service SDK configuration. directoryService :: Service directoryService = Service @@ -273,69 +287,97 @@ | otherwise = Nothing -- | The specified directory is unavailable or could not be found. +-- +-- _DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError _DirectoryUnavailableException = _ServiceError . hasCode "DirectoryUnavailableException" -- | An authentication error occurred. +-- +-- _AuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError _AuthenticationFailedException = _ServiceError . hasCode "AuthenticationFailedException" -- | One or more parameters are not valid. +-- +-- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidParameterException = _ServiceError . hasCode "InvalidParameterException" -- | The operation is not supported. +-- +-- _UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError _UnsupportedOperationException = _ServiceError . hasCode "UnsupportedOperationException" -- | The specified entity already exists. +-- +-- _EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError _EntityAlreadyExistsException = _ServiceError . hasCode "EntityAlreadyExistsException" --- | The maximum number of directories in the region has been reached. You can use the < GetDirectoryLimits> operation to determine your directory limits in the region. +-- | The maximum number of directories in the region has been reached. You can use the 'GetDirectoryLimits' operation to determine your directory limits in the region. +-- +-- _DirectoryLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _DirectoryLimitExceededException = _ServiceError . hasCode "DirectoryLimitExceededException" -- | The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks. +-- +-- _IPRouteLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _IPRouteLimitExceededException = _ServiceError . hasCode "IpRouteLimitExceededException" -- | The specified entity could not be found. +-- +-- _EntityDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError _EntityDoesNotExistException = _ServiceError . hasCode "EntityDoesNotExistException" -- | The account does not have sufficient permission to perform the operation. +-- +-- _InsufficientPermissionsException :: AsError a => Getting (First ServiceError) a ServiceError _InsufficientPermissionsException = _ServiceError . hasCode "InsufficientPermissionsException" -- | The /NextToken/ value is not valid. +-- +-- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidNextTokenException = _ServiceError . hasCode "InvalidNextTokenException" -- | An exception has occurred in AWS Directory Service. +-- +-- _ServiceException :: AsError a => Getting (First ServiceError) a ServiceError _ServiceException = _ServiceError . hasCode "ServiceException" --- | The maximum number of manual snapshots for the directory has been reached. You can use the < GetSnapshotLimits> operation to determine the snapshot limits for a directory. +-- | The maximum number of manual snapshots for the directory has been reached. You can use the 'GetSnapshotLimits' operation to determine the snapshot limits for a directory. +-- +-- _SnapshotLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _SnapshotLimitExceededException = _ServiceError . hasCode "SnapshotLimitExceededException" -- | The maximum allowed number of tags was exceeded. +-- +-- _TagLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _TagLimitExceededException = _ServiceError . hasCode "TagLimitExceededException" -- | A client exception has occurred. +-- +-- _ClientException :: AsError a => Getting (First ServiceError) a ServiceError _ClientException = _ServiceError . hasCode "ClientException" diff --git a/gen/Network/AWS/DirectoryService/Types/Product.hs b/gen/Network/AWS/DirectoryService/Types/Product.hs --- a/gen/Network/AWS/DirectoryService/Types/Product.hs +++ b/gen/Network/AWS/DirectoryService/Types/Product.hs @@ -23,6 +23,8 @@ -- | Represents a named directory attribute. -- +-- +-- -- /See:/ 'attribute' smart constructor. data Attribute = Attribute' { _aValue :: !(Maybe Text) @@ -33,9 +35,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'aValue' +-- * 'aValue' - The value of the attribute. -- --- * 'aName' +-- * 'aName' - The name of the attribute. attribute :: Attribute attribute = @@ -70,6 +72,8 @@ -- | Contains information about a computer account in a directory. -- +-- +-- -- /See:/ 'computer' smart constructor. data Computer = Computer' { _cComputerId :: !(Maybe Text) @@ -81,11 +85,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cComputerId' +-- * 'cComputerId' - The identifier of the computer. -- --- * 'cComputerAttributes' +-- * 'cComputerAttributes' - An array of 'Attribute' objects containing the LDAP attributes that belong to the computer account. -- --- * 'cComputerName' +-- * 'cComputerName' - The computer name. computer :: Computer computer = @@ -99,7 +103,7 @@ cComputerId :: Lens' Computer (Maybe Text) cComputerId = lens _cComputerId (\ s a -> s{_cComputerId = a}); --- | An array of < Attribute> objects containing the LDAP attributes that belong to the computer account. +-- | An array of 'Attribute' objects containing the LDAP attributes that belong to the computer account. cComputerAttributes :: Lens' Computer [Attribute] cComputerAttributes = lens _cComputerAttributes (\ s a -> s{_cComputerAttributes = a}) . _Default . _Coerce; @@ -122,6 +126,8 @@ -- | Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain. -- +-- +-- -- /See:/ 'conditionalForwarder' smart constructor. data ConditionalForwarder = ConditionalForwarder' { _cfDNSIPAddrs :: !(Maybe [Text]) @@ -133,11 +139,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cfDNSIPAddrs' +-- * 'cfDNSIPAddrs' - The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to. -- --- * 'cfRemoteDomainName' +-- * 'cfRemoteDomainName' - The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder. -- --- * 'cfReplicationScope' +-- * 'cfReplicationScope' - The replication scope of the conditional forwarder. The only allowed value is @Domain@ , which will replicate the conditional forwarder to all of the domain controllers for your AWS directory. conditionalForwarder :: ConditionalForwarder conditionalForwarder = @@ -155,7 +161,7 @@ cfRemoteDomainName :: Lens' ConditionalForwarder (Maybe Text) cfRemoteDomainName = lens _cfRemoteDomainName (\ s a -> s{_cfRemoteDomainName = a}); --- | The replication scope of the conditional forwarder. The only allowed value is 'Domain', which will replicate the conditional forwarder to all of the domain controllers for your AWS directory. +-- | The replication scope of the conditional forwarder. The only allowed value is @Domain@ , which will replicate the conditional forwarder to all of the domain controllers for your AWS directory. cfReplicationScope :: Lens' ConditionalForwarder (Maybe ReplicationScope) cfReplicationScope = lens _cfReplicationScope (\ s a -> s{_cfReplicationScope = a}); @@ -172,8 +178,10 @@ instance NFData ConditionalForwarder --- | Contains information for the < ConnectDirectory> operation when an AD Connector directory is being created. +-- | Contains information for the 'ConnectDirectory' operation when an AD Connector directory is being created. -- +-- +-- -- /See:/ 'directoryConnectSettings' smart constructor. data DirectoryConnectSettings = DirectoryConnectSettings' { _dcsVPCId :: !Text @@ -186,13 +194,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dcsVPCId' +-- * 'dcsVPCId' - The identifier of the VPC in which the AD Connector is created. -- --- * 'dcsSubnetIds' +-- * 'dcsSubnetIds' - A list of subnet identifiers in the VPC in which the AD Connector is created. -- --- * 'dcsCustomerDNSIPs' +-- * 'dcsCustomerDNSIPs' - A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory. -- --- * 'dcsCustomerUserName' +-- * 'dcsCustomerUserName' - The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges: * Read users and groups * Create computer objects * Join computers to the domain directoryConnectSettings :: Text -- ^ 'dcsVPCId' -> Text -- ^ 'dcsCustomerUserName' @@ -217,14 +225,7 @@ dcsCustomerDNSIPs :: Lens' DirectoryConnectSettings [Text] dcsCustomerDNSIPs = lens _dcsCustomerDNSIPs (\ s a -> s{_dcsCustomerDNSIPs = a}) . _Coerce; --- | The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges: --- --- - Read users and groups --- --- - Create computer objects --- --- - Join computers to the domain --- +-- | The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges: * Read users and groups * Create computer objects * Join computers to the domain dcsCustomerUserName :: Lens' DirectoryConnectSettings Text dcsCustomerUserName = lens _dcsCustomerUserName (\ s a -> s{_dcsCustomerUserName = a}); @@ -243,6 +244,8 @@ -- | Contains information about an AD Connector directory. -- +-- +-- -- /See:/ 'directoryConnectSettingsDescription' smart constructor. data DirectoryConnectSettingsDescription = DirectoryConnectSettingsDescription' { _dcsdCustomerUserName :: !(Maybe Text) @@ -257,17 +260,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dcsdCustomerUserName' +-- * 'dcsdCustomerUserName' - The username of the service account in the on-premises directory. -- --- * 'dcsdSubnetIds' +-- * 'dcsdSubnetIds' - A list of subnet identifiers in the VPC that the AD connector is in. -- --- * 'dcsdVPCId' +-- * 'dcsdVPCId' - The identifier of the VPC that the AD Connector is in. -- --- * 'dcsdSecurityGroupId' +-- * 'dcsdSecurityGroupId' - The security group identifier for the AD Connector directory. -- --- * 'dcsdConnectIPs' +-- * 'dcsdConnectIPs' - The IP addresses of the AD Connector servers. -- --- * 'dcsdAvailabilityZones' +-- * 'dcsdAvailabilityZones' - A list of the Availability Zones that the directory is in. directoryConnectSettingsDescription :: DirectoryConnectSettingsDescription directoryConnectSettingsDescription = @@ -323,6 +326,8 @@ -- | Contains information about an AWS Directory Service directory. -- +-- +-- -- /See:/ 'directoryDescription' smart constructor. data DirectoryDescription = DirectoryDescription' { _ddRadiusStatus :: !(Maybe RadiusStatus) @@ -349,41 +354,41 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ddRadiusStatus' +-- * 'ddRadiusStatus' - The status of the RADIUS MFA server connection. -- --- * 'ddStage' +-- * 'ddStage' - The current stage of the directory. -- --- * 'ddDirectoryId' +-- * 'ddDirectoryId' - The directory identifier. -- --- * 'ddAccessURL' +-- * 'ddAccessURL' - The access URL for the directory, such as @http://.awsapps.com@ . If no alias has been created for the directory, @@ is the directory identifier, such as @d-XXXXXXXXXX@ . -- --- * 'ddShortName' +-- * 'ddShortName' - The short name of the directory. -- --- * 'ddSize' +-- * 'ddSize' - The directory size. -- --- * 'ddRadiusSettings' +-- * 'ddRadiusSettings' - A 'RadiusSettings' object that contains information about the RADIUS server configured for this directory. -- --- * 'ddLaunchTime' +-- * 'ddLaunchTime' - Specifies when the directory was created. -- --- * 'ddAlias' +-- * 'ddAlias' - The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as @d-XXXXXXXXXX@ . -- --- * 'ddName' +-- * 'ddName' - The fully-qualified name of the directory. -- --- * 'ddStageLastUpdatedDateTime' +-- * 'ddStageLastUpdatedDateTime' - The date and time that the stage was last updated. -- --- * 'ddSSOEnabled' +-- * 'ddSSOEnabled' - Indicates if single-sign on is enabled for the directory. For more information, see 'EnableSso' and 'DisableSso' . -- --- * 'ddDNSIPAddrs' +-- * 'ddDNSIPAddrs' - The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected. -- --- * 'ddVPCSettings' +-- * 'ddVPCSettings' - A 'DirectoryVpcSettingsDescription' object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory. -- --- * 'ddType' +-- * 'ddType' - The directory size. -- --- * 'ddStageReason' +-- * 'ddStageReason' - Additional information about the directory stage. -- --- * 'ddConnectSettings' +-- * 'ddConnectSettings' - A 'DirectoryConnectSettingsDescription' object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory. -- --- * 'ddDescription' +-- * 'ddDescription' - The textual description for the directory. directoryDescription :: DirectoryDescription directoryDescription = @@ -420,7 +425,7 @@ ddDirectoryId :: Lens' DirectoryDescription (Maybe Text) ddDirectoryId = lens _ddDirectoryId (\ s a -> s{_ddDirectoryId = a}); --- | The access URL for the directory, such as 'http:\/\/\.awsapps.com'. If no alias has been created for the directory, '\' is the directory identifier, such as 'd-XXXXXXXXXX'. +-- | The access URL for the directory, such as @http://.awsapps.com@ . If no alias has been created for the directory, @@ is the directory identifier, such as @d-XXXXXXXXXX@ . ddAccessURL :: Lens' DirectoryDescription (Maybe Text) ddAccessURL = lens _ddAccessURL (\ s a -> s{_ddAccessURL = a}); @@ -432,7 +437,7 @@ ddSize :: Lens' DirectoryDescription (Maybe DirectorySize) ddSize = lens _ddSize (\ s a -> s{_ddSize = a}); --- | A < RadiusSettings> object that contains information about the RADIUS server configured for this directory. +-- | A 'RadiusSettings' object that contains information about the RADIUS server configured for this directory. ddRadiusSettings :: Lens' DirectoryDescription (Maybe RadiusSettings) ddRadiusSettings = lens _ddRadiusSettings (\ s a -> s{_ddRadiusSettings = a}); @@ -440,7 +445,7 @@ ddLaunchTime :: Lens' DirectoryDescription (Maybe UTCTime) ddLaunchTime = lens _ddLaunchTime (\ s a -> s{_ddLaunchTime = a}) . mapping _Time; --- | The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as 'd-XXXXXXXXXX'. +-- | The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as @d-XXXXXXXXXX@ . ddAlias :: Lens' DirectoryDescription (Maybe Text) ddAlias = lens _ddAlias (\ s a -> s{_ddAlias = a}); @@ -452,7 +457,7 @@ ddStageLastUpdatedDateTime :: Lens' DirectoryDescription (Maybe UTCTime) ddStageLastUpdatedDateTime = lens _ddStageLastUpdatedDateTime (\ s a -> s{_ddStageLastUpdatedDateTime = a}) . mapping _Time; --- | Indicates if single-sign on is enabled for the directory. For more information, see < EnableSso> and < DisableSso>. +-- | Indicates if single-sign on is enabled for the directory. For more information, see 'EnableSso' and 'DisableSso' . ddSSOEnabled :: Lens' DirectoryDescription (Maybe Bool) ddSSOEnabled = lens _ddSSOEnabled (\ s a -> s{_ddSSOEnabled = a}); @@ -460,7 +465,7 @@ ddDNSIPAddrs :: Lens' DirectoryDescription [Text] ddDNSIPAddrs = lens _ddDNSIPAddrs (\ s a -> s{_ddDNSIPAddrs = a}) . _Default . _Coerce; --- | A < DirectoryVpcSettingsDescription> object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory. +-- | A 'DirectoryVpcSettingsDescription' object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory. ddVPCSettings :: Lens' DirectoryDescription (Maybe DirectoryVPCSettingsDescription) ddVPCSettings = lens _ddVPCSettings (\ s a -> s{_ddVPCSettings = a}); @@ -472,7 +477,7 @@ ddStageReason :: Lens' DirectoryDescription (Maybe Text) ddStageReason = lens _ddStageReason (\ s a -> s{_ddStageReason = a}); --- | A < DirectoryConnectSettingsDescription> object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory. +-- | A 'DirectoryConnectSettingsDescription' object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory. ddConnectSettings :: Lens' DirectoryDescription (Maybe DirectoryConnectSettingsDescription) ddConnectSettings = lens _ddConnectSettings (\ s a -> s{_ddConnectSettings = a}); @@ -509,6 +514,8 @@ -- | Contains directory limit information for a region. -- +-- +-- -- /See:/ 'directoryLimits' smart constructor. data DirectoryLimits = DirectoryLimits' { _dlConnectedDirectoriesCurrentCount :: !(Maybe Nat) @@ -526,23 +533,23 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dlConnectedDirectoriesCurrentCount' +-- * 'dlConnectedDirectoriesCurrentCount' - The current number of connected directories in the region. -- --- * 'dlCloudOnlyMicrosoftADLimitReached' +-- * 'dlCloudOnlyMicrosoftADLimitReached' - Indicates if the Microsoft AD directory limit has been reached. -- --- * 'dlConnectedDirectoriesLimit' +-- * 'dlConnectedDirectoriesLimit' - The maximum number of connected directories allowed in the region. -- --- * 'dlConnectedDirectoriesLimitReached' +-- * 'dlConnectedDirectoriesLimitReached' - Indicates if the connected directory limit has been reached. -- --- * 'dlCloudOnlyMicrosoftADLimit' +-- * 'dlCloudOnlyMicrosoftADLimit' - The maximum number of Microsoft AD directories allowed in the region. -- --- * 'dlCloudOnlyDirectoriesLimit' +-- * 'dlCloudOnlyDirectoriesLimit' - The maximum number of cloud directories allowed in the region. -- --- * 'dlCloudOnlyDirectoriesCurrentCount' +-- * 'dlCloudOnlyDirectoriesCurrentCount' - The current number of cloud directories in the region. -- --- * 'dlCloudOnlyDirectoriesLimitReached' +-- * 'dlCloudOnlyDirectoriesLimitReached' - Indicates if the cloud directory limit has been reached. -- --- * 'dlCloudOnlyMicrosoftADCurrentCount' +-- * 'dlCloudOnlyMicrosoftADCurrentCount' - The current number of Microsoft AD directories in the region. directoryLimits :: DirectoryLimits directoryLimits = @@ -613,8 +620,10 @@ instance NFData DirectoryLimits --- | Contains VPC information for the < CreateDirectory> or < CreateMicrosoftAD> operation. +-- | Contains VPC information for the 'CreateDirectory' or 'CreateMicrosoftAD' operation. -- +-- +-- -- /See:/ 'directoryVPCSettings' smart constructor. data DirectoryVPCSettings = DirectoryVPCSettings' { _dvsVPCId :: !Text @@ -625,9 +634,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dvsVPCId' +-- * 'dvsVPCId' - The identifier of the VPC in which to create the directory. -- --- * 'dvsSubnetIds' +-- * 'dvsSubnetIds' - The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets. directoryVPCSettings :: Text -- ^ 'dvsVPCId' -> DirectoryVPCSettings @@ -658,6 +667,8 @@ -- | Contains information about the directory. -- +-- +-- -- /See:/ 'directoryVPCSettingsDescription' smart constructor. data DirectoryVPCSettingsDescription = DirectoryVPCSettingsDescription' { _dvsdSubnetIds :: !(Maybe [Text]) @@ -670,13 +681,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dvsdSubnetIds' +-- * 'dvsdSubnetIds' - The identifiers of the subnets for the directory servers. -- --- * 'dvsdVPCId' +-- * 'dvsdVPCId' - The identifier of the VPC that the directory is in. -- --- * 'dvsdSecurityGroupId' +-- * 'dvsdSecurityGroupId' - The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null. -- --- * 'dvsdAvailabilityZones' +-- * 'dvsdAvailabilityZones' - The list of Availability Zones that the directory is in. directoryVPCSettingsDescription :: DirectoryVPCSettingsDescription directoryVPCSettingsDescription = @@ -695,7 +706,7 @@ dvsdVPCId :: Lens' DirectoryVPCSettingsDescription (Maybe Text) dvsdVPCId = lens _dvsdVPCId (\ s a -> s{_dvsdVPCId = a}); --- | The security group identifier for the directory. If the directory was created before 8\/1\/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null. +-- | The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null. dvsdSecurityGroupId :: Lens' DirectoryVPCSettingsDescription (Maybe Text) dvsdSecurityGroupId = lens _dvsdSecurityGroupId (\ s a -> s{_dvsdSecurityGroupId = a}); @@ -719,6 +730,8 @@ -- | Information about SNS topic and AWS Directory Service directory associations. -- +-- +-- -- /See:/ 'eventTopic' smart constructor. data EventTopic = EventTopic' { _etStatus :: !(Maybe TopicStatus) @@ -732,15 +745,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'etStatus' +-- * 'etStatus' - The topic registration status. -- --- * 'etDirectoryId' +-- * 'etDirectoryId' - The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic. -- --- * 'etTopicName' +-- * 'etTopicName' - The name of an AWS SNS topic the receives status messages from the directory. -- --- * 'etTopicARN' +-- * 'etTopicARN' - The SNS topic ARN (Amazon Resource Name). -- --- * 'etCreatedDateTime' +-- * 'etCreatedDateTime' - The date and time of when you associated your directory with the SNS topic. eventTopic :: EventTopic eventTopic = @@ -788,9 +801,11 @@ -- | IP address block. This is often the address block of the DNS server used for your on-premises domain. -- +-- +-- -- /See:/ 'ipRoute' smart constructor. data IPRoute = IPRoute' - { _irCIdRIP :: !(Maybe Text) + { _irCidrIP :: !(Maybe Text) , _irDescription :: !(Maybe Text) } deriving (Eq,Read,Show,Data,Typeable,Generic) @@ -798,20 +813,20 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'irCIdRIP' +-- * 'irCidrIP' - IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32. -- --- * 'irDescription' +-- * 'irDescription' - Description of the address block. ipRoute :: IPRoute ipRoute = IPRoute' - { _irCIdRIP = Nothing + { _irCidrIP = Nothing , _irDescription = Nothing } --- | IP address block using CIDR format, for example 10.0.0.0\/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with \/32. For example 10.0.0.0\/32. -irCIdRIP :: Lens' IPRoute (Maybe Text) -irCIdRIP = lens _irCIdRIP (\ s a -> s{_irCIdRIP = a}); +-- | IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32. +irCidrIP :: Lens' IPRoute (Maybe Text) +irCidrIP = lens _irCidrIP (\ s a -> s{_irCidrIP = a}); -- | Description of the address block. irDescription :: Lens' IPRoute (Maybe Text) @@ -825,17 +840,19 @@ toJSON IPRoute'{..} = object (catMaybes - [("CidrIp" .=) <$> _irCIdRIP, + [("CidrIp" .=) <$> _irCidrIP, ("Description" .=) <$> _irDescription]) -- | Information about one or more IP address blocks. -- +-- +-- -- /See:/ 'ipRouteInfo' smart constructor. data IPRouteInfo = IPRouteInfo' { _iriDirectoryId :: !(Maybe Text) , _iriIPRouteStatusReason :: !(Maybe Text) , _iriAddedDateTime :: !(Maybe POSIX) - , _iriCIdRIP :: !(Maybe Text) + , _iriCidrIP :: !(Maybe Text) , _iriIPRouteStatusMsg :: !(Maybe IPRouteStatusMsg) , _iriDescription :: !(Maybe Text) } deriving (Eq,Read,Show,Data,Typeable,Generic) @@ -844,17 +861,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'iriDirectoryId' +-- * 'iriDirectoryId' - Identifier (ID) of the directory associated with the IP addresses. -- --- * 'iriIPRouteStatusReason' +-- * 'iriIPRouteStatusReason' - The reason for the IpRouteStatusMsg. -- --- * 'iriAddedDateTime' +-- * 'iriAddedDateTime' - The date and time the address block was added to the directory. -- --- * 'iriCIdRIP' +-- * 'iriCidrIP' - IP address block in the 'IpRoute' . -- --- * 'iriIPRouteStatusMsg' +-- * 'iriIPRouteStatusMsg' - The status of the IP address block. -- --- * 'iriDescription' +-- * 'iriDescription' - Description of the 'IpRouteInfo' . ipRouteInfo :: IPRouteInfo ipRouteInfo = @@ -862,7 +879,7 @@ { _iriDirectoryId = Nothing , _iriIPRouteStatusReason = Nothing , _iriAddedDateTime = Nothing - , _iriCIdRIP = Nothing + , _iriCidrIP = Nothing , _iriIPRouteStatusMsg = Nothing , _iriDescription = Nothing } @@ -879,15 +896,15 @@ iriAddedDateTime :: Lens' IPRouteInfo (Maybe UTCTime) iriAddedDateTime = lens _iriAddedDateTime (\ s a -> s{_iriAddedDateTime = a}) . mapping _Time; --- | IP address block in the < IpRoute>. -iriCIdRIP :: Lens' IPRouteInfo (Maybe Text) -iriCIdRIP = lens _iriCIdRIP (\ s a -> s{_iriCIdRIP = a}); +-- | IP address block in the 'IpRoute' . +iriCidrIP :: Lens' IPRouteInfo (Maybe Text) +iriCidrIP = lens _iriCidrIP (\ s a -> s{_iriCidrIP = a}); -- | The status of the IP address block. iriIPRouteStatusMsg :: Lens' IPRouteInfo (Maybe IPRouteStatusMsg) iriIPRouteStatusMsg = lens _iriIPRouteStatusMsg (\ s a -> s{_iriIPRouteStatusMsg = a}); --- | Description of the < IpRouteInfo>. +-- | Description of the 'IpRouteInfo' . iriDescription :: Lens' IPRouteInfo (Maybe Text) iriDescription = lens _iriDescription (\ s a -> s{_iriDescription = a}); @@ -909,6 +926,8 @@ -- | Contains information about a Remote Authentication Dial In User Service (RADIUS) server. -- +-- +-- -- /See:/ 'radiusSettings' smart constructor. data RadiusSettings = RadiusSettings' { _rsDisplayLabel :: !(Maybe Text) @@ -925,21 +944,21 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rsDisplayLabel' +-- * 'rsDisplayLabel' - Not currently used. -- --- * 'rsRadiusRetries' +-- * 'rsRadiusRetries' - The maximum number of times that communication with the RADIUS server is attempted. -- --- * 'rsAuthenticationProtocol' +-- * 'rsAuthenticationProtocol' - The protocol specified for your RADIUS endpoints. -- --- * 'rsRadiusServers' +-- * 'rsRadiusServers' - An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer. -- --- * 'rsUseSameUsername' +-- * 'rsUseSameUsername' - Not currently used. -- --- * 'rsSharedSecret' +-- * 'rsSharedSecret' - Not currently used. -- --- * 'rsRadiusTimeout' +-- * 'rsRadiusTimeout' - The amount of time, in seconds, to wait for the RADIUS server to respond. -- --- * 'rsRadiusPort' +-- * 'rsRadiusPort' - The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers. radiusSettings :: RadiusSettings radiusSettings = @@ -1017,8 +1036,99 @@ ("RadiusTimeout" .=) <$> _rsRadiusTimeout, ("RadiusPort" .=) <$> _rsRadiusPort]) +-- | Information about a schema extension. +-- +-- +-- +-- /See:/ 'schemaExtensionInfo' smart constructor. +data SchemaExtensionInfo = SchemaExtensionInfo' + { _seiDirectoryId :: !(Maybe Text) + , _seiSchemaExtensionId :: !(Maybe Text) + , _seiSchemaExtensionStatusReason :: !(Maybe Text) + , _seiSchemaExtensionStatus :: !(Maybe SchemaExtensionStatus) + , _seiDescription :: !(Maybe Text) + , _seiEndDateTime :: !(Maybe POSIX) + , _seiStartDateTime :: !(Maybe POSIX) + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'SchemaExtensionInfo' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'seiDirectoryId' - The identifier of the directory to which the schema extension is applied. +-- +-- * 'seiSchemaExtensionId' - The identifier of the schema extension. +-- +-- * 'seiSchemaExtensionStatusReason' - The reason for the @SchemaExtensionStatus@ . +-- +-- * 'seiSchemaExtensionStatus' - The current status of the schema extension. +-- +-- * 'seiDescription' - A description of the schema extension. +-- +-- * 'seiEndDateTime' - The date and time that the schema extension was completed. +-- +-- * 'seiStartDateTime' - The date and time that the schema extension started being applied to the directory. +schemaExtensionInfo + :: SchemaExtensionInfo +schemaExtensionInfo = + SchemaExtensionInfo' + { _seiDirectoryId = Nothing + , _seiSchemaExtensionId = Nothing + , _seiSchemaExtensionStatusReason = Nothing + , _seiSchemaExtensionStatus = Nothing + , _seiDescription = Nothing + , _seiEndDateTime = Nothing + , _seiStartDateTime = Nothing + } + +-- | The identifier of the directory to which the schema extension is applied. +seiDirectoryId :: Lens' SchemaExtensionInfo (Maybe Text) +seiDirectoryId = lens _seiDirectoryId (\ s a -> s{_seiDirectoryId = a}); + +-- | The identifier of the schema extension. +seiSchemaExtensionId :: Lens' SchemaExtensionInfo (Maybe Text) +seiSchemaExtensionId = lens _seiSchemaExtensionId (\ s a -> s{_seiSchemaExtensionId = a}); + +-- | The reason for the @SchemaExtensionStatus@ . +seiSchemaExtensionStatusReason :: Lens' SchemaExtensionInfo (Maybe Text) +seiSchemaExtensionStatusReason = lens _seiSchemaExtensionStatusReason (\ s a -> s{_seiSchemaExtensionStatusReason = a}); + +-- | The current status of the schema extension. +seiSchemaExtensionStatus :: Lens' SchemaExtensionInfo (Maybe SchemaExtensionStatus) +seiSchemaExtensionStatus = lens _seiSchemaExtensionStatus (\ s a -> s{_seiSchemaExtensionStatus = a}); + +-- | A description of the schema extension. +seiDescription :: Lens' SchemaExtensionInfo (Maybe Text) +seiDescription = lens _seiDescription (\ s a -> s{_seiDescription = a}); + +-- | The date and time that the schema extension was completed. +seiEndDateTime :: Lens' SchemaExtensionInfo (Maybe UTCTime) +seiEndDateTime = lens _seiEndDateTime (\ s a -> s{_seiEndDateTime = a}) . mapping _Time; + +-- | The date and time that the schema extension started being applied to the directory. +seiStartDateTime :: Lens' SchemaExtensionInfo (Maybe UTCTime) +seiStartDateTime = lens _seiStartDateTime (\ s a -> s{_seiStartDateTime = a}) . mapping _Time; + +instance FromJSON SchemaExtensionInfo where + parseJSON + = withObject "SchemaExtensionInfo" + (\ x -> + SchemaExtensionInfo' <$> + (x .:? "DirectoryId") <*> (x .:? "SchemaExtensionId") + <*> (x .:? "SchemaExtensionStatusReason") + <*> (x .:? "SchemaExtensionStatus") + <*> (x .:? "Description") + <*> (x .:? "EndDateTime") + <*> (x .:? "StartDateTime")) + +instance Hashable SchemaExtensionInfo + +instance NFData SchemaExtensionInfo + -- | Describes a directory snapshot. -- +-- +-- -- /See:/ 'snapshot' smart constructor. data Snapshot = Snapshot' { _sStatus :: !(Maybe SnapshotStatus) @@ -1033,17 +1143,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'sStatus' +-- * 'sStatus' - The snapshot status. -- --- * 'sDirectoryId' +-- * 'sDirectoryId' - The directory identifier. -- --- * 'sStartTime' +-- * 'sStartTime' - The date and time that the snapshot was taken. -- --- * 'sName' +-- * 'sName' - The descriptive name of the snapshot. -- --- * 'sType' +-- * 'sType' - The snapshot type. -- --- * 'sSnapshotId' +-- * 'sSnapshotId' - The snapshot identifier. snapshot :: Snapshot snapshot = @@ -1097,6 +1207,8 @@ -- | Contains manual snapshot limit information for a directory. -- +-- +-- -- /See:/ 'snapshotLimits' smart constructor. data SnapshotLimits = SnapshotLimits' { _slManualSnapshotsLimitReached :: !(Maybe Bool) @@ -1108,11 +1220,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'slManualSnapshotsLimitReached' +-- * 'slManualSnapshotsLimitReached' - Indicates if the manual snapshot limit has been reached. -- --- * 'slManualSnapshotsCurrentCount' +-- * 'slManualSnapshotsCurrentCount' - The current number of manual snapshots of the directory. -- --- * 'slManualSnapshotsLimit' +-- * 'slManualSnapshotsLimit' - The maximum number of manual snapshots allowed. snapshotLimits :: SnapshotLimits snapshotLimits = @@ -1149,6 +1261,8 @@ -- | Metadata assigned to an Amazon Directory Services directory consisting of a key-value pair. -- +-- +-- -- /See:/ 'tag' smart constructor. data Tag = Tag' { _tagKey :: !Text @@ -1159,9 +1273,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'tagKey' +-- * 'tagKey' - Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). -- --- * 'tagValue' +-- * 'tagValue' - The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). tag :: Text -- ^ 'tagKey' -> Text -- ^ 'tagValue' @@ -1172,11 +1286,11 @@ , _tagValue = pValue_ } --- | Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \'\/\', \'=\', \'+\', \'-\' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:\/=+\\\\-]*)>\"). +-- | Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). tagKey :: Lens' Tag Text tagKey = lens _tagKey (\ s a -> s{_tagKey = a}); --- | The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \'\/\', \'=\', \'+\', \'-\' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:\/=+\\\\-]*)>\"). +-- | The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). tagValue :: Lens' Tag Text tagValue = lens _tagValue (\ s a -> s{_tagValue = a}); @@ -1198,6 +1312,8 @@ -- | Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain. -- +-- +-- -- /See:/ 'trust' smart constructor. data Trust = Trust' { _tDirectoryId :: !(Maybe Text) @@ -1216,25 +1332,25 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'tDirectoryId' +-- * 'tDirectoryId' - The Directory ID of the AWS directory involved in the trust relationship. -- --- * 'tTrustState' +-- * 'tTrustState' - The trust relationship state. -- --- * 'tLastUpdatedDateTime' +-- * 'tLastUpdatedDateTime' - The date and time that the trust relationship was last updated. -- --- * 'tTrustDirection' +-- * 'tTrustDirection' - The trust relationship direction. -- --- * 'tStateLastUpdatedDateTime' +-- * 'tStateLastUpdatedDateTime' - The date and time that the TrustState was last updated. -- --- * 'tTrustType' +-- * 'tTrustType' - The trust relationship type. -- --- * 'tTrustStateReason' +-- * 'tTrustStateReason' - The reason for the TrustState. -- --- * 'tRemoteDomainName' +-- * 'tRemoteDomainName' - The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship. -- --- * 'tTrustId' +-- * 'tTrustId' - The unique ID of the trust relationship. -- --- * 'tCreatedDateTime' +-- * 'tCreatedDateTime' - The date and time that the trust relationship was created. trust :: Trust trust = diff --git a/gen/Network/AWS/DirectoryService/Types/Sum.hs b/gen/Network/AWS/DirectoryService/Types/Sum.hs --- a/gen/Network/AWS/DirectoryService/Types/Sum.hs +++ b/gen/Network/AWS/DirectoryService/Types/Sum.hs @@ -255,6 +255,53 @@ instance FromJSON ReplicationScope where parseJSON = parseJSONText "ReplicationScope" +data SchemaExtensionStatus + = SESCancelInProgress + | SESCancelled + | SESCompleted + | SESCreatingSnapshot + | SESFailed + | SESInitializing + | SESReplicating + | SESRollbackInProgress + | SESUpdatingSchema + deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + +instance FromText SchemaExtensionStatus where + parser = takeLowerText >>= \case + "cancelinprogress" -> pure SESCancelInProgress + "cancelled" -> pure SESCancelled + "completed" -> pure SESCompleted + "creatingsnapshot" -> pure SESCreatingSnapshot + "failed" -> pure SESFailed + "initializing" -> pure SESInitializing + "replicating" -> pure SESReplicating + "rollbackinprogress" -> pure SESRollbackInProgress + "updatingschema" -> pure SESUpdatingSchema + e -> fromTextError $ "Failure parsing SchemaExtensionStatus from value: '" <> e + <> "'. Accepted values: cancelinprogress, cancelled, completed, creatingsnapshot, failed, initializing, replicating, rollbackinprogress, updatingschema" + +instance ToText SchemaExtensionStatus where + toText = \case + SESCancelInProgress -> "CancelInProgress" + SESCancelled -> "Cancelled" + SESCompleted -> "Completed" + SESCreatingSnapshot -> "CreatingSnapshot" + SESFailed -> "Failed" + SESInitializing -> "Initializing" + SESReplicating -> "Replicating" + SESRollbackInProgress -> "RollbackInProgress" + SESUpdatingSchema -> "UpdatingSchema" + +instance Hashable SchemaExtensionStatus +instance NFData SchemaExtensionStatus +instance ToByteString SchemaExtensionStatus +instance ToQuery SchemaExtensionStatus +instance ToHeader SchemaExtensionStatus + +instance FromJSON SchemaExtensionStatus where + parseJSON = parseJSONText "SchemaExtensionStatus" + data SnapshotStatus = SSCompleted | SSCreating diff --git a/gen/Network/AWS/DirectoryService/UpdateConditionalForwarder.hs b/gen/Network/AWS/DirectoryService/UpdateConditionalForwarder.hs --- a/gen/Network/AWS/DirectoryService/UpdateConditionalForwarder.hs +++ b/gen/Network/AWS/DirectoryService/UpdateConditionalForwarder.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Updates a conditional forwarder that has been set up for your AWS directory. +-- +-- module Network.AWS.DirectoryService.UpdateConditionalForwarder ( -- * Creating a Request @@ -45,6 +47,8 @@ -- | Updates a conditional forwarder. -- +-- +-- -- /See:/ 'updateConditionalForwarder' smart constructor. data UpdateConditionalForwarder = UpdateConditionalForwarder' { _ucfDirectoryId :: !Text @@ -56,11 +60,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ucfDirectoryId' +-- * 'ucfDirectoryId' - The directory ID of the AWS directory for which to update the conditional forwarder. -- --- * 'ucfRemoteDomainName' +-- * 'ucfRemoteDomainName' - The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship. -- --- * 'ucfDNSIPAddrs' +-- * 'ucfDNSIPAddrs' - The updated IP addresses of the remote DNS server associated with the conditional forwarder. updateConditionalForwarder :: Text -- ^ 'ucfDirectoryId' -> Text -- ^ 'ucfRemoteDomainName' @@ -124,6 +128,8 @@ -- | The result of an UpdateConditionalForwarder request. -- +-- +-- -- /See:/ 'updateConditionalForwarderResponse' smart constructor. newtype UpdateConditionalForwarderResponse = UpdateConditionalForwarderResponse' { _ucfrsResponseStatus :: Int @@ -133,7 +139,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ucfrsResponseStatus' +-- * 'ucfrsResponseStatus' - -- | The response status code. updateConditionalForwarderResponse :: Int -- ^ 'ucfrsResponseStatus' -> UpdateConditionalForwarderResponse @@ -142,7 +148,7 @@ { _ucfrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. ucfrsResponseStatus :: Lens' UpdateConditionalForwarderResponse Int ucfrsResponseStatus = lens _ucfrsResponseStatus (\ s a -> s{_ucfrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/UpdateRadius.hs b/gen/Network/AWS/DirectoryService/UpdateRadius.hs --- a/gen/Network/AWS/DirectoryService/UpdateRadius.hs +++ b/gen/Network/AWS/DirectoryService/UpdateRadius.hs @@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. +-- +-- module Network.AWS.DirectoryService.UpdateRadius ( -- * Creating a Request @@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Contains the inputs for the < UpdateRadius> operation. +-- | Contains the inputs for the 'UpdateRadius' operation. -- +-- +-- -- /See:/ 'updateRadius' smart constructor. data UpdateRadius = UpdateRadius' { _urDirectoryId :: !Text @@ -54,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'urDirectoryId' +-- * 'urDirectoryId' - The identifier of the directory for which to update the RADIUS server information. -- --- * 'urRadiusSettings' +-- * 'urRadiusSettings' - A 'RadiusSettings' object that contains information about the RADIUS server. updateRadius :: Text -- ^ 'urDirectoryId' -> RadiusSettings -- ^ 'urRadiusSettings' @@ -71,7 +75,7 @@ urDirectoryId :: Lens' UpdateRadius Text urDirectoryId = lens _urDirectoryId (\ s a -> s{_urDirectoryId = a}); --- | A < RadiusSettings> object that contains information about the RADIUS server. +-- | A 'RadiusSettings' object that contains information about the RADIUS server. urRadiusSettings :: Lens' UpdateRadius RadiusSettings urRadiusSettings = lens _urRadiusSettings (\ s a -> s{_urRadiusSettings = a}); @@ -110,8 +114,10 @@ instance ToQuery UpdateRadius where toQuery = const mempty --- | Contains the results of the < UpdateRadius> operation. +-- | Contains the results of the 'UpdateRadius' operation. -- +-- +-- -- /See:/ 'updateRadiusResponse' smart constructor. newtype UpdateRadiusResponse = UpdateRadiusResponse' { _urrsResponseStatus :: Int @@ -121,7 +127,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'urrsResponseStatus' +-- * 'urrsResponseStatus' - -- | The response status code. updateRadiusResponse :: Int -- ^ 'urrsResponseStatus' -> UpdateRadiusResponse @@ -130,7 +136,7 @@ { _urrsResponseStatus = pResponseStatus_ } --- | The response status code. +-- | -- | The response status code. urrsResponseStatus :: Lens' UpdateRadiusResponse Int urrsResponseStatus = lens _urrsResponseStatus (\ s a -> s{_urrsResponseStatus = a}); diff --git a/gen/Network/AWS/DirectoryService/VerifyTrust.hs b/gen/Network/AWS/DirectoryService/VerifyTrust.hs --- a/gen/Network/AWS/DirectoryService/VerifyTrust.hs +++ b/gen/Network/AWS/DirectoryService/VerifyTrust.hs @@ -20,7 +20,9 @@ -- -- AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. -- +-- -- This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain. +-- module Network.AWS.DirectoryService.VerifyTrust ( -- * Creating a Request @@ -46,6 +48,8 @@ -- | Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain. -- +-- +-- -- /See:/ 'verifyTrust' smart constructor. newtype VerifyTrust = VerifyTrust' { _vtTrustId :: Text @@ -55,7 +59,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'vtTrustId' +-- * 'vtTrustId' - The unique Trust ID of the trust relationship to verify. verifyTrust :: Text -- ^ 'vtTrustId' -> VerifyTrust @@ -103,6 +107,8 @@ -- | Result of a VerifyTrust request. -- +-- +-- -- /See:/ 'verifyTrustResponse' smart constructor. data VerifyTrustResponse = VerifyTrustResponse' { _vtrsTrustId :: !(Maybe Text) @@ -113,9 +119,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'vtrsTrustId' +-- * 'vtrsTrustId' - The unique Trust ID of the trust relationship that was verified. -- --- * 'vtrsResponseStatus' +-- * 'vtrsResponseStatus' - -- | The response status code. verifyTrustResponse :: Int -- ^ 'vtrsResponseStatus' -> VerifyTrustResponse @@ -129,7 +135,7 @@ vtrsTrustId :: Lens' VerifyTrustResponse (Maybe Text) vtrsTrustId = lens _vtrsTrustId (\ s a -> s{_vtrsTrustId = a}); --- | The response status code. +-- | -- | The response status code. vtrsResponseStatus :: Lens' VerifyTrustResponse Int vtrsResponseStatus = lens _vtrsResponseStatus (\ s a -> s{_vtrsResponseStatus = a}); diff --git a/test/Test/AWS/Gen/DirectoryService.hs b/test/Test/AWS/Gen/DirectoryService.hs --- a/test/Test/AWS/Gen/DirectoryService.hs +++ b/test/Test/AWS/Gen/DirectoryService.hs @@ -82,6 +82,9 @@ -- , requestEnableSSO $ -- enableSSO -- +-- , requestCancelSchemaExtension $ +-- cancelSchemaExtension +-- -- , requestEnableRadius $ -- enableRadius -- @@ -91,6 +94,9 @@ -- , requestAddTagsToResource $ -- addTagsToResource -- +-- , requestListSchemaExtensions $ +-- listSchemaExtensions +-- -- , requestDisableRadius $ -- disableRadius -- @@ -106,6 +112,9 @@ -- , requestDeleteSnapshot $ -- deleteSnapshot -- +-- , requestStartSchemaExtension $ +-- startSchemaExtension +-- -- , requestCreateTrust $ -- createTrust -- @@ -190,6 +199,9 @@ -- , responseEnableSSO $ -- enableSSOResponse -- +-- , responseCancelSchemaExtension $ +-- cancelSchemaExtensionResponse +-- -- , responseEnableRadius $ -- enableRadiusResponse -- @@ -199,6 +211,9 @@ -- , responseAddTagsToResource $ -- addTagsToResourceResponse -- +-- , responseListSchemaExtensions $ +-- listSchemaExtensionsResponse +-- -- , responseDisableRadius $ -- disableRadiusResponse -- @@ -214,6 +229,9 @@ -- , responseDeleteSnapshot $ -- deleteSnapshotResponse -- +-- , responseStartSchemaExtension $ +-- startSchemaExtensionResponse +-- -- , responseCreateTrust $ -- createTrustResponse -- @@ -336,6 +354,11 @@ "EnableSSO" "fixture/EnableSSO.yaml" +requestCancelSchemaExtension :: CancelSchemaExtension -> TestTree +requestCancelSchemaExtension = req + "CancelSchemaExtension" + "fixture/CancelSchemaExtension.yaml" + requestEnableRadius :: EnableRadius -> TestTree requestEnableRadius = req "EnableRadius" @@ -351,6 +374,11 @@ "AddTagsToResource" "fixture/AddTagsToResource.yaml" +requestListSchemaExtensions :: ListSchemaExtensions -> TestTree +requestListSchemaExtensions = req + "ListSchemaExtensions" + "fixture/ListSchemaExtensions.yaml" + requestDisableRadius :: DisableRadius -> TestTree requestDisableRadius = req "DisableRadius" @@ -376,6 +404,11 @@ "DeleteSnapshot" "fixture/DeleteSnapshot.yaml" +requestStartSchemaExtension :: StartSchemaExtension -> TestTree +requestStartSchemaExtension = req + "StartSchemaExtension" + "fixture/StartSchemaExtension.yaml" + requestCreateTrust :: CreateTrust -> TestTree requestCreateTrust = req "CreateTrust" @@ -549,6 +582,13 @@ directoryService (Proxy :: Proxy EnableSSO) +responseCancelSchemaExtension :: CancelSchemaExtensionResponse -> TestTree +responseCancelSchemaExtension = res + "CancelSchemaExtensionResponse" + "fixture/CancelSchemaExtensionResponse.proto" + directoryService + (Proxy :: Proxy CancelSchemaExtension) + responseEnableRadius :: EnableRadiusResponse -> TestTree responseEnableRadius = res "EnableRadiusResponse" @@ -570,6 +610,13 @@ directoryService (Proxy :: Proxy AddTagsToResource) +responseListSchemaExtensions :: ListSchemaExtensionsResponse -> TestTree +responseListSchemaExtensions = res + "ListSchemaExtensionsResponse" + "fixture/ListSchemaExtensionsResponse.proto" + directoryService + (Proxy :: Proxy ListSchemaExtensions) + responseDisableRadius :: DisableRadiusResponse -> TestTree responseDisableRadius = res "DisableRadiusResponse" @@ -604,6 +651,13 @@ "fixture/DeleteSnapshotResponse.proto" directoryService (Proxy :: Proxy DeleteSnapshot) + +responseStartSchemaExtension :: StartSchemaExtensionResponse -> TestTree +responseStartSchemaExtension = res + "StartSchemaExtensionResponse" + "fixture/StartSchemaExtensionResponse.proto" + directoryService + (Proxy :: Proxy StartSchemaExtension) responseCreateTrust :: CreateTrustResponse -> TestTree responseCreateTrust = res