Task

Tasks to interact with the Archivematica REST API

source

Task

 Task (dashboard_url:str, dashboard_username:str, dashboard_api_key:str,
       storage_service_url:str, storage_service_username:str,
       storage_service_password:str, aws_access_key_id:str,
       aws_secret_access_key:str, aws_region:str)

*Constructor for the Task class. Initializes the Matica API client and the AWS S3 client.

Args: dashboard_url (str): URL for the Matica dashboard. dashboard_username (str): Username for the Matica dashboard. dashboard_api_key (str): API key for the Matica dashboard. storage_service_url (str): URL for the storage service. storage_service_username (str): Username for the storage service. storage_service_password (str): Password for the storage service. aws_access_key_id (str): AWS access key ID. aws_secret_access_key (str): AWS secret access key. aws_region (str): AWS region.*

Main


source

Task.main

 Task.main (dashboard_url:str, dashboard_username:str,
            dashboard_api_key:str, storage_service_url:str,
            storage_service_username:str, storage_service_password:str,
            aws_access_key_id:str, aws_secret_access_key:str, task_id:str,
            transfer_type:str, transfer_name:str, file_path:str,
            location_uuid:str, processing_config:str, bucket_name:str,
            transfer_source_prefix:str, aws_region:str)

*Executes the main process. Uploads a ZIP file to S3, then triggers processing in Matica.

Args: The following arguments are similar to those in the init method. task_id (str): Task ID. transfer_type (str): Transfer type. transfer_name (str): Transfer name. file_path (str): File path. location_uuid (str): Location UUID. processing_config (str): Processing configuration. bucket_name (str): Bucket name. transfer_source_prefix (str): Transfer source prefix. aws_region (str): AWS region.

Returns: Optional[str]: The URL of the processed file if successful, None otherwise.*