jobParameters

ジョブを定義するためのオプションを提供します。

目次

ArchiveId

必要なアーカイブの ID。このフィールドは、Type フィールドが select または archive-retrieval に設定されている場合に必要です。インベントリ取得ジョブのリクエストでこのフィールドを指定すると、エラーが発生します。

有効な値: Amazon S3 Glacier (S3 Glacier) に対する以前のリクエストで取得した有効なアーカイブ ID である必要があります。

タイプ: 文字列

必須: はい (Type が select または archive-retrieval に設定されている場合)

説明

ジョブの任意の説明。

有効な値: 説明は 1,024 バイト以下である必要があります。使用可能な文字は、制御コードを除く 7 ビット ASCII コードです。具体的には、32-126 (10 進) または 0x20-0x7E (16 進) の ASCII 値です。

タイプ: 文字列

必須: いいえ

[Format] (形式)

(オプション) ボールトインベントリを取得するジョブを開始する場合の出力形式。インベントリジョブを開始する際に、Format フィールドを指定しなかった場合、デフォルトの形式は JSON です。

有効な値: CSV | JSON

タイプ: 文字列

必須: いいえ

InventoryRetrievalParameters

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

タイプ: InventoryRetrievalJobInput オブジェクト

必須: いいえ

OutputLocation

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

タイプ: OutputLocation オブジェクト

必須: はい (select ジョブの場合)

RetrievalByteRange

取得するバイト範囲archive-retrieval、という形式にします。StartByteValue-EndByteValue「。このフィールドが指定されていない場合、アーカイブ全体が取得されます。このフィールドを指定する場合、バイト範囲はメガバイト単位 (1024 x 1024) に調整されている必要があります。メガバイト単位に調整するとは、StartByteValue は 1 MB で割り切れる値、EndByteValue は 1 を足すと 1 MB で割り切れる値またはアーカイブの終了値 (アーカイブのバイトサイズの値から 1 を引いた値) に等しい値である必要があるということです。RetrievalByteRange がメガバイト単位に調整されていない場合、このオペレーションではレスポンスで 400 が返されます。

inventory-retrieval または select ジョブのリクエストでこのフィールドを指定すると、エラーが発生します。

タイプ: 文字列

必須: いいえ

SelectParameters

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

タイプ: SelectParameters オブジェクト

必須: いいえ

SNSTopic

ジョブが完了し、出力をダウンロードする準備ができたときに S3 Glacier が通知を送信する Amazon SNS トピックの Amazon リソースネーム (ARN)。指定したトピックから受信者に通知が発行されます。

SNS トピックは存在している必要があります。存在しない場合、S3 Glacier が自動的にトピックを作成することはありません。さらに、SNS トピックには、ジョブを作成したアカウントでトピックにメッセージを発行することを許可するポリシーが必要です。SNS トピック名については、を参照してください。CreateTopicのAmazon Simple Notification Service API リファレンス。

タイプ: 文字列

必須: いいえ

階層

選択またはアーカイブの取得ジョブに使用する層。 Standard は使用されるデフォルト値です。

有効な値: Expedited | Standard | Bulk

タイプ: 文字列

必須: いいえ

タイプ

ジョブのタイプ。アーカイブに SELECT クエリを実行し、アーカイブを取得し、ボールトインベントリを取得する ジョブを開始することができます。

有効な値: select | archive-retrieval | inventory-retrieval

タイプ: 文字列

必須: はい

詳細

• ジョブの開始 (ジョブの POST)