AWS S3アクション

このページでは、ワークフロー自動化アクション・カタログで利用可能なAWS S3アクションのリファレンスを提供します。これらのアクションを使用して、Amazon S3バケット内のオブジェクトの一覧表示、取得、アップロード、および削除を行います。

前提条件

前提条件と認証情報のセットアップについては、AWS認証情報のセットアップをご覧ください。

バケット内のオブジェクトを一覧表示する

アクション識別子はaws.s3.listObjectsV2です。

バケット内のオブジェクトの一部またはすべて（最大1,000個）をメタデータとともに返します。listObjectsの推奨バージョンです。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ターゲットバケットのAWSリージョン。	`us-east-2`
`bucket`	弦	必須。オブジェクトを一覧表示するS3バケットの名前。	`examplebucket`
`prefix`	弦	オプション。このプレフィックスで始まるキーに応答を制限します。	`path/to/folder/`
`maxKeys`	整数	オプション。返すキーの最大数（最大1,000）。	`100`
`continuationToken`	弦	オプション。次のページの結果を取得するための、前回のレスポンスのトークンです。	`some-token`
`parameters`	地図	オプション。 APIコールに渡す追加のboto3パラメーター。	`{"Delimiter": "/"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

追加のオプションの boto3 フィールド（EncodingType、FetchOwner、StartAfter、RequestPayer、ExpectedBucketOwner、OptionalObjectAttributes、Delimiter）は、parameters 入力を介して利用できます。詳細については、list_objects_v2 boto3 リファレンスを参照してください。

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	list_objects_v2 boto3リファレンスを参照してください。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"Parameter validation failed: Invalid bucket name"`

出力

タイプ

例

response

オブジェクト

list_objects_v2 boto3リファレンス

を参照してください。

success

ブール値

true

または

false

errorMessage

弦

"Parameter validation failed: Invalid bucket name"

ワークフローの例

name: aws-s3-list-objects-v2
description: 'List Objects in an AWS S3 Bucket'
steps:
  - name: aws_s3_listObjectsV2_1
    type: action
    action: aws.s3.listObjectsV2
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      prefix: "path/to/folder/"
      maxKeys: 100
    next: end

バケットからオブジェクトを削除する

アクション識別子はaws.s3.deleteObjectです。

バケットから単一のオブジェクトを完全に削除します。バージョニングされたバケットの場合、VersionId が指定されない限り、この操作によって削除マーカーが挿入され、オブジェクトは完全に削除されることなく非表示になります。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ターゲットバケットのAWSリージョン。	`us-east-2`
`bucket`	弦	必須。オブジェクトを含むS3バケットの名前。	`examplebucket`
`key`	弦	必須。削除するオブジェクトのフルキー（パス）。	`path/to/object.txt`
`parameters`	地図	オプション。 APIコールに渡す追加のboto3パラメーター。	`{"VersionId": "testVersion", "MFA": "Test"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

追加のオプションの boto3 フィールド（RequestPayer、BypassGovernanceRetention、ExpectedBucketOwner、IfMatch、VersionId、MFA）は、parameters 入力を介して利用できます。詳細については、delete_object boto3 リファレンスを参照してください。

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	delete_object boto3 リファレンスを参照してください。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"Parameter validation failed: Invalid bucket name"`

出力

タイプ

例

response

オブジェクト

delete_object boto3 リファレンス

を参照してください。

success

ブール値

true

または

false

errorMessage

弦

"Parameter validation failed: Invalid bucket name"

ワークフローの例

name: aws-s3-delete-object
description: 'Delete an AWS S3 Object'
steps:
  - name: aws_s3_deleteObject_1
    type: action
    action: aws.s3.deleteObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-west-2"
      bucket: "my-bucket"
      key: "path/to/object.txt"
    next: end

バケットにオブジェクトを追加する

アクション識別子はaws.s3.putObjectです。

バケットにオブジェクトを追加します。Amazon S3は分散システムです — 同じオブジェクトに対して同時に複数の書き込みrequestsを受信した場合、最後に書き込まれたオブジェクト以外をすべて上書きします。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ターゲットバケットのAWSリージョン。	`us-east-2`
`bucket`	弦	必須。オブジェクトをアップロードするS3バケットの名前。	`examplebucket`
`key`	弦	必須。バケット内のオブジェクトのフルキー（パス）。	`path/to/object.txt`
`body`	弦	必須。アップロードするオブジェクトデータ。	`file content`
`contentType`	弦	必須。オブジェクトの標準MIMEタイプです。	`plain/text`
`tagging`	弦	オプション。オブジェクトに適用するURLエンコードされたタグセット。	`key1=value1`
`parameters`	地図	オプション。 APIコールに渡す追加のboto3パラメーター。	`{"ServerSideEncryption": "AES256", "Metadata": {"metadata1": "value1"}}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

追加のオプションのboto3フィールドは、parameters入力から利用できます。完全な一覧については、「put_object boto3リファレンス」をご覧ください。

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	put_object boto3リファレンスを参照してください。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"`

出力

タイプ

例

response

オブジェクト

put_object boto3リファレンス

を参照してください。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"

ワークフローの例

name: s3-put-object
description: 'Put an AWS S3 Object'
steps:
  - name: aws_s3_putObject_1
    type: action
    action: aws.s3.putObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      key: "path/to/object.txt"
      body: "Hello world"
      contentType: "plain/text"
      tagging: "key1=value1"
    next: end

バケットからオブジェクトを取得する

アクション識別子はaws.s3.getObjectです。

Amazon S3からオブジェクトを取得します。リクエストでオブジェクトの完全なキー名を指定してください。

重要

オブジェクトが100 KBより大きい場合、このアクションは失敗します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ターゲットバケットのAWSリージョン。	`us-east-2`
`bucket`	弦	必須。オブジェクトを含むS3バケットの名前。	`examplebucket`
`key`	弦	必須。取得するオブジェクトの完全なキー（パス）。	`path/to/object.txt`
`versionId`	弦	オプション。取得するオブジェクトのバージョンID。省略した場合、現在のバージョンが返されます。	`some-version-id`
`range`	弦	オプション。オブジェクトの特定のバイト範囲を取得するためのHTTP Rangeヘッダー。	`bytes=0-99`
`parameters`	地図	オプション。 APIコールに渡す追加のboto3パラメーター。	`{"ChecksumMode": "ENABLED"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

追加のオプションのboto3フィールドは、parameters入力から利用できます。完全なリストについては、get_object boto3リファレンスを参照してください。

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	get_object boto3リファレンスを参照してください。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"`

出力

タイプ

例

response

オブジェクト

get_object boto3リファレンス

を参照してください。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"

ワークフローの例

name: s3-get-object
description: 'Get an AWS S3 Object'
steps:
  - name: aws_s3_getObject_1
    type: action
    action: aws.s3.getObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      key: "path/to/object.txt"
    next: end

この機械翻訳は、参考として提供されています。

前提条件.css-21sua1{background:none;border:none;width:0;padding:0;}

バケット内のオブジェクトを一覧表示する

バケットからオブジェクトを削除する

バケットにオブジェクトを追加する

バケットからオブジェクトを取得する

重要

前提条件