Amazon CloudSearch
開発者ガイド (API バージョン 2013-01-01)

documents/batch XML API

XML documents/batch リクエスト

documents/batch リクエストの本文では、XML で、実行するドキュメントのオペレーションを指定します。(例:

<batch> <add id="tt0484562"> <field name="title">The Seeker: The Dark Is Rising</field> <field name="director">Cunningham, David L.</field> <field name="genre">Adventure</field> <field name="genre">Drama</field> <field name="genre">Fantasy</field> <field name="genre">Thriller</field> <field name="actor">McShane, Ian</field> <field name="actor">Eccleston, Christopher</field> <field name="actor">Conroy, Frances</field> <field name="actor">Ludwig, Alexander</field> <field name="actor">Crewson, Wendy</field> <field name="actor">Warner, Amelia</field> <field name="actor">Cosmo, James</field> <field name="actor">Hickey, John Benjamin</field> <field name="actor">Piddock, Jim</field> <field name="actor">Lockhart, Emma</field> </add> <delete id="tt0301199" /> </batch>

documents/batch リクエストの要素(XML)

要素 説明 必須
バッチ 検索ドメインに送信する追加または削除オペレーションのコレクション。バッチには、少なくとも 1 つの add または delete 要素を含める必要があります。 はい
add 検索ドメインに追加するドキュメントを指定します。id 属性は必須であり、add 要素には少なくとも 1 つのフィールドが含まれている必要があります。

属性:

  • id—英数字の文字列。A​~​Z(大文字または小文字)および 0​~​9 以外の文字は無効です。最大長は 128 文字です。

いいえ
field 追加されるドキュメント内のフィールドを指定します。名前属性およびフィールド値は必須です。フィールド名は英数字で始まっている必要があり、次の文字を含めることができます。a​~​z(小文字)、0​~​9、_(下線)。score という名前は予約済みのため、フィールド名として使用できません。フィールド値にはテキストや CDATA を指定できます。

フィールドに複数の値を指定するには、同じ名前の複数のフィールド要素を含めます。(例:

<field name="genre">Adventure</field> <field name="genre">Drama</field> <field name="genre">Fantasy</field> <field name="genre">Thriller</field>

制約:

  • name—文字で始まる英数字の文字列。含めることができる文字は、a~z (小文字)、0~9、_ (下線)、- (ハイフン)、および . (ピリオド) です。

条件: add 要素で少なくとも 1 個のフィールドを指定する必要があります。

条件付き
delete 検索ドメインから削除するドキュメントを指定します。id 属性は必須です。delete 要素は空にする必要があります。ドキュメントの完全な削除の詳細については、「Amazon CloudSearch でのドキュメントの削除」を参照してください。

制約:

  • id—英数字の文字列。A​~​Z(大文字または小文字)および 0​~​9 以外の文字は無効です。

いいえ

documents/batch 応答(XML)

応答の本文には、実行された追加や削除の数、および生成されたすべてのエラーや警告がリストされます。

ドキュメントサービス API 応答の RelaxNG スキーマは次のとおりです。

start = response response = element response { attribute status { "success" | "error" }, attribute adds { xsd:integer }, attribute deletes { xsd:integer }, element errors { element error { text }+ }? & element warnings { element warning { text }+ }? }

documents/batch 応答の要素(XML)

要素 説明
result

リクエストを解析および検証するときに生成されたエラーおよび警告をリストする要素が含まれます。

属性:

  • status—​ success または error である結果のステータス。

  • adds — 追加されたドキュメントの数。ステータスが error である場合、これは常に 0 です。

  • deletes ​— 削除されたドキュメントの数。ステータスが error である場合、これは常に 0 です。

制約: ステータスが error の場合、results 要素にはエラーのリストが含まれます。ステータスが success の場合、results 要素に警告のリストを含めることができますが、エラーは含まれません。

エラー リクエストの解析時および検証時に発生したエラーを示す error 要素のコレクションが含まれます。
error 解析エラーまたは検証エラーに関する情報を提供します。値はエラーの説明を提供します。
warnings リクエストの解析時および検証時に生成された警告を示す warning 要素のコレクションが含まれます。
warning 解析または検証の警告に関する情報を提供します。値はエラーの説明を提供します。