Wondering what’s next for npm?Check out our public roadmap! »

    @datafire/amazonaws_ds

    5.0.0 • Public • Published

    @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

    Output

    AddTagsToResource

    amazonaws_ds.AddTagsToResource({
      "ResourceId": "",
      "Tags": []
    }, context)

    Input

    Output

    CancelSchemaExtension

    amazonaws_ds.CancelSchemaExtension({
      "DirectoryId": "",
      "SchemaExtensionId": ""
    }, context)

    Input

    Output

    ConnectDirectory

    amazonaws_ds.ConnectDirectory({
      "Name": "",
      "Password": "",
      "Size": "",
      "ConnectSettings": {
        "VpcId": "",
        "SubnetIds": [],
        "CustomerDnsIps": [],
        "CustomerUserName": ""
      }
    }, context)

    Input

    Output

    CreateAlias

    amazonaws_ds.CreateAlias({
      "DirectoryId": "",
      "Alias": ""
    }, context)

    Input

    Output

    CreateComputer

    amazonaws_ds.CreateComputer({
      "DirectoryId": "",
      "ComputerName": "",
      "Password": ""
    }, context)

    Input

    Output

    CreateConditionalForwarder

    amazonaws_ds.CreateConditionalForwarder({
      "DirectoryId": "",
      "RemoteDomainName": "",
      "DnsIpAddrs": []
    }, context)

    Input

    Output

    CreateDirectory

    amazonaws_ds.CreateDirectory({
      "Name": "",
      "Password": "",
      "Size": ""
    }, context)

    Input

    Output

    CreateMicrosoftAD

    amazonaws_ds.CreateMicrosoftAD({
      "Name": "",
      "Password": "",
      "VpcSettings": {
        "VpcId": "",
        "SubnetIds": []
      }
    }, context)

    Input

    Output

    CreateSnapshot

    amazonaws_ds.CreateSnapshot({
      "DirectoryId": ""
    }, context)

    Input

    Output

    CreateTrust

    amazonaws_ds.CreateTrust({
      "DirectoryId": "",
      "RemoteDomainName": "",
      "TrustPassword": "",
      "TrustDirection": ""
    }, context)

    Input

    Output

    DeleteConditionalForwarder

    amazonaws_ds.DeleteConditionalForwarder({
      "DirectoryId": "",
      "RemoteDomainName": ""
    }, context)

    Input

    Output

    DeleteDirectory

    amazonaws_ds.DeleteDirectory({
      "DirectoryId": ""
    }, context)

    Input

    Output

    DeleteSnapshot

    amazonaws_ds.DeleteSnapshot({
      "SnapshotId": ""
    }, context)

    Input

    Output

    DeleteTrust

    amazonaws_ds.DeleteTrust({
      "TrustId": ""
    }, context)

    Input

    Output

    DeregisterEventTopic

    amazonaws_ds.DeregisterEventTopic({
      "DirectoryId": "",
      "TopicName": ""
    }, context)

    Input

    Output

    DescribeConditionalForwarders

    amazonaws_ds.DescribeConditionalForwarders({
      "DirectoryId": ""
    }, context)

    Input

    Output

    DescribeDirectories

    amazonaws_ds.DescribeDirectories({}, context)

    Input

    Output

    DescribeDomainControllers

    amazonaws_ds.DescribeDomainControllers({
      "DirectoryId": ""
    }, context)

    Input

    Output

    DescribeEventTopics

    amazonaws_ds.DescribeEventTopics({}, context)

    Input

    Output

    DescribeSnapshots

    amazonaws_ds.DescribeSnapshots({}, context)

    Input

    Output

    DescribeTrusts

    amazonaws_ds.DescribeTrusts({}, context)

    Input

    Output

    DisableRadius

    amazonaws_ds.DisableRadius({
      "DirectoryId": ""
    }, context)

    Input

    Output

    DisableSso

    amazonaws_ds.DisableSso({
      "DirectoryId": ""
    }, context)

    Input

    Output

    EnableRadius

    amazonaws_ds.EnableRadius({
      "DirectoryId": "",
      "RadiusSettings": {}
    }, context)

    Input

    Output

    EnableSso

    amazonaws_ds.EnableSso({
      "DirectoryId": ""
    }, context)

    Input

    Output

    GetDirectoryLimits

    amazonaws_ds.GetDirectoryLimits({}, context)

    Input

    • input object

    Output

    GetSnapshotLimits

    amazonaws_ds.GetSnapshotLimits({
      "DirectoryId": ""
    }, context)

    Input

    Output

    ListIpRoutes

    amazonaws_ds.ListIpRoutes({
      "DirectoryId": ""
    }, context)

    Input

    Output

    ListSchemaExtensions

    amazonaws_ds.ListSchemaExtensions({
      "DirectoryId": ""
    }, context)

    Input

    Output

    ListTagsForResource

    amazonaws_ds.ListTagsForResource({
      "ResourceId": ""
    }, context)

    Input

    Output

    RegisterEventTopic

    amazonaws_ds.RegisterEventTopic({
      "DirectoryId": "",
      "TopicName": ""
    }, context)

    Input

    Output

    RemoveIpRoutes

    amazonaws_ds.RemoveIpRoutes({
      "DirectoryId": "",
      "CidrIps": []
    }, context)

    Input

    Output

    RemoveTagsFromResource

    amazonaws_ds.RemoveTagsFromResource({
      "ResourceId": "",
      "TagKeys": []
    }, context)

    Input

    Output

    RestoreFromSnapshot

    amazonaws_ds.RestoreFromSnapshot({
      "SnapshotId": ""
    }, context)

    Input

    Output

    StartSchemaExtension

    amazonaws_ds.StartSchemaExtension({
      "DirectoryId": "",
      "CreateSnapshotBeforeSchemaExtension": true,
      "LdifContent": "",
      "Description": ""
    }, context)

    Input

    Output

    UpdateConditionalForwarder

    amazonaws_ds.UpdateConditionalForwarder({
      "DirectoryId": "",
      "RemoteDomainName": "",
      "DnsIpAddrs": []
    }, context)

    Input

    Output

    UpdateNumberOfDomainControllers

    amazonaws_ds.UpdateNumberOfDomainControllers({
      "DirectoryId": "",
      "DesiredNumber": 0
    }, context)

    Input

    Output

    UpdateRadius

    amazonaws_ds.UpdateRadius({
      "DirectoryId": "",
      "RadiusSettings": {}
    }, context)

    Input

    Output

    VerifyTrust

    amazonaws_ds.VerifyTrust({
      "TrustId": ""
    }, context)

    Input

    • input object

    Output

    Definitions

    AccessUrl

    • AccessUrl string

    AddIpRoutesRequest

    AddIpRoutesResult

    • AddIpRoutesResult object

    AddTagsToResourceRequest

    • AddTagsToResourceRequest object

    AddTagsToResourceResult

    • AddTagsToResourceResult object

    AddedDateTime

    • AddedDateTime string

    AliasName

    • AliasName string

    Attribute

    AttributeName

    • AttributeName string

    AttributeValue

    • AttributeValue string

    Attributes

    AuthenticationFailedException

    AvailabilityZone

    • AvailabilityZone string

    AvailabilityZones

    CancelSchemaExtensionRequest

    CancelSchemaExtensionResult

    • CancelSchemaExtensionResult object

    CidrIp

    • CidrIp string

    CidrIps

    ClientException

    CloudOnlyDirectoriesLimitReached

    • CloudOnlyDirectoriesLimitReached boolean

    Computer

    • Computer object: Contains information about a computer account in a directory.

    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.

    ConditionalForwarders

    ConnectDirectoryRequest

    ConnectDirectoryResult

    ConnectPassword

    • ConnectPassword string

    ConnectedDirectoriesLimitReached

    • ConnectedDirectoriesLimitReached boolean

    CreateAliasRequest

    CreateAliasResult

    CreateComputerRequest

    CreateComputerResult

    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.

    CreateConditionalForwarderResult

    • CreateConditionalForwarderResult object: The result of a CreateConditinalForwarder request.

    CreateDirectoryRequest

    CreateDirectoryResult

    CreateMicrosoftADRequest

    CreateMicrosoftADResult

    • CreateMicrosoftADResult object: Result of a CreateMicrosoftAD request.

    CreateSnapshotBeforeSchemaExtension

    • CreateSnapshotBeforeSchemaExtension boolean

    CreateSnapshotRequest

    CreateSnapshotResult

    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.

    CreateTrustResult

    • CreateTrustResult object: The result of a CreateTrust request.

    CreatedDateTime

    • CreatedDateTime string

    DeleteAssociatedConditionalForwarder

    • DeleteAssociatedConditionalForwarder boolean

    DeleteConditionalForwarderRequest

    • DeleteConditionalForwarderRequest object: Deletes a conditional forwarder.

    DeleteConditionalForwarderResult

    • DeleteConditionalForwarderResult object: The result of a DeleteConditionalForwarder request.

    DeleteDirectoryRequest

    DeleteDirectoryResult

    DeleteSnapshotRequest

    DeleteSnapshotResult

    DeleteTrustRequest

    • DeleteTrustRequest object: Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.

    DeleteTrustResult

    • DeleteTrustResult object: The result of a DeleteTrust request.

    DeregisterEventTopicRequest

    • DeregisterEventTopicRequest object: Removes the specified directory as a publisher to the specified SNS topic.

    DeregisterEventTopicResult

    • DeregisterEventTopicResult object: The result of a DeregisterEventTopic request.

    DescribeConditionalForwardersRequest

    • DescribeConditionalForwardersRequest object: Describes a conditional forwarder.

    DescribeConditionalForwardersResult

    • DescribeConditionalForwardersResult object: The result of a DescribeConditionalForwarder request.

    DescribeDirectoriesRequest

    DescribeDirectoriesResult

    DescribeDomainControllersRequest

    DescribeDomainControllersResult

    DescribeEventTopicsRequest

    • DescribeEventTopicsRequest object: Describes event topics.

    DescribeEventTopicsResult

    • DescribeEventTopicsResult object: The result of a DescribeEventTopic request.

    DescribeSnapshotsRequest

    DescribeSnapshotsResult

    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.

    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.

    DirectoryConnectSettingsDescription

    DirectoryDescription

    DirectoryDescriptions

    DirectoryEdition

    • DirectoryEdition string (values: Enterprise, Standard)

    DirectoryId

    • DirectoryId string

    DirectoryIds

    • DirectoryIds array: A list of directory identifiers.

    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.

    DirectoryLimits

    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.

    DirectoryVpcSettings

    DirectoryVpcSettingsDescription

    DisableRadiusRequest

    DisableRadiusResult

    • DisableRadiusResult object: Contains the results of the DisableRadius operation.

    DisableSsoRequest

    DisableSsoResult

    • DisableSsoResult object: Contains the results of the DisableSso operation.

    DnsIpAddrs

    • DnsIpAddrs array

    DomainController

    DomainControllerId

    • DomainControllerId string

    DomainControllerIds

    DomainControllerLimitExceededException

    • DomainControllerLimitExceededException object: The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.

    DomainControllerStatus

    • DomainControllerStatus string (values: Creating, Active, Impaired, Restoring, Deleting, Deleted, Failed)

    DomainControllerStatusReason

    • DomainControllerStatusReason string

    DomainControllers

    EnableRadiusRequest

    EnableRadiusResult

    • EnableRadiusResult object: Contains the results of the EnableRadius operation.

    EnableSsoRequest

    EnableSsoResult

    • EnableSsoResult object: Contains the results of the EnableSso operation.

    EndDateTime

    • EndDateTime string

    EntityAlreadyExistsException

    EntityDoesNotExistException

    EventTopic

    EventTopics

    ExceptionMessage

    • ExceptionMessage string: The descriptive message for the exception.

    GetDirectoryLimitsRequest

    • GetDirectoryLimitsRequest object: Contains the inputs for the GetDirectoryLimits operation.

    GetDirectoryLimitsResult

    GetSnapshotLimitsRequest

    GetSnapshotLimitsResult

    InsufficientPermissionsException

    • InsufficientPermissionsException object: The account does not have sufficient permission to perform the operation.

    InvalidNextTokenException

    InvalidParameterException

    IpAddr

    • IpAddr string

    IpAddrs

    IpRoute

    • IpRoute object: IP address block. This is often the address block of the DNS server used for your on-premises domain.

    IpRouteInfo

    IpRouteLimitExceededException

    • IpRouteLimitExceededException object: The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.

    IpRouteStatusMsg

    • IpRouteStatusMsg string (values: Adding, Added, Removing, Removed, AddFailed, RemoveFailed)

    IpRouteStatusReason

    • IpRouteStatusReason string

    IpRoutes

    IpRoutesInfo

    LastUpdatedDateTime

    • LastUpdatedDateTime string

    LaunchTime

    • LaunchTime string

    LdifContent

    • LdifContent string

    Limit

    • Limit integer

    ListIpRoutesRequest

    ListIpRoutesResult

    ListSchemaExtensionsRequest

    ListSchemaExtensionsResult

    ListTagsForResourceRequest

    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

    RadiusSharedSecret

    • RadiusSharedSecret string

    RadiusStatus

    • RadiusStatus string (values: Creating, Completed, Failed)

    RadiusTimeout

    • RadiusTimeout integer

    RegisterEventTopicRequest

    • RegisterEventTopicRequest object: Registers a new event topic.

    RegisterEventTopicResult

    • RegisterEventTopicResult object: The result of a RegisterEventTopic request.

    RemoteDomainName

    • RemoteDomainName string

    RemoteDomainNames

    RemoveIpRoutesRequest

    RemoveIpRoutesResult

    • RemoveIpRoutesResult object

    RemoveTagsFromResourceRequest

    • RemoveTagsFromResourceRequest object

    RemoveTagsFromResourceResult

    • RemoveTagsFromResourceResult object

    ReplicationScope

    • ReplicationScope string (values: Domain)

    RequestId

    • RequestId string: The AWS request identifier.

    ResourceId

    • ResourceId string

    RestoreFromSnapshotRequest

    RestoreFromSnapshotResult

    SID

    • SID string

    SchemaExtensionId

    • SchemaExtensionId string

    SchemaExtensionInfo

    SchemaExtensionStatus

    • SchemaExtensionStatus string (values: Initializing, CreatingSnapshot, UpdatingSchema, Replicating, CancelInProgress, RollbackInProgress, Cancelled, Failed, Completed)

    SchemaExtensionStatusReason

    • SchemaExtensionStatusReason string

    SchemaExtensionsInfo

    SecurityGroupId

    • SecurityGroupId string

    Server

    • Server string

    Servers

    ServiceException

    Snapshot

    SnapshotId

    • SnapshotId string

    SnapshotIds

    • SnapshotIds array: A list of directory snapshot identifiers.

    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.

    SnapshotLimits

    • SnapshotLimits object: Contains manual snapshot limit information for a directory.

    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.

    SsoEnabled

    • SsoEnabled boolean

    StageReason

    • StageReason string

    StartDateTime

    • StartDateTime string

    StartSchemaExtensionRequest

    StartSchemaExtensionResult

    StartTime

    • StartTime string

    StateLastUpdatedDateTime

    • StateLastUpdatedDateTime string

    SubnetId

    • SubnetId string

    SubnetIds

    Tag

    • Tag object: Metadata assigned to a directory consisting of a key-value pair.

    TagKey

    • TagKey string

    TagKeys

    TagLimitExceededException

    • TagLimitExceededException object: The maximum allowed number of tags was exceeded.

    TagValue

    • TagValue string

    Tags

    • Tags array

    TopicArn

    • TopicArn string

    TopicName

    • TopicName string

    TopicNames

    TopicStatus

    • TopicStatus string (values: Registered, Topic not found, Failed, Deleted)

    Trust

    TrustDirection

    • TrustDirection string (values: One-Way: Outgoing, One-Way: Incoming, Two-Way)

    TrustId

    • TrustId string

    TrustIds

    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

    UnsupportedOperationException

    UpdateConditionalForwarderRequest

    UpdateConditionalForwarderResult

    • UpdateConditionalForwarderResult object: The result of an UpdateConditionalForwarder request.

    UpdateNumberOfDomainControllersRequest

    UpdateNumberOfDomainControllersResult

    • UpdateNumberOfDomainControllersResult object

    UpdateRadiusRequest

    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.

    VerifyTrustResult

    • VerifyTrustResult object: Result of a VerifyTrust request.

    VpcId

    • VpcId string

    Keywords

    none

    Install

    npm i @datafire/amazonaws_ds

    DownloadsWeekly Downloads

    12

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    244 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar