翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

documents/batch

このセクションでは、documents/batch リソースの HTTP リクエストおよびレスポンスメッセージについて説明します。

ドキュメントバッチを作成して、Amazon CloudSearch ドメインにアップロードするデータを記述します。ドキュメントバッチは追加および削除操作のコレクションであり、ドメインで追加、更新、削除するドキュメントを表します。バッチは JSON または XML で記述できます。バッチは、Amazon がインデックス作成に CloudSearch 必要とするすべての情報を提供します。検索結果として返すことができるようにする各項目 (製品など) はドキュメントとして表されます。バッチは単に個々のドキュメントの追加および削除リクエストのコレクションです。各ドキュメントには固有の ID、および検索し、結果を返すデータを含むフィールドが 1 つ以上あります。

ドキュメントを更新するには、更新するドキュメントのドキュメント ID を使用して追加リクエストを指定します。詳細については、「Amazon CloudSearch でのドキュメントの追加および更新」を参照してください。同様に、ドキュメントを削除するには、削除するドキュメントのドキュメント ID を使用して削除リクエストを送信します。ドキュメントの削除の詳細については、「Amazon CloudSearch でのドキュメントの削除」を参照してください。

インデックス作成用のデータ送信の詳細については、「upload documents」を参照してください。

documents/batch JSON API

JSON documents/batch リクエスト

documents/batch リクエストの本文では、JSON または XML を使用して、実行するドキュメントのオペレーションを指定します。バッチの JSON 表現は、個々の追加および削除オペレーションを定義するオブジェクトのコレクションです。type プロパティは、オブジェクトが追加オペレーションと削除オペレーションのどちらを表すかを示します。例えば、次の JSON バッチは、1 個のドキュメントを追加し、1 個のドキュメントを削除します。

[
{ "type": "add",
  "id":   "tt0484562",
  "fields": {
    "title": "The Seeker: The Dark Is Rising",
    "directors": ["Cunningham, David L."],
    "genres": ["Adventure","Drama","Fantasy","Thriller"],
    "actors": ["McShane, Ian","Eccleston, Christopher","Conroy, Frances",
              "Crewson, Wendy","Ludwig, Alexander","Cosmo, James",
              "Warner, Amelia","Hickey, John Benjamin","Piddock, Jim",
              "Lockhart, Emma"]
  }
},
{ "type": "delete",
  "id":   "tt0484575"
}]

バッチの JSON スキーマ表現を次に示します。

{
    "type": "array",
    "minItems": 1,
    "items": {
        "type": "object",
        "properties": {
            "type": {
                "type": "string",
                "enum": ["add", "delete"],
                "required": true
            },
            "id": {
                "type": "string",
                "pattern": "[a-z0-9][a-z0-9_]{0,127}",
                "minLength": 1,
                "maxLength": 128,
                "required": true
            },
            "fields": {
                "type": "object",
                "patternProperties": {
                    "[a-zA-Z0-9][a-zA-Z0-9_]{0,63}": {
                        "type": "string",
                    }
                }
            }
        }
    }
}

documents/batch リクエストのプロパティ (JSON)

documents/batch レスポンス (JSON)

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

ドキュメントサービス API レスポンスの JSON スキーマの表現を次に示します。

{
    "type": "object",
    "properties": {
        "status": {
            "type": "text",
            "enum": ["success", "error"],
            "required": true
        },
        "adds": {
            "type": "integer",
            "minimum": 0,
            "required": true
        },
        "deletes": {
            "type": "integer",
            "minimum": 0,
            "required": true
        },
        "errors": {
            "type": "array",
            "required": false,
            "items": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        },
        "warnings": {
            "type": "array",
            "required": false,
            "items": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        }
    }
}

documents/batch レスポンスのプロパティ (JSON)

documents/batch ステータスコード

ドキュメントサービスリクエストは、3 種類のステータスコードを返すことができます。

一般的なリクエストヘッダー

共通のレスポンスヘッダー