@datafire/amazonaws_ds
Client library for AWS Directory Service
Installation and Usage
npm install --save @datafire/amazonaws_ds
let amazonaws_ds = require('@datafire/amazonaws_ds').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_ds.AddIpRoutes({
"DirectoryId": "",
"IpRoutes": []
}).then(data => {
console.log(data);
});
Description
AWS Directory Service
AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
Actions
AddIpRoutes
amazonaws_ds.AddIpRoutes({
"DirectoryId": "",
"IpRoutes": []
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- IpRoutes required IpRoutes
- UpdateSecurityGroupForDirectoryControllers UpdateSecurityGroupForDirectoryControllers
Output
- output AddIpRoutesResult
AddTagsToResource
amazonaws_ds.AddTagsToResource({
"ResourceId": "",
"Tags": []
}, context)
Input
- input
object
- ResourceId required ResourceId
- Tags required Tags
Output
- output AddTagsToResourceResult
CancelSchemaExtension
amazonaws_ds.CancelSchemaExtension({
"DirectoryId": "",
"SchemaExtensionId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- SchemaExtensionId required SchemaExtensionId
Output
- output CancelSchemaExtensionResult
ConnectDirectory
amazonaws_ds.ConnectDirectory({
"Name": "",
"Password": "",
"Size": "",
"ConnectSettings": {
"VpcId": "",
"SubnetIds": [],
"CustomerDnsIps": [],
"CustomerUserName": ""
}
}, context)
Input
- input
object
- ConnectSettings required DirectoryConnectSettings
- Description Description
- Name required DirectoryName
- Password required ConnectPassword
- ShortName DirectoryShortName
- Size required DirectorySize
Output
- output ConnectDirectoryResult
CreateAlias
amazonaws_ds.CreateAlias({
"DirectoryId": "",
"Alias": ""
}, context)
Input
- input
object
- Alias required AliasName
- DirectoryId required DirectoryId
Output
- output CreateAliasResult
CreateComputer
amazonaws_ds.CreateComputer({
"DirectoryId": "",
"ComputerName": "",
"Password": ""
}, context)
Input
- input
object
- ComputerAttributes Attributes
- ComputerName required ComputerName
- DirectoryId required DirectoryId
- OrganizationalUnitDistinguishedName OrganizationalUnitDN
- Password required ComputerPassword
Output
- output CreateComputerResult
CreateConditionalForwarder
amazonaws_ds.CreateConditionalForwarder({
"DirectoryId": "",
"RemoteDomainName": "",
"DnsIpAddrs": []
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- DnsIpAddrs required DnsIpAddrs
- RemoteDomainName required RemoteDomainName
Output
CreateDirectory
amazonaws_ds.CreateDirectory({
"Name": "",
"Password": "",
"Size": ""
}, context)
Input
- input
object
- Description Description
- Name required DirectoryName
- Password required Password
- ShortName DirectoryShortName
- Size required DirectorySize
- VpcSettings DirectoryVpcSettings
Output
- output CreateDirectoryResult
CreateMicrosoftAD
amazonaws_ds.CreateMicrosoftAD({
"Name": "",
"Password": "",
"VpcSettings": {
"VpcId": "",
"SubnetIds": []
}
}, context)
Input
- input
object
- Description Description
- Edition DirectoryEdition
- Name required DirectoryName
- Password required Password
- ShortName DirectoryShortName
- VpcSettings required DirectoryVpcSettings
Output
- output CreateMicrosoftADResult
CreateSnapshot
amazonaws_ds.CreateSnapshot({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- Name SnapshotName
Output
- output CreateSnapshotResult
CreateTrust
amazonaws_ds.CreateTrust({
"DirectoryId": "",
"RemoteDomainName": "",
"TrustPassword": "",
"TrustDirection": ""
}, context)
Input
- input
object
- ConditionalForwarderIpAddrs DnsIpAddrs
- DirectoryId required DirectoryId
- RemoteDomainName required RemoteDomainName
- TrustDirection required TrustDirection
- TrustPassword required TrustPassword
- TrustType TrustType
Output
- output CreateTrustResult
DeleteConditionalForwarder
amazonaws_ds.DeleteConditionalForwarder({
"DirectoryId": "",
"RemoteDomainName": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- RemoteDomainName required RemoteDomainName
Output
DeleteDirectory
amazonaws_ds.DeleteDirectory({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
Output
- output DeleteDirectoryResult
DeleteSnapshot
amazonaws_ds.DeleteSnapshot({
"SnapshotId": ""
}, context)
Input
- input
object
- SnapshotId required SnapshotId
Output
- output DeleteSnapshotResult
DeleteTrust
amazonaws_ds.DeleteTrust({
"TrustId": ""
}, context)
Input
- input
object
- DeleteAssociatedConditionalForwarder DeleteAssociatedConditionalForwarder
- TrustId required TrustId
Output
- output DeleteTrustResult
DeregisterEventTopic
amazonaws_ds.DeregisterEventTopic({
"DirectoryId": "",
"TopicName": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- TopicName required TopicName
Output
- output DeregisterEventTopicResult
DescribeConditionalForwarders
amazonaws_ds.DescribeConditionalForwarders({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- RemoteDomainNames RemoteDomainNames
Output
DescribeDirectories
amazonaws_ds.DescribeDirectories({}, context)
Input
- input
object
- DirectoryIds DirectoryIds
- Limit Limit
- NextToken NextToken
Output
- output DescribeDirectoriesResult
DescribeDomainControllers
amazonaws_ds.DescribeDomainControllers({
"DirectoryId": ""
}, context)
Input
- input
object
- Limit
string
- NextToken
string
- DirectoryId required DirectoryId
- DomainControllerIds DomainControllerIds
- Limit Limit
- NextToken NextToken
- Limit
Output
DescribeEventTopics
amazonaws_ds.DescribeEventTopics({}, context)
Input
- input
object
- DirectoryId DirectoryId
- TopicNames TopicNames
Output
- output DescribeEventTopicsResult
DescribeSnapshots
amazonaws_ds.DescribeSnapshots({}, context)
Input
- input
object
- DirectoryId DirectoryId
- Limit Limit
- NextToken NextToken
- SnapshotIds SnapshotIds
Output
- output DescribeSnapshotsResult
DescribeTrusts
amazonaws_ds.DescribeTrusts({}, context)
Input
- input
object
- DirectoryId DirectoryId
- Limit Limit
- NextToken NextToken
- TrustIds TrustIds
Output
- output DescribeTrustsResult
DisableRadius
amazonaws_ds.DisableRadius({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
Output
- output DisableRadiusResult
DisableSso
amazonaws_ds.DisableSso({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- Password ConnectPassword
- UserName UserName
Output
- output DisableSsoResult
EnableRadius
amazonaws_ds.EnableRadius({
"DirectoryId": "",
"RadiusSettings": {}
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- RadiusSettings required RadiusSettings
Output
- output EnableRadiusResult
EnableSso
amazonaws_ds.EnableSso({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- Password ConnectPassword
- UserName UserName
Output
- output EnableSsoResult
GetDirectoryLimits
amazonaws_ds.GetDirectoryLimits({}, context)
Input
- input
object
Output
- output GetDirectoryLimitsResult
GetSnapshotLimits
amazonaws_ds.GetSnapshotLimits({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
Output
- output GetSnapshotLimitsResult
ListIpRoutes
amazonaws_ds.ListIpRoutes({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- Limit Limit
- NextToken NextToken
Output
- output ListIpRoutesResult
ListSchemaExtensions
amazonaws_ds.ListSchemaExtensions({
"DirectoryId": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- Limit Limit
- NextToken NextToken
Output
- output ListSchemaExtensionsResult
ListTagsForResource
amazonaws_ds.ListTagsForResource({
"ResourceId": ""
}, context)
Input
- input
object
- Limit Limit
- NextToken NextToken
- ResourceId required ResourceId
Output
- output ListTagsForResourceResult
RegisterEventTopic
amazonaws_ds.RegisterEventTopic({
"DirectoryId": "",
"TopicName": ""
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- TopicName required TopicName
Output
- output RegisterEventTopicResult
RemoveIpRoutes
amazonaws_ds.RemoveIpRoutes({
"DirectoryId": "",
"CidrIps": []
}, context)
Input
- input
object
- CidrIps required CidrIps
- DirectoryId required DirectoryId
Output
- output RemoveIpRoutesResult
RemoveTagsFromResource
amazonaws_ds.RemoveTagsFromResource({
"ResourceId": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceId required ResourceId
- TagKeys required TagKeys
Output
- output RemoveTagsFromResourceResult
RestoreFromSnapshot
amazonaws_ds.RestoreFromSnapshot({
"SnapshotId": ""
}, context)
Input
- input
object
- SnapshotId required SnapshotId
Output
- output RestoreFromSnapshotResult
StartSchemaExtension
amazonaws_ds.StartSchemaExtension({
"DirectoryId": "",
"CreateSnapshotBeforeSchemaExtension": true,
"LdifContent": "",
"Description": ""
}, context)
Input
- input
object
- CreateSnapshotBeforeSchemaExtension required CreateSnapshotBeforeSchemaExtension
- Description required Description
- DirectoryId required DirectoryId
- LdifContent required LdifContent
Output
- output StartSchemaExtensionResult
UpdateConditionalForwarder
amazonaws_ds.UpdateConditionalForwarder({
"DirectoryId": "",
"RemoteDomainName": "",
"DnsIpAddrs": []
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- DnsIpAddrs required DnsIpAddrs
- RemoteDomainName required RemoteDomainName
Output
UpdateNumberOfDomainControllers
amazonaws_ds.UpdateNumberOfDomainControllers({
"DirectoryId": "",
"DesiredNumber": 0
}, context)
Input
- input
object
- DesiredNumber required DesiredNumberOfDomainControllers
- DirectoryId required DirectoryId
Output
UpdateRadius
amazonaws_ds.UpdateRadius({
"DirectoryId": "",
"RadiusSettings": {}
}, context)
Input
- input
object
- DirectoryId required DirectoryId
- RadiusSettings required RadiusSettings
Output
- output UpdateRadiusResult
VerifyTrust
amazonaws_ds.VerifyTrust({
"TrustId": ""
}, context)
Input
- input
object
- TrustId required TrustId
Output
- output VerifyTrustResult
Definitions
AccessUrl
- AccessUrl
string
AddIpRoutesRequest
- AddIpRoutesRequest
object
- DirectoryId required DirectoryId
- IpRoutes required IpRoutes
- UpdateSecurityGroupForDirectoryControllers UpdateSecurityGroupForDirectoryControllers
AddIpRoutesResult
- AddIpRoutesResult
object
AddTagsToResourceRequest
- AddTagsToResourceRequest
object
- ResourceId required ResourceId
- Tags required Tags
AddTagsToResourceResult
- AddTagsToResourceResult
object
AddedDateTime
- AddedDateTime
string
AliasName
- AliasName
string
Attribute
- Attribute
object
: Represents a named directory attribute.- Name AttributeName
- Value AttributeValue
AttributeName
- AttributeName
string
AttributeValue
- AttributeValue
string
Attributes
- Attributes
array
- items Attribute
AuthenticationFailedException
- AuthenticationFailedException
object
: An authentication error occurred.- Message ExceptionMessage
- RequestId RequestId
AvailabilityZone
- AvailabilityZone
string
AvailabilityZones
- AvailabilityZones
array
- items AvailabilityZone
CancelSchemaExtensionRequest
- CancelSchemaExtensionRequest
object
- DirectoryId required DirectoryId
- SchemaExtensionId required SchemaExtensionId
CancelSchemaExtensionResult
- CancelSchemaExtensionResult
object
CidrIp
- CidrIp
string
CidrIps
- CidrIps
array
- items CidrIp
ClientException
- ClientException
object
: A client exception has occurred.- Message ExceptionMessage
- RequestId RequestId
CloudOnlyDirectoriesLimitReached
- CloudOnlyDirectoriesLimitReached
boolean
Computer
- Computer
object
: Contains information about a computer account in a directory.- ComputerAttributes Attributes
- ComputerId SID
- ComputerName ComputerName
ComputerName
- ComputerName
string
ComputerPassword
- ComputerPassword
string
ConditionalForwarder
- ConditionalForwarder
object
: 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.- DnsIpAddrs DnsIpAddrs
- RemoteDomainName RemoteDomainName
- ReplicationScope ReplicationScope
ConditionalForwarders
- ConditionalForwarders
array
- items ConditionalForwarder
ConnectDirectoryRequest
- ConnectDirectoryRequest
object
: Contains the inputs for the ConnectDirectory operation.- ConnectSettings required DirectoryConnectSettings
- Description Description
- Name required DirectoryName
- Password required ConnectPassword
- ShortName DirectoryShortName
- Size required DirectorySize
ConnectDirectoryResult
- ConnectDirectoryResult
object
: Contains the results of the ConnectDirectory operation.- DirectoryId DirectoryId
ConnectPassword
- ConnectPassword
string
ConnectedDirectoriesLimitReached
- ConnectedDirectoriesLimitReached
boolean
CreateAliasRequest
- CreateAliasRequest
object
: Contains the inputs for the CreateAlias operation.- Alias required AliasName
- DirectoryId required DirectoryId
CreateAliasResult
- CreateAliasResult
object
: Contains the results of the CreateAlias operation.- Alias AliasName
- DirectoryId DirectoryId
CreateComputerRequest
- CreateComputerRequest
object
: Contains the inputs for the CreateComputer operation.- ComputerAttributes Attributes
- ComputerName required ComputerName
- DirectoryId required DirectoryId
- OrganizationalUnitDistinguishedName OrganizationalUnitDN
- Password required ComputerPassword
CreateComputerResult
- CreateComputerResult
object
: Contains the results for the CreateComputer operation.- Computer Computer
CreateConditionalForwarderRequest
- CreateConditionalForwarderRequest
object
: 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.- DirectoryId required DirectoryId
- DnsIpAddrs required DnsIpAddrs
- RemoteDomainName required RemoteDomainName
CreateConditionalForwarderResult
- CreateConditionalForwarderResult
object
: The result of a CreateConditinalForwarder request.
CreateDirectoryRequest
- CreateDirectoryRequest
object
: Contains the inputs for the CreateDirectory operation.- Description Description
- Name required DirectoryName
- Password required Password
- ShortName DirectoryShortName
- Size required DirectorySize
- VpcSettings DirectoryVpcSettings
CreateDirectoryResult
- CreateDirectoryResult
object
: Contains the results of the CreateDirectory operation.- DirectoryId DirectoryId
CreateMicrosoftADRequest
- CreateMicrosoftADRequest
object
: Creates a Microsoft AD in the AWS cloud.- Description Description
- Edition DirectoryEdition
- Name required DirectoryName
- Password required Password
- ShortName DirectoryShortName
- VpcSettings required DirectoryVpcSettings
CreateMicrosoftADResult
- CreateMicrosoftADResult
object
: Result of a CreateMicrosoftAD request.- DirectoryId DirectoryId
CreateSnapshotBeforeSchemaExtension
- CreateSnapshotBeforeSchemaExtension
boolean
CreateSnapshotRequest
- CreateSnapshotRequest
object
: Contains the inputs for the CreateSnapshot operation.- DirectoryId required DirectoryId
- Name SnapshotName
CreateSnapshotResult
- CreateSnapshotResult
object
: Contains the results of the CreateSnapshot operation.- SnapshotId SnapshotId
CreateTrustRequest
- CreateTrustRequest
object
: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.
- ConditionalForwarderIpAddrs DnsIpAddrs
- DirectoryId required DirectoryId
- RemoteDomainName required RemoteDomainName
- TrustDirection required TrustDirection
- TrustPassword required TrustPassword
- TrustType TrustType
CreateTrustResult
- CreateTrustResult
object
: The result of a CreateTrust request.- TrustId TrustId
CreatedDateTime
- CreatedDateTime
string
DeleteAssociatedConditionalForwarder
- DeleteAssociatedConditionalForwarder
boolean
DeleteConditionalForwarderRequest
- DeleteConditionalForwarderRequest
object
: Deletes a conditional forwarder.- DirectoryId required DirectoryId
- RemoteDomainName required RemoteDomainName
DeleteConditionalForwarderResult
- DeleteConditionalForwarderResult
object
: The result of a DeleteConditionalForwarder request.
DeleteDirectoryRequest
- DeleteDirectoryRequest
object
: Contains the inputs for the DeleteDirectory operation.- DirectoryId required DirectoryId
DeleteDirectoryResult
- DeleteDirectoryResult
object
: Contains the results of the DeleteDirectory operation.- DirectoryId DirectoryId
DeleteSnapshotRequest
- DeleteSnapshotRequest
object
: Contains the inputs for the DeleteSnapshot operation.- SnapshotId required SnapshotId
DeleteSnapshotResult
- DeleteSnapshotResult
object
: Contains the results of the DeleteSnapshot operation.- SnapshotId SnapshotId
DeleteTrustRequest
- DeleteTrustRequest
object
: Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.- DeleteAssociatedConditionalForwarder DeleteAssociatedConditionalForwarder
- TrustId required TrustId
DeleteTrustResult
- DeleteTrustResult
object
: The result of a DeleteTrust request.- TrustId TrustId
DeregisterEventTopicRequest
- DeregisterEventTopicRequest
object
: Removes the specified directory as a publisher to the specified SNS topic.- DirectoryId required DirectoryId
- TopicName required TopicName
DeregisterEventTopicResult
- DeregisterEventTopicResult
object
: The result of a DeregisterEventTopic request.
DescribeConditionalForwardersRequest
- DescribeConditionalForwardersRequest
object
: Describes a conditional forwarder.- DirectoryId required DirectoryId
- RemoteDomainNames RemoteDomainNames
DescribeConditionalForwardersResult
- DescribeConditionalForwardersResult
object
: The result of a DescribeConditionalForwarder request.- ConditionalForwarders ConditionalForwarders
DescribeDirectoriesRequest
- DescribeDirectoriesRequest
object
: Contains the inputs for the DescribeDirectories operation.- DirectoryIds DirectoryIds
- Limit Limit
- NextToken NextToken
DescribeDirectoriesResult
- DescribeDirectoriesResult
object
: Contains the results of the DescribeDirectories operation.- DirectoryDescriptions DirectoryDescriptions
- NextToken NextToken
DescribeDomainControllersRequest
- DescribeDomainControllersRequest
object
- DirectoryId required DirectoryId
- DomainControllerIds DomainControllerIds
- Limit Limit
- NextToken NextToken
DescribeDomainControllersResult
- DescribeDomainControllersResult
object
- DomainControllers DomainControllers
- NextToken NextToken
DescribeEventTopicsRequest
- DescribeEventTopicsRequest
object
: Describes event topics.- DirectoryId DirectoryId
- TopicNames TopicNames
DescribeEventTopicsResult
- DescribeEventTopicsResult
object
: The result of a DescribeEventTopic request.- EventTopics EventTopics
DescribeSnapshotsRequest
- DescribeSnapshotsRequest
object
: Contains the inputs for the DescribeSnapshots operation.- DirectoryId DirectoryId
- Limit Limit
- NextToken NextToken
- SnapshotIds SnapshotIds
DescribeSnapshotsResult
- DescribeSnapshotsResult
object
: Contains the results of the DescribeSnapshots operation.
DescribeTrustsRequest
- DescribeTrustsRequest
object
: 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.- DirectoryId DirectoryId
- Limit Limit
- NextToken NextToken
- TrustIds TrustIds
DescribeTrustsResult
- DescribeTrustsResult
object
: The result of a DescribeTrust request.
Description
- Description
string
DesiredNumberOfDomainControllers
- DesiredNumberOfDomainControllers
integer
DirectoryConnectSettings
- DirectoryConnectSettings
object
: Contains information for the ConnectDirectory operation when an AD Connector directory is being created.- CustomerDnsIps required DnsIpAddrs
- CustomerUserName required UserName
- SubnetIds required SubnetIds
- VpcId required VpcId
DirectoryConnectSettingsDescription
- DirectoryConnectSettingsDescription
object
: Contains information about an AD Connector directory.- AvailabilityZones AvailabilityZones
- ConnectIps IpAddrs
- CustomerUserName UserName
- SecurityGroupId SecurityGroupId
- SubnetIds SubnetIds
- VpcId VpcId
DirectoryDescription
- DirectoryDescription
object
: Contains information about an AWS Directory Service directory.- AccessUrl AccessUrl
- Alias AliasName
- ConnectSettings DirectoryConnectSettingsDescription
- Description Description
- DesiredNumberOfDomainControllers DesiredNumberOfDomainControllers
- DirectoryId DirectoryId
- DnsIpAddrs DnsIpAddrs
- Edition DirectoryEdition
- LaunchTime LaunchTime
- Name DirectoryName
- RadiusSettings RadiusSettings
- RadiusStatus RadiusStatus
- ShortName DirectoryShortName
- Size DirectorySize
- SsoEnabled SsoEnabled
- Stage DirectoryStage
- StageLastUpdatedDateTime LastUpdatedDateTime
- StageReason StageReason
- Type DirectoryType
- VpcSettings DirectoryVpcSettingsDescription
DirectoryDescriptions
- DirectoryDescriptions
array
: A list of directory descriptions.- items DirectoryDescription
DirectoryEdition
- DirectoryEdition
string
(values: Enterprise, Standard)
DirectoryId
- DirectoryId
string
DirectoryIds
- DirectoryIds
array
: A list of directory identifiers.- items DirectoryId
DirectoryLimitExceededException
- DirectoryLimitExceededException
object
: 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.- Message ExceptionMessage
- RequestId RequestId
DirectoryLimits
- DirectoryLimits
object
: Contains directory limit information for a region.- CloudOnlyDirectoriesCurrentCount Limit
- CloudOnlyDirectoriesLimit Limit
- CloudOnlyDirectoriesLimitReached CloudOnlyDirectoriesLimitReached
- CloudOnlyMicrosoftADCurrentCount Limit
- CloudOnlyMicrosoftADLimit Limit
- CloudOnlyMicrosoftADLimitReached CloudOnlyDirectoriesLimitReached
- ConnectedDirectoriesCurrentCount Limit
- ConnectedDirectoriesLimit Limit
- ConnectedDirectoriesLimitReached ConnectedDirectoriesLimitReached
DirectoryName
- DirectoryName
string
DirectoryShortName
- DirectoryShortName
string
DirectorySize
- DirectorySize
string
(values: Small, Large)
DirectoryStage
- DirectoryStage
string
(values: Requested, Creating, Created, Active, Inoperable, Impaired, Restoring, RestoreFailed, Deleting, Deleted, Failed)
DirectoryType
- DirectoryType
string
(values: SimpleAD, ADConnector, MicrosoftAD)
DirectoryUnavailableException
- DirectoryUnavailableException
object
: The specified directory is unavailable or could not be found.- Message ExceptionMessage
- RequestId RequestId
DirectoryVpcSettings
- DirectoryVpcSettings
object
: Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
DirectoryVpcSettingsDescription
- DirectoryVpcSettingsDescription
object
: Contains information about the directory.- AvailabilityZones AvailabilityZones
- SecurityGroupId SecurityGroupId
- SubnetIds SubnetIds
- VpcId VpcId
DisableRadiusRequest
- DisableRadiusRequest
object
: Contains the inputs for the DisableRadius operation.- DirectoryId required DirectoryId
DisableRadiusResult
- DisableRadiusResult
object
: Contains the results of the DisableRadius operation.
DisableSsoRequest
- DisableSsoRequest
object
: Contains the inputs for the DisableSso operation.- DirectoryId required DirectoryId
- Password ConnectPassword
- UserName UserName
DisableSsoResult
- DisableSsoResult
object
: Contains the results of the DisableSso operation.
DnsIpAddrs
- DnsIpAddrs
array
- items IpAddr
DomainController
- DomainController
object
: Contains information about the domain controllers for a specified directory.- AvailabilityZone AvailabilityZone
- DirectoryId DirectoryId
- DnsIpAddr IpAddr
- DomainControllerId DomainControllerId
- LaunchTime LaunchTime
- Status DomainControllerStatus
- StatusLastUpdatedDateTime LastUpdatedDateTime
- StatusReason DomainControllerStatusReason
- SubnetId SubnetId
- VpcId VpcId
DomainControllerId
- DomainControllerId
string
DomainControllerIds
- DomainControllerIds
array
- items DomainControllerId
DomainControllerLimitExceededException
- DomainControllerLimitExceededException
object
: The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.- Message ExceptionMessage
- RequestId RequestId
DomainControllerStatus
- DomainControllerStatus
string
(values: Creating, Active, Impaired, Restoring, Deleting, Deleted, Failed)
DomainControllerStatusReason
- DomainControllerStatusReason
string
DomainControllers
- DomainControllers
array
- items DomainController
EnableRadiusRequest
- EnableRadiusRequest
object
: Contains the inputs for the EnableRadius operation.- DirectoryId required DirectoryId
- RadiusSettings required RadiusSettings
EnableRadiusResult
- EnableRadiusResult
object
: Contains the results of the EnableRadius operation.
EnableSsoRequest
- EnableSsoRequest
object
: Contains the inputs for the EnableSso operation.- DirectoryId required DirectoryId
- Password ConnectPassword
- UserName UserName
EnableSsoResult
- EnableSsoResult
object
: Contains the results of the EnableSso operation.
EndDateTime
- EndDateTime
string
EntityAlreadyExistsException
- EntityAlreadyExistsException
object
: The specified entity already exists.- Message ExceptionMessage
- RequestId RequestId
EntityDoesNotExistException
- EntityDoesNotExistException
object
: The specified entity could not be found.- Message ExceptionMessage
- RequestId RequestId
EventTopic
- EventTopic
object
: Information about SNS topic and AWS Directory Service directory associations.- CreatedDateTime CreatedDateTime
- DirectoryId DirectoryId
- Status TopicStatus
- TopicArn TopicArn
- TopicName TopicName
EventTopics
- EventTopics
array
- items EventTopic
ExceptionMessage
- ExceptionMessage
string
: The descriptive message for the exception.
GetDirectoryLimitsRequest
- GetDirectoryLimitsRequest
object
: Contains the inputs for the GetDirectoryLimits operation.
GetDirectoryLimitsResult
- GetDirectoryLimitsResult
object
: Contains the results of the GetDirectoryLimits operation.- DirectoryLimits DirectoryLimits
GetSnapshotLimitsRequest
- GetSnapshotLimitsRequest
object
: Contains the inputs for the GetSnapshotLimits operation.- DirectoryId required DirectoryId
GetSnapshotLimitsResult
- GetSnapshotLimitsResult
object
: Contains the results of the GetSnapshotLimits operation.- SnapshotLimits SnapshotLimits
InsufficientPermissionsException
- InsufficientPermissionsException
object
: The account does not have sufficient permission to perform the operation.- Message ExceptionMessage
- RequestId RequestId
InvalidNextTokenException
- InvalidNextTokenException
object
: The NextToken value is not valid.- Message ExceptionMessage
- RequestId RequestId
InvalidParameterException
- InvalidParameterException
object
: One or more parameters are not valid.- Message ExceptionMessage
- RequestId RequestId
IpAddr
- IpAddr
string
IpAddrs
- IpAddrs
array
- items IpAddr
IpRoute
- IpRoute
object
: IP address block. This is often the address block of the DNS server used for your on-premises domain.- CidrIp CidrIp
- Description Description
IpRouteInfo
- IpRouteInfo
object
: Information about one or more IP address blocks.- AddedDateTime AddedDateTime
- CidrIp CidrIp
- Description Description
- DirectoryId DirectoryId
- IpRouteStatusMsg IpRouteStatusMsg
- IpRouteStatusReason IpRouteStatusReason
IpRouteLimitExceededException
- IpRouteLimitExceededException
object
: The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.- Message ExceptionMessage
- RequestId RequestId
IpRouteStatusMsg
- IpRouteStatusMsg
string
(values: Adding, Added, Removing, Removed, AddFailed, RemoveFailed)
IpRouteStatusReason
- IpRouteStatusReason
string
IpRoutes
- IpRoutes
array
- items IpRoute
IpRoutesInfo
- IpRoutesInfo
array
- items IpRouteInfo
LastUpdatedDateTime
- LastUpdatedDateTime
string
LaunchTime
- LaunchTime
string
LdifContent
- LdifContent
string
Limit
- Limit
integer
ListIpRoutesRequest
- ListIpRoutesRequest
object
- DirectoryId required DirectoryId
- Limit Limit
- NextToken NextToken
ListIpRoutesResult
- ListIpRoutesResult
object
- IpRoutesInfo IpRoutesInfo
- NextToken NextToken
ListSchemaExtensionsRequest
- ListSchemaExtensionsRequest
object
- DirectoryId required DirectoryId
- Limit Limit
- NextToken NextToken
ListSchemaExtensionsResult
- ListSchemaExtensionsResult
object
- NextToken NextToken
- SchemaExtensionsInfo SchemaExtensionsInfo
ListTagsForResourceRequest
- ListTagsForResourceRequest
object
- Limit Limit
- NextToken NextToken
- ResourceId required ResourceId
ListTagsForResourceResult
ManualSnapshotsLimitReached
- ManualSnapshotsLimitReached
boolean
NextToken
- NextToken
string
OrganizationalUnitDN
- OrganizationalUnitDN
string
Password
- Password
string
PortNumber
- PortNumber
integer
RadiusAuthenticationProtocol
- RadiusAuthenticationProtocol
string
(values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2)
RadiusDisplayLabel
- RadiusDisplayLabel
string
RadiusRetries
- RadiusRetries
integer
RadiusSettings
- RadiusSettings
object
: Contains information about a Remote Authentication Dial In User Service (RADIUS) server.- AuthenticationProtocol RadiusAuthenticationProtocol
- DisplayLabel RadiusDisplayLabel
- RadiusPort PortNumber
- RadiusRetries RadiusRetries
- RadiusServers Servers
- RadiusTimeout RadiusTimeout
- SharedSecret RadiusSharedSecret
- UseSameUsername UseSameUsername
RadiusSharedSecret
- RadiusSharedSecret
string
RadiusStatus
- RadiusStatus
string
(values: Creating, Completed, Failed)
RadiusTimeout
- RadiusTimeout
integer
RegisterEventTopicRequest
- RegisterEventTopicRequest
object
: Registers a new event topic.- DirectoryId required DirectoryId
- TopicName required TopicName
RegisterEventTopicResult
- RegisterEventTopicResult
object
: The result of a RegisterEventTopic request.
RemoteDomainName
- RemoteDomainName
string
RemoteDomainNames
- RemoteDomainNames
array
- items RemoteDomainName
RemoveIpRoutesRequest
- RemoveIpRoutesRequest
object
- CidrIps required CidrIps
- DirectoryId required DirectoryId
RemoveIpRoutesResult
- RemoveIpRoutesResult
object
RemoveTagsFromResourceRequest
- RemoveTagsFromResourceRequest
object
- ResourceId required ResourceId
- TagKeys required TagKeys
RemoveTagsFromResourceResult
- RemoveTagsFromResourceResult
object
ReplicationScope
- ReplicationScope
string
(values: Domain)
RequestId
- RequestId
string
: The AWS request identifier.
ResourceId
- ResourceId
string
RestoreFromSnapshotRequest
- RestoreFromSnapshotRequest
object
: An object representing the inputs for the RestoreFromSnapshot operation.- SnapshotId required SnapshotId
RestoreFromSnapshotResult
- RestoreFromSnapshotResult
object
: Contains the results of the RestoreFromSnapshot operation.
SID
- SID
string
SchemaExtensionId
- SchemaExtensionId
string
SchemaExtensionInfo
- SchemaExtensionInfo
object
: Information about a schema extension.- Description Description
- DirectoryId DirectoryId
- EndDateTime EndDateTime
- SchemaExtensionId SchemaExtensionId
- SchemaExtensionStatus SchemaExtensionStatus
- SchemaExtensionStatusReason SchemaExtensionStatusReason
- StartDateTime StartDateTime
SchemaExtensionStatus
- SchemaExtensionStatus
string
(values: Initializing, CreatingSnapshot, UpdatingSchema, Replicating, CancelInProgress, RollbackInProgress, Cancelled, Failed, Completed)
SchemaExtensionStatusReason
- SchemaExtensionStatusReason
string
SchemaExtensionsInfo
- SchemaExtensionsInfo
array
- items SchemaExtensionInfo
SecurityGroupId
- SecurityGroupId
string
Server
- Server
string
Servers
- Servers
array
- items Server
ServiceException
- ServiceException
object
: An exception has occurred in AWS Directory Service.- Message ExceptionMessage
- RequestId RequestId
Snapshot
- Snapshot
object
: Describes a directory snapshot.- DirectoryId DirectoryId
- Name SnapshotName
- SnapshotId SnapshotId
- StartTime StartTime
- Status SnapshotStatus
- Type SnapshotType
SnapshotId
- SnapshotId
string
SnapshotIds
- SnapshotIds
array
: A list of directory snapshot identifiers.- items SnapshotId
SnapshotLimitExceededException
- SnapshotLimitExceededException
object
: 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.- Message ExceptionMessage
- RequestId RequestId
SnapshotLimits
- SnapshotLimits
object
: Contains manual snapshot limit information for a directory.- ManualSnapshotsCurrentCount Limit
- ManualSnapshotsLimit Limit
- ManualSnapshotsLimitReached ManualSnapshotsLimitReached
SnapshotName
- SnapshotName
string
SnapshotStatus
- SnapshotStatus
string
(values: Creating, Completed, Failed)
SnapshotType
- SnapshotType
string
(values: Auto, Manual)
Snapshots
- Snapshots
array
: A list of descriptions of directory snapshots.- items Snapshot
SsoEnabled
- SsoEnabled
boolean
StageReason
- StageReason
string
StartDateTime
- StartDateTime
string
StartSchemaExtensionRequest
- StartSchemaExtensionRequest
object
- CreateSnapshotBeforeSchemaExtension required CreateSnapshotBeforeSchemaExtension
- Description required Description
- DirectoryId required DirectoryId
- LdifContent required LdifContent
StartSchemaExtensionResult
- StartSchemaExtensionResult
object
- SchemaExtensionId SchemaExtensionId
StartTime
- StartTime
string
StateLastUpdatedDateTime
- StateLastUpdatedDateTime
string
SubnetId
- SubnetId
string
SubnetIds
- SubnetIds
array
- items SubnetId
Tag
- Tag
object
: Metadata assigned to a directory consisting of a key-value pair.
TagKey
- TagKey
string
TagKeys
- TagKeys
array
- items TagKey
TagLimitExceededException
- TagLimitExceededException
object
: The maximum allowed number of tags was exceeded.- Message ExceptionMessage
- RequestId RequestId
TagValue
- TagValue
string
Tags
- Tags
array
- items Tag
TopicArn
- TopicArn
string
TopicName
- TopicName
string
TopicNames
- TopicNames
array
- items TopicName
TopicStatus
- TopicStatus
string
(values: Registered, Topic not found, Failed, Deleted)
Trust
- Trust
object
: Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain.- CreatedDateTime CreatedDateTime
- DirectoryId DirectoryId
- LastUpdatedDateTime LastUpdatedDateTime
- RemoteDomainName RemoteDomainName
- StateLastUpdatedDateTime StateLastUpdatedDateTime
- TrustDirection TrustDirection
- TrustId TrustId
- TrustState TrustState
- TrustStateReason TrustStateReason
- TrustType TrustType
TrustDirection
- TrustDirection
string
(values: One-Way: Outgoing, One-Way: Incoming, Two-Way)
TrustId
- TrustId
string
TrustIds
- TrustIds
array
- items TrustId
TrustPassword
- TrustPassword
string
TrustState
- TrustState
string
(values: Creating, Created, Verifying, VerifyFailed, Verified, Deleting, Deleted, Failed)
TrustStateReason
- TrustStateReason
string
TrustType
- TrustType
string
(values: Forest)
Trusts
- Trusts
array
- items Trust
UnsupportedOperationException
- UnsupportedOperationException
object
: The operation is not supported.- Message ExceptionMessage
- RequestId RequestId
UpdateConditionalForwarderRequest
- UpdateConditionalForwarderRequest
object
: Updates a conditional forwarder.- DirectoryId required DirectoryId
- DnsIpAddrs required DnsIpAddrs
- RemoteDomainName required RemoteDomainName
UpdateConditionalForwarderResult
- UpdateConditionalForwarderResult
object
: The result of an UpdateConditionalForwarder request.
UpdateNumberOfDomainControllersRequest
- UpdateNumberOfDomainControllersRequest
object
- DesiredNumber required DesiredNumberOfDomainControllers
- DirectoryId required DirectoryId
UpdateNumberOfDomainControllersResult
- UpdateNumberOfDomainControllersResult
object
UpdateRadiusRequest
- UpdateRadiusRequest
object
: Contains the inputs for the UpdateRadius operation.- DirectoryId required DirectoryId
- RadiusSettings required RadiusSettings
UpdateRadiusResult
- UpdateRadiusResult
object
: Contains the results of the UpdateRadius operation.
UpdateSecurityGroupForDirectoryControllers
- UpdateSecurityGroupForDirectoryControllers
boolean
UseSameUsername
- UseSameUsername
boolean
UserName
- UserName
string
VerifyTrustRequest
- VerifyTrustRequest
object
: Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain.- TrustId required TrustId
VerifyTrustResult
- VerifyTrustResult
object
: Result of a VerifyTrust request.- TrustId TrustId
VpcId
- VpcId
string