| Copyright | (c) 2013-2017 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Discovery.Types
Contents
Description
- 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
- data AgentStatus
- data ConfigurationItemType
- data ExportDataFormat
- data ExportStatus
- data OrderString
- 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)
- aiLastHealthPingTime :: 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)
- aiCollectionStatus :: Lens' AgentInfo (Maybe Text)
- aiRegisteredTime :: Lens' AgentInfo (Maybe Text)
- aiAgentType :: 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 CustomerAgentInfo
- customerAgentInfo :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> CustomerAgentInfo
- caiActiveAgents :: Lens' CustomerAgentInfo Int
- caiHealthyAgents :: Lens' CustomerAgentInfo Int
- caiBlackListedAgents :: Lens' CustomerAgentInfo Int
- caiShutdownAgents :: Lens' CustomerAgentInfo Int
- caiUnhealthyAgents :: Lens' CustomerAgentInfo Int
- caiTotalAgents :: Lens' CustomerAgentInfo Int
- caiUnknownAgents :: Lens' CustomerAgentInfo Int
- data CustomerConnectorInfo
- customerConnectorInfo :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> CustomerConnectorInfo
- cciActiveConnectors :: Lens' CustomerConnectorInfo Int
- cciHealthyConnectors :: Lens' CustomerConnectorInfo Int
- cciBlackListedConnectors :: Lens' CustomerConnectorInfo Int
- cciShutdownConnectors :: Lens' CustomerConnectorInfo Int
- cciUnhealthyConnectors :: Lens' CustomerConnectorInfo Int
- cciTotalConnectors :: Lens' CustomerConnectorInfo Int
- cciUnknownConnectors :: Lens' CustomerConnectorInfo Int
- data ExportFilter
- exportFilter :: Text -> Text -> ExportFilter
- efName :: Lens' ExportFilter Text
- efValues :: Lens' ExportFilter [Text]
- efCondition :: Lens' ExportFilter Text
- data ExportInfo
- exportInfo :: Text -> ExportStatus -> Text -> UTCTime -> ExportInfo
- eiConfigurationsDownloadURL :: Lens' ExportInfo (Maybe Text)
- eiRequestedStartTime :: Lens' ExportInfo (Maybe UTCTime)
- eiRequestedEndTime :: Lens' ExportInfo (Maybe UTCTime)
- eiIsTruncated :: Lens' ExportInfo (Maybe Bool)
- 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 NeighborConnectionDetail
- neighborConnectionDetail :: Text -> Text -> Integer -> NeighborConnectionDetail
- ncdTransportProtocol :: Lens' NeighborConnectionDetail (Maybe Text)
- ncdDestinationPort :: Lens' NeighborConnectionDetail (Maybe Int)
- ncdSourceServerId :: Lens' NeighborConnectionDetail Text
- ncdDestinationServerId :: Lens' NeighborConnectionDetail Text
- ncdConnectionsCount :: Lens' NeighborConnectionDetail Integer
- data OrderByElement
- orderByElement :: Text -> OrderByElement
- obeSortOrder :: Lens' OrderByElement (Maybe OrderString)
- obeFieldName :: Lens' OrderByElement 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
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameters are not valid. Verify the parameters and try again.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The server experienced an internal error. Try again.
_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This operation is not permitted.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified configuration ID was not located. Verify the configuration ID and try again.
AgentStatus
data AgentStatus Source #
Instances
ConfigurationItemType
data ConfigurationItemType Source #
Constructors
| Application | |
| Connection | |
| Process | |
| Server |
Instances
ExportDataFormat
data ExportDataFormat Source #
Instances
ExportStatus
data ExportStatus Source #
Constructors
| Failed | |
| InProgress | |
| Succeeded |
Instances
OrderString
data OrderString Source #
Instances
AgentConfigurationStatus
data AgentConfigurationStatus Source #
Information about agents or connectors that were instructed to start collecting data. Information includes the agentconnector ID, a description of the operation, and whether the agentconnector configuration was updated.
See: agentConfigurationStatus smart constructor.
Instances
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- The agent/connector ID.acsOperationSucceeded- Information about the status of theStartDataCollectionandStopDataCollectionoperations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command.acsDescription- A description of the operation performed.
acsAgentId :: Lens' AgentConfigurationStatus (Maybe Text) Source #
The agent/connector 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/connector 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 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.
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- The name of the host where the agent or connector resides. The host can be a server or virtual machine.aiLastHealthPingTime- Time since agent or connector health was reported.aiAgentNetworkInfoList- Network details about the host where the agent or connector resides.aiConnectorId- The ID of the connector.aiHealth- The health of the agent or connector.aiAgentId- The agent or connector ID.aiVersion- The agent or connector version.aiCollectionStatus- Status of the collection process for an agent or connector.aiRegisteredTime- Agent's first registration timestamp in UTC.aiAgentType- Type of agent.
aiHostName :: Lens' AgentInfo (Maybe Text) Source #
The name of the host where the agent or connector resides. The host can be a server or virtual machine.
aiLastHealthPingTime :: Lens' AgentInfo (Maybe Text) Source #
Time since agent or connector health was reported.
aiAgentNetworkInfoList :: Lens' AgentInfo [AgentNetworkInfo] Source #
Network details about the host where the agent or connector resides.
aiCollectionStatus :: Lens' AgentInfo (Maybe Text) Source #
Status of the collection process for an agent or connector.
aiRegisteredTime :: Lens' AgentInfo (Maybe Text) Source #
Agent's first registration timestamp in UTC.
AgentNetworkInfo
data AgentNetworkInfo Source #
Network details about the host where the agent/connector resides.
See: agentNetworkInfo smart constructor.
Instances
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- The IP address for the host where the agent/connector resides.aniMacAddress- The MAC address for the host where the agent/connector resides.
aniIpAddress :: Lens' AgentNetworkInfo (Maybe Text) Source #
The IP address for the host where the agent/connector resides.
aniMacAddress :: Lens' AgentNetworkInfo (Maybe Text) Source #
The MAC address for the host where the agent/connector resides.
ConfigurationTag
data ConfigurationTag Source #
Tags for a configuration item. Tags are metadata that help you categorize IT assets.
See: configurationTag smart constructor.
Instances
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- The time the configuration tag was created in Coordinated Universal Time (UTC).ctConfigurationId- The configuration ID for the item to tag. You can specify a list of keys and values.ctConfigurationType- A type of IT asset to tag.ctValue- A value on which to filter. For example key = serverType and value = web server .ctKey- A type of tag on which to filter. For example, serverType .
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 to tag. You can specify a list of keys and values.
ctConfigurationType :: Lens' ConfigurationTag (Maybe ConfigurationItemType) Source #
A type of IT asset to tag.
ctValue :: Lens' ConfigurationTag (Maybe Text) Source #
A value on which to filter. For example key = serverType and value = web server .
ctKey :: Lens' ConfigurationTag (Maybe Text) Source #
A type of tag on which to filter. For example, serverType .
CustomerAgentInfo
data CustomerAgentInfo Source #
Inventory data for installed discovery agents.
See: customerAgentInfo smart constructor.
Instances
Creates a value of CustomerAgentInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
caiActiveAgents- Number of active discovery agents.caiHealthyAgents- Number of healthy discovery agentscaiBlackListedAgents- Number of blacklisted discovery agents.caiShutdownAgents- Number of discovery agents with status SHUTDOWN.caiUnhealthyAgents- Number of unhealthy discovery agents.caiTotalAgents- Total number of discovery agents.caiUnknownAgents- Number of unknown discovery agents.
caiActiveAgents :: Lens' CustomerAgentInfo Int Source #
Number of active discovery agents.
caiHealthyAgents :: Lens' CustomerAgentInfo Int Source #
Number of healthy discovery agents
caiBlackListedAgents :: Lens' CustomerAgentInfo Int Source #
Number of blacklisted discovery agents.
caiShutdownAgents :: Lens' CustomerAgentInfo Int Source #
Number of discovery agents with status SHUTDOWN.
caiUnhealthyAgents :: Lens' CustomerAgentInfo Int Source #
Number of unhealthy discovery agents.
caiTotalAgents :: Lens' CustomerAgentInfo Int Source #
Total number of discovery agents.
caiUnknownAgents :: Lens' CustomerAgentInfo Int Source #
Number of unknown discovery agents.
CustomerConnectorInfo
data CustomerConnectorInfo Source #
Inventory data for installed discovery connectors.
See: customerConnectorInfo smart constructor.
Instances
customerConnectorInfo Source #
Creates a value of CustomerConnectorInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cciActiveConnectors- Number of active discovery connectors.cciHealthyConnectors- Number of healthy discovery connectors.cciBlackListedConnectors- Number of blacklisted discovery connectors.cciShutdownConnectors- Number of discovery connectors with status SHUTDOWN,cciUnhealthyConnectors- Number of unhealthy discovery connectors.cciTotalConnectors- Total number of discovery connectors.cciUnknownConnectors- Number of unknown discovery connectors.
cciActiveConnectors :: Lens' CustomerConnectorInfo Int Source #
Number of active discovery connectors.
cciHealthyConnectors :: Lens' CustomerConnectorInfo Int Source #
Number of healthy discovery connectors.
cciBlackListedConnectors :: Lens' CustomerConnectorInfo Int Source #
Number of blacklisted discovery connectors.
cciShutdownConnectors :: Lens' CustomerConnectorInfo Int Source #
Number of discovery connectors with status SHUTDOWN,
cciUnhealthyConnectors :: Lens' CustomerConnectorInfo Int Source #
Number of unhealthy discovery connectors.
cciTotalConnectors :: Lens' CustomerConnectorInfo Int Source #
Total number of discovery connectors.
cciUnknownConnectors :: Lens' CustomerConnectorInfo Int Source #
Number of unknown discovery connectors.
ExportFilter
data ExportFilter Source #
Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
See: exportFilter smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> ExportFilter |
Creates a value of ExportFilter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
efName- A singleExportFiltername. Supported filters:agentId.efValues- A singleagentIdfor a Discovery Agent. AnagentIdcan be found using the DescribeAgents action. Typically an ADSagentIdis in the formo-0123456789abcdef0.efCondition- Supported condition:EQUALS
efValues :: Lens' ExportFilter [Text] Source #
A single agentId for a Discovery Agent. An agentId can be found using the DescribeAgents action. Typically an ADS agentId is in the form o-0123456789abcdef0 .
efCondition :: Lens' ExportFilter Text Source #
Supported condition: EQUALS
ExportInfo
data ExportInfo Source #
Information regarding the export status of discovered data. The value is an array of objects.
See: exportInfo smart constructor.
Instances
Arguments
| :: 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- A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.eiRequestedStartTime- The value ofstartTimeparameter in theStartExportTaskrequest. If nostartTimewas requested, this result does not appear inExportInfo.eiRequestedEndTime- TheendTimeused in theStartExportTaskrequest. If noendTimewas requested, this result does not appear inExportInfo.eiIsTruncated- If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by usingstartDateandendDate.eiExportId- A unique identifier used to query an export.eiExportStatus- The status of the data export job.eiStatusMessage- A status message provided for API callers.eiExportRequestTime- The time that the data export was initiated.
eiConfigurationsDownloadURL :: Lens' ExportInfo (Maybe Text) Source #
A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
eiRequestedStartTime :: Lens' ExportInfo (Maybe UTCTime) Source #
The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo .
eiRequestedEndTime :: Lens' ExportInfo (Maybe UTCTime) Source #
The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo .
eiIsTruncated :: Lens' ExportInfo (Maybe Bool) Source #
If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate .
eiExportId :: Lens' ExportInfo Text Source #
A unique identifier used to query an export.
eiExportStatus :: Lens' ExportInfo ExportStatus Source #
The status of the data export job.
eiStatusMessage :: Lens' ExportInfo Text Source #
A status message provided for API callers.
eiExportRequestTime :: Lens' ExportInfo UTCTime Source #
The time that the data export was initiated.
Filter
A filter that can use conditional operators.
For more information about filters, see Querying Discovered Configuration Items .
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- The name of the filter.fValues- A string value on which to filter. For example, if you choose thedestinationServer.osVersionfilter name, you could specifyUbuntufor 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.
fValues :: Lens' Filter [Text] Source #
A string value on which to filter. 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.
NeighborConnectionDetail
data NeighborConnectionDetail Source #
Details about neighboring servers.
See: neighborConnectionDetail smart constructor.
Instances
neighborConnectionDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> Integer | |
| -> NeighborConnectionDetail |
Creates a value of NeighborConnectionDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncdTransportProtocol- The network protocol used for the connection.ncdDestinationPort- The destination network port for the connection.ncdSourceServerId- The ID of the server that opened the network connection.ncdDestinationServerId- The ID of the server that accepted the network connection.ncdConnectionsCount- The number of open network connections with the neighboring server.
ncdTransportProtocol :: Lens' NeighborConnectionDetail (Maybe Text) Source #
The network protocol used for the connection.
ncdDestinationPort :: Lens' NeighborConnectionDetail (Maybe Int) Source #
The destination network port for the connection.
ncdSourceServerId :: Lens' NeighborConnectionDetail Text Source #
The ID of the server that opened the network connection.
ncdDestinationServerId :: Lens' NeighborConnectionDetail Text Source #
The ID of the server that accepted the network connection.
ncdConnectionsCount :: Lens' NeighborConnectionDetail Integer Source #
The number of open network connections with the neighboring server.
OrderByElement
data OrderByElement Source #
A field and direction for ordered output.
See: orderByElement smart constructor.
Arguments
| :: Text | |
| -> OrderByElement |
Creates a value of OrderByElement with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
obeSortOrder- Ordering direction.obeFieldName- The field on which to order.
obeSortOrder :: Lens' OrderByElement (Maybe OrderString) Source #
Ordering direction.
obeFieldName :: Lens' OrderByElement Text Source #
The field on which to order.
Tag
Metadata that help you categorize IT assets.
See: tag smart constructor.
TagFilter
The tag filter. Valid names are: tagKey , tagValue , configurationId .
See: tagFilter smart constructor.