amazonka-discovery-1.4.5: Amazon Application Discovery Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Discovery

Contents

Description

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.

Synopsis

Service Configuration

discovery :: Service #

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 #

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 #

One or more parameters are not valid. Verify the parameters and try again.

InvalidParameterValueException

_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError #

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 #

The server experienced an internal error. Try again.

OperationNotPermittedException

_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError #

This operation is not permitted.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #

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 #

Instances

Bounded AgentStatus # 
Enum AgentStatus # 
Eq AgentStatus # 
Data AgentStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AgentStatus -> c AgentStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AgentStatus #

toConstr :: AgentStatus -> Constr #

dataTypeOf :: AgentStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AgentStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AgentStatus) #

gmapT :: (forall b. Data b => b -> b) -> AgentStatus -> AgentStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AgentStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AgentStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> AgentStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AgentStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AgentStatus -> m AgentStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentStatus -> m AgentStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentStatus -> m AgentStatus #

Ord AgentStatus # 
Read AgentStatus # 
Show AgentStatus # 
Generic AgentStatus # 

Associated Types

type Rep AgentStatus :: * -> * #

Hashable AgentStatus # 
FromJSON AgentStatus # 
NFData AgentStatus # 

Methods

rnf :: AgentStatus -> () #

ToQuery AgentStatus # 
ToHeader AgentStatus # 
ToByteString AgentStatus # 
FromText AgentStatus # 
ToText AgentStatus # 

Methods

toText :: AgentStatus -> Text #

type Rep AgentStatus # 
type Rep AgentStatus = D1 (MetaData "AgentStatus" "Network.AWS.Discovery.Types.Sum" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) ((:+:) ((:+:) (C1 (MetaCons "Blacklisted" PrefixI False) U1) ((:+:) (C1 (MetaCons "Healthy" PrefixI False) U1) (C1 (MetaCons "Running" PrefixI False) U1))) ((:+:) (C1 (MetaCons "Shutdown" PrefixI False) U1) ((:+:) (C1 (MetaCons "Unhealthy" PrefixI False) U1) (C1 (MetaCons "Unknown" PrefixI False) U1))))

ConfigurationItemType

data ConfigurationItemType #

Constructors

Connection 
Process 
Server 

Instances

Bounded ConfigurationItemType # 
Enum ConfigurationItemType # 
Eq ConfigurationItemType # 
Data ConfigurationItemType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConfigurationItemType -> c ConfigurationItemType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConfigurationItemType #

toConstr :: ConfigurationItemType -> Constr #

dataTypeOf :: ConfigurationItemType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConfigurationItemType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConfigurationItemType) #

gmapT :: (forall b. Data b => b -> b) -> ConfigurationItemType -> ConfigurationItemType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConfigurationItemType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConfigurationItemType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConfigurationItemType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConfigurationItemType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConfigurationItemType -> m ConfigurationItemType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfigurationItemType -> m ConfigurationItemType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfigurationItemType -> m ConfigurationItemType #

Ord ConfigurationItemType # 
Read ConfigurationItemType # 
Show ConfigurationItemType # 
Generic ConfigurationItemType # 
Hashable ConfigurationItemType # 
ToJSON ConfigurationItemType # 
FromJSON ConfigurationItemType # 
NFData ConfigurationItemType # 

Methods

rnf :: ConfigurationItemType -> () #

ToQuery ConfigurationItemType # 
ToHeader ConfigurationItemType # 
ToByteString ConfigurationItemType # 
FromText ConfigurationItemType # 
ToText ConfigurationItemType # 
type Rep ConfigurationItemType # 
type Rep ConfigurationItemType = D1 (MetaData "ConfigurationItemType" "Network.AWS.Discovery.Types.Sum" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) ((:+:) (C1 (MetaCons "Connection" PrefixI False) U1) ((:+:) (C1 (MetaCons "Process" PrefixI False) U1) (C1 (MetaCons "Server" PrefixI False) U1)))

ExportStatus

data ExportStatus #

Constructors

Failed 
InProgress 
Succeeded 

Instances

Bounded ExportStatus # 
Enum ExportStatus # 
Eq ExportStatus # 
Data ExportStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExportStatus -> c ExportStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExportStatus #

toConstr :: ExportStatus -> Constr #

dataTypeOf :: ExportStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExportStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExportStatus) #

gmapT :: (forall b. Data b => b -> b) -> ExportStatus -> ExportStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExportStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExportStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExportStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExportStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExportStatus -> m ExportStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportStatus -> m ExportStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportStatus -> m ExportStatus #

Ord ExportStatus # 
Read ExportStatus # 
Show ExportStatus # 
Generic ExportStatus # 

Associated Types

type Rep ExportStatus :: * -> * #

Hashable ExportStatus # 
FromJSON ExportStatus # 
NFData ExportStatus # 

Methods

rnf :: ExportStatus -> () #

ToQuery ExportStatus # 
ToHeader ExportStatus # 
ToByteString ExportStatus # 
FromText ExportStatus # 
ToText ExportStatus # 

Methods

toText :: ExportStatus -> Text #

type Rep ExportStatus # 
type Rep ExportStatus = D1 (MetaData "ExportStatus" "Network.AWS.Discovery.Types.Sum" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) ((:+:) (C1 (MetaCons "Failed" PrefixI False) U1) ((:+:) (C1 (MetaCons "InProgress" PrefixI False) U1) (C1 (MetaCons "Succeeded" PrefixI False) U1)))

AgentConfigurationStatus

data AgentConfigurationStatus #

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.

Instances

Eq AgentConfigurationStatus # 
Data AgentConfigurationStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AgentConfigurationStatus -> c AgentConfigurationStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AgentConfigurationStatus #

toConstr :: AgentConfigurationStatus -> Constr #

dataTypeOf :: AgentConfigurationStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AgentConfigurationStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AgentConfigurationStatus) #

gmapT :: (forall b. Data b => b -> b) -> AgentConfigurationStatus -> AgentConfigurationStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AgentConfigurationStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AgentConfigurationStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> AgentConfigurationStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AgentConfigurationStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AgentConfigurationStatus -> m AgentConfigurationStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentConfigurationStatus -> m AgentConfigurationStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentConfigurationStatus -> m AgentConfigurationStatus #

Read AgentConfigurationStatus # 
Show AgentConfigurationStatus # 
Generic AgentConfigurationStatus # 
Hashable AgentConfigurationStatus # 
FromJSON AgentConfigurationStatus # 
NFData AgentConfigurationStatus # 
type Rep AgentConfigurationStatus # 
type Rep AgentConfigurationStatus = D1 (MetaData "AgentConfigurationStatus" "Network.AWS.Discovery.Types.Product" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "AgentConfigurationStatus'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_acsAgentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_acsOperationSucceeded") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_acsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

agentConfigurationStatus :: AgentConfigurationStatus #

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 - The agent ID.
  • acsOperationSucceeded - 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 - A description of the operation performed.

acsOperationSucceeded :: Lens' AgentConfigurationStatus (Maybe Bool) #

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) #

A description of the operation performed.

AgentInfo

data 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.

Instances

Eq AgentInfo # 
Data AgentInfo # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AgentInfo -> c AgentInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AgentInfo #

toConstr :: AgentInfo -> Constr #

dataTypeOf :: AgentInfo -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AgentInfo) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AgentInfo) #

gmapT :: (forall b. Data b => b -> b) -> AgentInfo -> AgentInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AgentInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AgentInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> AgentInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AgentInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AgentInfo -> m AgentInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentInfo -> m AgentInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentInfo -> m AgentInfo #

Read AgentInfo # 
Show AgentInfo # 
Generic AgentInfo # 

Associated Types

type Rep AgentInfo :: * -> * #

Hashable AgentInfo # 
FromJSON AgentInfo # 
NFData AgentInfo # 

Methods

rnf :: AgentInfo -> () #

type Rep AgentInfo # 

agentInfo :: AgentInfo #

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) #

The name of the host where the agent resides. The host can be a server or virtual machine.

aiAgentNetworkInfoList :: Lens' AgentInfo [AgentNetworkInfo] #

Network details about the host where the agent resides.

aiConnectorId :: Lens' AgentInfo (Maybe Text) #

This data type is currently not valid.

aiHealth :: Lens' AgentInfo (Maybe AgentStatus) #

The health of the agent.

aiAgentId :: Lens' AgentInfo (Maybe Text) #

The agent ID.

aiVersion :: Lens' AgentInfo (Maybe Text) #

The agent version.

AgentNetworkInfo

data AgentNetworkInfo #

Network details about the host where the agent resides.

See: agentNetworkInfo smart constructor.

Instances

Eq AgentNetworkInfo # 
Data AgentNetworkInfo # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AgentNetworkInfo -> c AgentNetworkInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AgentNetworkInfo #

toConstr :: AgentNetworkInfo -> Constr #

dataTypeOf :: AgentNetworkInfo -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AgentNetworkInfo) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AgentNetworkInfo) #

gmapT :: (forall b. Data b => b -> b) -> AgentNetworkInfo -> AgentNetworkInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AgentNetworkInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AgentNetworkInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> AgentNetworkInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AgentNetworkInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AgentNetworkInfo -> m AgentNetworkInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentNetworkInfo -> m AgentNetworkInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentNetworkInfo -> m AgentNetworkInfo #

Read AgentNetworkInfo # 
Show AgentNetworkInfo # 
Generic AgentNetworkInfo # 
Hashable AgentNetworkInfo # 
FromJSON AgentNetworkInfo # 
NFData AgentNetworkInfo # 

Methods

rnf :: AgentNetworkInfo -> () #

type Rep AgentNetworkInfo # 
type Rep AgentNetworkInfo = D1 (MetaData "AgentNetworkInfo" "Network.AWS.Discovery.Types.Product" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "AgentNetworkInfo'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_aniIpAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aniMacAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

agentNetworkInfo :: AgentNetworkInfo #

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 - The IP address for the host where the agent resides.
  • aniMacAddress - The MAC address for the host where the agent resides.

aniIpAddress :: Lens' AgentNetworkInfo (Maybe Text) #

The IP address for the host where the agent resides.

aniMacAddress :: Lens' AgentNetworkInfo (Maybe Text) #

The MAC address for the host where the agent resides.

ConfigurationTag

data ConfigurationTag #

Tags for a configuration item. Tags are metadata that help you categorize IT assets.

See: configurationTag smart constructor.

Instances

Eq ConfigurationTag # 
Data ConfigurationTag # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConfigurationTag -> c ConfigurationTag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConfigurationTag #

toConstr :: ConfigurationTag -> Constr #

dataTypeOf :: ConfigurationTag -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConfigurationTag) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConfigurationTag) #

gmapT :: (forall b. Data b => b -> b) -> ConfigurationTag -> ConfigurationTag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConfigurationTag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConfigurationTag -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConfigurationTag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConfigurationTag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConfigurationTag -> m ConfigurationTag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfigurationTag -> m ConfigurationTag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfigurationTag -> m ConfigurationTag #

Read ConfigurationTag # 
Show ConfigurationTag # 
Generic ConfigurationTag # 
Hashable ConfigurationTag # 
FromJSON ConfigurationTag # 
NFData ConfigurationTag # 

Methods

rnf :: ConfigurationTag -> () #

type Rep ConfigurationTag # 
type Rep ConfigurationTag = D1 (MetaData "ConfigurationTag" "Network.AWS.Discovery.Types.Product" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "ConfigurationTag'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctTimeOfCreation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_ctConfigurationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ctConfigurationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ConfigurationItemType))) ((:*:) (S1 (MetaSel (Just Symbol "_ctValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ctKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

configurationTag :: ConfigurationTag #

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 - The time the configuration tag was created in Coordinated Universal Time (UTC).
  • ctConfigurationId - The configuration ID for the item you want to tag. You can specify a list of keys and values.
  • ctConfigurationType - A type of IT asset that you want to tag.
  • ctValue - A value to filter on. For example key = serverType and value = web server .
  • ctKey - A type of tag to filter on. For example, serverType .

ctTimeOfCreation :: Lens' ConfigurationTag (Maybe UTCTime) #

The time the configuration tag was created in Coordinated Universal Time (UTC).

ctConfigurationId :: Lens' ConfigurationTag (Maybe Text) #

The configuration ID for the item you want to tag. You can specify a list of keys and values.

ctConfigurationType :: Lens' ConfigurationTag (Maybe ConfigurationItemType) #

A type of IT asset that you want to tag.

ctValue :: Lens' ConfigurationTag (Maybe Text) #

A value to filter on. For example key = serverType and value = web server .

ctKey :: Lens' ConfigurationTag (Maybe Text) #

A type of tag to filter on. For example, serverType .

ExportInfo

data ExportInfo #

Information regarding the export status of the discovered data. The value is an array of objects.

See: exportInfo smart constructor.

Instances

Eq ExportInfo # 
Data ExportInfo # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExportInfo -> c ExportInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExportInfo #

toConstr :: ExportInfo -> Constr #

dataTypeOf :: ExportInfo -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExportInfo) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExportInfo) #

gmapT :: (forall b. Data b => b -> b) -> ExportInfo -> ExportInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExportInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExportInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExportInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExportInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExportInfo -> m ExportInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportInfo -> m ExportInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportInfo -> m ExportInfo #

Read ExportInfo # 
Show ExportInfo # 
Generic ExportInfo # 

Associated Types

type Rep ExportInfo :: * -> * #

Hashable ExportInfo # 
FromJSON ExportInfo # 
NFData ExportInfo # 

Methods

rnf :: ExportInfo -> () #

type Rep ExportInfo # 
type Rep ExportInfo = D1 (MetaData "ExportInfo" "Network.AWS.Discovery.Types.Product" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "ExportInfo'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eiConfigurationsDownloadURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_eiExportId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_eiExportStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ExportStatus)) ((:*:) (S1 (MetaSel (Just Symbol "_eiStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_eiExportRequestTime") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 POSIX))))))

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 - A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.
  • eiExportId - A unique identifier that you can use to query the export.
  • eiExportStatus - The status of the configuration data export. The status can succeed, fail, or be in-progress.
  • eiStatusMessage - Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.
  • eiExportRequestTime - The time the configuration data export was initiated.

eiConfigurationsDownloadURL :: Lens' ExportInfo (Maybe Text) #

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 #

A unique identifier that you can use to query the export.

eiExportStatus :: Lens' ExportInfo ExportStatus #

The status of the configuration data export. The status can succeed, fail, or be in-progress.

eiStatusMessage :: Lens' ExportInfo Text #

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 #

The time the configuration data export was initiated.

Filter

data Filter #

A filter that can use conditional operators.

See: filter' smart constructor.

Instances

Eq Filter # 

Methods

(==) :: Filter -> Filter -> Bool #

(/=) :: Filter -> Filter -> Bool #

Data Filter # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Filter -> c Filter #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Filter #

toConstr :: Filter -> Constr #

dataTypeOf :: Filter -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Filter) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Filter) #

gmapT :: (forall b. Data b => b -> b) -> Filter -> Filter #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r #

gmapQ :: (forall d. Data d => d -> u) -> Filter -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Filter -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Filter -> m Filter #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter #

Read Filter # 
Show Filter # 
Generic Filter # 

Associated Types

type Rep Filter :: * -> * #

Methods

from :: Filter -> Rep Filter x #

to :: Rep Filter x -> Filter #

Hashable Filter # 

Methods

hashWithSalt :: Int -> Filter -> Int #

hash :: Filter -> Int #

ToJSON Filter # 
NFData Filter # 

Methods

rnf :: Filter -> () #

type Rep Filter # 
type Rep Filter = D1 (MetaData "Filter" "Network.AWS.Discovery.Types.Product" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "Filter'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_fName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_fValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])) (S1 (MetaSel (Just Symbol "_fCondition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

filter' #

Arguments

:: Text

fName

-> Text

fCondition

-> Filter 

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 - 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 - 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 - 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.

fName :: Lens' Filter Text #

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] #

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 #

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

data Tag #

Metadata that help you categorize IT assets.

See: tag smart constructor.

Instances

Eq Tag # 

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Data Tag # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag #

toConstr :: Tag -> Constr #

dataTypeOf :: Tag -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Tag) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) #

gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r #

gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

Read Tag # 
Show Tag # 

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag # 

Associated Types

type Rep Tag :: * -> * #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Hashable Tag # 

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

ToJSON Tag # 
NFData Tag # 

Methods

rnf :: Tag -> () #

type Rep Tag # 
type Rep Tag = D1 (MetaData "Tag" "Network.AWS.Discovery.Types.Product" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "Tag'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

tag #

Arguments

:: Text

tagKey

-> Text

tagValue

-> Tag 

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • tagKey - A type of tag to filter on.
  • tagValue - A value for a tag key to filter on.

tagKey :: Lens' Tag Text #

A type of tag to filter on.

tagValue :: Lens' Tag Text #

A value for a tag key to filter on.

TagFilter

data TagFilter #

The name of a tag filter. Valid names are: tagKey , tagValue , configurationId .

See: tagFilter smart constructor.

Instances

Eq TagFilter # 
Data TagFilter # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TagFilter -> c TagFilter #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TagFilter #

toConstr :: TagFilter -> Constr #

dataTypeOf :: TagFilter -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TagFilter) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TagFilter) #

gmapT :: (forall b. Data b => b -> b) -> TagFilter -> TagFilter #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TagFilter -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TagFilter -> r #

gmapQ :: (forall d. Data d => d -> u) -> TagFilter -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TagFilter -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TagFilter -> m TagFilter #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TagFilter -> m TagFilter #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TagFilter -> m TagFilter #

Read TagFilter # 
Show TagFilter # 
Generic TagFilter # 

Associated Types

type Rep TagFilter :: * -> * #

Hashable TagFilter # 
ToJSON TagFilter # 
NFData TagFilter # 

Methods

rnf :: TagFilter -> () #

type Rep TagFilter # 
type Rep TagFilter = D1 (MetaData "TagFilter" "Network.AWS.Discovery.Types.Product" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "TagFilter'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_tfName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_tfValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text]))))

tagFilter #

Arguments

:: Text

tfName

-> TagFilter 

Creates a value of TagFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tfName :: Lens' TagFilter Text #

A name of a tag filter.

tfValues :: Lens' TagFilter [Text] #

Values of a tag filter.