ApplicationDiscoveryService / Paginator / DescribeExportConfigurations

DescribeExportConfigurations#

class ApplicationDiscoveryService.Paginator.DescribeExportConfigurations#
paginator = client.get_paginator('describe_export_configurations')
paginate(**kwargs)#

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    exportIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • exportIds (list) –

    A list of continuous export IDs to search for.

    • (string) –

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

dict

Returns:

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) –

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