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 |
- 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
- = 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
_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 #
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
- The agent ID.acsOperationSucceeded
- Information about the status of theStartDataCollection
andStopDataCollection
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.
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
- The name of the host where the agent resides. The host can be a server or virtual machine.aiAgentNetworkInfoList
- Network details about the host where the agent resides.aiConnectorId
- This data type is currently not valid.aiHealth
- The health of the agent.aiAgentId
- The agent ID.aiVersion
- The agent version.
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
- 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) 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
- 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) 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
- 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) 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
- The name of the filter. The following filter names are allowed forSERVER
configuration items. Server *server.hostName
*server.osName
*server.osVersion
*server.configurationid
*server.agentid
The name of the filter. The following filter names are allowed forPROCESS
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 forCONNECTION
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 thedestinationServer.osVersion
filter name, you could specifyUbuntu
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 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.
TagFilter
The name of a tag filter. Valid names are: tagKey
, tagValue
, configurationId
.
See: tagFilter
smart constructor.