翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# AWS CodePipeline アクションリファレンスを呼び出す
<a name="action-reference-PipelineInvoke"></a>

CodePipeline 呼び出しアクションを使用して、ダウンストリームパイプライン実行のトリガーと、パイプライン変数とソースリビジョンをパイプライン間で渡す処理を簡素化します。

**注記**  
このアクションは V2 タイプのパイプラインでのみサポートされています。

**Topics**
+ [アクションタイプ](#action-reference-PipelineInvoke-type)
+ [設定パラメータ](#action-reference-PipelineInvoke-parameters)
+ [入力アーティファクト](#action-reference-PipelineInvoke-input)
+ [出力アーティファクト](#action-reference-PipelineInvoke-output)
+ [CodePipeline 呼び出しアクションのサービスロールポリシーのアクセス許可](#action-reference-PipelineInvoke-permissions-action)
+ [アクションの宣言](#action-reference-PipelineInvoke-example)
+ [関連情報](#action-reference-PipelineInvoke-links)

## アクションタイプ
<a name="action-reference-PipelineInvoke-type"></a>
+ カテゴリ:`Invoke`
+ 所有者: `AWS`
+ プロバイダー: `CodePipeline`
+ バージョン: `1`

## 設定パラメータ
<a name="action-reference-PipelineInvoke-parameters"></a>

**PipelineName**  
必須: はい  
実行中に現在のターゲットパイプラインを開始するパイプラインの名前。呼び出しパイプラインを既に作成している必要があります。`my-s3-pipeline` という名前の (呼び出し) パイプラインが実行を開始すると、アクションは `s3-pipeline-test` (ターゲット) パイプラインを開始します。

**SourceRevisions**  
必須: いいえ  
呼び出しパイプラインによって開始されたときにターゲットパイプラインで使用するソースリビジョン。例えば、S3 ソースアクションは、S3 バージョン ID やオブジェクトキーなどの出力変数を提供します。パイプラインが呼び出されるときに使用するリビジョン値を指定できます。  
CLI では、ソースリビジョンをシリアル化された JSON 文字列として指定します。ソースリビジョンオーバーライドの使用の詳細については、「*CodePipeline API ガイド*」の「[SourceRevisionOverride](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_SourceRevisionOverride.html)」を参照してください。  
マッピングでは、次の例に示すように文字列形式を使用します。  

```
[{"actionName":"Source","revisionType":"S3_OBJECT_VERSION_ID","revision
Value":"zq8mjNEXAMPLE"}]
```

**[変数]**  
必須: いいえ  
アクションでサポートする変数の名前と値。  
CLI では、シリアル化された JSON 文字列として変数を指定します。パイプライン変数の使用の詳細については、「[CodePipeline API ガイド](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_PipelineVariable.html)」の「*PipelineVariable*」を参照してください。  
マッピングでは、次の例に示すように文字列形式を使用します。  

```
[{"name":"VAR1","value":"VALUE1"}]
```

次の図は、コンソールでパイプラインに追加されたアクションの例を示しています。

![\[S3 ソースを含むパイプライン、およびパイプライン呼び出しアクションを含むビルドステージ\]](http://docs.aws.amazon.com/ja_jp/codepipeline/latest/userguide/images/example-pipeline-invoke-run.png)


次の画像は、アクションの **[編集]** ページの例を示しています。次の例では、`s3-pipeline-test` という名前のパイプラインに、コンソールに示されているように設定されたパイプライン呼び出しアクションがあります。`my-s3-pipeline` という名前のパイプラインの実行が完了すると、アクションによって `s3-pipeline-test` パイプラインが開始されます。この例では、指定されたリビジョン値が `zq8mjNYEexample` の S3\$1OBJECT\$1VERSION\$1ID ソースオーバーライドのソースリビジョンオーバーライドを示しています。

![\[パイプライン呼び出しアクションを使用した、新しいパイプラインの [アクションを編集する] ページ\]](http://docs.aws.amazon.com/ja_jp/codepipeline/latest/userguide/images/example-pipeline-invoke-edit.png)


## 入力アーティファクト
<a name="action-reference-PipelineInvoke-input"></a>
+ **アーティファクトの数:** `0`
+ **説明:** 入力アーティファクトは、このアクションタイプには適用されません。

## 出力アーティファクト
<a name="action-reference-PipelineInvoke-output"></a>
+ **アーティファクトの数:** `0` 
+ **説明:** 出力アーティファクトは、このアクションタイプには適用されません。

## CodePipeline 呼び出しアクションのサービスロールポリシーのアクセス許可
<a name="action-reference-PipelineInvoke-permissions-action"></a>

CodePipeline がアクションを実行する際、CodePipeline サービスロールポリシーには、最小特権でアクセスを維持するために、パイプラインリソース ARN に適切にスコープダウンされた `codepipeline:StartPipelineExecution` アクセス許可が必要です。

```
 {
            "Sid": "StatementForPipelineInvokeAction",
            "Effect": "Allow",
            "Action": "codepipeline:StartPipelineExecution",
            "Resource": [
                "arn:aws:codepipeline:{{region}}:{{AccountId}}:{{pipelineName}}"
            ]
        }
```

## アクションの宣言
<a name="action-reference-PipelineInvoke-example"></a>

------
#### [ YAML ]

```
name: Invoke-pipeline
actionTypeId:
  category: Invoke
  owner: AWS
  provider: CodePipeline
  version: '1'
runOrder: 2
configuration:
  PipelineName: my-s3-pipeline
  SourceRevisions: '[{"actionName":"Source","revisionType":"S3_OBJECT_VERSION_ID","revision
Value":"zq8mjNEXAMPLE"}]'
  Variables: '[{"name":"VAR1","value":"VALUE1"}]'
```

------
#### [ JSON ]

```
{
    "name": "Invoke-pipeline",
    "actionTypeId": {
        "category": "Invoke",
        "owner": "AWS",
        "provider": "CodePipeline",
        "version": "1"
    },
    "runOrder": 2,
    "configuration": {
        "PipelineName": "my-s3-pipeline",
        "SourceRevisions": "[{\"actionName\":\"Source\",\"revisionType\":\"S3_OBJECT_VERSION_ID\",\"revisionValue\":\"zq8mjNEXAMPLE"}]",
        "Variables": "[{\"name\":\"VAR1\",\"value\":\"VALUE1\"}]"
    }
},
```

------

## 関連情報
<a name="action-reference-PipelineInvoke-links"></a>

このアクションを利用する際に役立つ関連リソースは以下の通りです。
+  [ソースリビジョンオーバーライドでパイプラインを開始する](pipelines-trigger-source-overrides.md) – このセクションでは、手動で、または EventBridge イベント入力トランスフォーマーを使用して、ソースリビジョンでパイプラインを開始する方法について説明します。