AWS DynamoDBアクション

このページでは、ワークフロー自動化のアクションカタログで利用できるAWS DynamoDBアクションのリファレンスを提供します。これらのアクションを使用して、DynamoDBテーブル内の項目の読み取り、書き込み、更新、削除を行ったり、ワークフロー定義から直接テーブル設定を検査または変更したりします。

前提条件

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

すべてのDynamoDBアクションは、同じ認証入力を受け付けます。awsRoleArn（推奨）またはアクセスキーペアを使用します。

アイテムを配置します。

アクション識別子はaws.dynamodb.putItemです。

DynamoDBテーブルに新しい項目を作成するか、既存の項目を置き換えます。itemマップには、DynamoDBの低レベルのAttributeValueフォーマットを使用します。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`item`	地図	必須。低レベルのDynamoDB AttributeValue形式の属性名/値ペアのマップ。プライマリキー属性のみが必須です；その他の属性はオプションです。	`{"id": {"S": "123"}, "status": {"S": "PLACED"}}`
`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 }}`
`conditionExpression`	弦	オプション。`PutItem`が成功するために満たす必要がある条件です。関数（`attribute_exists`、`attribute_not_exists`、`contains`）、比較演算子、および論理演算子（`AND`、`OR`、`NOT`）をサポートしています。	`attribute_not_exists(id)`
`expressionAttributeNames`	地図	オプション。式内の属性名の置換トークンです。予約語や特殊文字を参照するには、`#name`構文を使用してください。	`{"#n": "name"}`
`expressionAttributeValues`	地図	オプション。低レベルのAttributeValue形式の式の置換値です。`:value`構文を使用してください。	`{":id": {"S": "123"}}`
`parameters`	地図	オプション。上記でモデル化されていない`put_item`フィールドのパススルーです。フィールド名にはboto3のPascalCaseを使用する必要があります。一般的な値：`ReturnValues`（`NONE` デフォルト \| `ALL_OLD`）、`ReturnConsumedCapacity`（`NONE` デフォルト \| `TOTAL` \| `INDEXES`）、`ReturnValuesOnConditionCheckFailure`（`NONE` デフォルト \| `ALL_OLD`）。PutItem APIリファレンスを参照してください。	`{"ReturnValues": "ALL_OLD"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "attributes", "expression": ".response.Attributes"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	生の`put_item`レスポンス。`ReturnValues`が`parameters`経由で設定されている場合、`Attributes`が含まれます。PutItem APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: put-dynamodb-item
description: Write an order item to DynamoDB
steps:
  - name: putOrderItem
    type: action
    action: aws.dynamodb.putItem
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      item:
        orderId: { "S": "123" }
        status: { "S": "PLACED" }
    next: end

アイテムの取得

アクション識別子はaws.dynamodb.getItemです。

プライマリキーによって、DynamoDBテーブルから単一の項目を取得します。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`key`	地図	必須。低レベルのAttributeValue形式の、取得する項目のプライマリキーです。	`{"orderId": {"S": "123"}}`
`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 }}`
`projectionExpression`	弦	オプション。取得する属性のカンマ区切りのリスト。省略した場合、すべての属性が返されます。	`id, #n`
`expressionAttributeNames`	地図	オプション。式内の属性名の置換トークンです。予約語や特殊文字を参照するには、`#name`構文を使用してください。	`{"#n": "name"}`
`consistentRead`	ブール値	オプション。`true` の場合、強力な整合性のある読み込みを使用します。デフォルト：`false`（結果的な整合性）。	`false`
`parameters`	地図	オプション。上記でモデル化されていない`get_item`フィールドをパススルーします。一般的な値：`ReturnConsumedCapacity`（`NONE` デフォルト \| `TOTAL` \| `INDEXES`）。GetItem APIリファレンスを参照してください。	`{"ReturnConsumedCapacity": "TOTAL"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "item", "expression": ".response.Item"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	アイテムが見つかった場合、`Item`が含まれます。GetItem APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: get-dynamodb-item
description: Retrieve an order item from DynamoDB by primary key
steps:
  - name: getOrderItem
    type: action
    action: aws.dynamodb.getItem
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      key:
        orderId: { "S": "123" }
      selectors:
        - name: item
          expression: '.response.Item'
    next: end

アイテムの更新

アクション識別子はaws.dynamodb.updateItemです。

既存の項目の属性を編集するか、項目がまだ存在しない場合は新しい項目を追加します。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`key`	地図	必須。低レベルのAttributeValue形式の、更新する項目のプライマリキーです。	`{"orderId": {"S": "123"}}`
`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 }}`
`updateExpression`	弦	オプション。更新する属性を定義します。`SET`、`REMOVE`、`ADD`、および`DELETE`のアクションをサポートします。	`SET #s = :status`
`conditionExpression`	弦	オプション。`UpdateItem`が成功するために満たす必要がある条件です。	`attribute_exists(orderId)`
`expressionAttributeNames`	地図	オプション。式内の属性名の置換トークンです。予約語や特殊文字を参照するには、`#name`構文を使用してください。	`{"#s": "status"}`
`expressionAttributeValues`	地図	オプション。低レベルのAttributeValue形式の式の置換値です。	`{":status": {"S": "SHIPPED"}}`
`parameters`	地図	オプション。上記でモデル化されていない`update_item`フィールドをパススルーします。一般的な値：`ReturnValues`（`NONE` デフォルト \| `ALL_OLD` \| `UPDATED_OLD` \| `ALL_NEW` \| `UPDATED_NEW`）。UpdateItem APIリファレンスをご覧ください。	`{"ReturnValues": "UPDATED_NEW"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "attributes", "expression": ".response.Attributes"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	`parameters`を介して`ReturnValues`が設定されている場合、`Attributes`が含まれます。UpdateItem APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: update-dynamodb-item
description: Update the status of an order in DynamoDB
steps:
  - name: updateOrderStatus
    type: action
    action: aws.dynamodb.updateItem
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      key:
        orderId: { "S": "123" }
      updateExpression: 'SET #s = :status'
      expressionAttributeNames:
        '#s': status
      expressionAttributeValues:
        ':status': { "S": "SHIPPED" }
      parameters:
        ReturnValues: UPDATED_NEW
      selectors:
        - name: attributes
          expression: '.response.Attributes'
    next: end

アイテムの削除

アクション識別子はaws.dynamodb.deleteItemです。

プライマリキーを使用して、DynamoDBテーブルから単一の項目を削除します。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`key`	地図	必須。低レベルのAttributeValue形式の、削除する項目のプライマリキーです。	`{"orderId": {"S": "123"}}`
`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 }}`
`conditionExpression`	弦	オプション。`DeleteItem`が成功するために満たす必要がある条件です。	`attribute_exists(orderId)`
`expressionAttributeNames`	地図	オプション。式内の属性名の置換トークンです。	`{"#n": "name"}`
`expressionAttributeValues`	地図	オプション。低レベルのAttributeValue形式の式の置換値です。	`{":id": {"S": "123"}}`
`parameters`	地図	オプション。上記でモデル化されていない`delete_item`フィールドをパススルーします。共通の値：`ReturnValues`（`NONE` デフォルト \| `ALL_OLD`）。DeleteItem APIリファレンスをご覧ください。	`{"ReturnValues": "ALL_OLD"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "attributes", "expression": ".response.Attributes"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	`parameters`を介して`ReturnValues`が設定されている場合、`Attributes`が含まれます。DeleteItem APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: delete-dynamodb-item
description: Delete an order item from DynamoDB
steps:
  - name: deleteOrderItem
    type: action
    action: aws.dynamodb.deleteItem
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      key:
        orderId: { "S": "123" }
    next: end

テーブルのスキャン

アクション識別子はaws.dynamodb.scanです。

必要に応じてフィルタリングを行い、テーブル全体をスキャンすることで、DynamoDBテーブルまたはインデックスから項目を返します。1回のスキャン応答は、ワークフロー自動化によって100 KBに制限されています（DynamoDB自体の制限は1 MBです）。大きなテーブルをページングするには、limitとexclusiveStartKeyを使用します。

重要

ワークフロー自動化は、アクションごとに100 KBの出力サイズ制限を適用します。aws.dynamodb.scanは、レスポンスがこの制限を超過した場合、DynamoDB独自の1レスポンスあたり1 MBの上限に収まっていたとしても、出力サイズ制限超過例外をスローします。結果をページ分割し、この制限内に収めるには、limitとexclusiveStartKeyを使用してください。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`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 }}`
`indexName`	弦	オプション。ベーステーブルの代わりにスキャンするローカルまたはグローバルのセカンダリインデックスの名前です。	`my-gsi`
`filterExpression`	弦	オプション。アイテムの読み取り後に適用される条件です。フィルタリングされたアイテムは返されませんが、読み取りキャパシティは消費されます。	`#s = :status`
`projectionExpression`	弦	オプション。取得する属性のカンマ区切りのリスト。省略した場合、すべての属性が返されます。	`id, #n`
`expressionAttributeNames`	地図	オプション。式内の属性名の置換トークンです。	`{"#s": "status"}`
`expressionAttributeValues`	地図	オプション。低レベルのAttributeValue形式の式の置換値です。	`{":status": {"S": "ACTIVE"}}`
`select`	弦	オプション。返す属性。許可される値：`ALL_ATTRIBUTES`、`ALL_PROJECTED_ATTRIBUTES`、`SPECIFIC_ATTRIBUTES`、`COUNT`。	`ALL_ATTRIBUTES`
`limit`	整数	オプション。評価する項目の最大数です（必ずしも返される項目ではありません）。最小値：1。	`100`
`consistentRead`	ブール値	オプション。`true`の場合、強力な整合性のある読み込みを使用します。グローバルセカンダリインデックスではサポートされていません。デフォルト：`false`。	`false`
`exclusiveStartKey`	地図	オプション。評価する1番目のアイテムのプライマリ・キーです。ページネーションを行うには、前回のスキャンの`LastEvaluatedKey`を使用してください。	`{"orderId": {"S": "123"}}`
`totalSegments`	整数	オプション。並列スキャン用のセグメントの総数です。`segment`と一緒に使用する必要があります。許容範囲：1～1,000,000。	`4`
`segment`	整数	オプション。並列スキャン用の0から始まるセグメントID。`totalSegments`と一緒に使用する必要があります。	`0`
`parameters`	地図	オプション。上記でモデル化されていない`scan`フィールドをパススルーします。Scan APIリファレンスを参照してください。	`{"ReturnConsumedCapacity": "TOTAL"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "items", "expression": ".response.Items"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	`Items`（一致したアイテム）および`LastEvaluatedKey`（さらにページが存在する場合に存在）が含まれます。Scan APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: scan-dynamodb-table
description: Scan for active orders in DynamoDB
steps:
  - name: scanActiveOrders
    type: action
    action: aws.dynamodb.scan
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      filterExpression: '#s = :status'
      expressionAttributeNames:
        '#s': status
      expressionAttributeValues:
        ':status': { "S": "ACTIVE" }
      limit: 50
      selectors:
        - name: items
          expression: '.response.Items'
        - name: lastKey
          expression: '.response.LastEvaluatedKey'
    next: end

テーブルをクエリします。

アクション識別子はaws.dynamodb.queryです。

パーティションキーに一致するDynamoDBテーブルまたはインデックスの項目を返します。オプションで、ソートキー条件またはフィルター式によって絞り込むことができます。キーベースのルックアップでは、スキャンよりも効率的です。

重要

ワークフロー自動化は、アクションごとに100 KBの出力サイズ制限を適用します。aws.dynamodb.queryは、レスポンスがこの制限を超過した場合、DynamoDB独自の1レスポンスあたり1 MBの上限に収まっていたとしても、出力サイズ制限超過例外をスローします。結果をページ分割し、この制限内に収めるには、limitとexclusiveStartKeyを使用してください。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`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 }}`
`indexName`	弦	オプション。クエリを実行するローカルまたはグローバルセカンダリインデックスの名前。	`customerId-index`
`keyConditionExpression`	弦	オプション。パーティションキー（必須）、およびオプションでソートキーに対する条件です。	`customerId = :cid`
`filterExpression`	弦	オプション。アイテムの読み取り後に適用される条件です。キー属性は参照できません。フィルタリングされた項目は返されませんが、引き続き読み取りキャパシティを消費します。	`#s = :status`
`projectionExpression`	弦	オプション。取得する属性のカンマ区切りのリストです。	`id, #n`
`expressionAttributeNames`	地図	オプション。式内の属性名の置換トークンです。	`{"#s": "status"}`
`expressionAttributeValues`	地図	オプション。低レベルのAttributeValue形式の式の置換値です。	`{":cid": {"S": "cust-1"}}`
`select`	弦	オプション。返す属性。許可される値：`ALL_ATTRIBUTES`、`ALL_PROJECTED_ATTRIBUTES`、`SPECIFIC_ATTRIBUTES`、`COUNT`。	`ALL_ATTRIBUTES`
`limit`	整数	オプション。評価する項目の最大数です。最小値：1。	`100`
`scanIndexForward`	ブール値	オプション。`true`（デフォルト）の場合、ソートキーの昇順で結果を返します。`false`の場合、降順で返します。	`true`
`consistentRead`	ブール値	オプション。`true`の場合、強力な整合性のある読み込みを使用します。グローバルセカンダリインデックスではサポートされていません。デフォルト：`false`。	`false`
`exclusiveStartKey`	地図	オプション。評価する1番目のアイテムのプライマリ・キーです。ページ分割するには、前のクエリの`LastEvaluatedKey`を使用してください。	`{"orderId": {"S": "123"}}`
`parameters`	地図	オプション。上記でモデル化されていない`query`フィールドのパススルーです。クエリAPIリファレンスを参照してください。	`{"ReturnConsumedCapacity": "TOTAL"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "items", "expression": ".response.Items"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	`Items`（一致した項目）および`LastEvaluatedKey`（さらにページが存在する場合に表示されます）が含まれます。クエリAPIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: query-dynamodb-table
description: Query orders by customer ID
steps:
  - name: queryCustomerOrders
    type: action
    action: aws.dynamodb.query
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      indexName: customerId-index
      keyConditionExpression: 'customerId = :cid'
      expressionAttributeValues:
        ':cid': { "S": "cust-1" }
      selectors:
        - name: items
          expression: '.response.Items'
    next: end

テーブルの説明

アクション識別子はaws.dynamodb.describeTableです。

ステータス、プライマリキースキーマ、プロビジョニングされたスループット、および（グローバルテーブルの場合は）レプリカのステータスを含むテーブル情報を返します。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`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 }}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "tableStatus", "expression": ".response.Table.TableStatus"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	グローバルテーブル用の`TableStatus`、`KeySchema`、`ProvisionedThroughput`、および`Replicas`とともに、`Table`が含まれます。DescribeTable APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: describe-dynamodb-table
description: Get the status and configuration of a DynamoDB table
steps:
  - name: describeOrdersTable
    type: action
    action: aws.dynamodb.describeTable
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      selectors:
        - name: tableStatus
          expression: '.response.Table.TableStatus'
    next: end

テーブルの一覧

アクション識別子はaws.dynamodb.listTablesです。

現在のAWSアカウントおよびリージョンにあるDynamoDBテーブル名のリストを返します。結果はページ分割されます — 結果をページ送りするには、前のレスポンスのLastEvaluatedTableNameとともにexclusiveStartTableNameを使用してください。

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

入力	タイプ	説明	例
`region`	弦	必須。テーブルを一覧表示するAWSリージョンです。	`us-east-2`
`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 }}`
`exclusiveStartTableName`	弦	オプション。評価する最初のテーブル名。ページネーションするには、以前のレスポンスの`LastEvaluatedTableName`を使用してください。	`my-table`
`limit`	整数	オプション。返すテーブル名の最大数（1～100）。デフォルト：100。	`50`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "tableNames", "expression": ".response.TableNames"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	さらにページが存在する場合、`TableNames`（テーブル名の文字列のリスト）と`LastEvaluatedTableName`が含まれます。ListTables APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: list-dynamodb-tables
description: List all DynamoDB tables in a region
steps:
  - name: listDynamoTables
    type: action
    action: aws.dynamodb.listTables
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      selectors:
        - name: tableNames
          expression: '.response.TableNames'
    next: end

テーブルの更新

アクション識別子はaws.dynamodb.updateTableです。

DynamoDBテーブルのプロビジョニングされたスループット設定、請求モード、グローバルセカンダリインデックス、レプリケーションリージョン、またはその他の設定を変更します。

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

入力	タイプ	説明	例
`region`	弦	必須。ターゲットテーブルのAWSリージョン。	`us-east-2`
`tableName`	弦	必須。DynamoDBテーブルの名前。	`Orders`
`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 }}`
`attributeDefinitions`	リスト	オプション。テーブルおよびインデックスの属性定義の配列。新しいグローバルセカンダリインデックスを追加する際に必須です。	`[{"AttributeName": "id", "AttributeType": "S"}]`
`billingMode`	弦	オプション。スループットの課金方法を制御します。許可される値：`PROVISIONED`、`PAY_PER_REQUEST`。	`PAY_PER_REQUEST`
`provisionedThroughput`	地図	オプション。`billingMode`が`PROVISIONED`の場合に必須です。`billingMode`が`PAY_PER_REQUEST`の場合は設定できません。	`{"ReadCapacityUnits": 5, "WriteCapacityUnits": 5}`
`globalSecondaryIndexUpdates`	リスト	オプション。1つ以上のグローバルセカンダリインデックスの更新アクション（作成、更新、または削除）。テーブルあたり最大20個のGSI。	`[{"Update": {"IndexName": "my-gsi", "ProvisionedThroughput": {"ReadCapacityUnits": 5, "WriteCapacityUnits": 5}}}]`
`streamSpecification`	地図	オプション。DynamoDB Streamsの設定。	`{"StreamEnabled": true, "StreamViewType": "NEW_AND_OLD_IMAGES"}`
`sseSpecification`	地図	オプション。サーバー側の暗号化設定。	`{"Enabled": true, "SSEType": "KMS"}`
`deletionProtectionEnabled`	ブール値	オプション。テーブルの削除保護を有効または無効にします。	`true`
`parameters`	地図	オプション。上記でモデル化されていない`update_table`フィールドのパススルーです。一般的な値：`ReplicaUpdates`（グローバルテーブルレプリカの追加/削除）、`TableClass`（`STANDARD` \| `STANDARD_INFREQUENT_ACCESS`）。UpdateTable APIリファレンスを参照してください。	`{"ReplicaUpdates": [{"Create": {"RegionName": "eu-west-1"}}]}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "tableStatus", "expression": ".response.TableDescription.TableStatus"}]`

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

出力	タイプ	例
`success`	ブール値	`true` または `false`
`response`	オブジェクト	`TableDescription`を含みます。UpdateTable APIリファレンスを参照してください。
`errorMessage`	弦	失敗時のエラーメッセージ。

例

name: update-dynamodb-table
description: Switch a DynamoDB table to on-demand billing
steps:
  - name: setPayPerRequest
    type: action
    action: aws.dynamodb.updateTable
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-2
      tableName: Orders
      billingMode: PAY_PER_REQUEST
      selectors:
        - name: tableStatus
          expression: '.response.TableDescription.TableStatus'
    next: end

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

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

アイテムを配置します。

アイテムの取得

アイテムの更新

アイテムの削除

テーブルのスキャン

重要

テーブルをクエリします。

重要

テーブルの説明

テーブルの一覧

テーブルの更新

前提条件