| 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.StartExportTask
Description
Begins the export of discovered data to an S3 bucket.
If you specify agentIds in a filter, the task exports up to 72 hours
of detailed data collected by the identified Application Discovery
Agent, including network, process, and performance details. A time range
for exported agent data may be set by using startTime and endTime.
Export of detailed agent data is limited to five concurrently running
exports.
If you do not include an agentIds filter, summary data is exported
that includes both AWS Agentless Discovery Connector data and summary
data from AWS Discovery Agents. Export of summary data is limited to two
exports per day.
Synopsis
- data StartExportTask = StartExportTask' {}
- newStartExportTask :: StartExportTask
- startExportTask_exportDataFormat :: Lens' StartExportTask (Maybe [ExportDataFormat])
- startExportTask_startTime :: Lens' StartExportTask (Maybe UTCTime)
- startExportTask_filters :: Lens' StartExportTask (Maybe [ExportFilter])
- startExportTask_endTime :: Lens' StartExportTask (Maybe UTCTime)
- data StartExportTaskResponse = StartExportTaskResponse' {
- exportId :: Maybe Text
- httpStatus :: Int
- newStartExportTaskResponse :: Int -> StartExportTaskResponse
- startExportTaskResponse_exportId :: Lens' StartExportTaskResponse (Maybe Text)
- startExportTaskResponse_httpStatus :: Lens' StartExportTaskResponse Int
Creating a Request
data StartExportTask Source #
See: newStartExportTask smart constructor.
Constructors
| StartExportTask' | |
Fields
| |
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.
Request Lenses
startExportTask_exportDataFormat :: Lens' StartExportTask (Maybe [ExportDataFormat]) Source #
The file format for the returned export data. Default value is CSV.
Note: The GRAPHML option has been deprecated.
startExportTask_startTime :: Lens' StartExportTask (Maybe UTCTime) Source #
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.
startExportTask_filters :: Lens' StartExportTask (Maybe [ExportFilter]) Source #
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.
startExportTask_endTime :: Lens' StartExportTask (Maybe UTCTime) Source #
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.
Destructuring the Response
data StartExportTaskResponse Source #
See: newStartExportTaskResponse smart constructor.
Constructors
| StartExportTaskResponse' | |
Fields
| |
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.
Response Lenses
startExportTaskResponse_exportId :: Lens' StartExportTaskResponse (Maybe Text) Source #
A unique identifier used to query the status of an export request.
startExportTaskResponse_httpStatus :: Lens' StartExportTaskResponse Int Source #
The response's http status code.