Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
The AWS Application Discovery Service helps Systems Integrators quickly and reliably plan application migration projects by automatically identifying applications running in on-premises data centers, their associated dependencies, and their performance profile.
Planning data center migrations can involve thousands of workloads that are often deeply interdependent. Application discovery and dependency mapping are important early first steps in the migration process, but difficult to perform at scale due to the lack of automated tools.
The AWS Application Discovery Service automatically collects configuration and usage data from servers to develop a list of applications, how they perform, and how they are interdependent. This information is securely retained in an AWS Application Discovery Service database which you can export as a CSV file into your preferred visualization tool or cloud migration solution to help reduce the complexity and time in planning your cloud migration.
The Application Discovery Service is currently available for preview. Only customers who are engaged with AWS Professional Services or a certified AWS partner can use the service. To see the list of certified partners and request access to the Application Discovery Service, complete the following preview form.
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the 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 Discovery Service User Guide.
The following are short descriptions of each API action, organized by function.
Managing AWS Agents Using the Application Discovery Service
An AWS agent is software that you install on on-premises servers and virtual machines that are targeted for discovery and migration. Agents run on Linux and Windows Server and collect server configuration and activity information about your applications and infrastructure. Specifically, agents collect the following information and send it to the Application Discovery Service using Secure Sockets Layer (SSL) encryption:
- User information (user name, home directory)
- Group information (name)
- List of installed packages
- List of kernel modules
- All create and stop process events
- DNS queries
- NIC information
- TCP/UDP process listening ports
- TCPV4/V6 connections
- Operating system information
- System performance
- Process performance
The Application Discovery Service API includes the following actions to manage AWS agents:
- StartDataCollectionByAgentIds: Instructs the specified agents to start collecting data. The Application Discovery Service takes several minutes to receive and process data after you initiate data collection.
- StopDataCollectionByAgentIds: Instructs the specified agents to stop collecting data.
- DescribeAgents: Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID. The output includes agent IDs, IP addresses, media access control (MAC) addresses, agent health, host name where the agent resides, and the version number of each agent.
Querying Configuration Items
A configuration item is an IT asset that was discovered in your data center by an AWS agent. When you use the Application Discovery Service, you can specify filters and query specific configuration items. The service supports Server, Process, and Connection configuration items. This means you can specify a value for the following keys and query your IT assets:
Server
- server.HostName
- server.osName
- server.osVersion
- server.configurationId
- server.agentId
Process
- process.name
- process.CommandLine
- process.configurationId
- server.hostName
- server.osName
- server.osVersion
- server.configurationId
- server.agentId
Connection
- connection.sourceIp
- connection.sourcePort
- connection.destinationIp
- connection.destinationPort
- sourceProcess.configurationId
- sourceProcess.commandLine
- sourceProcess.name
- destinationProcessId.configurationId
- destinationProcess.commandLine
- destinationProcess.name
- sourceServer.configurationId
- sourceServer.hostName
- sourceServer.osName
- sourceServer.osVersion
- destinationServer.configurationId
- destinationServer.hostName
- destinationServer.osName
- destinationServer.osVersion
The Application Discovery Service includes the following actions for querying configuration items.
- DescribeConfigurations: Retrieves a list of attributes for a specific configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
- ListConfigurations: Retrieves a list of configuration items according to the criteria you specify in a filter. The filter criteria identify relationship requirements. For example, you can specify filter criteria of process.name with values of nginx and apache.
Tagging Discovered Configuration Items
You can tag discovered configuration items. Tags are metadata that help you categorize IT assets in your data center. Tags use a key-value format. For example, '{"key": "serverType", "value": "webServer"}'.
- CreateTags: Creates one or more tags for a configuration items.
- DescribeTags: Retrieves a list of configuration items that are tagged with a specific tag. Or, retrieves a list of all tags assigned to a specific configuration item.
- DeleteTags: Deletes the association between a configuration item and one or more tags.
Exporting Data
You can export data as a CSV file to an Amazon S3 bucket or into your preferred visualization tool or cloud migration solution to help reduce the complexity and time in planning your cloud migration.
- ExportConfigurations: Exports all discovered configuration data to an Amazon S3 bucket. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID which you can query using the GetExportStatus API.
- DescribeExportConfigurations: Gets the status of the data export. When the export is complete, the service returns an Amazon S3 URL where you can download CSV files that include the data.
- discovery :: Service
- _AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServerInternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Discovery.DescribeTags
- module Network.AWS.Discovery.ExportConfigurations
- module Network.AWS.Discovery.StopDataCollectionByAgentIds
- module Network.AWS.Discovery.CreateTags
- module Network.AWS.Discovery.DeleteTags
- module Network.AWS.Discovery.DescribeConfigurations
- module Network.AWS.Discovery.ListConfigurations
- module Network.AWS.Discovery.DescribeAgents
- module Network.AWS.Discovery.DescribeExportConfigurations
- module Network.AWS.Discovery.StartDataCollectionByAgentIds
- data AgentStatus
- data ConfigurationItemType
- = Connection
- | Process
- | Server
- data ExportStatus
- data AgentConfigurationStatus
- agentConfigurationStatus :: AgentConfigurationStatus
- acsAgentId :: Lens' AgentConfigurationStatus (Maybe Text)
- acsOperationSucceeded :: Lens' AgentConfigurationStatus (Maybe Bool)
- acsDescription :: Lens' AgentConfigurationStatus (Maybe Text)
- data AgentInfo
- agentInfo :: AgentInfo
- aiHostName :: Lens' AgentInfo (Maybe Text)
- aiAgentNetworkInfoList :: Lens' AgentInfo [AgentNetworkInfo]
- aiConnectorId :: Lens' AgentInfo (Maybe Text)
- aiHealth :: Lens' AgentInfo (Maybe AgentStatus)
- aiAgentId :: Lens' AgentInfo (Maybe Text)
- aiVersion :: Lens' AgentInfo (Maybe Text)
- data AgentNetworkInfo
- agentNetworkInfo :: AgentNetworkInfo
- aniIpAddress :: Lens' AgentNetworkInfo (Maybe Text)
- aniMacAddress :: Lens' AgentNetworkInfo (Maybe Text)
- data ConfigurationTag
- configurationTag :: ConfigurationTag
- ctTimeOfCreation :: Lens' ConfigurationTag (Maybe UTCTime)
- ctConfigurationId :: Lens' ConfigurationTag (Maybe Text)
- ctConfigurationType :: Lens' ConfigurationTag (Maybe ConfigurationItemType)
- ctValue :: Lens' ConfigurationTag (Maybe Text)
- ctKey :: Lens' ConfigurationTag (Maybe Text)
- data ExportInfo
- exportInfo :: Text -> ExportStatus -> Text -> UTCTime -> ExportInfo
- eiConfigurationsDownloadURL :: Lens' ExportInfo (Maybe Text)
- eiExportId :: Lens' ExportInfo Text
- eiExportStatus :: Lens' ExportInfo ExportStatus
- eiStatusMessage :: Lens' ExportInfo Text
- eiExportRequestTime :: Lens' ExportInfo UTCTime
- data Filter
- filter' :: Text -> Text -> Filter
- fName :: Lens' Filter Text
- fValues :: Lens' Filter [Text]
- fCondition :: Lens' Filter Text
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data TagFilter
- tagFilter :: Text -> TagFilter
- tfName :: Lens' TagFilter Text
- tfValues :: Lens' TagFilter [Text]
Service Configuration
API version '2015-11-01' of the Amazon Application Discovery Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Discovery
.
AuthorizationErrorException
_AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException
_ServerInternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The server experienced an internal error. Try again.
OperationNotPermittedException
_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This operation is not permitted.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified configuration ID was not located. Verify the configuration ID and try again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeTags
ExportConfigurations
StopDataCollectionByAgentIds
CreateTags
DeleteTags
DescribeConfigurations
ListConfigurations
DescribeAgents
DescribeExportConfigurations
StartDataCollectionByAgentIds
Types
AgentStatus
data AgentStatus Source #
ConfigurationItemType
data ConfigurationItemType Source #
ExportStatus
data ExportStatus Source #
AgentConfigurationStatus
data AgentConfigurationStatus Source #
Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation, and whether or not the agent configuration was updated.
See: agentConfigurationStatus
smart constructor.
agentConfigurationStatus :: AgentConfigurationStatus Source #
Creates a value of AgentConfigurationStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acsAgentId :: Lens' AgentConfigurationStatus (Maybe Text) Source #
The agent ID.
acsOperationSucceeded :: Lens' AgentConfigurationStatus (Maybe Bool) Source #
Information about the status of the StartDataCollection
and StopDataCollection
operations. The system has recorded the data collection operation. The agent receives this command the next time it polls for a new command.
acsDescription :: Lens' AgentConfigurationStatus (Maybe Text) Source #
A description of the operation performed.
AgentInfo
Information about agents associated with the user’s AWS account. Information includes agent IDs, IP addresses, media access control (MAC) addresses, agent health, hostname where the agent resides, and agent version for each agent.
See: agentInfo
smart constructor.
agentInfo :: AgentInfo Source #
Creates a value of AgentInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aiHostName :: Lens' AgentInfo (Maybe Text) Source #
The name of the host where the agent resides. The host can be a server or virtual machine.
aiAgentNetworkInfoList :: Lens' AgentInfo [AgentNetworkInfo] Source #
Network details about the host where the agent resides.
AgentNetworkInfo
data AgentNetworkInfo Source #
Network details about the host where the agent resides.
See: agentNetworkInfo
smart constructor.
agentNetworkInfo :: AgentNetworkInfo Source #
Creates a value of AgentNetworkInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aniIpAddress :: Lens' AgentNetworkInfo (Maybe Text) Source #
The IP address for the host where the agent resides.
aniMacAddress :: Lens' AgentNetworkInfo (Maybe Text) Source #
The MAC address for the host where the agent resides.
ConfigurationTag
data ConfigurationTag Source #
Tags for a configuration item. Tags are metadata that help you categorize IT assets.
See: configurationTag
smart constructor.
configurationTag :: ConfigurationTag Source #
Creates a value of ConfigurationTag
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ctTimeOfCreation :: Lens' ConfigurationTag (Maybe UTCTime) Source #
The time the configuration tag was created in Coordinated Universal Time (UTC).
ctConfigurationId :: Lens' ConfigurationTag (Maybe Text) Source #
The configuration ID for the item you want to tag. You can specify a list of keys and values.
ctConfigurationType :: Lens' ConfigurationTag (Maybe ConfigurationItemType) Source #
A type of IT asset that you want to tag.
ctValue :: Lens' ConfigurationTag (Maybe Text) Source #
A value to filter on. For example key = serverType and value = web server.
ctKey :: Lens' ConfigurationTag (Maybe Text) Source #
A type of tag to filter on. For example, serverType.
ExportInfo
data ExportInfo Source #
Information regarding the export status of the discovered data. The value is an array of objects.
See: exportInfo
smart constructor.
:: Text | |
-> ExportStatus | |
-> Text | |
-> UTCTime | |
-> ExportInfo |
Creates a value of ExportInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eiConfigurationsDownloadURL :: Lens' ExportInfo (Maybe Text) Source #
A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.
eiExportId :: Lens' ExportInfo Text Source #
A unique identifier that you can use to query the export.
eiExportStatus :: Lens' ExportInfo ExportStatus Source #
The status of the configuration data export. The status can succeed, fail, or be in-progress.
eiStatusMessage :: Lens' ExportInfo Text Source #
Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.
eiExportRequestTime :: Lens' ExportInfo UTCTime Source #
The time the configuration data export was initiated.
Filter
A filter that can use conditional operators.
See: filter'
smart constructor.
Creates a value of Filter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fName :: Lens' Filter Text Source #
The name of the filter. The following filter names are allowed for SERVER
configuration items.
Server
- 'server.hostName'
- 'server.osName'
- 'server.osVersion'
- 'server.configurationid'
- 'server.agentid'
The name of the filter. The following filter names are allowed for PROCESS
configuration items.
Process
- 'process.configurationid'
- 'process.name'
- 'process.commandLine'
- 'server.configurationid'
- 'server.hostName'
- 'server.osName'
- 'server.osVersion'
- 'server.agentId'
The name of the filter. The following filter names are allowed for CONNECTION
configuration items.
Connection
- 'connection.sourceIp'
- 'connection.destinationIp'
- 'connection.destinationPort'
- 'sourceProcess.configurationId'
- 'sourceProcess.name'
- 'sourceProcess.commandLine'
- 'destinationProcess.configurationId'
- 'destinationProcess.name'
- 'destinationProcess.commandLine'
- 'sourceServer.configurationId'
- 'sourceServer.hostName'
- 'sourceServer.osName'
- 'sourceServer.osVersion'
- 'sourceServer.agentId'
- 'destinationServer.configurationId'
- 'destinationServer.hostName'
- 'destinationServer.osName'
- 'destinationServer.osVersion'
- 'destinationServer.agentId'
fValues :: Lens' Filter [Text] Source #
A string value that you want to filter on. For example, if you choose the 'destinationServer.osVersion' filter name, you could specify Ubuntu
for the value.
fCondition :: Lens' Filter Text Source #
A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.
Tag
Metadata that help you categorize IT assets.
See: tag
smart constructor.