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ヘッダーを読み取って実際にファイルをダウンロードすることなくファイルサイズを確認できます。

ドロップダウン

Bucket（バケット）

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

GET /?list-type=2 HTTP/1.1

Host: <Bucket>.s3.amazonaws.com

テキスト

Relative URL（相対URL）

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

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

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

テキスト

Query（クエリ）

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

オブジェクト

Body（本文）

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

オブジェクト

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

操作の結果。コネクターは、カードによって実行されたアクションの成否を示すHTTPステータスコードを返します。例：

• 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
• 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

Headers（ヘッダー）

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