Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # AWS Data Pipeline を使用した の例 AWS CLI 次のコード例は、 AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS Data Pipeline。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `activate-pipeline` 次のコード例は、`activate-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインをアクティブ化するには** この例では、指定されたパイプラインをアクティブ化しています。 ``` aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` 特定の日時でパイプラインをアクティブ化するには、次のコマンドを使用します。 ``` aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --start-timestamp 2015-04-07T00:00:00Z ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ActivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/activate-pipeline.html)」を参照してください。 ### `add-tags` 次のコード例は、`add-tags` を使用する方法を示しています。 **AWS CLI** **パイプラインにタグを追加するには** この例では、指定されたタグを指定されたパイプラインに追加しています。 ``` aws datapipeline add-tags --pipeline-id df-00627471SOVYZEXAMPLE --tags key=environment,value=production key=owner,value=sales ``` タグを表示するには、describe-pipelines コマンドを使用します。たとえば、サンプルコマンドで追加されたタグは、describe-pipelines の出力に次のように表示されます。 ``` { ... "tags": [ { "value": "production", "key": "environment" }, { "value": "sales", "key": "owner" } ] ... } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/add-tags.html)」を参照してください。 ### `create-pipeline` 次のコード例は、`create-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインを作成するには** この例では、パイプラインを作成しています。 ``` aws datapipeline create-pipeline --name my-pipeline --unique-id my-pipeline-token ``` 出力例を次に示します。 ``` { "pipelineId": "df-00627471SOVYZEXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/create-pipeline.html)」を参照してください。 ### `deactivate-pipeline` 次のコード例は、`deactivate-pipeline` を使用する方法を示しています。 **AWS CLI** パイプラインを非アクティブ化するには この例では、指定されたパイプラインを非アクティブ化しています。 ``` aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` すべての実行中のアクティビティが終了した後にのみ、パイプラインを非アクティブ化するには、次のコマンドを使用します。 ``` aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --no-cancel-active ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeactivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/deactivate-pipeline.html)」を参照してください。 ### `delete-pipeline` 次のコード例は、`delete-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインを削除するには** この例では、指定されたパイプラインを削除しています。 ``` aws datapipeline delete-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/delete-pipeline.html)」を参照してください。 ### `describe-pipelines` 次のコード例は、`describe-pipelines` を使用する方法を示しています。 **AWS CLI** **パイプラインを記述するには** この例では、指定されたパイプラインを記述します。 ``` aws datapipeline describe-pipelines --pipeline-ids df-00627471SOVYZEXAMPLE ``` 出力例を次に示します。 ``` { "pipelineDescriptionList": [ { "fields": [ { "stringValue": "PENDING", "key": "@pipelineState" }, { "stringValue": "my-pipeline", "key": "name" }, { "stringValue": "2015-04-07T16:05:58", "key": "@creationTime" }, { "stringValue": "df-00627471SOVYZEXAMPLE", "key": "@id" }, { "stringValue": "123456789012", "key": "pipelineCreator" }, { "stringValue": "PIPELINE", "key": "@sphere" }, { "stringValue": "123456789012", "key": "@userId" }, { "stringValue": "123456789012", "key": "@accountId" }, { "stringValue": "my-pipeline-token", "key": "uniqueId" } ], "pipelineId": "df-00627471SOVYZEXAMPLE", "name": "my-pipeline", "tags": [] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/describe-pipelines.html)」を参照してください。 ### `get-pipeline-definition` 次のコード例は、`get-pipeline-definition` を使用する方法を示しています。 **AWS CLI** **パイプライン定義を取得するには** 次の例では、指定したパイプラインのパイプライン定義を取得しています。 ``` aws datapipeline get-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE ``` 出力例を次に示します。 ``` { "parameters": [ { "type": "AWS::S3::ObjectKey", "id": "myS3OutputLoc", "description": "S3 output folder" }, { "default": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data", "type": "AWS::S3::ObjectKey", "id": "myS3InputLoc", "description": "S3 input folder" }, { "default": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt", "type": "String", "id": "myShellCmd", "description": "Shell command to run" } ], "objects": [ { "type": "Ec2Resource", "terminateAfter": "20 Minutes", "instanceType": "t1.micro", "id": "EC2ResourceObj", "name": "EC2ResourceObj" }, { "name": "Default", "failureAndRerunMode": "CASCADE", "resourceRole": "DataPipelineDefaultResourceRole", "schedule": { "ref": "DefaultSchedule" }, "role": "DataPipelineDefaultRole", "scheduleType": "cron", "id": "Default" }, { "directoryPath": "#{myS3OutputLoc}/#{format(@scheduledStartTime, 'YYYY-MM-dd-HH-mm-ss')}", "type": "S3DataNode", "id": "S3OutputLocation", "name": "S3OutputLocation" }, { "directoryPath": "#{myS3InputLoc}", "type": "S3DataNode", "id": "S3InputLocation", "name": "S3InputLocation" }, { "startAt": "FIRST_ACTIVATION_DATE_TIME", "name": "Every 15 minutes", "period": "15 minutes", "occurrences": "4", "type": "Schedule", "id": "DefaultSchedule" }, { "name": "ShellCommandActivityObj", "command": "#{myShellCmd}", "output": { "ref": "S3OutputLocation" }, "input": { "ref": "S3InputLocation" }, "stage": "true", "type": "ShellCommandActivity", "id": "ShellCommandActivityObj", "runsOn": { "ref": "EC2ResourceObj" } } ], "values": { "myS3OutputLoc": "s3://amzn-s3-demo-bucket/", "myS3InputLoc": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data", "myShellCmd": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/get-pipeline-definition.html)」を参照してください。 ### `list-pipelines` 次のコード例は、`list-pipelines` を使用する方法を示しています。 **AWS CLI** **パイプラインを一覧表示するには** この例では、パイプラインを一覧表示しています。 ``` aws datapipeline list-pipelines ``` 出力例を次に示します。 ``` { "pipelineIdList": [ { "id": "df-00627471SOVYZEXAMPLE", "name": "my-pipeline" }, { "id": "df-09028963KNVMREXAMPLE", "name": "ImportDDB" }, { "id": "df-0870198233ZYVEXAMPLE", "name": "CrossRegionDDB" }, { "id": "df-00189603TB4MZEXAMPLE", "name": "CopyRedshift" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-pipelines.html)」を参照してください。 ### `list-runs` 次のコード例は、`list-runs` を使用する方法を示しています。 **AWS CLI** **例 1: パイプラインの実行を一覧表示するには** 次の `list-runs` の例では、指定されたパイプラインの実行を一覧表示しています。 ``` aws datapipeline list-runs --pipeline-id df-00627471SOVYZEXAMPLE ``` 出力: ``` Name Scheduled Start Status ID Started Ended ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. EC2ResourceObj 2015-04-12T17:33:02 CREATING @EC2ResourceObj_2015-04-12T17:33:02 2015-04-12T17:33:10 2. S3InputLocation 2015-04-12T17:33:02 FINISHED @S3InputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 2015-04-12T17:33:09 3. S3OutputLocation 2015-04-12T17:33:02 WAITING_ON_DEPENDENCIES @S3OutputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 4. ShellCommandActivityObj 2015-04-12T17:33:02 WAITING_FOR_RUNNER @ShellCommandActivityObj_2015-04-12T17:33:02 2015-04-12T17:33:09 ``` **例 2: 指定された日付の間のパイプライン実行を一覧表示するには** 次の `list-runs` の例では、`--start-interval` を使用して、出力に含める日付を指定しています。 ``` aws datapipeline list-runs --pipeline-id df-01434553B58A2SHZUKO5 --start-interval 2017-10-07T00:00:00,2017-10-08T00:00:00 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-runs.html)」を参照してください。 ### `put-pipeline-definition` 次のコード例は、`put-pipeline-definition` を使用する方法を示しています。 **AWS CLI** **パイプライン定義をアップロードするには** この例では、指定されたパイプライン定義を指定されたパイプラインにアップロードしています。 ``` aws datapipeline put-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE --pipeline-definition file://my-pipeline-definition.json ``` 出力例を次に示します。 ``` { "validationErrors": [], "errored": false, "validationWarnings": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/put-pipeline-definition.html)」を参照してください。 ### `remove-tags` 次のコード例は、`remove-tags` を使用する方法を示しています。 **AWS CLI** **パイプラインからタグを削除するには** この例では、指定されたタグを指定されたパイプラインから削除しています。 ``` aws datapipeline remove-tags --pipeline-id df-00627471SOVYZEXAMPLE --tag-keys environment ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/remove-tags.html)」を参照してください。