ApplicationDiscoveryService / Paginator / DescribeContinuousExports

DescribeContinuousExports#

class ApplicationDiscoveryService.Paginator.DescribeContinuousExports#

paginator = client.get_paginator('describe_continuous_exports')

paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

exportIds (list) –
The unique IDs assigned to the exports.
- (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

{
    '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 have occurred. This data type can have the following values:
      - ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery Service User Guide.
      - DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
      - FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies in the Application Discovery Service User Guide.
      - FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM User is missing one or more of the Kinesis data delivery streams.
      - INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact Amazon Web Services Support.
      - LAKE_FORMATION_ACCESS_DENIED - You don’t have sufficient lake formation permissions to start continuous export. For more information, see `Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model <http://docs.aws.amazon.com/lake-formation/latest/dg/upgrade-glue-lake-formation.html>`__in the Amazon Web Services Lake Formation Developer Guide. You can use one of the following two ways to resolve this issue.
        
        If you don’t want to use the Lake Formation permission model, you can change the default Data Catalog settings to use only Amazon Web Services Identity and Access Management (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation Developer Guide.
        
        You can give the service-linked IAM roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For more information, see Granting Database Permissions in the Lake Formation Developer Guide.
        
        AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database creator permissions, which gives the role database creation ability and implicit permissions for any created tables. For more information, see `Implicit Lake Formation Permissions <https://docs.aws.amazon.com/lake-formation/latest/dg/implicit-permissions.html>`__in the Lake Formation Developer Guide.
        
        AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all tables in the database.
      - S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.
      - S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
    - 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) –
  
  A token to resume pagination.