Comprehend / Paginator / ListTopicsDetectionJobs

ListTopicsDetectionJobs#

class Comprehend.Paginator.ListTopicsDetectionJobs#

paginator = client.get_paginator('list_topics_detection_jobs')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Comprehend.Client.list_topics_detection_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Filter (dict) –
Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.
- JobName (string) –
- JobStatus (string) –
  
  Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
- SubmitTimeBefore (datetime) –
  
  Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
- SubmitTimeAfter (datetime) –
  
  Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
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

{
    'TopicsDetectionJobPropertiesList': [
        {
            'JobId': 'string',
            'JobArn': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'S3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
                'DocumentReaderConfig': {
                    'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes': [
                        'TABLES'|'FORMS',
                    ]
                }
            },
            'OutputDataConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            },
            'NumberOfTopics': 123,
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string',
            'VpcConfig': {
                'SecurityGroupIds': [
                    'string',
                ],
                'Subnets': [
                    'string',
                ]
            }
        },
    ],

}

Response Structure

(dict) –
- TopicsDetectionJobPropertiesList (list) –
  
  A list containing the properties of each job that is returned.
  - (dict) –
    
    Provides information about a topic detection job.
    - JobId (string) –
      
      The identifier assigned to the topic detection job.
    - JobArn (string) –
      
      The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
    - JobName (string) –
      
      The name of the topic detection job.
    - JobStatus (string) –
      
      The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    - Message (string) –
      
      A description for the status of a job.
    - SubmitTime (datetime) –
      
      The time that the topic detection job was submitted for processing.
    - EndTime (datetime) –
      
      The time that the topic detection job was completed.
    - InputDataConfig (dict) –
      
      The input data configuration supplied when you created the topic detection job.
      - S3Uri (string) –
        
        The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.
        
        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
      - InputFormat (string) –
        
        Specifies how the text in an input file should be processed:
        
        ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
        
        ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
      - DocumentReaderConfig (dict) –
        
        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
        
        DocumentReadAction (string) –
        
        This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
        
        TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.
        
        TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.
        
        DocumentReadMode (string) –
        
        Determines the text extraction actions for PDF files. Enter one of the following values:
        
        SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.
        
        FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
        
        FeatureTypes (list) –
        
        Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
        
        TABLES - Returns information about any tables that are detected in the input document.
        
        FORMS - Returns information and the data from any forms that are detected in the input document.
        
        (string) –
        
        Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
        
        TABLES - Returns additional information about any tables that are detected in the input document.
        
        FORMS - Returns additional information about any forms that are detected in the input document.
    - OutputDataConfig (dict) –
      
      The output data configuration supplied when you created the topic detection job.
      - S3Uri (string) –
        
        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.
        
        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.
        
        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
      - KmsKeyId (string) –
        
        ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
        
        KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
        
        Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        
        KMS Key Alias: "alias/ExampleAlias"
        
        ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
    - NumberOfTopics (integer) –
      
      The number of topics to detect supplied when you created the topic detection job. The default is 10.
    - DataAccessRoleArn (string) –
      
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your job data.
    - VolumeKmsKeyId (string) –
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - VpcConfig (dict) –
      
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
      - SecurityGroupIds (list) –
        
        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by “sg-”, for instance: “sg-03b388029b0a285ea”. For more information, see Security Groups for your VPC.
        
        (string) –
      - Subnets (list) –
        
        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by “subnet-”, for instance: “subnet-04ccf456919e69055”. For more information, see VPCs and Subnets.
        
        (string) –