amazonka-ds-1.0.0: Amazon Directory Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DirectoryService

Contents

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.

See: AWS API Reference

Synopsis

Service

data DirectoryService Source

Version 2015-04-16 of the Amazon Directory Service SDK.

Instances

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by DirectoryService.

AuthenticationFailedException

_AuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source

An authentication error occurred.

DirectoryUnavailableException

_DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified directory is unavailable or could not be found.

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source

One or more parameters are not valid.

UnsupportedOperationException

_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source

The operation is not supported.

EntityAlreadyExistsException

_EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified entity already exists.

DirectoryLimitExceededException

_DirectoryLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

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.

EntityDoesNotExistException

_EntityDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified entity could not be found.

InsufficientPermissionsException

_InsufficientPermissionsException :: AsError a => Getting (First ServiceError) a ServiceError Source

The account does not have sufficient permission to perform the operation.

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source

The NextToken value is not valid.

ServiceException

_ServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source

An exception has occurred in AWS Directory Service.

SnapshotLimitExceededException

_SnapshotLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

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.

ClientException

_ClientException :: AsError a => Getting (First ServiceError) a ServiceError Source

A client exception has occurred.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetSnapshotLimits

module Network.AWS.DirectoryService.GetSnapshotLimits

ConnectDirectory

module Network.AWS.DirectoryService.ConnectDirectory

DescribeDirectories

module Network.AWS.DirectoryService.DescribeDirectories

CreateAlias

module Network.AWS.DirectoryService.CreateAlias

CreateDirectory

module Network.AWS.DirectoryService.CreateDirectory

EnableSSO

module Network.AWS.DirectoryService.EnableSSO

EnableRadius

module Network.AWS.DirectoryService.EnableRadius

DisableRadius

module Network.AWS.DirectoryService.DisableRadius

DescribeSnapshots

module Network.AWS.DirectoryService.DescribeSnapshots

RestoreFromSnapshot

module Network.AWS.DirectoryService.RestoreFromSnapshot

DeleteSnapshot

module Network.AWS.DirectoryService.DeleteSnapshot

CreateSnapshot

module Network.AWS.DirectoryService.CreateSnapshot

DeleteDirectory

module Network.AWS.DirectoryService.DeleteDirectory

DisableSSO

module Network.AWS.DirectoryService.DisableSSO

CreateComputer

module Network.AWS.DirectoryService.CreateComputer

GetDirectoryLimits

module Network.AWS.DirectoryService.GetDirectoryLimits

UpdateRadius

module Network.AWS.DirectoryService.UpdateRadius

Types

DirectorySize

data DirectorySize Source

Constructors

Large 
Small 

Instances

DirectoryStage

data DirectoryStage Source

Constructors

DSActive 
DSCreated 
DSCreating 
DSDeleted 
DSDeleting 
DSFailed 
DSImpaired 
DSInoperable 
DSRequested 
DSRestoreFailed 
DSRestoring 

Instances

DirectoryType

data DirectoryType Source

Constructors

ADConnector 
SimpleAD 

Instances

RadiusAuthenticationProtocol

data RadiusAuthenticationProtocol Source

Constructors

Chap 
MsCHAPV1 
MsCHAPV2 
Pap 

Instances

RadiusStatus

data RadiusStatus Source

Constructors

Completed 
Creating 
Failed 

Instances

SnapshotStatus

data SnapshotStatus Source

Constructors

SSCompleted 
SSCreating 
SSFailed 

Instances

SnapshotType

data SnapshotType Source

Constructors

Auto 
Manual 

Instances

Attribute

data Attribute Source

Represents a named directory attribute.

See: attribute smart constructor.

Instances

attribute :: Attribute Source

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

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

aValue :: Lens' Attribute (Maybe Text) Source

The value of the attribute.

aName :: Lens' Attribute (Maybe Text) Source

The name of the attribute.

Computer

data Computer Source

Contains information about a computer account in a directory.

See: computer smart constructor.

Instances

computer :: Computer Source

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

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

cComputerId :: Lens' Computer (Maybe Text) Source

The identifier of the computer.

cComputerAttributes :: Lens' Computer [Attribute] Source

An array of Attribute objects that contain the LDAP attributes that belong to the computer account.

cComputerName :: Lens' Computer (Maybe Text) Source

The computer name.

DirectoryConnectSettings

data DirectoryConnectSettings Source

Contains information for the ConnectDirectory operation when an AD Connector directory is being created.

See: directoryConnectSettings smart constructor.

Instances

directoryConnectSettings Source

Arguments

:: Text

dcsVPCId

-> Text

dcsCustomerUserName

-> DirectoryConnectSettings 

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

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

dcsVPCId :: Lens' DirectoryConnectSettings Text Source

The identifier of the VPC that the AD Connector is created in.

dcsSubnetIds :: Lens' DirectoryConnectSettings [Text] Source

A list of subnet identifiers in the VPC that the AD Connector is created in.

dcsCustomerDNSIPs :: Lens' DirectoryConnectSettings [Text] Source

A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.

dcsCustomerUserName :: Lens' DirectoryConnectSettings Text Source

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

DirectoryConnectSettingsDescription

data DirectoryConnectSettingsDescription Source

Contains information about an AD Connector directory.

See: directoryConnectSettingsDescription smart constructor.

Instances

directoryConnectSettingsDescription :: DirectoryConnectSettingsDescription Source

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

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

dcsdCustomerUserName :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source

The username of the service account in the on-premises directory.

dcsdSubnetIds :: Lens' DirectoryConnectSettingsDescription [Text] Source

A list of subnet identifiers in the VPC that the AD connector is in.

dcsdVPCId :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source

The identifier of the VPC that the AD Connector is in.

dcsdConnectIPs :: Lens' DirectoryConnectSettingsDescription [Text] Source

The IP addresses of the AD Connector servers.

dcsdSecurityGroupId :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source

The security group identifier for the AD Connector directory.

dcsdAvailabilityZones :: Lens' DirectoryConnectSettingsDescription [Text] Source

A list of the Availability Zones that the directory is in.

DirectoryDescription

data DirectoryDescription Source

Contains information about an AWS Directory Service directory.

See: directoryDescription smart constructor.

Instances

directoryDescription :: DirectoryDescription Source

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

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

ddRadiusStatus :: Lens' DirectoryDescription (Maybe RadiusStatus) Source

The status of the RADIUS MFA server connection.

ddDirectoryId :: Lens' DirectoryDescription (Maybe Text) Source

The directory identifier.

ddStage :: Lens' DirectoryDescription (Maybe DirectoryStage) Source

The current stage of the directory.

ddAccessURL :: Lens' DirectoryDescription (Maybe Text) Source

The access URL for the directory, such as 'http:\/\/\<alias>.awsapps.com'.

ddShortName :: Lens' DirectoryDescription (Maybe Text) Source

The short name of the directory.

ddSize :: Lens' DirectoryDescription (Maybe DirectorySize) Source

The directory size.

ddRadiusSettings :: Lens' DirectoryDescription (Maybe RadiusSettings) Source

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

ddLaunchTime :: Lens' DirectoryDescription (Maybe UTCTime) Source

Specifies when the directory was created.

ddAlias :: Lens' DirectoryDescription (Maybe Text) Source

The alias for the directory.

ddName :: Lens' DirectoryDescription (Maybe Text) Source

The fully-qualified name of the directory.

ddSSOEnabled :: Lens' DirectoryDescription (Maybe Bool) Source

Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.

ddStageLastUpdatedDateTime :: Lens' DirectoryDescription (Maybe UTCTime) Source

The date and time that the stage was last updated.

ddStageReason :: Lens' DirectoryDescription (Maybe Text) Source

Additional information about the directory stage.

ddDNSIPAddrs :: Lens' DirectoryDescription [Text] Source

The IP addresses of the DNS servers for the directory. For a Simple AD directory, these are the IP addresses of the Simple 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 that the AD Connector is connected to.

ddVPCSettings :: Lens' DirectoryDescription (Maybe DirectoryVPCSettingsDescription) Source

A DirectoryVpcSettingsDescription object that contains additional information about a Simple AD directory. This member is only present if the directory is a Simple AD directory.

ddType :: Lens' DirectoryDescription (Maybe DirectoryType) Source

The directory size.

ddConnectSettings :: Lens' DirectoryDescription (Maybe DirectoryConnectSettingsDescription) Source

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 :: Lens' DirectoryDescription (Maybe Text) Source

The textual description for the directory.

DirectoryLimits

data DirectoryLimits Source

Contains directory limit information for a region.

See: directoryLimits smart constructor.

Instances

directoryLimits :: DirectoryLimits Source

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

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

dlConnectedDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source

The current number of connected directories in the region.

dlConnectedDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural) Source

The maximum number of connected directories allowed in the region.

dlConnectedDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source

Indicates if the connected directory limit has been reached.

dlCloudOnlyDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural) Source

The maximum number of cloud directories allowed in the region.

dlCloudOnlyDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source

The current number of cloud directories in the region.

dlCloudOnlyDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source

Indicates if the cloud directory limit has been reached.

DirectoryVPCSettings

data DirectoryVPCSettings Source

Contains information for the CreateDirectory operation when a Simple AD directory is being created.

See: directoryVPCSettings smart constructor.

Instances

directoryVPCSettings Source

Arguments

:: Text

dvsVPCId

-> DirectoryVPCSettings 

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

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

dvsVPCId :: Lens' DirectoryVPCSettings Text Source

The identifier of the VPC to create the Simple AD directory in.

dvsSubnetIds :: Lens' DirectoryVPCSettings [Text] Source

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.

DirectoryVPCSettingsDescription

data DirectoryVPCSettingsDescription Source

Contains information about a Simple AD directory.

See: directoryVPCSettingsDescription smart constructor.

Instances

directoryVPCSettingsDescription :: DirectoryVPCSettingsDescription Source

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

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

dvsdSubnetIds :: Lens' DirectoryVPCSettingsDescription [Text] Source

The identifiers of the subnets for the directory servers.

dvsdVPCId :: Lens' DirectoryVPCSettingsDescription (Maybe Text) Source

The identifier of the VPC that the directory is in.

dvsdSecurityGroupId :: Lens' DirectoryVPCSettingsDescription (Maybe Text) Source

The security group identifier for the directory.

dvsdAvailabilityZones :: Lens' DirectoryVPCSettingsDescription [Text] Source

The list of Availability Zones that the directory is in.

RadiusSettings

data RadiusSettings Source

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

See: radiusSettings smart constructor.

Instances

radiusSettings :: RadiusSettings Source

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

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

rsDisplayLabel :: Lens' RadiusSettings (Maybe Text) Source

Not currently used.

rsRadiusServers :: Lens' RadiusSettings [Text] Source

An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

rsRadiusRetries :: Lens' RadiusSettings (Maybe Natural) Source

The maximum number of times that communication with the RADIUS server is attempted.

rsAuthenticationProtocol :: Lens' RadiusSettings (Maybe RadiusAuthenticationProtocol) Source

The protocol specified for your RADIUS endpoints.

rsUseSameUsername :: Lens' RadiusSettings (Maybe Bool) Source

Not currently used.

rsSharedSecret :: Lens' RadiusSettings (Maybe Text) Source

The shared secret code that was specified when your RADIUS endpoints were created.

rsRadiusTimeout :: Lens' RadiusSettings (Maybe Natural) Source

The amount of time, in seconds, to wait for the RADIUS server to respond.

rsRadiusPort :: Lens' RadiusSettings (Maybe Natural) Source

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.

Snapshot

data Snapshot Source

Describes a directory snapshot.

See: snapshot smart constructor.

Instances

snapshot :: Snapshot Source

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

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

sDirectoryId :: Lens' Snapshot (Maybe Text) Source

The directory identifier.

sStatus :: Lens' Snapshot (Maybe SnapshotStatus) Source

The snapshot status.

sStartTime :: Lens' Snapshot (Maybe UTCTime) Source

The date and time that the snapshot was taken.

sName :: Lens' Snapshot (Maybe Text) Source

The descriptive name of the snapshot.

sType :: Lens' Snapshot (Maybe SnapshotType) Source

The snapshot type.

sSnapshotId :: Lens' Snapshot (Maybe Text) Source

The snapshot identifier.

SnapshotLimits

data SnapshotLimits Source

Contains manual snapshot limit information for a directory.

See: snapshotLimits smart constructor.

Instances

snapshotLimits :: SnapshotLimits Source

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

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

slManualSnapshotsLimitReached :: Lens' SnapshotLimits (Maybe Bool) Source

Indicates if the manual snapshot limit has been reached.

slManualSnapshotsCurrentCount :: Lens' SnapshotLimits (Maybe Natural) Source

The current number of manual snapshots of the directory.

slManualSnapshotsLimit :: Lens' SnapshotLimits (Maybe Natural) Source

The maximum number of manual snapshots allowed.