5.0.0 • Published 8 years ago
@datafire/amazonaws_sms v5.0.0
@datafire/amazonaws_sms
Client library for AWS Server Migration Service
Installation and Usage
npm install --save @datafire/amazonaws_smslet 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
- input
object- description Description
- frequency required Frequency
- licenseType LicenseType
- roleName RoleName
- seedReplicationTime required Timestamp
- serverId required ServerId
Output
- output CreateReplicationJobResponse
DeleteReplicationJob
amazonaws_sms.DeleteReplicationJob({
"replicationJobId": ""
}, context)Input
- input
object- replicationJobId required ReplicationJobId
Output
- output DeleteReplicationJobResponse
DeleteServerCatalog
amazonaws_sms.DeleteServerCatalog({}, context)Input
- input
object
Output
- output DeleteServerCatalogResponse
DisassociateConnector
amazonaws_sms.DisassociateConnector({
"connectorId": ""
}, context)Input
- input
object- connectorId required ConnectorId
Output
GetConnectors
amazonaws_sms.GetConnectors({}, context)Input
- input
object- maxResults
string - nextToken
string - maxResults MaxResults
- nextToken NextToken
- maxResults
Output
- output GetConnectorsResponse
GetReplicationJobs
amazonaws_sms.GetReplicationJobs({}, context)Input
- input
object- maxResults
string - nextToken
string - maxResults MaxResults
- nextToken NextToken
- replicationJobId ReplicationJobId
- maxResults
Output
- output GetReplicationJobsResponse
GetReplicationRuns
amazonaws_sms.GetReplicationRuns({
"replicationJobId": ""
}, context)Input
- input
object- maxResults
string - nextToken
string - maxResults MaxResults
- nextToken NextToken
- replicationJobId required ReplicationJobId
- maxResults
Output
- output GetReplicationRunsResponse
GetServers
amazonaws_sms.GetServers({}, context)Input
- input
object- maxResults
string - nextToken
string - maxResults MaxResults
- nextToken NextToken
- maxResults
Output
- output GetServersResponse
ImportServerCatalog
amazonaws_sms.ImportServerCatalog({}, context)Input
- input
object
Output
- output ImportServerCatalogResponse
StartOnDemandReplicationRun
amazonaws_sms.StartOnDemandReplicationRun({
"replicationJobId": ""
}, context)Input
- input
object- description Description
- replicationJobId required ReplicationJobId
Output
UpdateReplicationJob
amazonaws_sms.UpdateReplicationJob({
"replicationJobId": ""
}, context)Input
- input
object- description Description
- frequency Frequency
- licenseType LicenseType
- nextReplicationRunStartTime Timestamp
- replicationJobId required ReplicationJobId
- roleName RoleName
Output
- output UpdateReplicationJobResponse
Definitions
AmiId
- AmiId
string: The AMI id for the image resulting from a Replication Run.
Connector
- Connector
object: Object representing a Connector- associatedOn Timestamp
- capabilityList ConnectorCapabilityList
- connectorId ConnectorId
- ipAddress IpAddress
- macAddress MacAddress
- status ConnectorStatus
- version ConnectorVersion
- vmManagerId VmManagerId
- vmManagerName VmManagerName
- vmManagerType VmManagerType
ConnectorCapability
- ConnectorCapability
string(values: VSPHERE): Capabilities for a Connector
ConnectorCapabilityList
- ConnectorCapabilityList
array: List of Connector Capabilities- items ConnectorCapability
ConnectorId
- ConnectorId
string: Unique Identifier for Connector
ConnectorList
- ConnectorList
array: List of connectors- items Connector
ConnectorStatus
- ConnectorStatus
string(values: HEALTHY, UNHEALTHY): Status of on-premise Connector
ConnectorVersion
- ConnectorVersion
string: Connector version string
CreateReplicationJobRequest
- CreateReplicationJobRequest
object- description Description
- frequency required Frequency
- licenseType LicenseType
- roleName RoleName
- seedReplicationTime required Timestamp
- serverId required ServerId
CreateReplicationJobResponse
- CreateReplicationJobResponse
object- replicationJobId ReplicationJobId
DeleteReplicationJobRequest
- DeleteReplicationJobRequest
object- replicationJobId required ReplicationJobId
DeleteReplicationJobResponse
- DeleteReplicationJobResponse
object
DeleteServerCatalogRequest
- DeleteServerCatalogRequest
object
DeleteServerCatalogResponse
- DeleteServerCatalogResponse
object
Description
- Description
string: The description for a Replication Job/Run.
DisassociateConnectorRequest
- DisassociateConnectorRequest
object- connectorId required ConnectorId
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
- GetConnectorsRequest
object- maxResults MaxResults
- nextToken NextToken
GetConnectorsResponse
- GetConnectorsResponse
object- connectorList ConnectorList
- nextToken NextToken
GetReplicationJobsRequest
- GetReplicationJobsRequest
object- maxResults MaxResults
- nextToken NextToken
- replicationJobId ReplicationJobId
GetReplicationJobsResponse
- GetReplicationJobsResponse
object- nextToken NextToken
- replicationJobList ReplicationJobList
GetReplicationRunsRequest
- GetReplicationRunsRequest
object- maxResults MaxResults
- nextToken NextToken
- replicationJobId required ReplicationJobId
GetReplicationRunsResponse
- GetReplicationRunsResponse
object- nextToken NextToken
- replicationJob ReplicationJob
- replicationRunList ReplicationRunList
GetServersRequest
- GetServersRequest
object- maxResults MaxResults
- nextToken NextToken
GetServersResponse
- GetServersResponse
object- lastModifiedOn Timestamp
- nextToken NextToken
- serverCatalogStatus ServerCatalogStatus
- serverList ServerList
ImportServerCatalogRequest
- ImportServerCatalogRequest
object
ImportServerCatalogResponse
- ImportServerCatalogResponse
object
InternalError
- InternalError
object: An internal error has occured.- message ErrorMessage
InvalidParameterException
- InvalidParameterException
object: A parameter specified in the request is not valid, is unsupported, or cannot be used.- message ErrorMessage
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.- message ErrorMessage
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.- message ErrorMessage
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.- message ErrorMessage
ReplicationJob
- ReplicationJob
object: Object representing a Replication Job- description Description
- frequency Frequency
- latestAmiId AmiId
- licenseType LicenseType
- nextReplicationRunStartTime Timestamp
- replicationJobId ReplicationJobId
- replicationRunList ReplicationRunList
- roleName RoleName
- seedReplicationTime Timestamp
- serverId ServerId
- serverType ServerType
- state ReplicationJobState
- statusMessage ReplicationJobStatusMessage
- vmServer VmServer
ReplicationJobAlreadyExistsException
- ReplicationJobAlreadyExistsException
object: An active Replication Job already exists for the specified server.- message ErrorMessage
ReplicationJobId
- ReplicationJobId
string: The unique identifier for a Replication Job.
ReplicationJobList
- ReplicationJobList
array: List of Replication Jobs- items ReplicationJob
ReplicationJobNotFoundException
- ReplicationJobNotFoundException
object: The specified Replication Job cannot be found.- message ErrorMessage
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
- ReplicationRun
object: Object representing a Replication Run- amiId AmiId
- completedTime Timestamp
- description Description
- replicationRunId ReplicationRunId
- scheduledStartTime Timestamp
- state ReplicationRunState
- statusMessage ReplicationRunStatusMessage
- type ReplicationRunType
ReplicationRunId
- ReplicationRunId
string: The unique identifier for a Replication Run.
ReplicationRunLimitExceededException
- ReplicationRunLimitExceededException
object: This user has exceeded the maximum allowed Replication Run limit.- message ErrorMessage
ReplicationRunList
- ReplicationRunList
array: List of Replication Runs- items ReplicationRun
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
- Server
object: Object representing a server- replicationJobId ReplicationJobId
- replicationJobTerminated ReplicationJobTerminated
- serverId ServerId
- serverType ServerType
- vmServer VmServer
ServerCannotBeReplicatedException
- ServerCannotBeReplicatedException
object: The provided server cannot be replicated.- message ErrorMessage
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- items Server
ServerType
- ServerType
string(values: VIRTUAL_MACHINE): Type of server.
StartOnDemandReplicationRunRequest
- StartOnDemandReplicationRunRequest
object- description Description
- replicationJobId required ReplicationJobId
StartOnDemandReplicationRunResponse
- StartOnDemandReplicationRunResponse
object- replicationRunId ReplicationRunId
Timestamp
- Timestamp
string: Timestamp of an operation
UnauthorizedOperationException
- UnauthorizedOperationException
object: This user does not have permissions to perform this operation.- message ErrorMessage
UpdateReplicationJobRequest
- UpdateReplicationJobRequest
object- description Description
- frequency Frequency
- licenseType LicenseType
- nextReplicationRunStartTime Timestamp
- replicationJobId required ReplicationJobId
- roleName RoleName
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
- VmServer
object: Object representing a VM server- vmManagerName VmManagerName
- vmManagerType VmManagerType
- vmName VmName
- vmPath VmPath
- vmServerAddress VmServerAddress
VmServerAddress
- VmServerAddress
object: Object representing a server's location- vmId VmId
- vmManagerId VmManagerId