mgn / Client / list_import_file_enrichments

list_import_file_enrichments¶

mgn.Client.list_import_file_enrichments(**kwargs)¶

Lists import file enrichment jobs with optional filtering by job IDs.

Request Syntax

response = client.list_import_file_enrichments(
    filters={
        'jobIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

filters (dict) –
Filters to apply when listing import file enrichment jobs.
- jobIDs (list) –
  
  A list of job IDs to filter by.
  - (string) –
maxResults (integer) – The maximum number of results to return in a single call.
nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'jobID': 'string',
            'createdAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED'|'SUCCEEDED_WITH_WARNINGS',
            'statusDetails': 'string',
            'checksum': {
                'encryptionAlgorithm': 'SHA256',
                'hash': 'string'
            },
            's3BucketTarget': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of import file enrichment jobs.
  - (dict) –
    
    Details about an import file enrichment job.
    - jobID (string) –
      
      The unique identifier of the import file enrichment job.
    - createdAt (datetime) –
      
      The timestamp when the enrichment job was created.
    - endedAt (datetime) –
      
      The timestamp when the enrichment job completed or failed.
    - status (string) –
      
      The current status of the import file enrichment job.
    - statusDetails (string) –
      
      Detailed status information about the enrichment job.
    - checksum (dict) –
      
      The checksum of the enriched file for integrity verification.
      - encryptionAlgorithm (string) –
        
        The encryption algorithm used to generate the checksum.
      - hash (string) –
        
        The hash value of the checksum.
    - s3BucketTarget (dict) –
      
      The target S3 configuration for the enriched import file.
      - s3Bucket (string) –
        
        The name of the S3 bucket where the enriched import file will be stored.
      - s3BucketOwner (string) –
        
        The AWS account ID of the target S3 bucket owner.
      - s3Key (string) –
        
        The S3 key (path) where the enriched import file will be stored.
- nextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

mgn.Client.exceptions.ValidationException