ApplicationDiscoveryService / Paginator / DescribeExportTasks


class ApplicationDiscoveryService.Paginator.DescribeExportTasks#
paginator = client.get_paginator('describe_export_tasks')

Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_export_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'name': 'string',
            'values': [
            'condition': 'string'
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • exportIds (list) –

    One or more unique identifiers used to query the status of an export request.

    • (string) –

  • filters (list) –

    One or more filters.

    • AgentId - ID of the agent whose collected data will be exported

    • (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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'exportsInfo': [
            'exportId': 'string',
            'exportStatus': 'FAILED'|'SUCCEEDED'|'IN_PROGRESS',
            'statusMessage': 'string',
            'configurationsDownloadUrl': 'string',
            'exportRequestTime': datetime(2015, 1, 1),
            'isTruncated': True|False,
            'requestedStartTime': datetime(2015, 1, 1),
            'requestedEndTime': datetime(2015, 1, 1)
    'NextToken': 'string'

Response Structure

  • (dict) –

    • exportsInfo (list) –

      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.

      • (dict) –

        Information regarding the export status of discovered data. The value is an array of objects.

        • exportId (string) –

          A unique identifier used to query an export.

        • exportStatus (string) –

          The status of the data export job.

        • statusMessage (string) –

          A status message provided for API callers.

        • configurationsDownloadUrl (string) –

          A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.

        • exportRequestTime (datetime) –

          The time that the data export was initiated.

        • isTruncated (boolean) –

          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.

        • requestedStartTime (datetime) –

          The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.

        • requestedEndTime (datetime) –

          The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.

    • NextToken (string) –

      A token to resume pagination.