startExportTask method

Future<StartExportTaskResponse> startExportTask({ DateTime? endTime, List<ExportDataFormat>? exportDataFormat, List<ExportFilter>? filters, DateTime? startTime, })

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.

May throw AuthorizationErrorException. May throw InvalidParameterException. May throw InvalidParameterValueException. May throw ServerInternalErrorException. May throw OperationNotPermittedException. May throw HomeRegionNotSetException.

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

Parameter exportDataFormat : The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

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

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

Implementation

Future<StartExportTaskResponse> startExportTask({
  DateTime? endTime,
  List<ExportDataFormat>? exportDataFormat,
  List<ExportFilter>? filters,
  DateTime? startTime,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSPoseidonService_V2015_11_01.StartExportTask'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (endTime != null) 'endTime': unixTimestampToJson(endTime),
      if (exportDataFormat != null)
        'exportDataFormat': exportDataFormat.map((e) => e.toValue()).toList(),
      if (filters != null) 'filters': filters,
      if (startTime != null) 'startTime': unixTimestampToJson(startTime),
    },
  );

  return StartExportTaskResponse.fromJson(jsonResponse.body);
}