ジョブの説明 (GET JobID)

説明

このオペレーションでは、以前に開始したジョブに関する情報 (ジョブの開始日、ジョブを開始したユーザー、ジョブのステータスコード、ジョブのステータスメッセージ)、Amazon S3 Glacier (S3 Glacier) がジョブの完了後に通知する Amazon Simple Notification Service (Amazon SNS) トピックなどが返されます。ジョブの開始の詳細については、「ジョブの開始 (ジョブの POST)」を参照してください。

注記

このオペレーションにより、ジョブのステータスを確認することができます。ただし、S3 Glacier がジョブの完了後に Amazon SNS トピックに通知できるように、トピックを設定してジョブの開始リクエストでそのトピックを指定することを強くお勧めします。

ジョブ ID は、S3 Glacier がジョブを完了してから少なくとも 24 時間は有効です。

リクエスト

構文

ジョブに関する情報を取得するには、HTTP GET メソッドを使用し、特定のジョブをリクエストの範囲として指定します。相対 URI パスは、ジョブを開始したときに S3 Glacier によって返されたパスと同じであることに注意してください。

GET /AccountID/vaults/VaultName/jobs/JobID HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: date
Authorization: signatureValue
x-amz-glacier-version: 2012-06-01

注記

-AccountIdvalueAWS アカウントボールトを所有するアカウントの ID。AWS アカウント ID、または Amazon S3 Glacier がリクエストの署名に使用した認証情報に関連する AWS アカウント ID を使用している場合はオプションで`-`「-」のどちらかを指定できます。アカウント ID を使用する場合は、ID にハイフン ('-') を含めないでください。

注記

リクエストで JobID を指定しなかった場合、レスポンスでは、指定したボールトのすべてのアクティブなジョブのリストが返されます。ジョブのリストの詳細については、「ジョブのリスト表示 (GET jobs)」を参照してください。

リクエストパラメータ

このオペレーションではリクエストパラメータを使用しません。

リクエストヘッダー

この操作では、すべての操作で共通のリクエストヘッダーのみ使用します。共通のリクエストヘッダーの詳細については、「一般的なリクエストヘッダー」を参照してください。

リクエスト本文

この操作にリクエストボディはありません。

レスポンス

構文

HTTP/1.1 201 Created
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: Length

{
    "Action": "string",
    "ArchiveId": "string",
    "ArchiveSHA256TreeHash": "string",
    "ArchiveSizeInBytes": number,
    "Completed": boolean,
    "CompletionDate": "string",
    "CreationDate": "string",
    "InventoryRetrievalParameters": {
        "EndDate": "string",
        "Format": "string",
        "Limit": "string",
        "Marker": "string",
        "StartDate": "string"
    },
    "InventorySizeInBytes": number,
    "JobDescription": "string",
    "JobId": "string",
    "JobOutputPath": "string",
    "OutputLocation": {
        "S3": {
            "AccessControlList": [
                {
                    "Grantee": {
                        "DisplayName": "string",
                        "EmailAddress": "string",
                        "ID": "string",
                        "Type": "string",
                        "URI": "string"
                    },
                    "Permission": "string"
                }
            ],
            "BucketName": "string",
            "CannedACL": "string",
            "Encryption": {
                "EncryptionType": "string",
                "KMSContext": "string",
                "KMSKeyId": "string"
            },
            "Prefix": "string",
            "StorageClass": "string",
            "Tagging": {
                "string": "string"
            },
            "UserMetadata": {
                "string": "string"
            }
        }
    },
    "RetrievalByteRange": "string",
    "SelectParameters": {
        "Expression": "string",
        "ExpressionType": "string",
        "InputSerialization": {
            "csv": {
                "Comments": "string",
                "FieldDelimiter": "string",
                "FileHeaderInfo": "string",
                "QuoteCharacter": "string",
                "QuoteEscapeCharacter": "string",
                "RecordDelimiter": "string"
            }
        },
        "OutputSerialization": {
            "csv": {
                "FieldDelimiter": "string",
                "QuoteCharacter": "string",
                "QuoteEscapeCharacter": "string",
                "QuoteFields": "string",
                "RecordDelimiter": "string"
            }
        }
    },
    "SHA256TreeHash": "string",
    "SNSTopic": "string",
    "StatusCode": "string",
    "StatusMessage": "string",
    "Tier": "string",
    "VaultARN": "string"
}

レスポンスヘッダー

この操作はほとんどのレスポンスに共通のレスポンスヘッダーのみを使用します。共通のレスポンスヘッダーの詳細については、「共通のレスポンスヘッダー」を参照してください。

レスポンス本文

レスポンス本文には次の JSON フィールドが含まれています。

[Action] (アクション)

ジョブのタイプ。ArchiveRetrieval、InventoryRetrieval、または Select です。

タイプ: 文字列

ArchiveId

選択ジョブまたはアーカイブの取得ジョブにリクエストされたアーカイブ ID。それ以外の場合、このフィールドは null です。

タイプ: 文字列

ArchiveSHA256TreeHash

アーカイブの取得ジョブを行うアーカイブ全体の SHA256 木構造ハッシュ。インベントリの取得ジョブの場合、このフィールドは null です。

タイプ: 文字列

ArchiveSizeInBytes

ArchiveRetrieval ジョブの場合、これはダウンロードに必要なアーカイブのサイズ (バイト単位) です。InventoryRetrieval ジョブの場合、この値は null です。

タイプ: 数値

Completed

ジョブのステータス。アーカイブの取得ジョブまたはインベントリの取得ジョブが完了したら、ジョブの出力の取得 (GET output) を使用してジョブの出力を取得します。

タイプ: ブール

CompletionDate

ジョブリクエストが完了した協定世界時 (UTC) 時間。ジョブが進行中の場合、値は null です。

タイプ: 文字列

CreationDate

ジョブが作成された UTC 時間。

タイプ: ISO 8601 の日付形式の文字列表現。たとえば2013-03-20T17:03:43.221Z。

InventoryRetrievalParameters

インベントリの取得の範囲に使用される入力パラメータ。

タイプ: InventoryRetrievalJobInput オブジェクト

InventorySizeInBytes

InventoryRetrieval ジョブの場合、これはダウンロードに必要なインベントリのサイズ (バイト単位) です。ArchiveRetrieval または Select ジョブの場合、値は null です。

タイプ: 数値

JobDescription

ジョブを開始したときに指定したジョブの説明。

タイプ: 文字列

JobId

でジョブを識別する ID。

タイプ: 文字列

JobOutputPath

ジョブの出力場所が含まれます。

タイプ: 文字列

OutputLocation

選択ジョブの結果とエラーが保存されている場所についての情報を含むオブジェクト。

タイプ: OutputLocation オブジェクト

RetrievalByteRange

"StartByteValue-EndByteValue" という形式で示される、アーカイブの取得ジョブで取得したバイト範囲。アーカイブの取得で範囲を指定しなかった場合は、アーカイブ全体が取得され、また StartByteValue は 0、EndByteValue はアーカイブのサイズから 1 を引いた値になります。インベントリの取得ジョブまたは選択ジョブの場合、このフィールドは null です。

タイプ: 文字列

SelectParameters

選択に使用されるパラメータに関する情報を含むオブジェクト。

タイプ: SelectParameters オブジェクト

SHA256TreeHash

アーカイブのリクエストされた範囲の SHA256 木構造ハッシュ値。アーカイブのジョブの開始 (ジョブの POST)リクエストで木構造ハッシュ可能な範囲を指定した場合、このフィールドに値が返されます。アーカイブの範囲取得で木構造ハッシュを可能にするための調整の詳細については、「データをダウンロードするときのチェックサムの受信」を参照してください。

アーカイブ全体を取得する特別な場合は、この値は ArchiveSHA256TreeHash の値と同じです。

次の場合、このフィールドは null です。

• 木構造ハッシュ可能ではない範囲を指定したアーカイブの取得ジョブ。

• アーカイブ全体を範囲に指定したアーカイブのジョブで、ジョブのステータスが InProgress の場合。

• インベントリジョブ。

• 選択ジョブ。

タイプ: 文字列

SNSTopic

通知を受け取る Amazon SNS トピック。

タイプ: 文字列

StatusCode

ジョブのステータスを示すコード。

有効な値: InProgress | Succeeded | Failed

タイプ: 文字列

StatusMessage

ジョブのステータスを説明するわかりやすいメッセージ。

タイプ: 文字列

階層

選択またはアーカイブの取得に使用するデータアクセス層。

有効な値: Bulk | Expedited | Standard

タイプ: 文字列

VaultARN

ジョブがサブリソースとなるボールトの Amazon リソースネーム (ARN)。

タイプ: 文字列

エラー

Amazon S3 Glacier の例外とエラーメッセージについては、「エラーレスポンス」を参照してください。

例

以下の例は、アーカイブの取得ジョブのリクエストを示しています。

リクエストの例: ジョブの説明を取得する

GET /-/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID HTTP/1.1
Host: glacier.us-west-2.amazonaws.com
x-amz-Date: 20170210T120000Z
x-amz-glacier-version: 2012-06-01
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2

レスポンスの例

レスポンス本文には指定したジョブを説明する JSON が含まれます。インベントリの取得ジョブおよびアーカイブの取得ジョブの場合、JSON フィールドはどちらも同じであることに注意してください。ただし、ジョブのタイプに適用されないフィールドの値は null です。以下は、アーカイブの取得ジョブに対するレスポンスの例です。次の点に注意してください。

• Action フィールドの値は ArchiveRetrieval です。

• ArchiveSizeInBytes フィールドは、アーカイブの取得ジョブでリクエストされたアーカイブのサイズを示しています。

• ArchiveSHA256TreeHash フィールドは、アーカイブ全体の SHA256 木構造ハッシュを示しています。

• RetrievalByteRange フィールドは、ジョブの開始リクエストでリクエストされた範囲を示しています。この例では、アーカイブ全体をリクエストしています。

• SHA256TreeHash フィールドは、ジョブの開始リクエストでリクエストされた範囲の SHA256 木構造ハッシュを示しています。この例では、ArchiveSHA256TreeHash フィールドと同じ値になっています。これは、アーカイブ全体がリクエストされたことを意味します。

• InventorySizeInBytes フィールド値は null です。このフィールドは、アーカイブの取得ジョブには適用されないためです。

HTTP/1.1 200 OK
x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
Date: Wed, 10 Feb 2017 12:00:00 GMT
Content-Type: application/json
Content-Length: 419
{
  "Action": "ArchiveRetrieval",
  "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
  "ArchiveSizeInBytes": 16777216,
  "ArchiveSHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
  "Completed": false,
  "CompletionDate": null,
  "CreationDate": "2012-05-15T17:21:39.339Z",
  "InventorySizeInBytes": null,
  "JobDescription": "My ArchiveRetrieval Job",
  "JobId": "HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
  "RetrievalByteRange": "0-16777215",
  "SHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
  "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic",
  "StatusCode": "InProgress",
  "StatusMessage": "Operation in progress.",
  "Tier": "Bulk",
  "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
} 

以下は、インベントリの取得ジョブに対するレスポンスの例です。次の点に注意してください。

• Action フィールドの値は InventoryRetrieval です。

• ArchiveSizeInBytes フィールド、ArchiveSHA256TreeHash フィールド、および RetrievalByteRange フィールドの値は null です。これらのフィールドはインベントリの取得ジョブに適用されないためです。

• InventorySizeInBytes フィールドの値は null です。ジョブが進行中であり、インベントリをダウンロードする準備が完了していないためです。ジョブの説明リクエストの前にジョブが完了していた場合、このフィールドには出力のサイズが示されることになります。

{
   "Action": "InventoryRetrieval",
   "ArchiveId": null,
   "ArchiveSizeInBytes": null,
   "ArchiveSHA256TreeHash": null,
   "Completed": false,
   "CompletionDate": null,
   "CreationDate": "2012-05-15T23:18:13.224Z",
   "InventorySizeInBytes": null,
   "JobDescription": "Inventory Description",
   "JobId": "HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
   "RetrievalByteRange": null,
   "SHA256TreeHash": null,
   "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic",
   "StatusCode": "InProgress",
   "StatusMessage": "Operation in progress.",
   "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
}

以下は、完了したインベントリ取得ジョブのレスポンスの例です。ボールトインベントリの取得のページ分割を継続する場合に使用するマーカーが含まれています。

{ 
    "Action": "InventoryRetrieval", 
    "ArchiveId": null, 
    "ArchiveSHA256TreeHash": null, 
    "ArchiveSizeInBytes": null, 
    "Completed": true, 
    "CompletionDate": "2013-12-05T21:51:13.591Z", 
    "CreationDate": "2013-12-05T21:51:12.281Z", 
    "InventorySizeInBytes": 777062, 
    "JobDescription": null, 
    "JobId": "sCC2RZNBF2nildYD_roe0J9bHRdPQUbDRkmTdg-mXi2u3lc49uW6TcEhDF2D9pB2phx-BN30JaBru7PMyOlfXHdStzu8", 
    "NextInventoryRetrievalMarker": null, 
    "RetrievalByteRange": null, 
    "SHA256TreeHash": null, 
    "SNSTopic": null, 
    "StatusCode": "Succeeded", 
    "StatusMessage": "Succeeded", 
    "Tier": "Bulk",
    "VaultARN": "arn:aws:glacier-devo:us-west-2:836579025725:vaults/inventory-icecube-2", 
    "InventoryRetrievalParameters": {
        "StartDate": "2013-11-12T13:43:12Z",
        "EndDate": "2013-11-20T08:12:45Z", 
        "Limit": "120000",
        "Format": "JSON",
        "Marker": "vyS0t2jHQe5qbcDggIeD50chS1SXwYMrkVKo0KHiTUjEYxBGCqRLKaiySzdN7QXGVVV5XZpNVG67pCZ_uykQXFMLaxOSu2hO_-5C0AtWMDrfo7LgVOyfnveDRuOSecUo3Ueq7K0"
    },   
}

関連するセクション

• ジョブの出力の取得 (GET output)

• Amazon S3 Glacier の ID とアクセス管理