@datafire/amazonaws_discovery v5.0.0

@datafire/amazonaws_discovery

Client library for AWS Application Discovery Service

Installation and Usage

npm install --save @datafire/amazonaws_discovery

let amazonaws_discovery = require('@datafire/amazonaws_discovery').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_discovery.AssociateConfigurationItemsToApplication({
  "applicationConfigurationId": "",
  "configurationIds": []
}).then(data => {
  console.log(data);
});

Description

AWS Application Discovery Service AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service FAQ. Application Discovery Service offers two modes of operation. Agentless discovery mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies. Agent-based discovery mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution. Application Discovery Service doesn't gather sensitive information. All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service. Your AWS account must be granted access to Application Discovery Service, a process called whitelisting. This is true for AWS partners and customers alike. To request access, sign up for AWS Application Discovery Service. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs. This guide is intended for use with the AWS Application Discovery Service User Guide .

Actions

AssociateConfigurationItemsToApplication

amazonaws_discovery.AssociateConfigurationItemsToApplication({
  "applicationConfigurationId": "",
  "configurationIds": []
}, context)

Input

• input object
  • applicationConfigurationId required ApplicationId
  • configurationIds required ConfigurationIdList

Output

• output AssociateConfigurationItemsToApplicationResponse

CreateApplication

amazonaws_discovery.CreateApplication({
  "name": ""
}, context)

Input

• input object
  • description String
  • name required String

Output

• output CreateApplicationResponse

CreateTags

amazonaws_discovery.CreateTags({
  "configurationIds": [],
  "tags": []
}, context)

Input

• input object
  • configurationIds required ConfigurationIdList
  • tags required TagSet

Output

• output CreateTagsResponse

DeleteApplications

amazonaws_discovery.DeleteApplications({
  "configurationIds": []
}, context)

Input

• input object
  • configurationIds required ApplicationIdsList

Output

• output DeleteApplicationsResponse

DeleteTags

amazonaws_discovery.DeleteTags({
  "configurationIds": []
}, context)

Input

• input object
  • configurationIds required ConfigurationIdList
  • tags TagSet

Output

• output DeleteTagsResponse

DescribeAgents

amazonaws_discovery.DescribeAgents({}, context)

Input

• input object
  • agentIds AgentIds
  • filters Filters
  • maxResults Integer
  • nextToken NextToken

Output

• output DescribeAgentsResponse

DescribeConfigurations

amazonaws_discovery.DescribeConfigurations({
  "configurationIds": []
}, context)

Input

• input object
  • configurationIds required ConfigurationIdList

Output

• output DescribeConfigurationsResponse

DescribeExportConfigurations

amazonaws_discovery.DescribeExportConfigurations({}, context)

Input

• input object
  • exportIds ExportIds
  • maxResults Integer
  • nextToken NextToken

Output

• output DescribeExportConfigurationsResponse

DescribeExportTasks

amazonaws_discovery.DescribeExportTasks({}, context)

Input

• input object
  • exportIds ExportIds
  • filters ExportFilters
  • maxResults Integer
  • nextToken NextToken

Output

• output DescribeExportTasksResponse

DescribeTags

amazonaws_discovery.DescribeTags({}, context)

Input

• input object
  • filters TagFilters
  • maxResults Integer
  • nextToken NextToken

Output

• output DescribeTagsResponse

DisassociateConfigurationItemsFromApplication

amazonaws_discovery.DisassociateConfigurationItemsFromApplication({
  "applicationConfigurationId": "",
  "configurationIds": []
}, context)

Input

• input object
  • applicationConfigurationId required ApplicationId
  • configurationIds required ConfigurationIdList

Output

• output DisassociateConfigurationItemsFromApplicationResponse

ExportConfigurations

amazonaws_discovery.ExportConfigurations({}, context)

Input

• input object

Output

• output ExportConfigurationsResponse

GetDiscoverySummary

amazonaws_discovery.GetDiscoverySummary({}, context)

Input

• input object

Output

• output GetDiscoverySummaryResponse

ListConfigurations

amazonaws_discovery.ListConfigurations({
  "configurationType": ""
}, context)

Input

• input object
  • configurationType required ConfigurationItemType
  • filters Filters
  • maxResults Integer
  • nextToken NextToken
  • orderBy OrderByList

Output

• output ListConfigurationsResponse

ListServerNeighbors

amazonaws_discovery.ListServerNeighbors({
  "configurationId": ""
}, context)

Input

• input object
  • configurationId required ConfigurationId
  • maxResults Integer
  • neighborConfigurationIds ConfigurationIdList
  • nextToken String
  • portInformationNeeded Boolean

Output

• output ListServerNeighborsResponse

StartDataCollectionByAgentIds

amazonaws_discovery.StartDataCollectionByAgentIds({
  "agentIds": []
}, context)

Input

• input object
  • agentIds required AgentIds

Output

• output StartDataCollectionByAgentIdsResponse

StartExportTask

amazonaws_discovery.StartExportTask({}, context)

Input

• input object
  • endTime TimeStamp
  • exportDataFormat ExportDataFormats
  • filters ExportFilters
  • startTime TimeStamp

Output

• output StartExportTaskResponse

StopDataCollectionByAgentIds

amazonaws_discovery.StopDataCollectionByAgentIds({
  "agentIds": []
}, context)

Input

• input object
  • agentIds required AgentIds

Output

• output StopDataCollectionByAgentIdsResponse

UpdateApplication

amazonaws_discovery.UpdateApplication({
  "configurationId": ""
}, context)

Input

• input object
  • configurationId required ApplicationId
  • description String
  • name String

Output

• output UpdateApplicationResponse

Definitions

AgentConfigurationStatus

• AgentConfigurationStatus object: Information about agents or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.
  • agentId String
  • description String
  • operationSucceeded Boolean

AgentConfigurationStatusList

• AgentConfigurationStatusList array
  • items AgentConfigurationStatus

AgentId

• AgentId string

AgentIds

• AgentIds array
  • items AgentId

AgentInfo

• AgentInfo object: Information about agents or connectors associated with the user’s AWS account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.
  • agentId AgentId
  • agentNetworkInfoList AgentNetworkInfoList
  • agentType String
  • collectionStatus String
  • connectorId String
  • health AgentStatus
  • hostName String
  • lastHealthPingTime String
  • registeredTime String
  • version String

AgentNetworkInfo

• AgentNetworkInfo object: Network details about the host where the agent/connector resides.
  • ipAddress String
  • macAddress String

AgentNetworkInfoList

• AgentNetworkInfoList array
  • items AgentNetworkInfo

AgentStatus

• AgentStatus string (values: HEALTHY, UNHEALTHY, RUNNING, UNKNOWN, BLACKLISTED, SHUTDOWN)

AgentsInfo

• AgentsInfo array
  • items AgentInfo

ApplicationId

• ApplicationId string

ApplicationIdsList

• ApplicationIdsList array
  • items ApplicationId

AssociateConfigurationItemsToApplicationRequest

• AssociateConfigurationItemsToApplicationRequest object
  • applicationConfigurationId required ApplicationId
  • configurationIds required ConfigurationIdList

AssociateConfigurationItemsToApplicationResponse

• AssociateConfigurationItemsToApplicationResponse object

AuthorizationErrorException

• AuthorizationErrorException object: The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
  • message Message

Boolean

• Boolean boolean

BoxedInteger

• BoxedInteger integer

Condition

• Condition string

Configuration

• Configuration array
  • items object
    • key String
    • value String

ConfigurationId

• ConfigurationId string

ConfigurationIdList

• ConfigurationIdList array
  • items ConfigurationId

ConfigurationItemType

• ConfigurationItemType string (values: SERVER, PROCESS, CONNECTION, APPLICATION)

ConfigurationTag

• ConfigurationTag object: Tags for a configuration item. Tags are metadata that help you categorize IT assets.
  • configurationId ConfigurationId
  • configurationType ConfigurationItemType
  • key TagKey
  • timeOfCreation TimeStamp
  • value TagValue

ConfigurationTagSet

• ConfigurationTagSet array
  • items ConfigurationTag

Configurations

• Configurations array
  • items Configuration

ConfigurationsDownloadUrl

• ConfigurationsDownloadUrl string

ConfigurationsExportId

• ConfigurationsExportId string

CreateApplicationRequest

• CreateApplicationRequest object
  • description String
  • name required String

CreateApplicationResponse

• CreateApplicationResponse object
  • configurationId String

CreateTagsRequest

• CreateTagsRequest object
  • configurationIds required ConfigurationIdList
  • tags required TagSet

CreateTagsResponse

• CreateTagsResponse object

CustomerAgentInfo

• CustomerAgentInfo object: Inventory data for installed discovery agents.
  • activeAgents required Integer
  • blackListedAgents required Integer
  • healthyAgents required Integer
  • shutdownAgents required Integer
  • totalAgents required Integer
  • unhealthyAgents required Integer
  • unknownAgents required Integer

CustomerConnectorInfo

• CustomerConnectorInfo object: Inventory data for installed discovery connectors.
  • activeConnectors required Integer
  • blackListedConnectors required Integer
  • healthyConnectors required Integer
  • shutdownConnectors required Integer
  • totalConnectors required Integer
  • unhealthyConnectors required Integer
  • unknownConnectors required Integer

DeleteApplicationsRequest

• DeleteApplicationsRequest object
  • configurationIds required ApplicationIdsList

DeleteApplicationsResponse

• DeleteApplicationsResponse object

DeleteTagsRequest

• DeleteTagsRequest object
  • configurationIds required ConfigurationIdList
  • tags TagSet

DeleteTagsResponse

• DeleteTagsResponse object

DescribeAgentsRequest

• DescribeAgentsRequest object
  • agentIds AgentIds
  • filters Filters
  • maxResults Integer
  • nextToken NextToken

DescribeAgentsResponse

• DescribeAgentsResponse object
  • agentsInfo AgentsInfo
  • nextToken NextToken

DescribeConfigurationsAttribute

• DescribeConfigurationsAttribute array
  • items object
    • key String
    • value String

DescribeConfigurationsAttributes

• DescribeConfigurationsAttributes array
  • items DescribeConfigurationsAttribute

DescribeConfigurationsRequest

• DescribeConfigurationsRequest object
  • configurationIds required ConfigurationIdList

DescribeConfigurationsResponse

• DescribeConfigurationsResponse object
  • configurations DescribeConfigurationsAttributes

DescribeExportConfigurationsRequest

• DescribeExportConfigurationsRequest object
  • exportIds ExportIds
  • maxResults Integer
  • nextToken NextToken

DescribeExportConfigurationsResponse

• DescribeExportConfigurationsResponse object
  • exportsInfo ExportsInfo
  • nextToken NextToken

DescribeExportTasksRequest

• DescribeExportTasksRequest object
  • exportIds ExportIds
  • filters ExportFilters
  • maxResults Integer
  • nextToken NextToken

DescribeExportTasksResponse

• DescribeExportTasksResponse object
  • exportsInfo ExportsInfo
  • nextToken NextToken

DescribeTagsRequest

• DescribeTagsRequest object
  • filters TagFilters
  • maxResults Integer
  • nextToken NextToken

DescribeTagsResponse

• DescribeTagsResponse object
  • nextToken NextToken
  • tags ConfigurationTagSet

DisassociateConfigurationItemsFromApplicationRequest

• DisassociateConfigurationItemsFromApplicationRequest object
  • applicationConfigurationId required ApplicationId
  • configurationIds required ConfigurationIdList

DisassociateConfigurationItemsFromApplicationResponse

• DisassociateConfigurationItemsFromApplicationResponse object

ExportConfigurationsResponse

• ExportConfigurationsResponse object
  • exportId ConfigurationsExportId

ExportDataFormat

• ExportDataFormat string (values: CSV, GRAPHML)

ExportDataFormats

• ExportDataFormats array
  • items ExportDataFormat

ExportFilter

• ExportFilter object: Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
  • condition required Condition
  • name required FilterName
  • values required FilterValues

ExportFilters

• ExportFilters array
  • items ExportFilter

ExportIds

• ExportIds array
  • items ConfigurationsExportId

ExportInfo

• ExportInfo object: Information regarding the export status of discovered data. The value is an array of objects.
  • configurationsDownloadUrl ConfigurationsDownloadUrl
  • exportId required ConfigurationsExportId
  • exportRequestTime required ExportRequestTime
  • exportStatus required ExportStatus
  • isTruncated Boolean
  • requestedEndTime TimeStamp
  • requestedStartTime TimeStamp
  • statusMessage required ExportStatusMessage

ExportRequestTime

• ExportRequestTime string

ExportStatus

• ExportStatus string (values: FAILED, SUCCEEDED, IN_PROGRESS)

ExportStatusMessage

• ExportStatusMessage string

ExportsInfo

• ExportsInfo array
  • items ExportInfo

Filter

• Filter object: A filter that can use conditional operators. For more information about filters, see Querying Discovered Configuration Items.
  • condition required Condition
  • name required String
  • values required FilterValues

FilterName

• FilterName string

FilterValue

• FilterValue string

FilterValues

• FilterValues array
  • items FilterValue

Filters

• Filters array
  • items Filter

GetDiscoverySummaryRequest

• GetDiscoverySummaryRequest object

GetDiscoverySummaryResponse

• GetDiscoverySummaryResponse object
  • agentSummary CustomerAgentInfo
  • applications Long
  • connectorSummary CustomerConnectorInfo
  • servers Long
  • serversMappedToApplications Long
  • serversMappedtoTags Long

Integer

• Integer integer

InvalidParameterException

• InvalidParameterException object: One or more parameters are not valid. Verify the parameters and try again.
  • message Message

InvalidParameterValueException

• InvalidParameterValueException object: The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
  • message Message

ListConfigurationsRequest

• ListConfigurationsRequest object
  • configurationType required ConfigurationItemType
  • filters Filters
  • maxResults Integer
  • nextToken NextToken
  • orderBy OrderByList

ListConfigurationsResponse

• ListConfigurationsResponse object
  • configurations Configurations
  • nextToken NextToken

ListServerNeighborsRequest

• ListServerNeighborsRequest object
  • configurationId required ConfigurationId
  • maxResults Integer
  • neighborConfigurationIds ConfigurationIdList
  • nextToken String
  • portInformationNeeded Boolean

ListServerNeighborsResponse

• ListServerNeighborsResponse object
  • knownDependencyCount Long
  • neighbors required NeighborDetailsList
  • nextToken String

Long

• Long integer

Message

• Message string

NeighborConnectionDetail

• NeighborConnectionDetail object: Details about neighboring servers.
  • connectionsCount required Long
  • destinationPort BoxedInteger
  • destinationServerId required ConfigurationId
  • sourceServerId required ConfigurationId
  • transportProtocol String

NeighborDetailsList

• NeighborDetailsList array
  • items NeighborConnectionDetail

NextToken

• NextToken string

OperationNotPermittedException

• OperationNotPermittedException object: This operation is not permitted.
  • message Message

OrderByElement

• OrderByElement object: A field and direction for ordered output.
  • fieldName required String
  • sortOrder orderString

OrderByList

• OrderByList array
  • items OrderByElement

ResourceNotFoundException

• ResourceNotFoundException object: The specified configuration ID was not located. Verify the configuration ID and try again.
  • message Message

ServerInternalErrorException

• ServerInternalErrorException object: The server experienced an internal error. Try again.
  • message Message

StartDataCollectionByAgentIdsRequest

• StartDataCollectionByAgentIdsRequest object
  • agentIds required AgentIds

StartDataCollectionByAgentIdsResponse

• StartDataCollectionByAgentIdsResponse object
  • agentsConfigurationStatus AgentConfigurationStatusList

StartExportTaskRequest

• StartExportTaskRequest object
  • endTime TimeStamp
  • exportDataFormat ExportDataFormats
  • filters ExportFilters
  • startTime TimeStamp

StartExportTaskResponse

• StartExportTaskResponse object
  • exportId ConfigurationsExportId

StopDataCollectionByAgentIdsRequest

• StopDataCollectionByAgentIdsRequest object
  • agentIds required AgentIds

StopDataCollectionByAgentIdsResponse

• StopDataCollectionByAgentIdsResponse object
  • agentsConfigurationStatus AgentConfigurationStatusList

String

• String string

Tag

• Tag object: Metadata that help you categorize IT assets.
  • key required TagKey
  • value required TagValue

TagFilter

• TagFilter object: The tag filter. Valid names are: tagKey, tagValue, configurationId.
  • name required FilterName
  • values required FilterValues

TagFilters

• TagFilters array
  • items TagFilter

TagKey

• TagKey string

TagSet

• TagSet array
  • items Tag

TagValue

• TagValue string

TimeStamp

• TimeStamp string

UpdateApplicationRequest

• UpdateApplicationRequest object
  • configurationId required ApplicationId
  • description String
  • name String

UpdateApplicationResponse

• UpdateApplicationResponse object

orderString

• orderString string (values: ASC, DESC)