on_job_list Event
Fires once for each job returned when calling ListJobs or GetJobInfo.
Syntax
class AmazonGlacierJobListEventParams(object): @property def job_type() -> int: ... @property def archive_id() -> str: ... @property def archive_size() -> int: ... @property def archive_sha256_tree_hash() -> str: ... @property def completed() -> bool: ... @property def completion_date() -> str: ... @property def creation_date() -> str: ... @property def description() -> str: ... @property def job_id() -> str: ... @property def sns_topic() -> str: ... @property def sha256_tree_hash() -> str: ... @property def status_code() -> int: ... @property def status_message() -> str: ... @property def vault_arn() -> str: ... @property def inventory_size() -> int: ... # In class AmazonGlacier: @property def on_job_list() -> Callable[[AmazonGlacierJobListEventParams], None]: ... @on_job_list.setter def on_job_list(event_hook: Callable[[AmazonGlacierJobListEventParams], None]) -> None: ...
Remarks
This event fires once for each job returned when calling list_jobs. When calling get_job_info this event will fire once since only one job is returned.
JobType indicates the type of job. Possible values are:
| 0 | Archive Retrieval |
| 1 | Inventory Retrieval |
ArchiveId is the Id of the archive associated with the job.
ArchiveSize is the size in bytes of the archive.
ArchiveSHA256TreeHash is the SHA256 tree hash of the entire archive for an archive retrieval job.
Completed indicates the status of the job.
CompletionDate is the UTC time that the job completed.
CreationDate is the UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".
Description is the user supplied description. This is specified by the JobDescription setting before calling create_job.
JobId is the Amazon assigned Id for the job.
SNSTopic is the Amazon SNS topic that will receive notification about the job status.
SHA256TreeHash is the SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.
StatusCode is the current status of the job. Possible values are:
| 0 | None |
| 1 | In Progress |
| 2 | Succeeded |
| 3 | Failed |
StatusMessage is a user friendly description of the status.
VaultArn is the Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.
InventorySize is the size in bytes of the inventory data.