| Copyright | (c) 2013-2021 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 |
Amazonka.Discovery
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- DescribeTags (Paginated)
- DescribeContinuousExports (Paginated)
- StopDataCollectionByAgentIds
- CreateTags
- BatchDeleteImportData
- DeleteTags
- StartImportTask
- DeleteApplications
- UpdateApplication
- DescribeConfigurations
- DescribeImportTasks
- CreateApplication
- ListConfigurations (Paginated)
- StartContinuousExport
- DescribeAgents (Paginated)
- DescribeExportTasks (Paginated)
- StartDataCollectionByAgentIds
- GetDiscoverySummary
- DisassociateConfigurationItemsFromApplication
- AssociateConfigurationItemsToApplication
- ListServerNeighbors
- StopContinuousExport
- StartExportTask
- Types
- AgentStatus
- BatchDeleteImportDataErrorCode
- ConfigurationItemType
- ContinuousExportStatus
- DataSource
- ExportDataFormat
- ExportStatus
- ImportStatus
- ImportTaskFilterName
- OrderString
- AgentConfigurationStatus
- AgentInfo
- AgentNetworkInfo
- BatchDeleteImportDataError
- ConfigurationTag
- ContinuousExportDescription
- CustomerAgentInfo
- CustomerConnectorInfo
- ExportFilter
- ExportInfo
- Filter
- ImportTask
- ImportTaskFilter
- NeighborConnectionDetail
- OrderByElement
- Tag
- TagFilter
Description
Derived from API version 2015-11-01 of the AWS service descriptions, licensed under Apache 2.0.
AWS Application Discovery Service
AWS Application Discovery Service helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the AWS Application Discovery Service FAQ. Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:
Agentless discovery is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. It does not work in non-VMware environments.
- Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment.
- Agentless discovery doesn't collect information about network dependencies, only agent-based discovery collects that information.
Agent-based discovery collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center.
- The agent captures infrastructure and application information, including an inventory of running processes, system performance information, resource utilization, and network dependencies.
- The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.
AWS Partner Network (APN) solutions integrate with Application Discovery Service, enabling you to import details of your on-premises environment directly into Migration Hub without using the discovery connector or discovery agent.
- Third-party application discovery tools can query AWS Application Discovery Service, and they can write to the Application Discovery Service database using the public API.
- In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.
Recommendations
We recommend that you use agent-based discovery for non-VMware environments, and whenever you want to collect information about network dependencies. You can run agent-based and agentless discovery simultaneously. Use agentless discovery to complete the initial infrastructure assessment quickly, and then install agents on select hosts to collect additional information.
Working With This Guide
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
- Remember that you must set your Migration Hub home region before you call any of these APIs.
- You must make API calls for write actions (create, notify,
associate, disassociate, import, or put) while in your home region,
or a
HomeRegionNotSetExceptionerror is returned. - API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
- Although it is unlikely, the Migration Hub home region could change.
If you call APIs outside the home region, an
InvalidInputExceptionis returned. - You must call
GetHomeRegionto obtain the latest Migration Hub home region.
This guide is intended for use with the AWS Application Discovery Service User Guide.
All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.
Synopsis
- defaultService :: Service
- _AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _HomeRegionNotSetException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictErrorException :: 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
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data DescribeTags = DescribeTags' (Maybe [TagFilter]) (Maybe Text) (Maybe Int)
- newDescribeTags :: DescribeTags
- data DescribeTagsResponse = DescribeTagsResponse' (Maybe Text) (Maybe [ConfigurationTag]) Int
- newDescribeTagsResponse :: Int -> DescribeTagsResponse
- data DescribeContinuousExports = DescribeContinuousExports' (Maybe Text) (Maybe [Text]) (Maybe Natural)
- newDescribeContinuousExports :: DescribeContinuousExports
- data DescribeContinuousExportsResponse = DescribeContinuousExportsResponse' (Maybe Text) (Maybe [ContinuousExportDescription]) Int
- newDescribeContinuousExportsResponse :: Int -> DescribeContinuousExportsResponse
- data StopDataCollectionByAgentIds = StopDataCollectionByAgentIds' [Text]
- newStopDataCollectionByAgentIds :: StopDataCollectionByAgentIds
- data StopDataCollectionByAgentIdsResponse = StopDataCollectionByAgentIdsResponse' (Maybe [AgentConfigurationStatus]) Int
- newStopDataCollectionByAgentIdsResponse :: Int -> StopDataCollectionByAgentIdsResponse
- data CreateTags = CreateTags' [Text] [Tag]
- newCreateTags :: CreateTags
- data CreateTagsResponse = CreateTagsResponse' Int
- newCreateTagsResponse :: Int -> CreateTagsResponse
- data BatchDeleteImportData = BatchDeleteImportData' (NonEmpty Text)
- newBatchDeleteImportData :: NonEmpty Text -> BatchDeleteImportData
- data BatchDeleteImportDataResponse = BatchDeleteImportDataResponse' (Maybe [BatchDeleteImportDataError]) Int
- newBatchDeleteImportDataResponse :: Int -> BatchDeleteImportDataResponse
- data DeleteTags = DeleteTags' (Maybe [Tag]) [Text]
- newDeleteTags :: DeleteTags
- data DeleteTagsResponse = DeleteTagsResponse' Int
- newDeleteTagsResponse :: Int -> DeleteTagsResponse
- data StartImportTask = StartImportTask' (Maybe Text) Text Text
- newStartImportTask :: Text -> Text -> StartImportTask
- data StartImportTaskResponse = StartImportTaskResponse' (Maybe ImportTask) Int
- newStartImportTaskResponse :: Int -> StartImportTaskResponse
- data DeleteApplications = DeleteApplications' [Text]
- newDeleteApplications :: DeleteApplications
- data DeleteApplicationsResponse = DeleteApplicationsResponse' Int
- newDeleteApplicationsResponse :: Int -> DeleteApplicationsResponse
- data UpdateApplication = UpdateApplication' (Maybe Text) (Maybe Text) Text
- newUpdateApplication :: Text -> UpdateApplication
- data UpdateApplicationResponse = UpdateApplicationResponse' Int
- newUpdateApplicationResponse :: Int -> UpdateApplicationResponse
- data DescribeConfigurations = DescribeConfigurations' [Text]
- newDescribeConfigurations :: DescribeConfigurations
- data DescribeConfigurationsResponse = DescribeConfigurationsResponse' (Maybe [HashMap Text Text]) Int
- newDescribeConfigurationsResponse :: Int -> DescribeConfigurationsResponse
- data DescribeImportTasks = DescribeImportTasks' (Maybe [ImportTaskFilter]) (Maybe Text) (Maybe Natural)
- newDescribeImportTasks :: DescribeImportTasks
- data DescribeImportTasksResponse = DescribeImportTasksResponse' (Maybe [ImportTask]) (Maybe Text) Int
- newDescribeImportTasksResponse :: Int -> DescribeImportTasksResponse
- data CreateApplication = CreateApplication' (Maybe Text) Text
- newCreateApplication :: Text -> CreateApplication
- data CreateApplicationResponse = CreateApplicationResponse' (Maybe Text) Int
- newCreateApplicationResponse :: Int -> CreateApplicationResponse
- data ListConfigurations = ListConfigurations' (Maybe [OrderByElement]) (Maybe [Filter]) (Maybe Text) (Maybe Int) ConfigurationItemType
- newListConfigurations :: ConfigurationItemType -> ListConfigurations
- data ListConfigurationsResponse = ListConfigurationsResponse' (Maybe [HashMap Text Text]) (Maybe Text) Int
- newListConfigurationsResponse :: Int -> ListConfigurationsResponse
- data StartContinuousExport = StartContinuousExport' {
- newStartContinuousExport :: StartContinuousExport
- data StartContinuousExportResponse = StartContinuousExportResponse' (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe DataSource) (Maybe Text) (Maybe Text) Int
- newStartContinuousExportResponse :: Int -> StartContinuousExportResponse
- data DescribeAgents = DescribeAgents' (Maybe [Text]) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeAgents :: DescribeAgents
- data DescribeAgentsResponse = DescribeAgentsResponse' (Maybe [AgentInfo]) (Maybe Text) Int
- newDescribeAgentsResponse :: Int -> DescribeAgentsResponse
- data DescribeExportTasks = DescribeExportTasks' (Maybe [ExportFilter]) (Maybe Text) (Maybe [Text]) (Maybe Int)
- newDescribeExportTasks :: DescribeExportTasks
- data DescribeExportTasksResponse = DescribeExportTasksResponse' (Maybe Text) (Maybe [ExportInfo]) Int
- newDescribeExportTasksResponse :: Int -> DescribeExportTasksResponse
- data StartDataCollectionByAgentIds = StartDataCollectionByAgentIds' [Text]
- newStartDataCollectionByAgentIds :: StartDataCollectionByAgentIds
- data StartDataCollectionByAgentIdsResponse = StartDataCollectionByAgentIdsResponse' (Maybe [AgentConfigurationStatus]) Int
- newStartDataCollectionByAgentIdsResponse :: Int -> StartDataCollectionByAgentIdsResponse
- data GetDiscoverySummary = GetDiscoverySummary' {
- newGetDiscoverySummary :: GetDiscoverySummary
- data GetDiscoverySummaryResponse = GetDiscoverySummaryResponse' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe CustomerConnectorInfo) (Maybe CustomerAgentInfo) (Maybe Integer) Int
- newGetDiscoverySummaryResponse :: Int -> GetDiscoverySummaryResponse
- data DisassociateConfigurationItemsFromApplication = DisassociateConfigurationItemsFromApplication' Text [Text]
- newDisassociateConfigurationItemsFromApplication :: Text -> DisassociateConfigurationItemsFromApplication
- data DisassociateConfigurationItemsFromApplicationResponse = DisassociateConfigurationItemsFromApplicationResponse' Int
- newDisassociateConfigurationItemsFromApplicationResponse :: Int -> DisassociateConfigurationItemsFromApplicationResponse
- data AssociateConfigurationItemsToApplication = AssociateConfigurationItemsToApplication' Text [Text]
- newAssociateConfigurationItemsToApplication :: Text -> AssociateConfigurationItemsToApplication
- data AssociateConfigurationItemsToApplicationResponse = AssociateConfigurationItemsToApplicationResponse' Int
- newAssociateConfigurationItemsToApplicationResponse :: Int -> AssociateConfigurationItemsToApplicationResponse
- data ListServerNeighbors = ListServerNeighbors' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Int) Text
- newListServerNeighbors :: Text -> ListServerNeighbors
- data ListServerNeighborsResponse = ListServerNeighborsResponse' (Maybe Text) (Maybe Integer) Int [NeighborConnectionDetail]
- newListServerNeighborsResponse :: Int -> ListServerNeighborsResponse
- data StopContinuousExport = StopContinuousExport' Text
- newStopContinuousExport :: Text -> StopContinuousExport
- data StopContinuousExportResponse = StopContinuousExportResponse' (Maybe POSIX) (Maybe POSIX) Int
- newStopContinuousExportResponse :: Int -> StopContinuousExportResponse
- data StartExportTask = StartExportTask' (Maybe [ExportDataFormat]) (Maybe POSIX) (Maybe [ExportFilter]) (Maybe POSIX)
- newStartExportTask :: StartExportTask
- data StartExportTaskResponse = StartExportTaskResponse' (Maybe Text) Int
- newStartExportTaskResponse :: Int -> StartExportTaskResponse
- newtype AgentStatus where
- AgentStatus' { }
- pattern AgentStatus_BLACKLISTED :: AgentStatus
- pattern AgentStatus_HEALTHY :: AgentStatus
- pattern AgentStatus_RUNNING :: AgentStatus
- pattern AgentStatus_SHUTDOWN :: AgentStatus
- pattern AgentStatus_UNHEALTHY :: AgentStatus
- pattern AgentStatus_UNKNOWN :: AgentStatus
- newtype BatchDeleteImportDataErrorCode where
- newtype ConfigurationItemType where
- newtype ContinuousExportStatus where
- ContinuousExportStatus' { }
- pattern ContinuousExportStatus_ACTIVE :: ContinuousExportStatus
- pattern ContinuousExportStatus_ERROR :: ContinuousExportStatus
- pattern ContinuousExportStatus_INACTIVE :: ContinuousExportStatus
- pattern ContinuousExportStatus_START_FAILED :: ContinuousExportStatus
- pattern ContinuousExportStatus_START_IN_PROGRESS :: ContinuousExportStatus
- pattern ContinuousExportStatus_STOP_FAILED :: ContinuousExportStatus
- pattern ContinuousExportStatus_STOP_IN_PROGRESS :: ContinuousExportStatus
- newtype DataSource where
- DataSource' { }
- pattern DataSource_AGENT :: DataSource
- newtype ExportDataFormat where
- ExportDataFormat' { }
- pattern ExportDataFormat_CSV :: ExportDataFormat
- pattern ExportDataFormat_GRAPHML :: ExportDataFormat
- newtype ExportStatus where
- ExportStatus' { }
- pattern ExportStatus_FAILED :: ExportStatus
- pattern ExportStatus_IN_PROGRESS :: ExportStatus
- pattern ExportStatus_SUCCEEDED :: ExportStatus
- newtype ImportStatus where
- ImportStatus' { }
- pattern ImportStatus_DELETE_COMPLETE :: ImportStatus
- pattern ImportStatus_DELETE_FAILED :: ImportStatus
- pattern ImportStatus_DELETE_FAILED_LIMIT_EXCEEDED :: ImportStatus
- pattern ImportStatus_DELETE_IN_PROGRESS :: ImportStatus
- pattern ImportStatus_IMPORT_COMPLETE :: ImportStatus
- pattern ImportStatus_IMPORT_COMPLETE_WITH_ERRORS :: ImportStatus
- pattern ImportStatus_IMPORT_FAILED :: ImportStatus
- pattern ImportStatus_IMPORT_FAILED_RECORD_LIMIT_EXCEEDED :: ImportStatus
- pattern ImportStatus_IMPORT_FAILED_SERVER_LIMIT_EXCEEDED :: ImportStatus
- pattern ImportStatus_IMPORT_IN_PROGRESS :: ImportStatus
- pattern ImportStatus_INTERNAL_ERROR :: ImportStatus
- newtype ImportTaskFilterName where
- newtype OrderString where
- OrderString' { }
- pattern OrderString_ASC :: OrderString
- pattern OrderString_DESC :: OrderString
- data AgentConfigurationStatus = AgentConfigurationStatus' (Maybe Text) (Maybe Bool) (Maybe Text)
- newAgentConfigurationStatus :: AgentConfigurationStatus
- data AgentInfo = AgentInfo' (Maybe Text) (Maybe Text) (Maybe [AgentNetworkInfo]) (Maybe Text) (Maybe AgentStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAgentInfo :: AgentInfo
- data AgentNetworkInfo = AgentNetworkInfo' (Maybe Text) (Maybe Text)
- newAgentNetworkInfo :: AgentNetworkInfo
- data BatchDeleteImportDataError = BatchDeleteImportDataError' (Maybe Text) (Maybe BatchDeleteImportDataErrorCode) (Maybe Text)
- newBatchDeleteImportDataError :: BatchDeleteImportDataError
- data ConfigurationTag = ConfigurationTag' (Maybe POSIX) (Maybe Text) (Maybe ConfigurationItemType) (Maybe Text) (Maybe Text)
- newConfigurationTag :: ConfigurationTag
- data ContinuousExportDescription = ContinuousExportDescription' (Maybe ContinuousExportStatus) (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe POSIX) (Maybe DataSource) (Maybe Text) (Maybe Text)
- newContinuousExportDescription :: ContinuousExportDescription
- data CustomerAgentInfo = CustomerAgentInfo' Int Int Int Int Int Int Int
- newCustomerAgentInfo :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> CustomerAgentInfo
- data CustomerConnectorInfo = CustomerConnectorInfo' Int Int Int Int Int Int Int
- newCustomerConnectorInfo :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> CustomerConnectorInfo
- data ExportFilter = ExportFilter' Text [Text] Text
- newExportFilter :: Text -> Text -> ExportFilter
- data ExportInfo = ExportInfo' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Bool) Text ExportStatus Text POSIX
- newExportInfo :: Text -> ExportStatus -> Text -> UTCTime -> ExportInfo
- data Filter = Filter' Text [Text] Text
- newFilter :: Text -> Text -> Filter
- data ImportTask = ImportTask' (Maybe Int) (Maybe ImportStatus) (Maybe Int) (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newImportTask :: ImportTask
- data ImportTaskFilter = ImportTaskFilter' (Maybe (NonEmpty Text)) (Maybe ImportTaskFilterName)
- newImportTaskFilter :: ImportTaskFilter
- data NeighborConnectionDetail = NeighborConnectionDetail' (Maybe Text) (Maybe Int) Text Text Integer
- newNeighborConnectionDetail :: Text -> Text -> Integer -> NeighborConnectionDetail
- data OrderByElement = OrderByElement' (Maybe OrderString) Text
- newOrderByElement :: Text -> OrderByElement
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TagFilter = TagFilter' Text [Text]
- newTagFilter :: Text -> TagFilter
Service Configuration
defaultService :: Service Source #
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.
HomeRegionNotSetException
_HomeRegionNotSetException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The home region is not set. Set the home region to continue.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameters are not valid. Verify the parameters and try again.
ConflictErrorException
_ConflictErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This issue occurs when the same clientRequestToken is used with the
StartImportTask action, but with different parameters. For example,
you use the same request token but have two different import URLs, you
can encounter this issue. If the import tasks are meant to be different,
use a different clientRequestToken, 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 (Paginated)
data DescribeTags Source #
See: newDescribeTags smart constructor.
Instances
newDescribeTags :: DescribeTags Source #
Create a value of DescribeTags with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeTags', describeTags_filters - You can filter the list using a key-value format. You can separate
these items by using logical operators. Allowed filters include
tagKey, tagValue, and configurationId.
$sel:nextToken:DescribeTags', describeTags_nextToken - A token to start the list. Use this token to get the next set of
results.
$sel:maxResults:DescribeTags', describeTags_maxResults - The total number of items to return in a single page of output. The
maximum value is 100.
data DescribeTagsResponse Source #
See: newDescribeTagsResponse smart constructor.
Constructors
| DescribeTagsResponse' (Maybe Text) (Maybe [ConfigurationTag]) Int |
Instances
newDescribeTagsResponse Source #
Arguments
| :: Int | |
| -> DescribeTagsResponse |
Create a value of DescribeTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeTags', describeTagsResponse_nextToken - The call returns a token. Use this token to get the next set of results.
$sel:tags:DescribeTagsResponse', describeTagsResponse_tags - Depending on the input, this is a list of configuration items tagged
with a specific tag, or a list of tags for a specific configuration
item.
$sel:httpStatus:DescribeTagsResponse', describeTagsResponse_httpStatus - The response's http status code.
DescribeContinuousExports (Paginated)
data DescribeContinuousExports Source #
See: newDescribeContinuousExports smart constructor.
Instances
newDescribeContinuousExports :: DescribeContinuousExports Source #
Create a value of DescribeContinuousExports with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeContinuousExports', describeContinuousExports_nextToken - The token from the previous call to DescribeExportTasks.
$sel:exportIds:DescribeContinuousExports', describeContinuousExports_exportIds - The unique IDs assigned to the exports.
$sel:maxResults:DescribeContinuousExports', describeContinuousExports_maxResults - A number between 1 and 100 specifying the maximum number of continuous
export descriptions returned.
data DescribeContinuousExportsResponse Source #
See: newDescribeContinuousExportsResponse smart constructor.
Constructors
| DescribeContinuousExportsResponse' (Maybe Text) (Maybe [ContinuousExportDescription]) Int |
Instances
newDescribeContinuousExportsResponse Source #
Arguments
| :: Int | |
| -> DescribeContinuousExportsResponse |
Create a value of DescribeContinuousExportsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeContinuousExports', describeContinuousExportsResponse_nextToken - The token from the previous call to DescribeExportTasks.
$sel:descriptions:DescribeContinuousExportsResponse', describeContinuousExportsResponse_descriptions - A list of continuous export descriptions.
$sel:httpStatus:DescribeContinuousExportsResponse', describeContinuousExportsResponse_httpStatus - The response's http status code.
StopDataCollectionByAgentIds
data StopDataCollectionByAgentIds Source #
See: newStopDataCollectionByAgentIds smart constructor.
Constructors
| StopDataCollectionByAgentIds' [Text] |
Instances
newStopDataCollectionByAgentIds :: StopDataCollectionByAgentIds Source #
Create a value of StopDataCollectionByAgentIds with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentIds:StopDataCollectionByAgentIds', stopDataCollectionByAgentIds_agentIds - The IDs of the agents or connectors from which to stop collecting data.
data StopDataCollectionByAgentIdsResponse Source #
See: newStopDataCollectionByAgentIdsResponse smart constructor.
Constructors
| StopDataCollectionByAgentIdsResponse' (Maybe [AgentConfigurationStatus]) Int |
Instances
newStopDataCollectionByAgentIdsResponse Source #
Arguments
| :: Int | |
| -> StopDataCollectionByAgentIdsResponse |
Create a value of StopDataCollectionByAgentIdsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentsConfigurationStatus:StopDataCollectionByAgentIdsResponse', stopDataCollectionByAgentIdsResponse_agentsConfigurationStatus - Information about the agents or connector that were instructed to stop
collecting data. Information includes the agent/connector ID, a
description of the operation performed, and whether the agent/connector
configuration was updated.
$sel:httpStatus:StopDataCollectionByAgentIdsResponse', stopDataCollectionByAgentIdsResponse_httpStatus - The response's http status code.
CreateTags
data CreateTags Source #
See: newCreateTags smart constructor.
Constructors
| CreateTags' [Text] [Tag] |
Instances
newCreateTags :: CreateTags Source #
Create a value of CreateTags with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationIds:CreateTags', createTags_configurationIds - A list of configuration items that you want to tag.
$sel:tags:CreateTags', createTags_tags - Tags that you want to associate with one or more configuration items.
Specify the tags that you want to create in a key-value format. For
example:
{"key": "serverType", "value": "webServer"}data CreateTagsResponse Source #
See: newCreateTagsResponse smart constructor.
Constructors
| CreateTagsResponse' Int |
Instances
newCreateTagsResponse Source #
Arguments
| :: Int | |
| -> CreateTagsResponse |
Create a value of CreateTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateTagsResponse', createTagsResponse_httpStatus - The response's http status code.
BatchDeleteImportData
data BatchDeleteImportData Source #
See: newBatchDeleteImportData smart constructor.
Constructors
| BatchDeleteImportData' (NonEmpty Text) |
Instances
newBatchDeleteImportData Source #
Create a value of BatchDeleteImportData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:importTaskIds:BatchDeleteImportData', batchDeleteImportData_importTaskIds - The IDs for the import tasks that you want to delete.
data BatchDeleteImportDataResponse Source #
See: newBatchDeleteImportDataResponse smart constructor.
Constructors
| BatchDeleteImportDataResponse' (Maybe [BatchDeleteImportDataError]) Int |
Instances
newBatchDeleteImportDataResponse Source #
Create a value of BatchDeleteImportDataResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchDeleteImportDataResponse', batchDeleteImportDataResponse_errors - Error messages returned for each import task that you deleted as a
response for this command.
$sel:httpStatus:BatchDeleteImportDataResponse', batchDeleteImportDataResponse_httpStatus - The response's http status code.
DeleteTags
data DeleteTags Source #
See: newDeleteTags smart constructor.
Constructors
| DeleteTags' (Maybe [Tag]) [Text] |
Instances
newDeleteTags :: DeleteTags Source #
Create a value of DeleteTags with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:DeleteTags', deleteTags_tags - Tags that you want to delete from one or more configuration items.
Specify the tags that you want to delete in a key-value format. For
example:
{"key": "serverType", "value": "webServer"}$sel:configurationIds:DeleteTags', deleteTags_configurationIds - A list of configuration items with tags that you want to delete.
data DeleteTagsResponse Source #
See: newDeleteTagsResponse smart constructor.
Constructors
| DeleteTagsResponse' Int |
Instances
newDeleteTagsResponse Source #
Arguments
| :: Int | |
| -> DeleteTagsResponse |
Create a value of DeleteTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteTagsResponse', deleteTagsResponse_httpStatus - The response's http status code.
StartImportTask
data StartImportTask Source #
See: newStartImportTask smart constructor.
Constructors
| StartImportTask' (Maybe Text) Text Text |
Instances
Create a value of StartImportTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:StartImportTask', startImportTask_clientRequestToken - Optional. A unique token that you can provide to prevent the same import
request from occurring more than once. If you don't provide a token, a
token is automatically generated.
Sending more than one StartImportTask request with the same client
request token will return information about the original import task
with that client request token.
$sel:name:StartImportTask', startImportTask_name - A descriptive name for this request. You can use this name to filter
future requests related to this import task, such as identifying
applications and servers that were included in this import task. We
recommend that you use a meaningful name for each import task.
$sel:importUrl:StartImportTask', startImportTask_importUrl - The URL for your import file that you've uploaded to Amazon S3.
If you're using the AWS CLI, this URL is structured as follows:
s3://BucketName/ImportFileName.CSV
data StartImportTaskResponse Source #
See: newStartImportTaskResponse smart constructor.
Constructors
| StartImportTaskResponse' (Maybe ImportTask) Int |
Instances
newStartImportTaskResponse Source #
Create a value of StartImportTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:task:StartImportTaskResponse', startImportTaskResponse_task - An array of information related to the import task request including
status information, times, IDs, the Amazon S3 Object URL for the import
file, and more.
$sel:httpStatus:StartImportTaskResponse', startImportTaskResponse_httpStatus - The response's http status code.
DeleteApplications
data DeleteApplications Source #
See: newDeleteApplications smart constructor.
Constructors
| DeleteApplications' [Text] |
Instances
newDeleteApplications :: DeleteApplications Source #
Create a value of DeleteApplications with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationIds:DeleteApplications', deleteApplications_configurationIds - Configuration ID of an application to be deleted.
data DeleteApplicationsResponse Source #
See: newDeleteApplicationsResponse smart constructor.
Constructors
| DeleteApplicationsResponse' Int |
Instances
newDeleteApplicationsResponse Source #
Create a value of DeleteApplicationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApplicationsResponse', deleteApplicationsResponse_httpStatus - The response's http status code.
UpdateApplication
data UpdateApplication Source #
See: newUpdateApplication smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateApplication |
Create a value of UpdateApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:UpdateApplication', updateApplication_name - New name of the application to be updated.
$sel:description:UpdateApplication', updateApplication_description - New description of the application to be updated.
$sel:configurationId:UpdateApplication', updateApplication_configurationId - Configuration ID of the application to be updated.
data UpdateApplicationResponse Source #
See: newUpdateApplicationResponse smart constructor.
Constructors
| UpdateApplicationResponse' Int |
Instances
newUpdateApplicationResponse Source #
Create a value of UpdateApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateApplicationResponse', updateApplicationResponse_httpStatus - The response's http status code.
DescribeConfigurations
data DescribeConfigurations Source #
See: newDescribeConfigurations smart constructor.
Constructors
| DescribeConfigurations' [Text] |
Instances
newDescribeConfigurations :: DescribeConfigurations Source #
Create a value of DescribeConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationIds:DescribeConfigurations', describeConfigurations_configurationIds - One or more configuration IDs.
data DescribeConfigurationsResponse Source #
See: newDescribeConfigurationsResponse smart constructor.
Instances
newDescribeConfigurationsResponse Source #
Create a value of DescribeConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurations:DescribeConfigurationsResponse', describeConfigurationsResponse_configurations - A key in the response map. The value is an array of data.
$sel:httpStatus:DescribeConfigurationsResponse', describeConfigurationsResponse_httpStatus - The response's http status code.
DescribeImportTasks
data DescribeImportTasks Source #
See: newDescribeImportTasks smart constructor.
Constructors
| DescribeImportTasks' (Maybe [ImportTaskFilter]) (Maybe Text) (Maybe Natural) |
Instances
newDescribeImportTasks :: DescribeImportTasks Source #
Create a value of DescribeImportTasks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeImportTasks', describeImportTasks_filters - An array of name-value pairs that you provide to filter the results for
the DescribeImportTask request to a specific subset of results.
Currently, wildcard values aren't supported for filters.
$sel:nextToken:DescribeImportTasks', describeImportTasks_nextToken - The token to request a specific page of results.
$sel:maxResults:DescribeImportTasks', describeImportTasks_maxResults - The maximum number of results that you want this request to return, up
to 100.
data DescribeImportTasksResponse Source #
See: newDescribeImportTasksResponse smart constructor.
Constructors
| DescribeImportTasksResponse' (Maybe [ImportTask]) (Maybe Text) Int |
Instances
newDescribeImportTasksResponse Source #
Create a value of DescribeImportTasksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tasks:DescribeImportTasksResponse', describeImportTasksResponse_tasks - A returned array of import tasks that match any applied filters, up to
the specified number of maximum results.
$sel:nextToken:DescribeImportTasks', describeImportTasksResponse_nextToken - The token to request the next page of results.
$sel:httpStatus:DescribeImportTasksResponse', describeImportTasksResponse_httpStatus - The response's http status code.
CreateApplication
data CreateApplication Source #
See: newCreateApplication smart constructor.
Constructors
| CreateApplication' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> CreateApplication |
Create a value of CreateApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:CreateApplication', createApplication_description - Description of the application to be created.
$sel:name:CreateApplication', createApplication_name - Name of the application to be created.
data CreateApplicationResponse Source #
See: newCreateApplicationResponse smart constructor.
Constructors
| CreateApplicationResponse' (Maybe Text) Int |
Instances
newCreateApplicationResponse Source #
Create a value of CreateApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationId:CreateApplicationResponse', createApplicationResponse_configurationId - Configuration ID of an application to be created.
$sel:httpStatus:CreateApplicationResponse', createApplicationResponse_httpStatus - The response's http status code.
ListConfigurations (Paginated)
data ListConfigurations Source #
See: newListConfigurations smart constructor.
Constructors
| ListConfigurations' (Maybe [OrderByElement]) (Maybe [Filter]) (Maybe Text) (Maybe Int) ConfigurationItemType |
Instances
newListConfigurations Source #
Create a value of ListConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orderBy:ListConfigurations', listConfigurations_orderBy - Certain filter criteria return output that can be sorted in ascending or
descending order. For a list of output characteristics for each filter,
see
Using the ListConfigurations Action
in the AWS Application Discovery Service User Guide.
$sel:filters:ListConfigurations', listConfigurations_filters - You can filter the request using various logical operators and a
key-value format. For example:
{"key": "serverType", "value": "webServer"}For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.
$sel:nextToken:ListConfigurations', listConfigurations_nextToken - Token to retrieve the next set of results. For example, if a previous
call to ListConfigurations returned 100 items, but you set
ListConfigurationsRequest$maxResults to 10, you received a set of 10
results along with a token. Use that token in this query to get the next
set of 10.
$sel:maxResults:ListConfigurations', listConfigurations_maxResults - The total number of items to return. The maximum value is 100.
$sel:configurationType:ListConfigurations', listConfigurations_configurationType - A valid configuration identified by Application Discovery Service.
data ListConfigurationsResponse Source #
See: newListConfigurationsResponse smart constructor.
Instances
newListConfigurationsResponse Source #
Create a value of ListConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurations:ListConfigurationsResponse', listConfigurationsResponse_configurations - Returns configuration details, including the configuration ID, attribute
names, and attribute values.
$sel:nextToken:ListConfigurations', listConfigurationsResponse_nextToken - Token to retrieve the next set of results. For example, if your call to
ListConfigurations returned 100 items, but you set
ListConfigurationsRequest$maxResults to 10, you received a set of 10
results along with this token. Use this token in the next query to
retrieve the next set of 10.
$sel:httpStatus:ListConfigurationsResponse', listConfigurationsResponse_httpStatus - The response's http status code.
StartContinuousExport
data StartContinuousExport Source #
See: newStartContinuousExport smart constructor.
Constructors
| StartContinuousExport' | |
Instances
newStartContinuousExport :: StartContinuousExport Source #
Create a value of StartContinuousExport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data StartContinuousExportResponse Source #
See: newStartContinuousExportResponse smart constructor.
Constructors
| StartContinuousExportResponse' (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe DataSource) (Maybe Text) (Maybe Text) Int |
Instances
newStartContinuousExportResponse Source #
Create a value of StartContinuousExportResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:StartContinuousExportResponse', startContinuousExportResponse_startTime - The timestamp representing when the continuous export was started.
$sel:schemaStorageConfig:StartContinuousExportResponse', startContinuousExportResponse_schemaStorageConfig - A dictionary which describes how the data is stored.
databaseName- the name of the Glue database used to store the schema.
$sel:dataSource:StartContinuousExportResponse', startContinuousExportResponse_dataSource - The type of data collector used to gather this data (currently only
offered for AGENT).
$sel:s3Bucket:StartContinuousExportResponse', startContinuousExportResponse_s3Bucket - The name of the s3 bucket where the export data parquet files are
stored.
$sel:exportId:StartContinuousExportResponse', startContinuousExportResponse_exportId - The unique ID assigned to this export.
$sel:httpStatus:StartContinuousExportResponse', startContinuousExportResponse_httpStatus - The response's http status code.
DescribeAgents (Paginated)
data DescribeAgents Source #
See: newDescribeAgents smart constructor.
Instances
newDescribeAgents :: DescribeAgents Source #
Create a value of DescribeAgents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentIds:DescribeAgents', describeAgents_agentIds - The agent or the Connector IDs for which you want information. If you
specify no IDs, the system returns information about all
agents/Connectors associated with your AWS user account.
$sel:filters:DescribeAgents', describeAgents_filters - You can filter the request using various logical operators and a
key-value format. For example:
{"key": "collectionStatus", "value": "STARTED"}$sel:nextToken:DescribeAgents', describeAgents_nextToken - Token to retrieve the next set of results. For example, if you
previously specified 100 IDs for DescribeAgentsRequest$agentIds but
set DescribeAgentsRequest$maxResults to 10, you received a set of 10
results along with a token. Use that token in this query to get the next
set of 10.
$sel:maxResults:DescribeAgents', describeAgents_maxResults - The total number of agents/Connectors to return in a single page of
output. The maximum value is 100.
data DescribeAgentsResponse Source #
See: newDescribeAgentsResponse smart constructor.
Instances
newDescribeAgentsResponse Source #
Create a value of DescribeAgentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentsInfo:DescribeAgentsResponse', describeAgentsResponse_agentsInfo - Lists agents or the Connector by ID or lists all agents/Connectors
associated with your user account if you did not specify an
agent/Connector ID. The output includes agent/Connector IDs, IP
addresses, media access control (MAC) addresses, agent/Connector
health, host name where the agent/Connector resides, and the version
number of each agent/Connector.
$sel:nextToken:DescribeAgents', describeAgentsResponse_nextToken - Token to retrieve the next set of results. For example, if you specified
100 IDs for DescribeAgentsRequest$agentIds but set
DescribeAgentsRequest$maxResults to 10, you received a set of 10
results along with this token. Use this token in the next query to
retrieve the next set of 10.
$sel:httpStatus:DescribeAgentsResponse', describeAgentsResponse_httpStatus - The response's http status code.
DescribeExportTasks (Paginated)
data DescribeExportTasks Source #
See: newDescribeExportTasks smart constructor.
Constructors
| DescribeExportTasks' (Maybe [ExportFilter]) (Maybe Text) (Maybe [Text]) (Maybe Int) |
Instances
newDescribeExportTasks :: DescribeExportTasks Source #
Create a value of DescribeExportTasks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeExportTasks', describeExportTasks_filters - One or more filters.
AgentId- ID of the agent whose collected data will be exported
$sel:nextToken:DescribeExportTasks', describeExportTasks_nextToken - The nextToken value returned from a previous paginated
DescribeExportTasks request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
This value is null when there are no more results to return.
$sel:exportIds:DescribeExportTasks', describeExportTasks_exportIds - One or more unique identifiers used to query the status of an export
request.
$sel:maxResults:DescribeExportTasks', describeExportTasks_maxResults - The maximum number of volume results returned by DescribeExportTasks
in paginated output. When this parameter is used, DescribeExportTasks
only returns maxResults results in a single page along with a
nextToken response element.
data DescribeExportTasksResponse Source #
See: newDescribeExportTasksResponse smart constructor.
Constructors
| DescribeExportTasksResponse' (Maybe Text) (Maybe [ExportInfo]) Int |
Instances
newDescribeExportTasksResponse Source #
Create a value of DescribeExportTasksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeExportTasks', describeExportTasksResponse_nextToken - The nextToken value to include in a future DescribeExportTasks
request. When the results of a DescribeExportTasks request exceed
maxResults, this value can be used to retrieve the next page of
results. This value is null when there are no more results to return.
$sel:exportsInfo:DescribeExportTasksResponse', describeExportTasksResponse_exportsInfo - Contains one or more sets of export request details. When the status of
a request is SUCCEEDED, the response includes a URL for an Amazon S3
bucket where you can view the data in a CSV file.
$sel:httpStatus:DescribeExportTasksResponse', describeExportTasksResponse_httpStatus - The response's http status code.
StartDataCollectionByAgentIds
data StartDataCollectionByAgentIds Source #
See: newStartDataCollectionByAgentIds smart constructor.
Constructors
| StartDataCollectionByAgentIds' [Text] |
Instances
newStartDataCollectionByAgentIds :: StartDataCollectionByAgentIds Source #
Create a value of StartDataCollectionByAgentIds with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentIds:StartDataCollectionByAgentIds', startDataCollectionByAgentIds_agentIds - The IDs of the agents or connectors from which to start collecting data.
If you send a request to an agent/connector ID that you do not have
permission to contact, according to your AWS account, the service does
not throw an exception. Instead, it returns the error in the
Description field. If you send a request to multiple
agents/connectors and you do not have permission to contact some of
those agents/connectors, the system does not throw an exception.
Instead, the system shows Failed in the Description field.
data StartDataCollectionByAgentIdsResponse Source #
See: newStartDataCollectionByAgentIdsResponse smart constructor.
Constructors
| StartDataCollectionByAgentIdsResponse' (Maybe [AgentConfigurationStatus]) Int |
Instances
newStartDataCollectionByAgentIdsResponse Source #
Arguments
| :: Int | |
| -> StartDataCollectionByAgentIdsResponse |
Create a value of StartDataCollectionByAgentIdsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentsConfigurationStatus:StartDataCollectionByAgentIdsResponse', startDataCollectionByAgentIdsResponse_agentsConfigurationStatus - Information about agents or the connector that were instructed to start
collecting data. Information includes the agent/connector ID, a
description of the operation performed, and whether the agent/connector
configuration was updated.
$sel:httpStatus:StartDataCollectionByAgentIdsResponse', startDataCollectionByAgentIdsResponse_httpStatus - The response's http status code.
GetDiscoverySummary
data GetDiscoverySummary Source #
See: newGetDiscoverySummary smart constructor.
Constructors
| GetDiscoverySummary' | |
Instances
newGetDiscoverySummary :: GetDiscoverySummary Source #
Create a value of GetDiscoverySummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetDiscoverySummaryResponse Source #
See: newGetDiscoverySummaryResponse smart constructor.
Constructors
| GetDiscoverySummaryResponse' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe CustomerConnectorInfo) (Maybe CustomerAgentInfo) (Maybe Integer) Int |
Instances
newGetDiscoverySummaryResponse Source #
Create a value of GetDiscoverySummaryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:servers:GetDiscoverySummaryResponse', getDiscoverySummaryResponse_servers - The number of servers discovered.
$sel:serversMappedtoTags:GetDiscoverySummaryResponse', getDiscoverySummaryResponse_serversMappedtoTags - The number of servers mapped to tags.
$sel:serversMappedToApplications:GetDiscoverySummaryResponse', getDiscoverySummaryResponse_serversMappedToApplications - The number of servers mapped to applications.
$sel:connectorSummary:GetDiscoverySummaryResponse', getDiscoverySummaryResponse_connectorSummary - Details about discovered connectors, including connector status and
health.
$sel:agentSummary:GetDiscoverySummaryResponse', getDiscoverySummaryResponse_agentSummary - Details about discovered agents, including agent status and health.
$sel:applications:GetDiscoverySummaryResponse', getDiscoverySummaryResponse_applications - The number of applications discovered.
$sel:httpStatus:GetDiscoverySummaryResponse', getDiscoverySummaryResponse_httpStatus - The response's http status code.
DisassociateConfigurationItemsFromApplication
data DisassociateConfigurationItemsFromApplication Source #
See: newDisassociateConfigurationItemsFromApplication smart constructor.
Constructors
| DisassociateConfigurationItemsFromApplication' Text [Text] |
Instances
newDisassociateConfigurationItemsFromApplication Source #
Arguments
| :: Text |
|
| -> DisassociateConfigurationItemsFromApplication |
Create a value of DisassociateConfigurationItemsFromApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationConfigurationId:DisassociateConfigurationItemsFromApplication', disassociateConfigurationItemsFromApplication_applicationConfigurationId - Configuration ID of an application from which each item is
disassociated.
$sel:configurationIds:DisassociateConfigurationItemsFromApplication', disassociateConfigurationItemsFromApplication_configurationIds - Configuration ID of each item to be disassociated from an application.
data DisassociateConfigurationItemsFromApplicationResponse Source #
See: newDisassociateConfigurationItemsFromApplicationResponse smart constructor.
Instances
newDisassociateConfigurationItemsFromApplicationResponse Source #
Arguments
| :: Int |
|
| -> DisassociateConfigurationItemsFromApplicationResponse |
Create a value of DisassociateConfigurationItemsFromApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateConfigurationItemsFromApplicationResponse', disassociateConfigurationItemsFromApplicationResponse_httpStatus - The response's http status code.
AssociateConfigurationItemsToApplication
data AssociateConfigurationItemsToApplication Source #
See: newAssociateConfigurationItemsToApplication smart constructor.
Constructors
| AssociateConfigurationItemsToApplication' Text [Text] |
Instances
newAssociateConfigurationItemsToApplication Source #
Arguments
| :: Text |
|
| -> AssociateConfigurationItemsToApplication |
Create a value of AssociateConfigurationItemsToApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationConfigurationId:AssociateConfigurationItemsToApplication', associateConfigurationItemsToApplication_applicationConfigurationId - The configuration ID of an application with which items are to be
associated.
$sel:configurationIds:AssociateConfigurationItemsToApplication', associateConfigurationItemsToApplication_configurationIds - The ID of each configuration item to be associated with an application.
data AssociateConfigurationItemsToApplicationResponse Source #
See: newAssociateConfigurationItemsToApplicationResponse smart constructor.
Constructors
| AssociateConfigurationItemsToApplicationResponse' Int |
Instances
newAssociateConfigurationItemsToApplicationResponse Source #
Arguments
| :: Int |
|
| -> AssociateConfigurationItemsToApplicationResponse |
Create a value of AssociateConfigurationItemsToApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateConfigurationItemsToApplicationResponse', associateConfigurationItemsToApplicationResponse_httpStatus - The response's http status code.
ListServerNeighbors
data ListServerNeighbors Source #
See: newListServerNeighbors smart constructor.
Instances
newListServerNeighbors Source #
Create a value of ListServerNeighbors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:portInformationNeeded:ListServerNeighbors', listServerNeighbors_portInformationNeeded - Flag to indicate if port and protocol information is needed as part of
the response.
$sel:neighborConfigurationIds:ListServerNeighbors', listServerNeighbors_neighborConfigurationIds - List of configuration IDs to test for one-hop-away.
$sel:nextToken:ListServerNeighbors', listServerNeighbors_nextToken - Token to retrieve the next set of results. For example, if you
previously specified 100 IDs for
ListServerNeighborsRequest$neighborConfigurationIds but set
ListServerNeighborsRequest$maxResults to 10, you received a set of 10
results along with a token. Use that token in this query to get the next
set of 10.
$sel:maxResults:ListServerNeighbors', listServerNeighbors_maxResults - Maximum number of results to return in a single page of output.
$sel:configurationId:ListServerNeighbors', listServerNeighbors_configurationId - Configuration ID of the server for which neighbors are being listed.
data ListServerNeighborsResponse Source #
See: newListServerNeighborsResponse smart constructor.
Constructors
| ListServerNeighborsResponse' (Maybe Text) (Maybe Integer) Int [NeighborConnectionDetail] |
Instances
newListServerNeighborsResponse Source #
Create a value of ListServerNeighborsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListServerNeighbors', listServerNeighborsResponse_nextToken - Token to retrieve the next set of results. For example, if you specified
100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but
set ListServerNeighborsRequest$maxResults to 10, you received a set of
10 results along with this token. Use this token in the next query to
retrieve the next set of 10.
$sel:knownDependencyCount:ListServerNeighborsResponse', listServerNeighborsResponse_knownDependencyCount - Count of distinct servers that are one hop away from the given server.
$sel:httpStatus:ListServerNeighborsResponse', listServerNeighborsResponse_httpStatus - The response's http status code.
$sel:neighbors:ListServerNeighborsResponse', listServerNeighborsResponse_neighbors - List of distinct servers that are one hop away from the given server.
StopContinuousExport
data StopContinuousExport Source #
See: newStopContinuousExport smart constructor.
Constructors
| StopContinuousExport' Text |
Instances
newStopContinuousExport Source #
Arguments
| :: Text | |
| -> StopContinuousExport |
Create a value of StopContinuousExport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportId:StopContinuousExport', stopContinuousExport_exportId - The unique ID assigned to this export.
data StopContinuousExportResponse Source #
See: newStopContinuousExportResponse smart constructor.
Instances
newStopContinuousExportResponse Source #
Create a value of StopContinuousExportResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:StopContinuousExportResponse', stopContinuousExportResponse_startTime - Timestamp that represents when this continuous export started collecting
data.
$sel:stopTime:StopContinuousExportResponse', stopContinuousExportResponse_stopTime - Timestamp that represents when this continuous export was stopped.
$sel:httpStatus:StopContinuousExportResponse', stopContinuousExportResponse_httpStatus - The response's http status code.
StartExportTask
data StartExportTask Source #
See: newStartExportTask smart constructor.
Constructors
| StartExportTask' (Maybe [ExportDataFormat]) (Maybe POSIX) (Maybe [ExportFilter]) (Maybe POSIX) |
Instances
newStartExportTask :: StartExportTask Source #
Create a value of StartExportTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportDataFormat:StartExportTask', startExportTask_exportDataFormat - The file format for the returned export data. Default value is CSV.
Note: The GRAPHML option has been deprecated.
$sel:startTime:StartExportTask', startExportTask_startTime - The start timestamp for exported data from the single Application
Discovery Agent selected in the filters. If no value is specified, data
is exported starting from the first data collected by the agent.
$sel:filters:StartExportTask', startExportTask_filters - If a filter is present, it selects the single agentId of the
Application Discovery Agent for which data is exported. The agentId
can be found in the results of the DescribeAgents API or CLI. If no
filter is present, startTime and endTime are ignored and exported
data includes both Agentless Discovery Connector data and summary data
from Application Discovery agents.
$sel:endTime:StartExportTask', startExportTask_endTime - The end timestamp for exported data from the single Application
Discovery Agent selected in the filters. If no value is specified,
exported data includes the most recent data collected by the agent.
data StartExportTaskResponse Source #
See: newStartExportTaskResponse smart constructor.
Constructors
| StartExportTaskResponse' (Maybe Text) Int |
Instances
newStartExportTaskResponse Source #
Create a value of StartExportTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportId:StartExportTaskResponse', startExportTaskResponse_exportId - A unique identifier used to query the status of an export request.
$sel:httpStatus:StartExportTaskResponse', startExportTaskResponse_httpStatus - The response's http status code.
Types
AgentStatus
newtype AgentStatus Source #
Constructors
| AgentStatus' | |
Fields | |
Bundled Patterns
| pattern AgentStatus_BLACKLISTED :: AgentStatus | |
| pattern AgentStatus_HEALTHY :: AgentStatus | |
| pattern AgentStatus_RUNNING :: AgentStatus | |
| pattern AgentStatus_SHUTDOWN :: AgentStatus | |
| pattern AgentStatus_UNHEALTHY :: AgentStatus | |
| pattern AgentStatus_UNKNOWN :: AgentStatus |
Instances
BatchDeleteImportDataErrorCode
newtype BatchDeleteImportDataErrorCode Source #
Constructors
| BatchDeleteImportDataErrorCode' | |
Fields | |
Bundled Patterns
Instances
ConfigurationItemType
newtype ConfigurationItemType Source #
Constructors
| ConfigurationItemType' | |
Fields | |
Bundled Patterns
Instances
ContinuousExportStatus
newtype ContinuousExportStatus Source #
Constructors
| ContinuousExportStatus' | |
Fields | |
Bundled Patterns
Instances
DataSource
newtype DataSource Source #
Constructors
| DataSource' | |
Fields | |
Bundled Patterns
| pattern DataSource_AGENT :: DataSource |
Instances
ExportDataFormat
newtype ExportDataFormat Source #
Constructors
| ExportDataFormat' | |
Fields | |
Bundled Patterns
| pattern ExportDataFormat_CSV :: ExportDataFormat | |
| pattern ExportDataFormat_GRAPHML :: ExportDataFormat |
Instances
ExportStatus
newtype ExportStatus Source #
Constructors
| ExportStatus' | |
Fields | |
Bundled Patterns
| pattern ExportStatus_FAILED :: ExportStatus | |
| pattern ExportStatus_IN_PROGRESS :: ExportStatus | |
| pattern ExportStatus_SUCCEEDED :: ExportStatus |
Instances
ImportStatus
newtype ImportStatus Source #
Constructors
| ImportStatus' | |
Fields | |
Bundled Patterns
| pattern ImportStatus_DELETE_COMPLETE :: ImportStatus | |
| pattern ImportStatus_DELETE_FAILED :: ImportStatus | |
| pattern ImportStatus_DELETE_FAILED_LIMIT_EXCEEDED :: ImportStatus | |
| pattern ImportStatus_DELETE_IN_PROGRESS :: ImportStatus | |
| pattern ImportStatus_IMPORT_COMPLETE :: ImportStatus | |
| pattern ImportStatus_IMPORT_COMPLETE_WITH_ERRORS :: ImportStatus | |
| pattern ImportStatus_IMPORT_FAILED :: ImportStatus | |
| pattern ImportStatus_IMPORT_FAILED_RECORD_LIMIT_EXCEEDED :: ImportStatus | |
| pattern ImportStatus_IMPORT_FAILED_SERVER_LIMIT_EXCEEDED :: ImportStatus | |
| pattern ImportStatus_IMPORT_IN_PROGRESS :: ImportStatus | |
| pattern ImportStatus_INTERNAL_ERROR :: ImportStatus |
Instances
ImportTaskFilterName
newtype ImportTaskFilterName Source #
Constructors
| ImportTaskFilterName' | |
Fields | |
Bundled Patterns
| pattern ImportTaskFilterName_IMPORT_TASK_ID :: ImportTaskFilterName | |
| pattern ImportTaskFilterName_NAME :: ImportTaskFilterName | |
| pattern ImportTaskFilterName_STATUS :: ImportTaskFilterName |
Instances
OrderString
newtype OrderString Source #
Constructors
| OrderString' | |
Fields | |
Bundled Patterns
| pattern OrderString_ASC :: OrderString | |
| pattern OrderString_DESC :: OrderString |
Instances
AgentConfigurationStatus
data AgentConfigurationStatus Source #
Information about agents or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.
See: newAgentConfigurationStatus smart constructor.
Instances
newAgentConfigurationStatus :: AgentConfigurationStatus Source #
Create a value of AgentConfigurationStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentId:AgentConfigurationStatus', agentConfigurationStatus_agentId - The agent/connector ID.
$sel:operationSucceeded:AgentConfigurationStatus', agentConfigurationStatus_operationSucceeded - 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.
$sel:description:AgentConfigurationStatus', agentConfigurationStatus_description - 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: newAgentInfo smart constructor.
Constructors
| AgentInfo' (Maybe Text) (Maybe Text) (Maybe [AgentNetworkInfo]) (Maybe Text) (Maybe AgentStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newAgentInfo :: AgentInfo Source #
Create a value of AgentInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostName:AgentInfo', agentInfo_hostName - The name of the host where the agent or connector resides. The host can
be a server or virtual machine.
$sel:lastHealthPingTime:AgentInfo', agentInfo_lastHealthPingTime - Time since agent or connector health was reported.
$sel:agentNetworkInfoList:AgentInfo', agentInfo_agentNetworkInfoList - Network details about the host where the agent or connector resides.
$sel:connectorId:AgentInfo', agentInfo_connectorId - The ID of the connector.
$sel:health:AgentInfo', agentInfo_health - The health of the agent or connector.
$sel:agentId:AgentInfo', agentInfo_agentId - The agent or connector ID.
$sel:version:AgentInfo', agentInfo_version - The agent or connector version.
$sel:collectionStatus:AgentInfo', agentInfo_collectionStatus - Status of the collection process for an agent or connector.
$sel:registeredTime:AgentInfo', agentInfo_registeredTime - Agent's first registration timestamp in UTC.
$sel:agentType:AgentInfo', agentInfo_agentType - Type of agent.
AgentNetworkInfo
data AgentNetworkInfo Source #
Network details about the host where the agent/connector resides.
See: newAgentNetworkInfo smart constructor.
Constructors
| AgentNetworkInfo' (Maybe Text) (Maybe Text) |
Instances
newAgentNetworkInfo :: AgentNetworkInfo Source #
Create a value of AgentNetworkInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipAddress:AgentNetworkInfo', agentNetworkInfo_ipAddress - The IP address for the host where the agent/connector resides.
$sel:macAddress:AgentNetworkInfo', agentNetworkInfo_macAddress - The MAC address for the host where the agent/connector resides.
BatchDeleteImportDataError
data BatchDeleteImportDataError Source #
Error messages returned for each import task that you deleted as a response for this command.
See: newBatchDeleteImportDataError smart constructor.
Constructors
| BatchDeleteImportDataError' (Maybe Text) (Maybe BatchDeleteImportDataErrorCode) (Maybe Text) |
Instances
newBatchDeleteImportDataError :: BatchDeleteImportDataError Source #
Create a value of BatchDeleteImportDataError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:importTaskId:BatchDeleteImportDataError', batchDeleteImportDataError_importTaskId - The unique import ID associated with the error that occurred.
$sel:errorCode:BatchDeleteImportDataError', batchDeleteImportDataError_errorCode - The type of error that occurred for a specific import task.
$sel:errorDescription:BatchDeleteImportDataError', batchDeleteImportDataError_errorDescription - The description of the error that occurred for a specific import task.
ConfigurationTag
data ConfigurationTag Source #
Tags for a configuration item. Tags are metadata that help you categorize IT assets.
See: newConfigurationTag smart constructor.
Constructors
| ConfigurationTag' (Maybe POSIX) (Maybe Text) (Maybe ConfigurationItemType) (Maybe Text) (Maybe Text) |
Instances
newConfigurationTag :: ConfigurationTag Source #
Create a value of ConfigurationTag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeOfCreation:ConfigurationTag', configurationTag_timeOfCreation - The time the configuration tag was created in Coordinated Universal Time
(UTC).
$sel:configurationId:ConfigurationTag', configurationTag_configurationId - The configuration ID for the item to tag. You can specify a list of keys
and values.
$sel:configurationType:ConfigurationTag', configurationTag_configurationType - A type of IT asset to tag.
$sel:value:ConfigurationTag', configurationTag_value - A value on which to filter. For example key = serverType and /value =
web server/.
$sel:key:ConfigurationTag', configurationTag_key - A type of tag on which to filter. For example, serverType.
ContinuousExportDescription
data ContinuousExportDescription Source #
A list of continuous export descriptions.
See: newContinuousExportDescription smart constructor.
Constructors
| ContinuousExportDescription' (Maybe ContinuousExportStatus) (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe POSIX) (Maybe DataSource) (Maybe Text) (Maybe Text) |
Instances
newContinuousExportDescription :: ContinuousExportDescription Source #
Create a value of ContinuousExportDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ContinuousExportDescription', continuousExportDescription_status - Describes the status of the export. Can be one of the following values:
- START_IN_PROGRESS - setting up resources to start continuous export.
- START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.
- ACTIVE - data is being exported to the customer bucket.
- ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.
- STOP_IN_PROGRESS - stopping the export.
- STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.
- INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.
$sel:startTime:ContinuousExportDescription', continuousExportDescription_startTime - The timestamp representing when the continuous export was started.
$sel:schemaStorageConfig:ContinuousExportDescription', continuousExportDescription_schemaStorageConfig - An object which describes how the data is stored.
databaseName- the name of the Glue database used to store the schema.
$sel:statusDetail:ContinuousExportDescription', continuousExportDescription_statusDetail - Contains information about any errors that have occurred. This data type
can have the following values:
- ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your AWS administrator for help. For more information, see Setting Up AWS Application Discovery Service in the Application Discovery Service User Guide.
- DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
- FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies in the Application Discovery Service User Guide.
- FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM User is missing one or more of the Kinesis data delivery streams.
- INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact AWS Support.
- S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of Amazon S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.
- S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
$sel:stopTime:ContinuousExportDescription', continuousExportDescription_stopTime - The timestamp that represents when this continuous export was stopped.
$sel:dataSource:ContinuousExportDescription', continuousExportDescription_dataSource - The type of data collector used to gather this data (currently only
offered for AGENT).
$sel:s3Bucket:ContinuousExportDescription', continuousExportDescription_s3Bucket - The name of the s3 bucket where the export data parquet files are
stored.
$sel:exportId:ContinuousExportDescription', continuousExportDescription_exportId - The unique ID assigned to this export.
CustomerAgentInfo
data CustomerAgentInfo Source #
Inventory data for installed discovery agents.
See: newCustomerAgentInfo smart constructor.
Instances
Create a value of CustomerAgentInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeAgents:CustomerAgentInfo', customerAgentInfo_activeAgents - Number of active discovery agents.
$sel:healthyAgents:CustomerAgentInfo', customerAgentInfo_healthyAgents - Number of healthy discovery agents
$sel:blackListedAgents:CustomerAgentInfo', customerAgentInfo_blackListedAgents - Number of blacklisted discovery agents.
$sel:shutdownAgents:CustomerAgentInfo', customerAgentInfo_shutdownAgents - Number of discovery agents with status SHUTDOWN.
$sel:unhealthyAgents:CustomerAgentInfo', customerAgentInfo_unhealthyAgents - Number of unhealthy discovery agents.
$sel:totalAgents:CustomerAgentInfo', customerAgentInfo_totalAgents - Total number of discovery agents.
$sel:unknownAgents:CustomerAgentInfo', customerAgentInfo_unknownAgents - Number of unknown discovery agents.
CustomerConnectorInfo
data CustomerConnectorInfo Source #
Inventory data for installed discovery connectors.
See: newCustomerConnectorInfo smart constructor.
Instances
newCustomerConnectorInfo Source #
Create a value of CustomerConnectorInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeConnectors:CustomerConnectorInfo', customerConnectorInfo_activeConnectors - Number of active discovery connectors.
$sel:healthyConnectors:CustomerConnectorInfo', customerConnectorInfo_healthyConnectors - Number of healthy discovery connectors.
$sel:blackListedConnectors:CustomerConnectorInfo', customerConnectorInfo_blackListedConnectors - Number of blacklisted discovery connectors.
$sel:shutdownConnectors:CustomerConnectorInfo', customerConnectorInfo_shutdownConnectors - Number of discovery connectors with status SHUTDOWN,
$sel:unhealthyConnectors:CustomerConnectorInfo', customerConnectorInfo_unhealthyConnectors - Number of unhealthy discovery connectors.
$sel:totalConnectors:CustomerConnectorInfo', customerConnectorInfo_totalConnectors - Total number of discovery connectors.
$sel:unknownConnectors:CustomerConnectorInfo', customerConnectorInfo_unknownConnectors - 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: newExportFilter smart constructor.
Constructors
| ExportFilter' Text [Text] Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExportFilter |
Create a value of ExportFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ExportFilter', exportFilter_name - A single ExportFilter name. Supported filters: agentId.
$sel:values:ExportFilter', exportFilter_values - 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.
$sel:condition:ExportFilter', exportFilter_condition - Supported condition: EQUALS
ExportInfo
data ExportInfo Source #
Information regarding the export status of discovered data. The value is an array of objects.
See: newExportInfo smart constructor.
Constructors
| ExportInfo' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Bool) Text ExportStatus Text POSIX |
Instances
Arguments
| :: Text | |
| -> ExportStatus | |
| -> Text | |
| -> UTCTime | |
| -> ExportInfo |
Create a value of ExportInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationsDownloadUrl:ExportInfo', exportInfo_configurationsDownloadUrl - A URL for an Amazon S3 bucket where you can review the exported data.
The URL is displayed only if the export succeeded.
$sel:requestedStartTime:ExportInfo', exportInfo_requestedStartTime - The value of startTime parameter in the StartExportTask request. If
no startTime was requested, this result does not appear in
ExportInfo.
$sel:requestedEndTime:ExportInfo', exportInfo_requestedEndTime - The endTime used in the StartExportTask request. If no endTime was
requested, this result does not appear in ExportInfo.
$sel:isTruncated:ExportInfo', exportInfo_isTruncated - 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.
$sel:exportId:ExportInfo', exportInfo_exportId - A unique identifier used to query an export.
$sel:exportStatus:ExportInfo', exportInfo_exportStatus - The status of the data export job.
$sel:statusMessage:ExportInfo', exportInfo_statusMessage - A status message provided for API callers.
$sel:exportRequestTime:ExportInfo', exportInfo_exportRequestTime - 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 in the AWS Application Discovery Service User Guide.
See: newFilter smart constructor.
Instances
| Eq Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.Discovery.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.Discovery.Types.Filter | |
| ToJSON Filter Source # | |
Defined in Amazonka.Discovery.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.Discovery.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.Discovery.Types.Filter" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Filter', filter_name - The name of the filter.
$sel:values:Filter', filter_values - A string value on which to filter. For example, if you choose the
destinationServer.osVersion filter name, you could specify Ubuntu
for the value.
$sel:condition:Filter', filter_condition - 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.
ImportTask
data ImportTask Source #
An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
See: newImportTask smart constructor.
Constructors
| ImportTask' (Maybe Int) (Maybe ImportStatus) (Maybe Int) (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newImportTask :: ImportTask Source #
Create a value of ImportTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationImportSuccess:ImportTask', importTask_applicationImportSuccess - The total number of application records in the import file that were
successfully imported.
$sel:status:ImportTask', importTask_status - The status of the import task. An import can have the status of
IMPORT_COMPLETE and still have some records fail to import from the
overall request. More information can be found in the downloadable
archive defined in the errorsAndFailedEntriesZip field, or in the
Migration Hub management console.
$sel:serverImportSuccess:ImportTask', importTask_serverImportSuccess - The total number of server records in the import file that were
successfully imported.
$sel:importCompletionTime:ImportTask', importTask_importCompletionTime - The time that the import task request finished, presented in the Unix
time stamp format.
$sel:name:ImportTask', importTask_name - A descriptive name for an import task. You can use this name to filter
future requests related to this import task, such as identifying
applications and servers that were included in this import task. We
recommend that you use a meaningful name for each import task.
$sel:applicationImportFailure:ImportTask', importTask_applicationImportFailure - The total number of application records in the import file that failed
to be imported.
$sel:errorsAndFailedEntriesZip:ImportTask', importTask_errorsAndFailedEntriesZip - A link to a compressed archive folder (in the ZIP format) that contains
an error log and a file of failed records. You can use these two files
to quickly identify records that failed, why they failed, and correct
those records. Afterward, you can upload the corrected file to your
Amazon S3 bucket and create another import task request.
This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.
If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.
$sel:importTaskId:ImportTask', importTask_importTaskId - The unique ID for a specific import task. These IDs aren't globally
unique, but they are unique within an AWS account.
$sel:importDeletedTime:ImportTask', importTask_importDeletedTime - The time that the import task request was deleted, presented in the Unix
time stamp format.
$sel:serverImportFailure:ImportTask', importTask_serverImportFailure - The total number of server records in the import file that failed to be
imported.
$sel:clientRequestToken:ImportTask', importTask_clientRequestToken - A unique token used to prevent the same import request from occurring
more than once. If you didn't provide a token, a token was
automatically generated when the import task request was sent.
$sel:importUrl:ImportTask', importTask_importUrl - The URL for your import file that you've uploaded to Amazon S3.
$sel:importRequestTime:ImportTask', importTask_importRequestTime - The time that the import task request was made, presented in the Unix
time stamp format.
ImportTaskFilter
data ImportTaskFilter Source #
A name-values pair of elements you can use to filter the results when querying your import tasks. Currently, wildcards are not supported for filters.
When filtering by import status, all other filter values are ignored.
See: newImportTaskFilter smart constructor.
Constructors
| ImportTaskFilter' (Maybe (NonEmpty Text)) (Maybe ImportTaskFilterName) |
Instances
newImportTaskFilter :: ImportTaskFilter Source #
Create a value of ImportTaskFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:ImportTaskFilter', importTaskFilter_values - An array of strings that you can provide to match against a specific
name, status, or import task ID to filter the results for your import
task queries.
$sel:name:ImportTaskFilter', importTaskFilter_name - The name, status, or import task ID for a specific import task.
NeighborConnectionDetail
data NeighborConnectionDetail Source #
Details about neighboring servers.
See: newNeighborConnectionDetail smart constructor.
Instances
newNeighborConnectionDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> Integer | |
| -> NeighborConnectionDetail |
Create a value of NeighborConnectionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:transportProtocol:NeighborConnectionDetail', neighborConnectionDetail_transportProtocol - The network protocol used for the connection.
$sel:destinationPort:NeighborConnectionDetail', neighborConnectionDetail_destinationPort - The destination network port for the connection.
$sel:sourceServerId:NeighborConnectionDetail', neighborConnectionDetail_sourceServerId - The ID of the server that opened the network connection.
$sel:destinationServerId:NeighborConnectionDetail', neighborConnectionDetail_destinationServerId - The ID of the server that accepted the network connection.
$sel:connectionsCount:NeighborConnectionDetail', neighborConnectionDetail_connectionsCount - The number of open network connections with the neighboring server.
OrderByElement
data OrderByElement Source #
A field and direction for ordered output.
See: newOrderByElement smart constructor.
Constructors
| OrderByElement' (Maybe OrderString) Text |
Instances
Arguments
| :: Text | |
| -> OrderByElement |
Create a value of OrderByElement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sortOrder:OrderByElement', orderByElement_sortOrder - Ordering direction.
$sel:fieldName:OrderByElement', orderByElement_fieldName - The field on which to order.
Tag
Metadata that help you categorize IT assets.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Discovery.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.Discovery.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.Discovery.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Discovery.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Discovery.Types.Tag" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The type of tag on which to filter.
$sel:value:Tag', tag_value - A value for a tag key on which to filter.
TagFilter
The tag filter. Valid names are: tagKey, tagValue,
configurationId.
See: newTagFilter smart constructor.
Constructors
| TagFilter' Text [Text] |
Instances
| Eq TagFilter Source # | |
| Read TagFilter Source # | |
| Show TagFilter Source # | |
| Generic TagFilter Source # | |
| NFData TagFilter Source # | |
Defined in Amazonka.Discovery.Types.TagFilter | |
| Hashable TagFilter Source # | |
Defined in Amazonka.Discovery.Types.TagFilter | |
| ToJSON TagFilter Source # | |
Defined in Amazonka.Discovery.Types.TagFilter | |
| type Rep TagFilter Source # | |
Defined in Amazonka.Discovery.Types.TagFilter type Rep TagFilter = D1 ('MetaData "TagFilter" "Amazonka.Discovery.Types.TagFilter" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "TagFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) | |
Create a value of TagFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TagFilter', tagFilter_name - A name of the tag filter.
$sel:values:TagFilter', tagFilter_values - Values for the tag filter.