ApplicationDiscoveryService / Client / start_export_task

start_export_task#

ApplicationDiscoveryService.Client.start_export_task(**kwargs)#

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 Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery Agents. Export of summary data is limited to two exports per day.

See also: AWS API Documentation

Request Syntax

response = client.start_export_task(
    exportDataFormat=[
        'CSV'|'GRAPHML',
    ],
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ],
            'condition': 'string'
        },
    ],
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
Parameters:

  • exportDataFormat (list) –

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

    • (string) –

  • filters (list) –

    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.

    • (dict) –

      Used to select which agent’s data is to be exported. A single agent ID may be selected for export using the StartExportTask action.

      • name (string) – [REQUIRED]

        A single ExportFilter name. Supported filters: agentIds.

      • values (list) – [REQUIRED]

        A single agent ID for a Discovery Agent. An agent ID can be found using the DescribeAgents action. Typically an ADS agent ID is in the form o-0123456789abcdef0.

        • (string) –

      • condition (string) – [REQUIRED]

        Supported condition: EQUALS

  • startTime (datetime) – 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.

  • endTime (datetime) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'exportId': 'string'
}

Response Structure

  • (dict) –

    • exportId (string) –

      A unique identifier used to query the status of an export request.

Exceptions

  • ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException

  • ApplicationDiscoveryService.Client.exceptions.InvalidParameterException

  • ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException

  • ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException

  • ApplicationDiscoveryService.Client.exceptions.OperationNotPermittedException

  • ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException