mgn / Paginator / ListImportFileEnrichments

ListImportFileEnrichments

class mgn.Paginator.ListImportFileEnrichments

paginator = client.get_paginator('list_import_file_enrichments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from mgn.Client.list_import_file_enrichments().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• filters (dict) –

  Filters to apply when listing import file enrichment jobs.

  • jobIDs (list) –

    A list of job IDs to filter by.

    • (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

{
    '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) –

    A token to resume pagination.