AWS Application Discovery Service

Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.

See also: AWS API Documentation

Request Syntax

client.start_export_task(
    exportDataFormat=[
        'CSV'|'GRAPHML',
    ]
)

type exportDataFormat

list

param exportDataFormat

The file format for the returned export data. Default value is CSV .

• (string) --

rtype

dict

returns

Response Syntax

{
    'exportId': 'string'
}

Response Structure

• (dict) --

  • exportId (string) --

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

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

See also: AWS API Documentation

Request Syntax

client.describe_export_tasks(
    exportIds=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

type exportIds

list

param exportIds

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

• (string) --

type maxResults

integer

param maxResults

The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.

type nextToken

string

param nextToken

The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

rtype

dict

returns

Response Syntax

{
    'exportsInfo': [
        {
            'exportId': 'string',
            'exportStatus': 'FAILED'|'SUCCEEDED'|'IN_PROGRESS',
            'statusMessage': 'string',
            'configurationsDownloadUrl': 'string',
            'exportRequestTime': 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 the discovered data. The value is an array of objects.

      • exportId (string) --

        A unique identifier that you can use to query the export.

      • exportStatus (string) --

        The status of the configuration data export. The status can succeed, fail, or be in-progress.

      • statusMessage (string) --

        Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.

      • configurationsDownloadUrl (string) --

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

      • exportRequestTime (datetime) --

        The time that the configuration data export was initiated.

  • nextToken (string) --

    The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.