Custom API Action

リクエストタイプ（Request Type）

カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです（「HTTPリクエストメソッド」を参照）。

• GET：パラメーターに応じてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。

• POST：パラメーターに応じてWebサーバーにデータを送信します (たとえば、ファイルのアップロード)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信しないよう、注意が必要です。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。

• PUT：パラメーターに基づいて、Webサーバーの特定の場所に格納するデータを送信します （ファイルのアップロードなど）。POSTリクエストとは異なり、PUTリクエストは冪等（べきとう）です。リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200 (OK)、201 (Created)、または204 (No Content)レスポンスメッセージが返されます。

• PATCH：パラメーターに応じてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージが返されます。

• DELETE：パラメーターに応じてWebサーバーから特定のリソース（存在する場合）を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。

• HEAD：HTTP GETメソッドを使用する代わりに、HEADリクエストのURLを要求した場合に返されるヘッダーを要求します。たとえば、あるURLが大規模なダウンロードを生じると考えられる場合、 HEADリクエストはそのContent-Lengthヘッダーを読み取って実際にファイルをダウンロードすることなくファイルサイズを確認できます。

リージョン（Region）

Amazon S3バケットのリージョンを選択します。

リクエスト（Request）

バケット（Bucket）

リクエスト内で参照するバケットの名前。次に例を示します。

GET /?list-type=2 HTTP/1.1

Host: <Bucket>.s3.amazonaws.com

相対URL（Relative URL）

呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。相対URLの先頭にスラッシュを使用します。

「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりできます。

たとえば、AWS S3 APIエンドポイントがhttp://aws.s3.<region>.amazonaws.com/listobjectsであれば、相対URLは/listobjectsとなります。

クエリ（Query）

含める追加のクエリパラメーターをオブジェクト形式（キー/値のペア）で指定します。

本文（Body）

リクエストボディーをJSON形式で指定します。

ヘッダー（Headers）

authorizationまたはcontent-type（これらのヘッダーにはすでにコネクターが対応しています）以外に必要な任意のヘッダーを指定します。

レスポンス（Response ）

ステータスコード（Status Code）

ヘッダー（Headers）

出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。

本文（Body）

選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。