Amazon S3

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

• エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

  ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

• オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
  • リスト
  • 取得
  • 作成
  • 更新
  • 削除

  使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

• アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

アクション

このセクションでは、コネクタでサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。

CopyObject アクション

このアクションにより、あるバケットから別のバケットにオブジェクトをコピーしたり、同じバケット内にオブジェクトをコピーしたりできます。

CopyObject アクションの入力パラメータ

CopyObject アクションの出力パラメータ

このアクションは、コピーが正常に完了した場合、ステータス 200（OK）を返します。

CopyObject アクションの構成方法については、アクションの例をご覧ください。

DownloadObjects アクション

このアクションにより、バケットから 1 つ以上のオブジェクトを取得します。

DownloadObjects アクションの入力パラメータ

DownloadObjects アクションの出力パラメータ

このアクションは、ダウンロードが正常に完了した場合、ステータス 200（OK）を返します。

DownloadObjects アクションの構成方法については、アクションの例をご覧ください。

UploadObject アクション

このアクションにより、オブジェクトをバケットにアップロードできます。

UploadObject アクションの入力パラメータ

UploadObject アクションの出力パラメータ

このアクションは、オブジェクトのアップロードが正常に完了した場合、ステータス 200（OK）を返します。

UploadObject アクションの構成方法については、アクションの例をご覧ください。

DeleteObject アクション

このアクションにより、バケットからオブジェクトを削除できます。

DeleteObject アクションの入力パラメータ

DeleteObject アクションの出力パラメータ

このアクションは、削除が正常に完了した場合、ステータス 200（OK）を返します。

DeleteObject アクションの構成方法については、アクションの例をご覧ください。

MoveObject アクション

このアクションにより、ユーザーは特定のバケットの既存のオブジェクトを別のバケットへ、または同じバケット内で移動できます。

MoveObject アクションの入力パラメータ

MoveObject アクションの出力パラメータ

このアクションは、移動オペレーションが正常に完了した場合、ステータス 200（OK）を返します。

MoveObject アクションの構成方法については、アクションの例をご覧ください。

PutBucketAcl アクション

このアクションにより、バケットのアクセス制御リスト（ACL）を更新できます。

PutBucketAcl アクションの入力パラメータ

PutBucketAcl アクションの出力パラメータ

このアクションは、バケット ACL の更新が正常に完了した場合、ステータス 200（OK）を返します。

PutBucketAcl アクションの構成方法については、アクションの例をご覧ください。

PutObjectAcl アクション

このアクションにより、バケット内のオブジェクトのアクセス制御リスト（ACL）を更新できます。

PutObjectAcl アクションの入力パラメータ

PutObjectAcl アクションの出力パラメータ

このアクションは、オブジェクト ACL の更新が正常に完了した場合、ステータス 200（OK）を返します。

PutObjectAcl アクションの構成方法については、アクションの例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - オブジェクトをコピーする

この例では、あるバケットから別のバケットにオブジェクトをコピーします。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [CopyObject] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "pic.jpg",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "new_pic.jpg"
   }

アクションが成功すると、CopyObject タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - オブジェクトをダウンロードする

この例では、指定したバケットからオブジェクトをダウンロードします。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [DownloadObjects] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "Bucket": "aws-s3-bucket-source",
   "HasBytes": true
   }

アクションが成功すると、DownloadObjects タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
"Success": "True",
"RemoteFile": "prefix1%2Faws-s3-bucket-source%2Finventory-test-1%2F2023-09-10T01-00Z%2Fmanifest.json",
"ContentBytes": "ewogICJzb3VyY2VCdWNrZXQiIDogImF3cy1zMy1idWNrZXQtYmNvbmUiLAogICJnOK"
},
{
"Success": "True",
"RemoteFile": "upload1.txt",
"ContentBytes": "VGhpcyBpcyBhIHRlc3RpbmcgZmlsZQ=="
}]

例 - オブジェクトをアップロードする

この例では、指定したバケットにオブジェクトをアップロードします。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [UploadObject] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "Bucket": "aws-s3-bucket-source",
   "FileName": "upload_1.txt",
   "Content": "This is a testing file",
   "AccessPolicy": "PUBLIC"
   }

アクションが成功すると、UploadObject タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
"Status": "success",
"bucket": "aws-s3-bucket-source",
"rss:title": "Object 'upload_1.txt' was created in the bucket: aws-s3-bucket-source",
"object": "upload_1.txt"
}]

例 - オブジェクトを削除する

この例では、指定したバケットからオブジェクトを削除します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [DeleteObject] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "Bucket": "aws-s3-bucket-source",
   "Object": "abc.png"
   }

アクションが成功すると、DeleteObject タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - オブジェクトを移動する

この例では、あるバケットから別のバケットにオブジェクトを移動します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [MoveObject] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "abc.png",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "moved.png"
   }

アクションが成功すると、MoveObject タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - バケットの ACL を更新する

この例では、バケットのアクセス制御権限を更新します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [PutBucketAcl] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "BucketSource": "aws-s3-bucket-source",
   "ACL": "public-read"
   }

アクションが成功すると、PutBucketAcl タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - オブジェクトの ACL を更新する

この例では、バケット内のオブジェクトのアクセス制御権限を更新します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [PutObjectAcl] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "Bucket": "aws-s3-bucket-source",
   "ACL": "aws-exec-read",
   "Key": "AWS_S3_BusinessCase_V2.xlsx"
   }

アクションが成功すると、PutObjectAcl タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
"Status": "Success"
}]

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

例 - すべてのオブジェクトのメタデータを一覧表示する

この例では、Object エンティティ内のすべてのオブジェクトのメタデータを取得します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Object を選択します。
3. [List] オペレーションを選択し、[完了] をクリックします。
4. 必要に応じて、コネクタタスクの [タスク入力] セクションでフィルタ句を指定して、結果セットをフィルタリングできます。 フィルタ句の値は常に単一引用符（'）内で指定します。例: Bucket='test-bucket'。論理演算子を使用して複数のフィルタ条件を指定することもできます。例: Bucket='test-bucket' and OwnerId='b1ecc809ad8467088afb'。

例 - バケットのメタデータを取得する

この例では、Bucket エンティティから、指定した ID のバケットのメタデータを取得します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Bucket を選択します。
3. [Get] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] フィールドに demo_replication を入力します。

   ここで、demo_replication は Bucket エンティティの一意のバケット ID です。

例 - バケットを作成する

この例では、Bucket エンティティにバケットを作成します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Bucket を選択します。
3. [Create] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "Bucket": "Demo1697528098686"
   }

   統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

   [{
   "Bucket": "Demo1697528098686"
   }]

例 - バケットを削除する

この例では、Bucket エンティティ内の指定された ID のバケットを削除します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Bucket を選択します。
3. [Delete] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに demo1697528098686 を入力します。