Have ideas to improve npm?Join in the discussion! »

    @datafire/amazonaws_sms

    5.0.0 • Public • Published

    @datafire/amazonaws_sms

    Client library for AWS Server Migration Service

    Installation and Usage

    npm install --save @datafire/amazonaws_sms
    let amazonaws_sms = require('@datafire/amazonaws_sms').create({
      accessKeyId: "",
      secretAccessKey: "",
      region: ""
    });
     
    amazonaws_sms.CreateReplicationJob({
      "serverId": "",
      "seedReplicationTime": "",
      "frequency": 0
    }).then(data => {
      console.log(data);
    });

    Description

    Amazon Server Migration Service automates the process of migrating servers to EC2.

    Actions

    CreateReplicationJob

    amazonaws_sms.CreateReplicationJob({
      "serverId": "",
      "seedReplicationTime": "",
      "frequency": 0
    }, context)

    Input

    Output

    DeleteReplicationJob

    amazonaws_sms.DeleteReplicationJob({
      "replicationJobId": ""
    }, context)

    Input

    Output

    DeleteServerCatalog

    amazonaws_sms.DeleteServerCatalog({}, context)

    Input

    • input object

    Output

    DisassociateConnector

    amazonaws_sms.DisassociateConnector({
      "connectorId": ""
    }, context)

    Input

    Output

    GetConnectors

    amazonaws_sms.GetConnectors({}, context)

    Input

    Output

    GetReplicationJobs

    amazonaws_sms.GetReplicationJobs({}, context)

    Input

    Output

    GetReplicationRuns

    amazonaws_sms.GetReplicationRuns({
      "replicationJobId": ""
    }, context)

    Input

    Output

    GetServers

    amazonaws_sms.GetServers({}, context)

    Input

    Output

    ImportServerCatalog

    amazonaws_sms.ImportServerCatalog({}, context)

    Input

    • input object

    Output

    StartOnDemandReplicationRun

    amazonaws_sms.StartOnDemandReplicationRun({
      "replicationJobId": ""
    }, context)

    Input

    Output

    UpdateReplicationJob

    amazonaws_sms.UpdateReplicationJob({
      "replicationJobId": ""
    }, context)

    Input

    Output

    Definitions

    AmiId

    • AmiId string: The AMI id for the image resulting from a Replication Run.

    Connector

    ConnectorCapability

    • ConnectorCapability string (values: VSPHERE): Capabilities for a Connector

    ConnectorCapabilityList

    ConnectorId

    • ConnectorId string: Unique Identifier for Connector

    ConnectorList

    • ConnectorList array: List of connectors

    ConnectorStatus

    • ConnectorStatus string (values: HEALTHY, UNHEALTHY): Status of on-premise Connector

    ConnectorVersion

    • ConnectorVersion string: Connector version string

    CreateReplicationJobRequest

    CreateReplicationJobResponse

    DeleteReplicationJobRequest

    DeleteReplicationJobResponse

    • DeleteReplicationJobResponse object

    DeleteServerCatalogRequest

    • DeleteServerCatalogRequest object

    DeleteServerCatalogResponse

    • DeleteServerCatalogResponse object

    Description

    • Description string: The description for a Replication Job/Run.

    DisassociateConnectorRequest

    • DisassociateConnectorRequest object

    DisassociateConnectorResponse

    • DisassociateConnectorResponse object

    ErrorMessage

    • ErrorMessage string: Error Message string

    Frequency

    • Frequency integer: Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.

    GetConnectorsRequest

    GetConnectorsResponse

    GetReplicationJobsRequest

    GetReplicationJobsResponse

    GetReplicationRunsRequest

    GetReplicationRunsResponse

    GetServersRequest

    GetServersResponse

    ImportServerCatalogRequest

    • ImportServerCatalogRequest object

    ImportServerCatalogResponse

    • ImportServerCatalogResponse object

    InternalError

    • InternalError object: An internal error has occured.

    InvalidParameterException

    • InvalidParameterException object: A parameter specified in the request is not valid, is unsupported, or cannot be used.

    IpAddress

    • IpAddress string: Internet Protocol (IP) Address

    LicenseType

    • LicenseType string (values: AWS, BYOL): The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun.

    MacAddress

    • MacAddress string: Hardware (MAC) address

    MaxResults

    • MaxResults integer: The maximum number of results to return in one API call. If left empty, this will default to 50.

    MissingRequiredParameterException

    • MissingRequiredParameterException object: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

    NextToken

    • NextToken string: Pagination token to pass as input to API call

    NoConnectorsAvailableException

    • NoConnectorsAvailableException object: No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.

    OperationNotPermittedException

    • OperationNotPermittedException object: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

    ReplicationJob

    ReplicationJobAlreadyExistsException

    • ReplicationJobAlreadyExistsException object: An active Replication Job already exists for the specified server.

    ReplicationJobId

    • ReplicationJobId string: The unique identifier for a Replication Job.

    ReplicationJobList

    • ReplicationJobList array: List of Replication Jobs

    ReplicationJobNotFoundException

    • ReplicationJobNotFoundException object: The specified Replication Job cannot be found.

    ReplicationJobState

    • ReplicationJobState string (values: PENDING, ACTIVE, FAILED, DELETING, DELETED): Current state of Replication Job

    ReplicationJobStatusMessage

    • ReplicationJobStatusMessage string: String describing current status of Replication Job

    ReplicationJobTerminated

    • ReplicationJobTerminated boolean: An indicator of the Replication Job being deleted or failed.

    ReplicationRun

    ReplicationRunId

    • ReplicationRunId string: The unique identifier for a Replication Run.

    ReplicationRunLimitExceededException

    • ReplicationRunLimitExceededException object: This user has exceeded the maximum allowed Replication Run limit.

    ReplicationRunList

    • ReplicationRunList array: List of Replication Runs

    ReplicationRunState

    • ReplicationRunState string (values: PENDING, MISSED, ACTIVE, FAILED, COMPLETED, DELETING, DELETED): Current state of Replication Run

    ReplicationRunStatusMessage

    • ReplicationRunStatusMessage string: String describing current status of Replication Run

    ReplicationRunType

    • ReplicationRunType string (values: ON_DEMAND, AUTOMATIC): Type of Replication Run

    RoleName

    • RoleName string: Name of service role in customer's account to be used by SMS service.

    Server

    ServerCannotBeReplicatedException

    • ServerCannotBeReplicatedException object: The provided server cannot be replicated.

    ServerCatalogStatus

    • ServerCatalogStatus string (values: NOT_IMPORTED, IMPORTING, AVAILABLE, DELETED, EXPIRED): Status of Server catalog

    ServerId

    • ServerId string: Unique Identifier for a server

    ServerList

    • ServerList array: List of servers from catalog

    ServerType

    • ServerType string (values: VIRTUAL_MACHINE): Type of server.

    StartOnDemandReplicationRunRequest

    StartOnDemandReplicationRunResponse

    Timestamp

    • Timestamp string: Timestamp of an operation

    UnauthorizedOperationException

    • UnauthorizedOperationException object: This user does not have permissions to perform this operation.

    UpdateReplicationJobRequest

    UpdateReplicationJobResponse

    • UpdateReplicationJobResponse object

    VmId

    • VmId string: Unique Identifier for a VM

    VmManagerId

    • VmManagerId string: Unique Identifier for VM Manager

    VmManagerName

    • VmManagerName string: VM Manager Name

    VmManagerType

    • VmManagerType string (values: VSPHERE): VM Management Product

    VmName

    • VmName string: Name of Virtual Machine

    VmPath

    • VmPath string: Path to VM

    VmServer

    VmServerAddress

    • VmServerAddress object: Object representing a server's location

    Keywords

    none

    Install

    npm i @datafire/amazonaws_sms

    DownloadsWeekly Downloads

    19

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    67.8 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar