AWS Application Discovery Service

Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.

See also: AWS API Documentation

Request Syntax

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

type exportIds:

list

param exportIds:

The unique IDs assigned to the exports.

• (string) --

type maxResults:

integer

param maxResults:

A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

type nextToken:

string

param nextToken:

The token from the previous call to DescribeExportTasks.

rtype:

dict

returns:

Response Syntax

{
    'descriptions': [
        {
            'exportId': 'string',
            'status': 'START_IN_PROGRESS'|'START_FAILED'|'ACTIVE'|'ERROR'|'STOP_IN_PROGRESS'|'STOP_FAILED'|'INACTIVE',
            'statusDetail': 'string',
            's3Bucket': 'string',
            'startTime': datetime(2015, 1, 1),
            'stopTime': datetime(2015, 1, 1),
            'dataSource': 'AGENT',
            'schemaStorageConfig': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • descriptions (list) --

    A list of continuous export descriptions.

    • (dict) --

      A list of continuous export descriptions.

      • exportId (string) --

        The unique ID assigned to this export.

      • status (string) --

        Describes the status of the export. Can be one of the following values:

        • START_IN_PROGRESS - setting up resources to start continuous export.

        • START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.

        • ACTIVE - data is being exported to the customer bucket.

        • ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.

        • STOP_IN_PROGRESS - stopping the export.

        • STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.

        • INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

      • statusDetail (string) --

        Contains information about any errors that may have occurred.

      • s3Bucket (string) --

        The name of the s3 bucket where the export data parquet files are stored.

      • startTime (datetime) --

        The timestamp representing when the continuous export was started.

      • stopTime (datetime) --

        The timestamp that represents when this continuous export was stopped.

      • dataSource (string) --

        The type of data collector used to gather this data (currently only offered for AGENT).

      • schemaStorageConfig (dict) --

        An object which describes how the data is stored.

        • databaseName - the name of the Glue database used to store the schema.

        • (string) --

          • (string) --

  • nextToken (string) --

    The token from the previous call to DescribeExportTasks.

Start the continuous flow of agent's discovered data into Amazon Athena.

See also: AWS API Documentation

Request Syntax

client.start_continuous_export()

rtype:

dict

returns:

Response Syntax

{
    'exportId': 'string',
    's3Bucket': 'string',
    'startTime': datetime(2015, 1, 1),
    'dataSource': 'AGENT',
    'schemaStorageConfig': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • exportId (string) --

    The unique ID assigned to this export.

  • s3Bucket (string) --

    The name of the s3 bucket where the export data parquet files are stored.

  • startTime (datetime) --

    The timestamp representing when the continuous export was started.

  • dataSource (string) --

    The type of data collector used to gather this data (currently only offered for AGENT).

  • schemaStorageConfig (dict) --

    A dictionary which describes how the data is stored.

    • databaseName - the name of the Glue database used to store the schema.

    • (string) --

      • (string) --

Stop the continuous flow of agent's discovered data into Amazon Athena.

See also: AWS API Documentation

Request Syntax

client.stop_continuous_export(
    exportId='string'
)

type exportId:

string

param exportId:

[REQUIRED]

The unique ID assigned to this export.

rtype:

dict

returns:

Response Syntax

{
    'startTime': datetime(2015, 1, 1),
    'stopTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • startTime (datetime) --

    Timestamp that represents when this continuous export started collecting data.

  • stopTime (datetime) --

    Timestamp that represents when this continuous export was stopped.