},
...
}
},
...
}
}
```
+ ログの取得は、ベストエフォートベースで実行されます。ログの取得エラーが発生した場合は、`log` フィールドの代わりに、`error` および `cause` フィールドが存在します。
+ `LogOptions.RetrieveLogs`: ジョブの完了後にログの取得を有効にします。デフォルトでは、ログは取得されません。
+ `Type`: `Boolean`
+ 必須: いいえ
+ `LogOptions.RawLogs`: `RawLogs` が true に設定されている場合、ログは JSON に解析しようとせずに生文字列として返されます。デフォルトでは、可能であれば、ログは JSON に逆シリアル化されます。場合によっては、このような解析によって、多くの桁数を含む数値の精度を制限するなど、望ましくない変更を導入しかねません。
+ `Type`: `Boolean`
+ 必須: いいえ
+ `LogOptions.LogParameters`: Kubernetes API のログ読み取り API は、ログの取得を制御するクエリパラメータをサポートしています。例えば、`tailLines` または `limitBytes` を使用して、取得したログのサイズを制限し、Step Functions のデータサイズクォータ内に留まります。詳細については、SDK for Go API リファレンスの[ログを読み取り](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#read-log-pod-v1-core)セクションを参照してください。
+ `List of Strings` への `String` の `Type: ` マッピング
+ 必須: いいえ
+ 例:
```
"LogParameters": {
"tailLines": [ "6" ]
}
```
次の例には、ジョブを実行し、完了を待ってから、ジョブのログを取得する `Task` 状態が含まれます。
```
{
"StartAt": "Run a job on EKS",
"States": {
"Run a job on EKS": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:runJob.sync",
"Arguments": {
"ClusterName": "MyCluster",
"CertificateAuthority": "ANPAJ2UCCR6DPCEXAMPLE",
"Endpoint": "https://AKIAIOSFODNN7EXAMPLE.yl4.us-east-1.eks.amazonaws.com",
"LogOptions": {
"RetrieveLogs": true
},
"Job": {
"apiVersion": "batch/v1",
"kind": "Job",
"metadata": {
"name": "example-job"
},
"spec": {
"backoffLimit": 0,
"template": {
"metadata": {
"name": "example-job"
},
"spec": {
"containers": [
{
"name": "pi-2000",
"image": "perl",
"command": [ "perl" ],
"args": [
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
]
}
],
"restartPolicy": "Never"
}
}
}
}
},
"End": true
}
}
}
```
### `Call`
`eks:call` サービス統合は、Kubernetes API の使用を許可し、Kubernetes API エンドポイントを経由して Kubernetes リソースオブジェクトを読み取り書き込みます。
Kubernetes API サーバーは、ステートマシンで使用される IAM ロールにアクセス権限を付与する必要があります。詳細については、「[アクセス許可](#connect-eks-permissions)」を参照してください。
使用できる操作の詳細については、[Kubernetes API リファレンス](https://kubernetes.io/docs/reference/kubernetes-api/)を参照してください。
`Call` 用にサポートされているパラメータには以下が含まれます。
+ `ClusterName`: コールしたい Amazon EKS クラスター名。
+ `Type`: 文字列
+ 必須: はい
+ `CertificateAuthority`: ご自分のクラスターとの通信に必要な Base64 でエンコードされた証明書データ。この値は、[Amazon EKS コンソール](https://console.aws.amazon.com/eks/home)から、または Amazon EKS [DescribeCluster](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeCluster.html) API を使用して取得できます。
+ `Type`: `String`
+ 必須: はい
+ `Endpoint`: Kubernetes API サーバーのエンドポイント。この値は、[Amazon EKS コンソール](https://console.aws.amazon.com/eks/home)または、Amazon EKS の DescribeCluster API を使用して見つけることができます。
+ `Type`: `String`
+ 必須: はい
+ `Method`: リクエストの HTTP メソッド。`GET`、`POST`、`PUT`、`DELETE`、`HEAD`、`PATCH` のいずれかです。
+ `Type`: `String`
+ 必須: はい
+ `Path`: Kubernetes REST API オペレーションの HTTP パス。
+ `Type`: `String`
+ 必須: はい
+ `QueryParameters`: Kubernetes REST API オペレーションの HTTP クエリパラメーター。
+ `List of Strings` への `String` の `Type: ` マッピング
+ 必須: いいえ
+ 例:
```
"QueryParameters": {
"labelSelector": [ "job-name=example-job" ]
}
```
+ `RequestBody`: Kubernetes REST API オペレーションの HTTP メッセージ本文。
+ `Type`: `JSON` または `String`
+ 必須: いいえ
以下には、`eks:call` を使用して、ジョブ `example-job` に所属するポッドをリストする `Task` 状態が含まれます。
```
{
"StartAt": "Call EKS",
"States": {
"Call EKS": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:call",
"Arguments": {
"ClusterName": "MyCluster",
"CertificateAuthority": "ANPAJ2UCCR6DPCEXAMPLE",
"Endpoint": "https://444455556666.yl4.us-east-1.eks.amazonaws.com",
"Method": "GET",
"Path": "/api/v1/namespaces/default/pods",
"QueryParameters": {
"labelSelector": [
"job-name=example-job"
]
}
},
"End": true
}
}
}
```
以下には、`eks:call` を使用して、ジョブ `example-job` を削除する `Task` 状態が含まれ、`propagationPolicy` をジョブのポッドも確実に削除されるよう設定します。
```
{
"StartAt": "Call EKS",
"States": {
"Call EKS": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:call",
"Arguments": {
"ClusterName": "MyCluster",
"CertificateAuthority": "ANPAJ2UCCR6DPCEXAMPLE",
"Endpoint": "https://444455556666.yl4.us-east-1.eks.amazonaws.com",
"Method": "DELETE",
"Path": "/apis/batch/v1/namespaces/default/jobs/example-job",
"QueryParameters": {
"propagationPolicy": [
"Foreground"
]
}
},
"End": true
}
}
}
```
## 最適化された Amazon EKS API
サポートされている Amazon EKS API と構文には次のものが含まれます。
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html)
+ [リクエストの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html#API_CreateCluster_RequestSyntax)
+ [レスポンスの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html#API_CreateCluster_ResponseSyntax)
`eks:createCluster` サービス統合を使って Amazon EKS クラスターが作成され時点で、IAM ロールが Kubernetes RBAC 認可テーブルに (システム: マスター許可のある) 管理者として追加されます。初期状態では、その IAM エンティティのみが、Kubernetes API サーバーを呼び出すことができます。詳細については、以下を参照してください。
+ *Amazon EKS ユーザーガイド*の[クラスターのユーザーまたは IAM ロールの管理](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html)
+ [アクセス許可](#connect-eks-permissions) セクション
Amazon EKS は、ユーザーに代わって他のサービスを呼び出すために Amazon EKS が必要な許可を含むサービスにリンクされたロールを使用します。これらのサービスにリンクされたロールがアカウントにまだ存在しない場合は、Step Functions で使用される IAM ロールに対する `iam:CreateServiceLinkedRole` 許可を追加する必要があります。詳細については、*Amazon EKS ユーザーガイド*の[サーバーがリンクしたロールを使用](https://docs.aws.amazon.com/eks/latest/userguide/using-service-linked-roles.html)を参照してください。
Step Functions が使用する IAM ロールには、クラスタ IAM ロールを Amazon EKS に渡す `iam:PassRole` 許可がおりている必要があります。詳細については、*Amazon EKS ユーザーガイド*の [Amazon EKS クラスターの IAM ロール](https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html)を参照してください。
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteCluster.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteCluster.html)
+ [リクエストの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteCluster.html#API_DeleteCluster_RequestSyntax)
+ [レスポンスの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteCluster.html#API_DeleteCluster_ResponseSyntax)
クラスターを削除する前に、Fargate プロファイルまたはノードグループを削除する必要があります。
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateFargateProfile.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateFargateProfile.html)
+ [リクエストの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateFargateProfile.html#API_CreateFargateProfile_RequestSyntax)
+ [レスポンスの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateFargateProfile.html#API_CreateFargateProfile_ResponseSyntax)
Amazon EKS は、ユーザーに代わって他のサービスを呼び出すために Amazon EKS が必要な許可を含むサービスにリンクされたロールを使用します。これらのサービスにリンクされたロールがアカウントにまだ存在しない場合は、Step Functions で使用される IAM ロールに対する `iam:CreateServiceLinkedRole` 許可を追加する必要があります。詳細については、*Amazon EKS ユーザーガイド*の[サーバーがリンクしたロールを使用](https://docs.aws.amazon.com/eks/latest/userguide/using-service-linked-roles.html)を参照してください。
Fargate 上の Amazon EKS はすべてのリージョンで利用可能なわけではありません。リージョンの可用性の詳細については、[Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate.html) の *Amazon EKS ユーザーガイド*の Fargate に関するセクションを参照してください。
Step Functions で使用されている IAM ロールには、ポッド実行 IAM ロールを Amazon EKS に渡す `iam:PassRole` 許可が必要です。詳細については、*Amazon EKS ユーザーガイド*の[ポッド実行ロール](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html)を参照してください。
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteFargateProfile.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteFargateProfile.html)
+ [リクエストの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteFargateProfile.html#API_DeleteFargateProfile_RequestSyntax)
+ [レスポンスの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteFargateProfile.html#API_DeleteFargateProfile_ResponseSyntax)
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateNodegroup.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateNodegroup.html)
+ [リクエストの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateNodegroup.html#API_CreateNodegroup_RequestSyntax)
+ [レスポンスの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateNodegroup.html#API_CreateNodegroup_ResponseSyntax)
Amazon EKS は、ユーザーに代わって他のサービスを呼び出すために Amazon EKS が必要な許可を含むサービスにリンクされたロールを使用します。これらのサービスにリンクされたロールがアカウントにまだ存在しない場合は、Step Functions で使用される IAM ロールに対する `iam:CreateServiceLinkedRole` 許可を追加する必要があります。詳細については、*Amazon EKS ユーザーガイド*の[サーバーがリンクしたロールを使用](https://docs.aws.amazon.com/eks/latest/userguide/using-service-linked-roles.html)を参照してください。
Step Functions で使用される IAM ロールには、ノード IAM ロールを Amazon EKS に渡すため `iam:PassRole` 許可が必要です。詳細については、*Amazon EKS ユーザーガイド*の[サーバーがリンクしたロールを使用](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html)を参照してください。
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteNodegroup.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteNodegroup.html)
+ [リクエストの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteNodegroup.html#API_DeleteNodegroup_RequestSyntax)
+ [レスポンスの構文](https://docs.aws.amazon.com/eks/latest/APIReference/API_DeleteNodegroup.html#API_DeleteNodegroup_ResponseSyntax)
以下には Amazon EKS クラスターを作成する `Task` が含まれています。
```
{
"StartAt": "CreateCluster.sync",
"States": {
"CreateCluster.sync": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:createCluster.sync",
"Arguments": {
"Name": "MyCluster",
"ResourcesVpcConfig": {
"SubnetIds": [
"subnet-053e7c47012341234",
"subnet-027cfea4b12341234"
]
},
"RoleArn": "arn:aws:iam::account-id:role/MyEKSClusterRole"
},
"End": true
}
}
}
```
以下には Amazon EKS クラスターを削除する `Task` 状態が含まれています。
```
{
"StartAt": "DeleteCluster.sync",
"States": {
"DeleteCluster.sync": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:deleteCluster.sync",
"Arguments": {
"Name": "MyCluster"
},
"End": true
}
}
}
```
以下には Fargate プロファイルを作成する `Task` 状態が含まれています。
```
{
"StartAt": "CreateFargateProfile.sync",
"States": {
"CreateFargateProfile.sync": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:createFargateProfile.sync",
"Arguments": {
"ClusterName": "MyCluster",
"FargateProfileName": "MyFargateProfile",
"PodExecutionRoleArn": "arn:aws:iam::account-id:role/MyFargatePodExecutionRole",
"Selectors": [{
"Namespace": "my-namespace",
"Labels": { "my-label": "my-value" }
}]
},
"End": true
}
}
}
```
以下には Fargate プロファイルを削除する `Task` 状態が含まれています。
```
{
"StartAt": "DeleteFargateProfile.sync",
"States": {
"DeleteFargateProfile.sync": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:deleteFargateProfile.sync",
"Arguments": {
"ClusterName": "MyCluster",
"FargateProfileName": "MyFargateProfile"
},
"End": true
}
}
}
```
以下にはノードグループを作成する `Task` 状態が含まれています。
```
{
"StartAt": "CreateNodegroup.sync",
"States": {
"CreateNodegroup.sync": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:createNodegroup.sync",
"Arguments": {
"ClusterName": "MyCluster",
"NodegroupName": "MyNodegroup",
"NodeRole": "arn:aws:iam::account-id:role/MyNodeInstanceRole",
"Subnets": ["subnet-09fb51df01234", "subnet-027cfea4b1234"]
},
"End": true
}
}
}
```
以下にはノードグループを削除する `Task` 状態が含まれています。
```
{
"StartAt": "DeleteNodegroup.sync",
"States": {
"DeleteNodegroup.sync": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:deleteNodegroup.sync",
"Arguments": {
"ClusterName": "MyCluster",
"NodegroupName": "MyNodegroup"
},
"End": true
}
}
}
```
## アクセス許可
`eks:createCluster` サービス統合を使って Amazon EKS クラスターが作成され時点で、IAM ロールを `system:masters` 許可を受けた管理者として、Kubernetes RBAC 認可テーブルに追加されています。初期状態では、その IAM エンティティのみが、Kubernetes API サーバーを呼び出すことができます。例えば、Step Functions ステートマシンと同じロールを引き受けるのでなければ、または追加の IAM エンティティに許可を付与するように Kubernetes を構成している場合は、**kubectl** を使用して、Kubernetes API と対話することはできません。詳細については、*Amazon EKS ユーザーガイド*の[クラスター用ユーザーまたは IAM ロールを管理](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html)を参照してください。
kube-system 名前空間の中の `aws-auth` `ConfigMap` に追加して、ユーザーまたはロールなど、追加 IAM エンティティの許可を追加できます。Step Functions からクラスターを作成する場合は、`eks:call` サービス統合を使用します。
以下には、`aws-auth` `ConfigMap` を作成し、ユーザー `arn:aws:iam::account-id:user/my-user` と IAM ロール `arn:aws:iam::account-id:role/my-role` に `system:masters` 許可を付与する `Task` 状態が含まれます。
```
{
"StartAt": "Add authorized user",
"States": {
"Add authorized user": {
"Type": "Task",
"Resource": "arn:aws:states:::eks:call",
"Arguments": {
"ClusterName": "MyCluster",
"CertificateAuthority": "LS0tLS1CRUd...UtLS0tLQo=",
"Endpoint": "https://444455556666.yl4.region.eks.amazonaws.com",
"Method": "POST",
"Path": "/api/v1/namespaces/kube-system/configmaps",
"RequestBody": {
"apiVersion": "v1",
"kind": "ConfigMap",
"metadata": {
"name": "aws-auth",
"namespace": "kube-system"
},
"data": {
"mapUsers": "[{ \"userarn\": \"arn:aws:iam::account-id:user/my-user\", \"username\": \"my-user\", \"groups\": [ \"system:masters\" ] } ]",
"mapRoles": "[{ \"rolearn\": \"arn:aws:iam::account-id:role/my-role\", \"username\": \"my-role\", \"groups\": [ \"system:masters\" ] } ]"
}
}
},
"End": true
}
}
```
**注記**
IAM ロールの ARN が、`arn:aws:iam::account-id:role/service-role/my-role` などのパス **/service-role/** を含む形式で表示されるのをご覧になるかもしれません。`aws-auth` でロールを一覧表示するときは、この **service-role** パストークンを含めないでください。
クラスターが最初に作成されるときは、`aws-auth` `ConfigMap` は存在しませんが、Fargate プロファイルを作成すると、自動的に追加されます。`aws-auth` の現在の値を取得し、追加許可を追加し、新しいバージョンを `PUT` します。通常、Fargate プロファイルの前に `aws-auth` を作成するほうが簡単です。
Step Functions の外部でクラスターが作成された場合は、**kubectl** を設定して、Kubernetes API サーバーと通信します。次に、`kubectl apply -f aws-auth.yaml` を使って新しい `aws-auth` `ConfigMap` を作成します。または、`kubectl edit -n kube-system configmap/aws-auth` を使用して既に存在するものを編集します。詳細については、以下を参照してください。
+ *Amazon EKS ユーザーガイド*の [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) 用 kubeconfig を作成します。
+ *Amazon EKS ユーザーガイド*の[クラスターのユーザーまたは IAM ロールを管理](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html)。
Kubernetes で IAM ロールに十分な許可がない場合、`eks:call` または `eks:runJob` のサービス統合は、次のエラーで失敗します。
```
Error:
EKS.401
Cause:
{
"ResponseBody": {
"kind": "Status",
"apiVersion": "v1",
"metadata": {},
"status": "Failure",
"message": "Unauthorized",
"reason": "Unauthorized",
"code": 401
},
"StatusCode": 401,
"StatusText": "Unauthorized"
}
```
## Amazon EKS を呼び出すための IAM ポリシー
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシー AWS Step Functions を生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
### `CreateCluster`
*リソース*
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"eks:CreateCluster"
],
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"eks:DescribeCluster",
"eks:DeleteCluster"
],
"Resource": "arn:aws:eks:us-east-1:444455556666:cluster/*"
},
{
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": [
"arn:aws:iam::444455556666:role/StepFunctionsSample-EKSClusterManag-EKSServiceRole-ANPAJ2UCCR6DPCEXAMPLE"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "eks.amazonaws.com"
}
}
}
]
}
```
```
```
### `CreateNodeGroup`
*リソース*
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ec2:DescribeSubnets",
"eks:CreateNodegroup"
],
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"eks:DescribeNodegroup",
"eks:DeleteNodegroup"
],
"Resource": "arn:aws:eks:us-east-1:444455556666:nodegroup/*"
},
{
"Effect": "Allow",
"Action": [
"iam:GetRole",
"iam:ListAttachedRolePolicies"
],
"Resource": "arn:aws:iam::444455556666:role/*"
},
{
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": [
"arn:aws:iam::444455556666:role/StepFunctionsSample-EKSClusterMan-NodeInstanceRole-ANPAJ2UCCR6DPCEXAMPLE"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "eks.amazonaws.com"
}
}
}
]
}
```
### `DeleteCluster`
*リソース*
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"eks:DeleteCluster",
"eks:DescribeCluster"
],
"Resource": [
"arn:aws:eks:us-east-1:444455556666:cluster/ExampleCluster"
]
}
]
}
```
### `DeleteNodegroup`
*リソース*
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"eks:DeleteNodegroup",
"eks:DescribeNodegroup"
],
"Resource": [
"arn:aws:eks:us-east-1:444455556666:nodegroup/ExampleCluster/ExampleNodegroup/*"
]
}
]
}
```
Step Functions での Amazon EKS の使用の詳細については、[Step Functions を使用した Amazon EKS クラスターの作成と管理](#connect-eks) を参照してください。
# Step Functions を使用した Amazon EMR クラスターの作成と管理
が提供する Amazon EMR サービス統合 APIs を使用して Amazon EMR AWS Step Functionsと を統合する方法について説明します。サービス統合 API は対応する Amazon EMR API に似ていますが、渡されるフィールドと返される応答にいくつかの違いがあります。
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された Amazon EMR 統合の主な機能**
最適化された Amazon EMR サービス統合には、以下で説明するような基になる Amazon EMR API をラップするカスタマイズされた一連の API があります。このため、Amazon EMR AWSSDK サービス統合とは大きく異なります。
[ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) 統合パターンがサポートされています。
Step Functions は、実行が停止しても Amazon EMR クラスターを自動的に終了しません。Amazon EMR クラスターが終了する前にステートマシンが停止した場合、クラスターは無期限に実行され、追加料金が発生する可能性があります。これを回避するには、作成した Amazon EMR クラスターが正しく終了していることを確認してください。詳細については、以下を参照してください。
+ Amazon EMR ユーザーガイド の[クラスター終了コントロール](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html)。
+ サービス統合パターン [ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) セクション。
**注記**
`emr-5.28.0` の時点で、クラスターの作成時に `StepConcurrencyLevel` パラメータを指定して、単一のクラスターで複数のステップを並行して実行することを許可します。Step Functions `Map` および `Parallel` 状態を使用して、並行して作業をクラスターに送信できます。
Amazon EMR サービス統合の可用性は、Amazon EMR API の可用性により決定します。特別なリージョンにおける制限については、[Amazon EMR](https://docs.aws.amazon.com//govcloud-us/latest/UserGuide/govcloud-emr.html) のドキュメントを参照してください。
**注記**
Amazon EMR との統合のため、Step Functions は最初の 10 分とその後の 300 秒間、ジョブポーリング頻度をハードコーディングして 60 秒に設定しています。
## 最適化された Amazon EMR API
各 Amazon EMR サービス統合 API および対応する Amazon EMR API の違いを次の表に示します。
| Amazon EMR サービス統合 API | 対応する EMR API | 相違点 |
| --- | --- | --- |
| createCluster 新しいクラスター (ジョブフロー) を作成して実行を開始します。 Amazon EMR はサービスリンクロールとして知られる IAM ロールの一意のタイプに直接リンクされています。`createCluster` と `createCluster.sync` が機能するには、サービスリンクロール `AWSServiceRoleForEMRCleanup` を作成するために必要なアクセス許可が設定されている必要があります。IAM 許可ポリシーに追加できるステートメントなど、この詳細については、[Amazon EMR のサービスリンクロールを使用する](https://docs.aws.amazon.com/emr/latest/ManagementGuide/using-service-linked-roles.html)を参照してください。 | [runJobFlow](https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html) | createCluster は次の場合を除き、[runJobFlow](https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html) と同じリクエスト構文を使用します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/step-functions/latest/dg/connect-emr.html)レスポンスは次のとおりです。{
"ClusterId": "string"
} Amazon EMR は以下を使用します。{
"JobFlowId": "string"
} |
| createCluster.sync 新しいクラスター (ジョブフロー) を作成して実行を開始します。 | [runJobFlow](https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html) | createCluster と同じですが、クラスターが WAITING 状態になるまで待機します。 |
| setClusterTerminationProtection クラスター (ジョブフロー) をロックして、クラスター内の EC2 インスタンスをユーザーの介入、API コール、またはジョブフローエラーが発生した場合に終了できないようにします。 | [setTerminationProtection](https://docs.aws.amazon.com/emr/latest/APIReference/API_SetTerminationProtection.html) | リクエストは以下を使用します。{
"ClusterId": "string"
} Amazon EMR は以下を使用します。{
"JobFlowIds": ["string"]
} |
| terminateCluster クラスター (ジョブフロー) をシャットダウンします。 | [terminateJobFlows](https://docs.aws.amazon.com/emr/latest/APIReference/API_TerminateJobFlows.html) | リクエストは以下を使用します。{
"ClusterId": "string"
} Amazon EMR は以下を使用します。{
"JobFlowIds": ["string"]
} |
| terminateCluster.syncクラスター (ジョブフロー) をシャットダウンします。 | [terminateJobFlows](https://docs.aws.amazon.com/emr/latest/APIReference/API_TerminateJobFlows.html) | terminateCluster と同じですが、クラスターが終了するまで待機します。 |
| addStep 実行中のクラスターに新しいステップを追加します。 オプションで、この API `[ExecutionRoleArn](https://docs.aws.amazon.com/emr/latest/APIReference/API_AddJobFlowSteps.html#EMR-AddJobFlowSteps-request-ExecutionRoleArn)` を使用する際に パラメータを指定することもできます。 | [addJobFlowSteps](https://docs.aws.amazon.com/emr/latest/APIReference/API_AddJobFlowSteps.html) | リクエストはキー "ClusterId" を使用します。Amazon EMR は "JobFlowId" を使用します。リクエストは 1 つのステップを使用します。{
"Step": <"StepConfig object">
} Amazon EMR は以下を使用します。{
"Steps": []
} レスポンスは次のとおりです。{
"StepId": "string"
} Amazon EMR はこれを返します。{
"StepIds": []
} |
| addStep.sync 実行中のクラスターに新しいステップを追加します。 オプションで、この API `[ExecutionRoleArn](https://docs.aws.amazon.com/emr/latest/APIReference/API_AddJobFlowSteps.html#EMR-AddJobFlowSteps-request-ExecutionRoleArn)` を使用する際に パラメータを指定することもできます。 | [addJobFlowSteps](https://docs.aws.amazon.com/emr/latest/APIReference/API_AddJobFlowSteps.html) | addStep と同じですが、ステップが完了するまで待機します。 |
| cancelStep 実行中のクラスターで保留中のステップを取り消します。 | [cancelSteps](https://docs.aws.amazon.com/emr/latest/APIReference/API_CancelSteps.html) | リクエストは以下を使用します。{
"StepId": "string"
} Amazon EMR は以下を使用します。{
"StepIds": []
} レスポンスは次のとおりです。{
"CancelStepsInfo":
} Amazon EMR は以下を使用します。{
"CancelStepsInfoList": []
} |
| modifyInstanceFleetByName 指定された `InstanceFleetName` を使用して、インスタンスフリートのターゲットオンデマンドおよびターゲットスポット容量を変更します。 | [modifyInstanceFleet](https://docs.aws.amazon.com/emr/latest/APIReference/API_ModifyInstanceFleet.html) | リクエストは modifyInstanceFleet の場合と同じですが、以下が異なります。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/step-functions/latest/dg/connect-emr.html) |
| modifyInstanceGroupByName インスタンスグループのノード数と構成設定を変更します。 | [modifyInstanceGroups](https://docs.aws.amazon.com/emr/latest/APIReference/API_ModifyInstanceGroups.html) | リクエストは次のとおりです。{
"ClusterId": "string",
"InstanceGroup":
} Amazon EMR は以下のリストを使用します。{
"ClusterId": ["string"],
"InstanceGroups": []
} `InstanceGroupModifyConfig` オブジェクト内では、フィールド `InstanceGroupId` は使用できません。 新しいフィールド `InstanceGroupName` が追加されました。実行時に、`InstanceGroupId` は `ListInstanceGroups` を呼び出して結果を解析することにより、サービス統合によって自動的に決定されます。 |
## ワークフローの例
以下にはクラスターを作成する `Task` 状態が含まれています。
```
"Create_Cluster": {
"Type": "Task",
"Resource": "arn:aws:states:::elasticmapreduce:createCluster.sync",
"Arguments": {
"Name": "MyWorkflowCluster",
"VisibleToAllUsers": true,
"ReleaseLabel": "emr-5.28.0",
"Applications": [
{
"Name": "Hive"
}
],
"ServiceRole": "EMR_DefaultRole",
"JobFlowRole": "EMR_EC2_DefaultRole",
"LogUri": "s3n://aws-logs-account-id-us-east-1/elasticmapreduce/",
"Instances": {
"KeepJobFlowAliveWhenNoSteps": true,
"InstanceFleets": [
{
"InstanceFleetType": "MASTER",
"Name": "MASTER",
"TargetOnDemandCapacity": 1,
"InstanceTypeConfigs": [
{
"InstanceType": "m4.xlarge"
}
]
},
{
"InstanceFleetType": "CORE",
"Name": "CORE",
"TargetOnDemandCapacity": 1,
"InstanceTypeConfigs": [
{
"InstanceType": "m4.xlarge"
}
]
}
]
}
},
"End": true
}
```
以下には終了保護を有効にする `Task` 状態が含まれています。
```
"Enable_Termination_Protection": {
"Type": "Task",
"Resource": "arn:aws:states:::elasticmapreduce:setClusterTerminationProtection",
"Arguments": {
"ClusterId": "{% $ClusterId %}",
"TerminationProtected": true
},
"End": true
}
```
以下にはクラスターにステップを送信する `Task` 状態が含まれています。
```
"Step_One": {
"Type": "Task",
"Resource": "arn:aws:states:::elasticmapreduce:addStep.sync",
"Arguments": {
"ClusterId": "{% $ClusterId %}",
"ExecutionRoleArn": "arn:aws:iam::account-id:role/myEMR-execution-role",
"Step": {
"Name": "The first step",
"ActionOnFailure": "TERMINATE_CLUSTER",
"HadoopJarStep": {
"Jar": "command-runner.jar",
"Args": [
"hive-script",
"--run-hive-script",
"--args",
"-f",
"s3://region.elasticmapreduce.samples/cloudfront/code/Hive_CloudFront.q",
"-d",
"INPUT=s3://region.elasticmapreduce.samples",
"-d",
"OUTPUT=s3:///MyHiveQueryResults/"
]
}
}
},
"End": true
}
```
以下には、ステップをキャンセルする `Task` 状態が含まれます。
```
"Cancel_Step_One": {
"Type": "Task",
"Resource": "arn:aws:states:::elasticmapreduce:cancelStep",
"Arguments": {
"ClusterId": "{% $ClusterId %}",
"StepId": "{% $AddStepsResult.StepId %}"
},
"End": true
}
```
以下には、クラスターを終了する `Task` 状態を示します。
```
"Terminate_Cluster": {
"Type": "Task",
"Resource": "arn:aws:states:::elasticmapreduce:terminateCluster.sync",
"Arguments": {
"ClusterId": "{% $ClusterId %}",
},
"End": true
}
```
以下には、インスタンスグループに合わせてクラスターをスケールアップまたはスケールダウンする `Task` 状態が含まれています。
```
"ModifyInstanceGroupByName": {
"Type": "Task",
"Resource": "arn:aws:states:::elasticmapreduce:modifyInstanceGroupByName",
"Arguments": {
"ClusterId": "j-account-id3",
"InstanceGroupName": "MyCoreGroup",
"InstanceGroup": {
"InstanceCount": 8
}
},
"End": true
}
```
以下には、インスタンスフリートに合わせてクラスターをスケールアップまたはスケールダウンする `Task` 状態が含まれています。
```
"ModifyInstanceFleetByName": {
"Type": "Task",
"Resource": "arn:aws:states:::elasticmapreduce:modifyInstanceFleetByName",
"Arguments": {
"ClusterId": "j-account-id3",
"InstanceFleetName": "MyCoreFleet",
"InstanceFleet": {
"TargetOnDemandCapacity": 8,
"TargetSpotCapacity": 0
}
},
"End": true
}
```
## Amazon EMR を呼び出すための IAM ポリシー
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
### `addStep`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:AddJobFlowSteps",
"elasticmapreduce:DescribeStep",
"elasticmapreduce:CancelSteps"
],
"Resource": [
"arn:aws:elasticmapreduce:us-east-1:123456789012:cluster/clusterId"
]
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:AddJobFlowSteps",
"elasticmapreduce:DescribeStep",
"elasticmapreduce:CancelSteps"
],
"Resource": "arn:aws:elasticmapreduce:*:*:cluster/*"
}
]
}
```
### `cancelStep`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "elasticmapreduce:CancelSteps",
"Resource": [
"arn:aws:elasticmapreduce:us-east-1:123456789012:cluster/myCluster-id"
]
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "elasticmapreduce:CancelSteps",
"Resource": "arn:aws:elasticmapreduce:*:*:cluster/*"
}
]
}
```
### `createCluster`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:RunJobFlow",
"elasticmapreduce:DescribeCluster",
"elasticmapreduce:TerminateJobFlows"
],
"Resource": "*"
},
{
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": [
"arn:aws:iam::123456789012:role/myRoleName"
]
}
]
}
```
### `setClusterTerminationProtection`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "elasticmapreduce:SetTerminationProtection",
"Resource": [
"arn:aws:elasticmapreduce:us-east-1:123456789012:cluster/myCluster-id"
]
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "elasticmapreduce:SetTerminationProtection",
"Resource": "arn:aws:elasticmapreduce:*:*:cluster/*"
}
]
}
```
### `modifyInstanceFleetByName`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:ModifyInstanceFleet",
"elasticmapreduce:ListInstanceFleets"
],
"Resource": [
"arn:aws:elasticmapreduce:us-east-1:123456789012:cluster/myCluster-id"
]
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:ModifyInstanceFleet",
"elasticmapreduce:ListInstanceFleets"
],
"Resource": "arn:aws:elasticmapreduce:*:*:cluster/*"
}
]
}
```
### `modifyInstanceGroupByName`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:ModifyInstanceGroups",
"elasticmapreduce:ListInstanceGroups"
],
"Resource": [
"arn:aws:elasticmapreduce:us-east-1:123456789012:cluster/myCluster-id"
]
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:ModifyInstanceGroups",
"elasticmapreduce:ListInstanceGroups"
],
"Resource": "*"
}
]
}
```
### `terminateCluster`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:TerminateJobFlows",
"elasticmapreduce:DescribeCluster"
],
"Resource": [
"arn:aws:elasticmapreduce:us-east-1:123456789012:cluster/myCluster-id"
]
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:TerminateJobFlows",
"elasticmapreduce:DescribeCluster"
],
"Resource": "arn:aws:elasticmapreduce:*:*:cluster/*"
}
]
}
```
# を使用した EKS での Amazon EMR クラスターの作成と管理 AWS Step Functions
Amazon EMR on EKS サービス統合 APIs を使用して Amazon EMR on EKS AWS Step Functions と を統合する方法について説明します。サービス統合 API は EKS API の対応する Amazon EMR と同じですが、次の表で示すとおり、すべての API があらゆる統合パターンをサポートしているわけではありません。
Step Functions での AWS サービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された Amazon EMR on EKS 統合と Amazon EMR on EKS AWS SDK 統合の違い**
[ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) 統合パターンがサポートされています。
[レスポンスのリクエスト](connect-to-resource.md#connect-default) 統合パターンに固有の最適化はありません。
[タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token) 統合パターンはサポートされていません。
**注記**
Amazon EMR との統合のため、Step Functions は最初の 10 分とその後の 300 秒間、ジョブポーリング頻度をハードコーディングして 60 秒に設定しています。
| API | リクエストレスポンス | ジョブの実行 (.sync) |
| --- | --- | --- |
| CreateVirtualCluster | サポート | サポートされません |
| DeleteVirtualCluster | サポート対象 | サポート |
| StartJobRun | サポート対象 | サポート |
EKS API 上でサポートされる Amazon EMR は次のとおりです。
**入力または結果データのクォータ**
サービス間でデータを送受信する際、タスクの入力または結果の最大サイズは、UTF-8 でエンコードされた文字列で 256 KiB です。「[ステートマシンの実行に関連するクォータ](service-quotas.md#service-limits-state-machine-executions)」を参照してください。
+ [https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_CreateVirtualCluster.html](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_CreateVirtualCluster.html)
+ [リクエストの構文](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_CreateVirtualCluster.html#API_CreateVirtualCluster_RequestSyntax)
+ [サポートされているパラメータ](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_CreateVirtualCluster.html#API_CreateVirtualCluster_RequestBody)
+ [レスポンスの構文](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_CreateVirtualCluster.html#API_CreateVirtualCluster_ResponseSyntax)
+ [https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_DeleteVirtualCluster.html](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_DeleteVirtualCluster.html)
+ [リクエストの構文](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_DeleteVirtualCluster.html#API_DeleteVirtualCluster_RequestSyntax)
+ [サポートされているパラメータ](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_DeleteVirtualCluster.html#API_DeleteVirtualCluster_RequestParameters)
+ [レスポンスの構文](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_CreateVirtualCluster.html#API_CreateVirtualCluster_ResponseSyntax)
+ [https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_StartJobRun.html](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_StartJobRun.html)
+ [リクエストの構文](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_StartJobRun.html#API_StartJobRun_RequestSyntax)
+ [サポートされているパラメータ](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_StartJobRun.html#API_StartJobRun_RequestParameters)
+ [レスポンスの構文](https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_StartJobRun.html#API_StartJobRun_ResponseSyntax)
以下には仮想クラスターを作成する `Task` 状態が含まれています。
```
"Create_Virtual_Cluster": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-containers:createVirtualCluster",
"Arguments": {
"Name": "MyVirtualCluster",
"ContainerProvider": {
"Id": "EKSClusterName",
"Type": "EKS",
"Info": {
"EksInfo": {
"Namespace": "Namespace"
}
}
}
},
"End": true
}
```
以下には、 ジョブを仮想クラスターに送信し、完了するまで待機する `Task` 状態が含まれます。
```
"Submit_Job": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-containers:startJobRun.sync",
"Arguments": {
"Name": "MyJobName",
"VirtualClusterId": "{% $VirtualClusterId %}",
"ExecutionRoleArn": "arn:aws:iam:::role/job-execution-role",
"ReleaseLabel": "emr-6.2.0-latest",
"JobDriver": {
"SparkSubmitJobDriver": {
"EntryPoint": "s3:///jobs/trip-count.py",
"EntryPointArguments": [
"60"
],
"SparkSubmitParameters": "--conf spark.driver.cores=2 --conf spark.executor.instances=10 --conf spark.kubernetes.pyspark.pythonVersion=3 --conf spark.executor.memory=10G --conf spark.driver.memory=10G --conf spark.executor.cores=1 --conf spark.dynamicAllocation.enabled=false"
}
},
"ConfigurationOverrides": {
"ApplicationConfiguration": [
{
"Classification": "spark-defaults",
"Properties": {
"spark.executor.instances": "2",
"spark.executor.memory": "2G"
}
}
],
"MonitoringConfiguration": {
"PersistentAppUI": "ENABLED",
"CloudWatchMonitoringConfiguration": {
"LogGroupName": "MyLogGroupName",
"LogStreamNamePrefix": "MyLogStreamNamePrefix"
},
"S3MonitoringConfiguration": {
"LogUri": "s3://"
}
}
},
"Tags": {
"taskType": "jobName"
}
},
"End": true
}
```
以下には、仮想クラスターを削除し、削除が完了するまで待機する `Task` 状態が含まれます。
```
"Delete_Virtual_Cluster": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-containers:deleteVirtualCluster.sync",
"Arguments": {
"Id": "{% $states.input.VirtualClusterId %}",
},
"End": true
}
```
を他の AWS サービスStep Functionsで使用する際のIAMアクセス許可の設定については、「」を参照してください[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)。
# Step Functions で Amazon EMR Serverless アプリケーションを作成および管理する
Step Functions を使用して EMR Serverless でアプリケーションを作成、開始、停止、削除する方法について説明します。このページでは、サポートされている API を一覧表示し、一般的なユースケースを実行するための `Task` 状態の例を示します。
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された EMR Serverless 統合の主な機能**
最適化された EMR Serverless サービス統合には、基になる EMR Serverless API をラップする [API](#connect-emr-serverless-custom-apis) のカスタマイズされたセットがあります。このカスタマイズにより、最適化されたEMR Serverless統合は AWSSDK サービス統合とは大きく異なります。
さらに、最適化された EMR Serverless 統合は [ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) 統合パターンをサポートします。
[タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token) 統合パターンは**サポートされていません**。
## EMR Serverless サービス統合 API
AWS Step Functions を EMR Serverless と統合するために、以下の 6 つの EMR Serverless サービス統合 API を使用できます。これらのサービス統合 API は、対応する EMR Serverless API に似ていますが、渡されるフィールドと返される応答にいくつかの違いがあります。
各 EMR Serverless サービス統合 API と対応する EMR Serverless API の違いを次の表に示します。
| EMR Serverless サービス統合 API | 対応する EMR Serverless API | 相違点 |
| --- | --- | --- |
| *createApplication* アプリケーションを作成します。 EMR Serverless はサービスリンクロールとして知られる IAM ロールの一意のタイプにリンクされています。`createApplication` と `createApplication.sync` が機能するには、サービスリンクロール `AWSServiceRoleForAmazonEMRServerless` を作成するために必要なアクセス許可が設定されている必要があります。IAM アクセス許可ポリシーに追加できるステートメントなど、詳細については、「[EMR Serverless のサービスにリンクされたロールの使用](https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/using-service-linked-roles.html)」を参照してください。 | [CreateApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_CreateApplication.html) | なし |
| *createApplication.sync* アプリケーションを作成します。 | [CreateApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_CreateApplication.html) | EMR Serverless API と EMR Serverless サービス統合 API のリクエストとレスポンスには違いはありません。ただし、*createApplication.sync* はアプリケーションが `CREATED` 状態に達するまで待機します。 |
| *startApplication* 指定されたアプリケーションを起動し、設定されている場合はアプリケーションの初期容量を初期化します。 | [StartApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StartApplication.html) | EMR Serverless API レスポンスにはデータは含まれませんが、EMR Serverless サービス統合 API レスポンスには以下のデータが含まれます。 {
"ApplicationId": "string"
} |
| *startApplication.sync* 指定されたアプリケーションを起動し、設定されている場合は初期容量を初期化します。 | [StartApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StartApplication.html) | EMR Serverless API レスポンスにはデータは含まれませんが、EMR Serverless サービス統合 API レスポンスには以下のデータが含まれます。 {
"ApplicationId": "string"
} また、*startApplication.sync* はアプリケーションが `STARTED` 状態に達するまで待機します。 |
| *stopApplication* 指定されたアプリケーションを停止し、設定されている場合は初期容量を解放します。アプリケーションを停止する前に、スケジュールされたジョブと実行中のジョブをすべて完了またはキャンセルする必要があります。 | [StopApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StopApplication.html) | EMR Serverless API レスポンスにはデータは含まれませんが、EMR Serverless サービス統合 API レスポンスには以下のデータが含まれます。 {
"ApplicationId": "string"
} |
| *stopApplication.sync* 指定されたアプリケーションを停止し、設定されている場合は初期容量を解放します。アプリケーションを停止する前に、スケジュールされたジョブと実行中のジョブをすべて完了またはキャンセルする必要があります。 | [StopApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StopApplication.html) | EMR Serverless API レスポンスにはデータは含まれませんが、EMR Serverless サービス統合 API レスポンスには以下のデータが含まれます。 {
"ApplicationId": "string"
} また、*stopApplication.sync* はアプリケーションが `STOPPED` 状態に達するまで待機します。 |
| *DeleteApplication* アプリケーションを削除します アプリケーションを削除するには、そのアプリケーションが `STOPPED` または `CREATED` 状態になっている必要があります。 | [DeleteApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_DeleteApplication.html) | EMR Serverless API レスポンスにはデータは含まれませんが、EMR Serverless サービス統合 API レスポンスには以下のデータが含まれます。 {
"ApplicationId": "string"
} |
| *deleteApplication.sync* アプリケーションを削除します アプリケーションを削除するには、そのアプリケーションが `STOPPED` または `CREATED` 状態になっている必要があります。 | [DeleteApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_DeleteApplication.html) | EMR Serverless API レスポンスにはデータは含まれませんが、EMR Serverless サービス統合 API レスポンスには以下のデータが含まれます。 {
"ApplicationId": "string"
} また、*stopApplication.sync* はアプリケーションが `TERMINATED` 状態に達するまで待機します。 |
| *startJobRun* ジョブ実行を開始します。 | [StartJobRun](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StartJobRun.html) | なし |
| *startJobRun.sync* ジョブ実行を開始します。 | [StartJobRun](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StartJobRun.html) | EMR Serverless API と EMR Serverless サービス統合 API のリクエストとレスポンスには違いはありません。ただし、*startJobRun.sync* はアプリケーションが `SUCCESS` 状態に達するまで待機します。 |
| *cancelJobRun* ジョブ実行をキャンセルします。 | [CancelJobRun](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_CancelJobRun.html) | なし |
| *cancelJobRun.sync* ジョブ実行をキャンセルします。 | [CancelJobRun](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_CancelJobRun.html) | EMR Serverless API と EMR Serverless サービス統合 API のリクエストとレスポンスには違いはありません。ただし、*cancelJobRun.sync* はアプリケーションが `CANCELLED` 状態に達するまで待機します。 |
## EMR サーバーレス統合のユースケース
最適化された EMR Serverless サービス統合では、アプリケーションを 1 つ作成して、そのアプリケーションを使用して複数のジョブを実行することをお勧めします。例えば、1 つのステートマシンに、同じアプリケーションを使用する複数の [startJobRun](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StartJobRun.html) リクエストを含めることができます。以下の [Task ワークフロー状態](state-task.md) 状態の例は、API EMR Serverless を Step Functions と統合するユースケースを示しています。EMR Serverless のその他のユースケースの情報については、「[Amazon EMR Serverless とは](https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/emr-serverless.html)」を参照してください。
**ヒント**
EMR Serverless と統合して複数のジョブを実行するステートマシンの例をデプロイするには、「[EMR Serverless ジョブを実行する](sample-emr-serverless-job.md)」を参照してください。
+ [アプリケーションの作成](#connect-emr-serverless-task-state-createapp)
+ [アプリケーションの起動](#connect-emr-serverless-task-state-startapp)
+ [アプリケーションの停止](#connect-emr-serverless-task-state-stopapp)
+ [アプリケーションの削除](#connect-emr-serverless-task-state-deleteapp)
+ [アプリケーションでのジョブの開始](#connect-emr-serverless-task-state-startjobrun)
+ [アプリケーションでのジョブのキャンセル](#connect-emr-serverless-task-state-canceljobrun)
を他の AWSサービスStep Functionsで使用する際のIAMアクセス許可の設定については、「」を参照してください[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)。
以下のユースケースの例で*斜体で示されている*テキストを、リソース固有の情報に置き換えてください。例えば、*yourApplicationId* を EMR Serverless アプリケーションの ID (`00yv7iv71inak893` など) に置き換えてください。
### アプリケーションの作成
次のタスクステートの例では、*createApplication.sync* サービス統合 API を使用してアプリケーションを作成しています。
```
"Create_Application": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-serverless:createApplication.sync",
"Arguments": {
"Name": "MyApplication",
"ReleaseLabel": "emr-6.9.0",
"Type": "SPARK"
},
"End": true
}
```
### アプリケーションの起動
次のタスク状態の例では、*startApplication.sync* サービス統合 API を使用してアプリケーションを起動します。
```
"Start_Application": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-serverless:startApplication.sync",
"Arguments": {
"ApplicationId": "yourApplicationId"
},
"End": true
}
```
### アプリケーションの停止
次のタスク状態の例では、*stopApplication.sync* サービス統合 API を使用してアプリケーションを停止します。
```
"Stop_Application": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-serverless:stopApplication.sync",
"Arguments": {
"ApplicationId": "yourApplicationId"
},
"End": true
}
```
### アプリケーションの削除
次のタスク状態の例では、*deleteApplication.sync* サービス統合 API を使用してアプリケーションを削除します。
```
"Delete_Application": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-serverless:deleteApplication.sync",
"Arguments": {
"ApplicationId": "yourApplicationId"
},
"End": true
}
```
### アプリケーションでのジョブの開始
次のタスク状態の例では、*startJobRun.sync* サービス統合 API を使用してアプリケーションでジョブを開始します。
```
"Start_Job": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-serverless:startJobRun.sync",
"Arguments": {
"ApplicationId": "yourApplicationId",
"ExecutionRoleArn": "arn:aws:iam::account-id:role/myEMRServerless-execution-role",
"JobDriver": {
"SparkSubmit": {
"EntryPoint": "s3:///sample.py",
"EntryPointArguments": ["1"],
"SparkSubmitParameters": "--conf spark.executor.cores=4 --conf spark.executor.memory=4g --conf spark.driver.cores=2 --conf spark.driver.memory=4g --conf spark.executor.instances=1"
}
}
},
"End": true
}
```
### アプリケーションでのジョブのキャンセル
次のタスク状態の例では、*cancelJobRun.sync* サービス統合 API を使用してアプリケーション内のジョブをキャンセルします。
```
"Cancel_Job": {
"Type": "Task",
"Resource": "arn:aws:states:::emr-serverless:cancelJobRun.sync",
"Arguments": {
"ApplicationId": "{% $states.input.ApplicationId %}",
"JobRunId": "{% $states.input.JobRunId %}"
},
"End": true
}
```
## Amazon EMR Serverless を呼び出すための IAM ポリシー
コンソールを使用してステートマシンを作成すると、必要な最小特権を持つステートマシンの実行ロールがStep Functions によって自動的に作成されます。これらの自動生成されたIAMロールは、ステートマシンを作成する AWS リージョンで有効です。
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
IAM ポリシーを作成するときは、ポリシーにワイルドカードを含めないことをお勧めします。セキュリティのベストプラクティスとして、ポリシーの範囲をできるだけ絞り込む必要があります。動的ポリシーは、ランタイム中に特定の入力パラメータが不明な場合にのみ使用してください。
さらに、管理者ユーザーが非管理者ユーザーに、ステートマシンを実行するための実行ロールを付与する場合には注意が必要です。自分でポリシーを作成する場合は、実行ロールに PassRole ポリシーを含めることをお勧めします。また、実行ロールには `aws:SourceARN` および `aws:SourceAccount` のコンテキストキーを追加することをお勧めします。
### EMR Serverless と Step Functions の統合の場合の IAM ポリシーの例
+ [CreateApplication の IAM ポリシーの例](#emr-serverless-policy-createapp)
+ [StartApplication の IAM ポリシーの例](#emr-serverless-policy-startapp)
+ [StopApplication の IAM ポリシーの例](#emr-serverless-policy-stopapp)
+ [DeleteApplication の IAM ポリシーの例](#emr-serverless-policy-deleteapp)
+ [StartJobRun の IAM ポリシーの例](#emr-serverless-policy-startjobrun)
+ [CancelJobRun の IAM ポリシーの例](#emr-serverless-policy-canceljobrun)
#### CreateApplication の IAM ポリシーの例
以下は、CreateApplication が [Task ワークフロー状態](state-task.md) 状態でのステートマシンの IAM ポリシーの例です。
**注記**
アカウントで初めてアプリケーションを作成するときには、IAM ポリシーで CreateServiceLinkedRole 許可を指定する必要があります。それ以降、この許可を追加する必要はありません。CreateServiceLinkedRole の詳細については、https://docs.aws.amazon.com/IAM/latest/APIReference/ の「[CreateServiceLinkedRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateServiceLinkedRole.html)」を参照してください。
以下のポリシーは、静的リソースと動的リソースで同じです。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:CreateApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/*"
]
},
{
"Effect": "Allow",
"Action": [
"emr-serverless:GetApplication",
"emr-serverless:DeleteApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessApplicationRule"
]
},
{
"Effect": "Allow",
"Action": "iam:CreateServiceLinkedRole",
"Resource": "arn:aws:iam::123456789012:role/aws-service-role/ops.emr-serverless.amazonaws.com/AWSServiceRoleForAmazonEMRServerless*",
"Condition": {
"StringLike": {
"iam:AWSServiceName": "ops.emr-serverless.amazonaws.com"
}
}
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:CreateApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/*"
]
},
{
"Effect": "Allow",
"Action": "iam:CreateServiceLinkedRole",
"Resource": "arn:aws:iam::123456789012:role/aws-service-role/ops.emr-serverless.amazonaws.com/AWSServiceRoleForAmazonEMRServerless*",
"Condition": {
"StringLike": {
"iam:AWSServiceName": "ops.emr-serverless.amazonaws.com"
}
}
}
]
}
```
------
#### StartApplication の IAM ポリシーの例
**静的リソース**
以下は、StartApplication が [Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の静的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartApplication",
"emr-serverless:GetApplication",
"emr-serverless:StopApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessApplicationRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
}
]
}
```
------
**動的リソース**
以下は、StartApplication が[Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の動的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartApplication",
"emr-serverless:GetApplication",
"emr-serverless:StopApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessApplicationRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
}
]
}
```
------
#### StopApplication の IAM ポリシーの例
**静的リソース**
以下は、StopApplication が [Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の静的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StopApplication",
"emr-serverless:GetApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessApplicationRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StopApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
}
]
}
```
------
**動的リソース**
以下は、StopApplication が [Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の動的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StopApplication",
"emr-serverless:GetApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessApplicationRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StopApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
}
]
}
```
------
#### DeleteApplication の IAM ポリシーの例
**静的リソース**
以下は、DeleteApplication が [Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の静的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:DeleteApplication",
"emr-serverless:GetApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessApplicationRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:DeleteApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
}
]
}
```
------
**動的リソース**
以下は、DeleteApplication が [Task ワークフロー状態](state-task.md) 状態でステートマシンを使用する場合の動的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:DeleteApplication",
"emr-serverless:GetApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessApplicationRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:DeleteApplication"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
}
]
}
```
------
#### StartJobRun の IAM ポリシーの例
**静的リソース**
以下は、StartJobRun が [Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の静的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
},
{
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": [
"arn:aws:iam::123456789012:role/jobExecutionRoleArn"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "emr-serverless.amazonaws.com"
}
}
},
{
"Effect": "Allow",
"Action": [
"emr-serverless:GetJobRun",
"emr-serverless:CancelJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId/jobruns/*"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessJobRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId"
]
},
{
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": [
"arn:aws:iam::123456789012:role/jobExecutionRoleArn"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "emr-serverless.amazonaws.com"
}
}
}
]
}
```
------
**動的リソース**
以下は、StartJobRun が[Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の動的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartJobRun",
"emr-serverless:GetJobRun",
"emr-serverless:CancelJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
},
{
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": [
"arn:aws:iam::123456789012:role/jobExecutionRoleArn"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "emr-serverless.amazonaws.com"
}
}
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessJobRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:StartJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
},
{
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": [
"arn:aws:iam::123456789012:role/jobExecutionRoleArn"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "emr-serverless.amazonaws.com"
}
}
}
]
}
```
------
#### CancelJobRun の IAM ポリシーの例
**静的リソース**
以下は、CancelJobRun が [Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の静的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:CancelJobRun",
"emr-serverless:GetJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId/jobruns/jobRunId"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessJobRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:CancelJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/applicationId/jobruns/jobRunId"
]
}
]
}
```
------
**動的リソース**
以下は、CancelJobRun が [Task ワークフロー状態](state-task.md) 状態で、ステートマシンを使用する場合の動的リソースの IAM ポリシーの例です。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:CancelJobRun",
"emr-serverless:GetJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForEMRServerlessJobRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"emr-serverless:CancelJobRun"
],
"Resource": [
"arn:aws:emr-serverless:us-east-1:123456789012:/applications/*"
]
}
]
}
```
------
# Step Functions で EventBridge イベントを追加する
Step Functions は、Amazon EventBridge と統合するため、サービス統合 API を提供します。Step Functions ワークフローから直接カスタムイベントを送信して、イベント駆動型アプリケーションを構築する方法について説明します。
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された EventBridge 統合の主な機能**
実行 ARN とステートマシン ARN は、各 `PutEventsRequestEntry` の `Resources` フィールドに自動的に追加されます。
`PutEvents` からのレスポンスにゼロ以外の `FailedEntryCount` が含まれるのであれば、`Task` 状態はエラー `EventBridge.FailedEntry` で失敗します。
`PutEvents` API を使用する場合、送信するイベントの特定のパターンに一致する EventBridge ルールをアカウント内に作成する必要があります。例えば、次のことができます。
+ EventBridge ルールに一致するイベントを受信して印刷する Lambda 関数をアカウントに作成します。
+ 特定のイベントパターンに一致し、Lambda 関数をターゲットとする、デフォルトのイベントバスで EventBridge ルールをアカウントで作成します。
詳細については、以下を参照してください。
+ EventBridge ユーザーガイドの [PutEvents を使って Amazon EventBridge イベントを追加](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevents.html)。
+ サービス統合パターンの [タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token)。
以下には、カスタムイベントを送信する `Task` が含まれます。
```
{
"Type": "Task",
"Resource": "arn:aws:states:::events:putEvents",
"Arguments": {
"Entries": [
{
"Detail": {
"Message": "MyMessage"
},
"DetailType": "MyDetailType",
"EventBusName": "MyEventBus",
"Source": "my.source"
}
]
},
"End": true
}
```
**入力または結果データのクォータ**
サービス間でデータを送受信する際、タスクの入力または結果の最大サイズは、UTF-8 でエンコードされた文字列で 256 KiB です。「[ステートマシンの実行に関連するクォータ](service-quotas.md#service-limits-state-machine-executions)」を参照してください。
## 最適化された EventBridge API
サポートされている EventBridge API と構文には次のものが含まれます。
+ [https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html)
## エラー処理
`PutEvents` API はエントリの配列を入力として受け取り、結果エントリの配列を返します。`PutEvents` アクションが成功する限り、`PutEvents` は、1 つ以上のエントリが失敗した場合でも、HTTP 200 レスポンスを返します。`PutEvents` は `FailedEntryCount` フィールドの失敗したエントリの数を返します。
Step Functions、`FailedEntryCount` がゼロより大きいかどうかをチェックします。0 より大きい場合、Step Functions はエラー `EventBridge.FailedEntry` を使って状態を失敗させます。こうして、エントリに失敗した場合、キャッチまたは再試行のため、タスクの状態で Step Functions の組み込みエラー処理を使用できます。レスポンスから `FailedEntryCount` を分析する追加状態を使う必要はありません。
**注記**
べき等を実装し、すべてのエントリで安全に再試行できる場合は、Step Functions の再試行ロジックを使用できます。Step Functions は、再試行する前に、`PutEvents` 入力配列から成功したエントリを削除しません。代わりに、元のエントリの配列を使って再試行します。
## EventBridge を呼び出すための IAM ポリシー
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
### `PutEvents`
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Action": [
"events:PutEvents"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:event-bus/my-project-eventbus"
],
"Effect": "Allow"
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"events:PutEvents"
],
"Resource": "arn:aws:events:*:*:event-bus/*"
}
]
}
```
# Step Functions で AWS Glueジョブを開始する
Step Functions を使用して AWS Glue でジョブの実行を開始する方法について説明します。このページでは、サポートされている API アクションを一覧表示し、AWS Glueジョブを開始するための`Task`状態の例を示します。
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化AWS Glue統合の主な機能**
[ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) 統合パターンが利用可能です。
`JobName` フィールドがリクエストから抽出され、レスポンスに挿入されます。通常は `JobRunID` のみが含まれます。
以下には、 AWS Glueジョブを開始する`Task`状態が含まれます。
```
"Glue StartJobRun": {
"Type": "Task",
"Resource": "arn:aws:states:::glue:startJobRun.sync",
"Arguments": {
"JobName": "GlueJob-JTrRO5l98qMG"
},
"Next": "ValidateOutput"
},
```
**Step Functions のパラメータは PascalCase で表されます。**
ネイティブサービス API が、API アクション `startSyncExecution` などの camelCase である場合でも、`StateMachineArn` などの PascalCase でパラメータを指定します。
## AWS GlueAPIs
+ [https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html#aws-glue-api-jobs-runs-StartJobRun](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html#aws-glue-api-jobs-runs-StartJobRun)
## を呼び出すための IAM ポリシーAWS Glue
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
AWS Glueにはリソースベースのコントロールはありません。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"glue:StartJobRun",
"glue:GetJobRun",
"glue:GetJobRuns",
"glue:BatchStopJobRun"
],
"Resource": "*"
}
]
}
```
------
#### [ Request Response and Callback (.waitForTaskToken) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"glue:StartJobRun"
],
"Resource": "*"
}
]
}
```
------
# Step Functions で AWS Glue DataBrew ジョブを開始する
DataBrew 統合を使用して、Step Functions で分析および機械学習のワークフローにデータのクリーニングとデータの正規化手順を追加する方法について説明します。
Step Functions での AWS サービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
以下には、リクエスト/レスポンス DataBrew ジョブがスタートする `Task` 状態が含まれます。
```
"DataBrew StartJobRun": {
"Type": "Task",
"Resource": "arn:aws:states:::databrew:startJobRun",
"Arguments": {
"Name": "sample-proj-job-1"
},
"Next": "NEXT_STATE"
},
```
以下には、DataBrew ジョブをスタートする `Task` 状態が含まれます。
```
"DataBrew StartJobRun": {
"Type": "Task",
"Resource": "arn:aws:states:::databrew:startJobRun.sync",
"Arguments": {
"Name": "sample-proj-job-1"
},
"Next": "NEXT_STATE"
},
```
**Step Functions のパラメータは PascalCase で表されます。**
ネイティブサービス API が、API アクション `startSyncExecution` などの camelCase である場合でも、`StateMachineArn` などの PascalCase でパラメータを指定します。
## サポートされている DataBrew API
+ `[https://docs.aws.amazon.com/databrew/latest/dg/API_StartJobRun.html](https://docs.aws.amazon.com/databrew/latest/dg/API_StartJobRun.html)`
## DataBrew を呼び出すための IAM ポリシー
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシー AWS Step Functions を生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"databrew:startJobRun",
"databrew:listJobRuns",
"databrew:stopJobRun"
],
"Resource": [
"arn:aws:databrew:us-east-1:123456789012:job/*"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"databrew:startJobRun"
],
"Resource": [
"arn:aws:databrew:us-east-1:123456789012:job/*"
]
}
]
}
```
------
# Step Functions を使用して AWS Lambda関数を呼び出す
Step Functions を使用して、イベント駆動型サーバーレスアプリケーションの一部として同期的にまたは非同期的に Lambda 関数を呼び出す方法について説明します。
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された Lambda 統合の主な機能**
レスポンスの `Payload` フィールドは、エスケープされた Json から Json に解析されます。
Lambda 関数内で例外がスローされた場合、タスクは失敗します。実用的な例については、「[Step Functions ステートマシンでのエラー条件の処理](tutorial-handling-error-conditions.md)」を参照してください。
## 最適化された Lambda API
+ [https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html)
## ワークフローの例
以下には、Lambda 関数を呼び出す `Task` 状態が含まれます。
```
{
"StartAt":"CallLambda",
"States":{
"CallLambda":{
"Type":"Task",
"Resource":"arn:aws:states:::lambda:invoke",
"Arguments":{
"FunctionName":"arn:aws:lambda:region:account-id:function:MyFunction"
},
"End":true
}
}
}
```
以下には、[コールバック](connect-to-resource.md#connect-wait-token)サービス統合パターンを実行する `Task` の状態が含まれます。
```
{
"StartAt":"GetManualReview",
"States":{
"GetManualReview":{
"Type":"Task",
"Resource":"arn:aws:states:::lambda:invoke.waitForTaskToken",
"Arguments":{
"FunctionName":"arn:aws:lambda:region:account-id:function:get-model-review-decision",
"Payload":{
"model":"{% $states.input.my-model %}",
"TaskToken": "{% $states.context.Task.Token %}"
},
"Qualifier":"prod-v1"
},
"End":true
}
}
}
```
Lambda 関数を呼び出すと、実行は関数の完了を待ちます。コールバックタスクで Lambda 関数を呼び出す場合、Lambda 関数の実行が完了して結果を返すまで、ハートビートタイムアウトのカウントは開始されません。Lambda 関数が実行されている限り、ハートビートタイムアウトは適用されません。
ただし、次の例に示されているとおり、`InvocationType` パラメータを使って非同期で Lambda を呼び出すこともできます。
```
{
"Comment": "A Hello World example of the Amazon States Language using Pass states",
"StartAt": "Hello",
"States": {
"Hello": {
"Type": "Task",
"Resource": "arn:aws:states:::lambda:invoke",
"Arguments": {
"FunctionName": "arn:aws:lambda:region:account-id:function:echo",
"InvocationType": "Event"
},
"End": true
}
}
}
```
**注記**
Lambda 関数の非同期呼び出しでは、ハートビートタイムアウト期間がすぐに開始されます。
ときに `Task` の結果が返されると、関数の出力はメタデータのディクショナリ内にネストされます。例えば、次のようになります。
```
{
"ExecutedVersion":"$LATEST",
"Payload":"FUNCTION OUTPUT",
"SdkHttpMetadata":{
"HttpHeaders":{
"Connection":"keep-alive",
"Content-Length":"4",
"Content-Type":"application/json",
"Date":"Fri, 26 Mar 2021 07:42:02 GMT",
"X-Amz-Executed-Version":"$LATEST",
"x-amzn-Remapped-Content-Length":"0",
"x-amzn-RequestId":"0101aa0101-1111-111a-aa55-1010aaa1010",
"X-Amzn-Trace-Id":"root=1-1a1a000a2a2-fe0101aa10ab;sampled=0"
},
"HttpStatusCode":200
},
"SdkResponseMetadata":{
"RequestId":"6b3bebdb-9251-453a-ae45-512d9e2bf4d3"
},
"StatusCode":200
}
```
## 直接指定された関数リソース
または、「リソース」フィールドに関数 ARN を直接指定して Lambda 関数を呼び出せます。この方法で Lambda 関数を呼び出す場合、`.waitForTaskToken` を指定することはできず、タスク結果には関数の出力のみが含まれます。
```
{
"StartAt":"CallFunction",
"States":{
"CallFunction": {
"Type":"Task",
"Resource":"arn:aws:lambda:region:account-id:function:HelloFunction",
"End": true
}
}
}
```
この形式の統合では、関数は成功しても、`FunctionError` フィールドを含むレスポンスを返すことがあります。このシナリオでは、ワークフロータスクは失敗します。
Lambda 関数の特定バージョンまたはエイリアスを呼び出すには、`Resource` フィールドの ARN でそれらのオプションを指定します。Lambda ドキュメントで以下を参照してください。
+ [AWS Lambda バージョニング](https://docs.aws.amazon.com/lambda/latest/dg/versioning-intro.html)
+ [AWS Lambdaエイリアス](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)
## を呼び出すための IAM ポリシーAWS Lambda
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
次の例では、2 つのAWS Lambdaタスクを持つステートマシンが `function1`と を呼び出すと`function2`、自動生成されたポリシーには両方の関数に対する`lambda:Invoke`アクセス許可が含まれます。
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"lambda:InvokeFunction"
],
"Resource": [
"arn:aws:lambda:us-east-1:123456789012:function:myFn1",
"arn:aws:lambda:us-east-1:123456789012:function:myFn2"
]
}
]
}
```
# Step Functions を使用して AWS Elemental MediaConvertジョブを作成する
Step Functions を使用して [https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobspost](https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobspost) API を使用して AWS Elemental MediaConvertジョブを作成する方法について説明します。
**Step Functions と MediaConvert を試す**
長さが不明な SMTPE カラーバーを検出して動画クリップの先頭から削除するワークフローで MediaConvert 最適化統合を使用する方法について説明します。2024 年 4 月 12 日のブログ記事を読む: [https://aws.amazon.com/blogs/media/low-code-workflows-with-aws-elemental-mediaconvert/](https://aws.amazon.com/blogs/media/low-code-workflows-with-aws-elemental-mediaconvert/)
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された MediaConvert 統合の主な機能**
[ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) と [レスポンスのリクエスト](connect-to-resource.md#connect-default) の統合パターンがサポートされています。
Step Functions は MediaConvert ジョブに次のカスタムタグを追加します。`ManagedByService: AWSStepFunctions`
[タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token) 統合パターンに固有の最適化はありません。
次に示しているのは、MediaConvert ジョブを送信し、完了するまで待機する `Task` ステートです。
```
{
"StartAt": "MediaConvert_CreateJob",
"States": {
"MediaConvert_CreateJob": {
"Type": "Task",
"Resource": "arn:aws:states:::mediaconvert:createJob.sync",
"Arguments": {
"Role": "arn:aws:iam::111122223333:role/Admin",
"Settings": {
"OutputGroups": [
{
"Outputs": [
{
"ContainerSettings": {
"Container": "MP4"
},
"VideoDescription": {
"CodecSettings": {
"Codec": "H_264",
"H264Settings": {
"MaxBitrate": 1000,
"RateControlMode": "QVBR",
"SceneChangeDetect": "TRANSITION_DETECTION"
}
}
},
"AudioDescriptions": [
{
"CodecSettings": {
"Codec": "AAC",
"AacSettings": {
"Bitrate": 96000,
"CodingMode": "CODING_MODE_2_0",
"SampleRate": 48000
}
}
}
]
}
],
"OutputGroupSettings": {
"Type": "FILE_GROUP_SETTINGS",
"FileGroupSettings": {
"Destination": "s3://amzn-s3-demo-destination-bucket/"
}
}
}
],
"Inputs": [
{
"AudioSelectors": {
"Audio Selector 1": {
"DefaultSelection": "DEFAULT"
}
},
"FileInput": "s3://amzn-s3-demo-bucket/DOC-EXAMPLE-SOURCE_FILE"
}
]
}
},
"End": true
}
}
}
```
**Step Functions のパラメータは PascalCase で表されます。**
ネイティブサービス API が、API アクション `startSyncExecution` などの camelCase である場合でも、`StateMachineArn` などの PascalCase でパラメータを指定します。
## 最適化された MediaConvert API
+ [https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobspost](https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobspost)
+ [リクエストの構文](https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-request-body-post-example)
+ サポートされているパラメータ:
+ [https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-prop-createjobrequest-role](https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-prop-createjobrequest-role) (必須)
+ [https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-prop-createjobrequest-settings](https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-prop-createjobrequest-settings) (必須)
+ [https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-model-createjobrequest](https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-model-createjobrequest) (オプション)
+ [レスポンス構文](https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-response-examples) - 「**CreateJobResponse スキーマ**」を参照してください。
## を呼び出すための IAM ポリシーAWS Elemental MediaConvert
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
`GetJob` および `CancelJob` アクションに関する IAM ポリシーは、`ManagedByService: AWSStepFunctions` タグ付きのジョブへのアクセスのみを許可するようにスコープ設定されています。
**タグベースのポリシー**
自動生成された `ManagedByService: AWSStepFunctions` タグを変更すると、ステートマシンの実行は失敗します。
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "MediaConvertCreateJob",
"Effect": "Allow",
"Action": [
"mediaconvert:CreateJob"
],
"Resource": [
"arn:aws:mediaconvert:us-east-1:123456789012:queues/*",
"arn:aws:mediaconvert:us-east-1:123456789012:jobTemplates/*",
"arn:aws:mediaconvert:us-east-1:123456789012:presets/*"
]
},
{
"Sid": "MediaConvertManageJob",
"Effect": "Allow",
"Action": [
"mediaconvert:GetJob",
"mediaconvert:CancelJob"
],
"Resource": "arn:aws:mediaconvert:us-east-1:123456789012:jobs/*",
"Condition": {
"StringEquals": {
"aws:ResourceTag/ManagedByService": "AWSStepFunctions"
}
}
},
{
"Sid": "IamPassRole",
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/myRoleName"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": [
"mediaconvert.amazonaws.com"
]
}
}
},
{
"Sid": "EventBridgeManageRule",
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForMediaConvertJobRule"
]
}
]
}
```
------
#### [ Request Response ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "MediaConvertCreateJob",
"Effect": "Allow",
"Action": [
"mediaconvert:CreateJob"
],
"Resource": [
"arn:aws:mediaconvert:us-east-1:123456789012:queues/*",
"arn:aws:mediaconvert:us-east-1:123456789012:jobTemplates/*",
"arn:aws:mediaconvert:us-east-1:123456789012:presets/*"
]
},
{
"Sid": "IamPassRole",
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/myRoleName"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": [
"mediaconvert.amazonaws.com"
]
}
}
}
]
}
```
------
# Step Functions を使用して Amazon SageMaker AI ジョブを作成および管理する
Step Functions を使用して SageMaker AI でジョブを作成および管理する方法について説明します。このページでは、サポートされている SageMaker API アクションのリストと、SageMaker AI の変換、トレーニング、ラベル付け、および処理ジョブを作成する `Task` ステート例を示しています。
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された SageMaker AI 統合の主な特徴**
[ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) 統合パターンがサポートされています。
[レスポンスのリクエスト](connect-to-resource.md#connect-default) 統合パターンに固有の最適化はありません。
[タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token) 統合パターンはサポートされていません。
## 最適化された SageMaker AI API
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html)
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html)
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateHyperParameterTuningJob.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateHyperParameterTuningJob.html) - `.sync` 統合パターンをサポートします。
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateLabelingJob.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateLabelingJob.html) - `.sync` 統合パターンをサポートします。
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateModel.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateModel.html)
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateProcessingJob.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateProcessingJob.html) - `.sync` 統合パターンをサポートします。
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTrainingJob.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTrainingJob.html) - `.sync` 統合パターンをサポートします。
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTransformJob.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTransformJob.html) - `.sync` 統合パターンをサポートします。
+ [https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html)
**注記**
AWS Step Functionsは のポリシーを自動的に作成しません`CreateTransformJob`。インラインポリシーは、作成したロールにアタッチする必要があります。詳細については、次の IAM ポリシー例: [`CreateTrainingJob`](#sagemaker-iam-createtrainingjob) を参照してください。
## SageMaker AI 変換ジョブの例
次に示しているのは、Amazon SageMaker AI 変換ジョブを作成する`Task` ステートであり、`DataSource` と `TransformOutput` の Amazon S3 ロケーションを指定しています。
```
{
"SageMaker CreateTransformJob": {
"Type": "Task",
"Resource": "arn:aws:states:::sagemaker:createTransformJob.sync",
"Arguments": {
"ModelName": "SageMakerCreateTransformJobModel-9iFBKsYti9vr",
"TransformInput": {
"CompressionType": "None",
"ContentType": "text/csv",
"DataSource": {
"S3DataSource": {
"S3DataType": "S3Prefix",
"S3Uri": "s3://amzn-s3-demo-source-bucket1/TransformJobDataInput.txt"
}
}
},
"TransformOutput": {
"S3OutputPath": "s3://amzn-s3-demo-source-bucket1/TransformJobOutputPath"
},
"TransformResources": {
"InstanceCount": 1,
"InstanceType": "ml.m4.xlarge"
},
"TransformJobName": "sfn-binary-classification-prediction"
},
"Next": "ValidateOutput"
},
```
## SageMaker AI トレーニングジョブの例
次に示しているのは、Amazon SageMaker AI トレーニングジョブを作成する `Task` ステートです。
```
{
"SageMaker CreateTrainingJob":{
"Type":"Task",
"Resource":"arn:aws:states:::sagemaker:createTrainingJob.sync",
"Arguments":{
"TrainingJobName":"search-model",
"ResourceConfig":{
"InstanceCount":4,
"InstanceType":"ml.c4.8xlarge",
"VolumeSizeInGB":20
},
"HyperParameters":{
"mode":"batch_skipgram",
"epochs":"5",
"min_count":"5",
"sampling_threshold":"0.0001",
"learning_rate":"0.025",
"window_size":"5",
"vector_dim":"300",
"negative_samples":"5",
"batch_size":"11"
},
"AlgorithmSpecification":{
"TrainingImage":"...",
"TrainingInputMode":"File"
},
"OutputDataConfig":{
"S3OutputPath":"s3://amzn-s3-demo-destination-bucket1/doc-search/model"
},
"StoppingCondition":{
"MaxRuntimeInSeconds":100000
},
"RoleArn":"arn:aws:iam::account-id:role/docsearch-stepfunction-iam-role",
"InputDataConfig":[
{
"ChannelName":"train",
"DataSource":{
"S3DataSource":{
"S3DataType":"S3Prefix",
"S3Uri":"s3://amzn-s3-demo-destination-bucket1/doc-search/interim-data/training-data/",
"S3DataDistributionType":"FullyReplicated"
}
}
}
]
},
"Retry":[
{
"ErrorEquals":[
"SageMaker.AmazonSageMakerException"
],
"IntervalSeconds":1,
"MaxAttempts":100,
"BackoffRate":1.1
},
{
"ErrorEquals":[
"SageMaker.ResourceLimitExceededException"
],
"IntervalSeconds":60,
"MaxAttempts":5000,
"BackoffRate":1
},
{
"ErrorEquals":[
"States.Timeout"
],
"IntervalSeconds":1,
"MaxAttempts":5,
"BackoffRate":1
}
],
"Catch":[
{
"ErrorEquals":[
"States.ALL"
],
"Next":"Sagemaker Training Job Error"
}
],
"Next":"Delete Interim Data Job"
}
}
```
## SageMaker AI ラベル付けジョブの例
次に示しているのは、Amazon SageMaker AI ラベル付けジョブを作成する `Task` ステートです。
```
{
"StartAt": "SageMaker CreateLabelingJob",
"TimeoutSeconds": 3600,
"States": {
"SageMaker CreateLabelingJob": {
"Type": "Task",
"Resource": "arn:aws:states:::sagemaker:createLabelingJob.sync",
"Arguments": {
"HumanTaskConfig": {
"AnnotationConsolidationConfig": {
"AnnotationConsolidationLambdaArn": "arn:aws:lambda:region:123456789012:function:ACS-TextMultiClass"
},
"NumberOfHumanWorkersPerDataObject": 1,
"PreHumanTaskLambdaArn": "arn:aws:lambda:region:123456789012:function:PRE-TextMultiClass",
"TaskDescription": "Classify the following text",
"TaskKeywords": [
"tc",
"Labeling"
],
"TaskTimeLimitInSeconds": 300,
"TaskTitle": "Classify short bits of text",
"UiConfig": {
"UiTemplateS3Uri": "s3://amzn-s3-demo-bucket/TextClassification.template"
},
"WorkteamArn": "arn:aws:sagemaker:region:123456789012:workteam/private-crowd/ExampleTesting"
},
"InputConfig": {
"DataAttributes": {
"ContentClassifiers": [
"FreeOfPersonallyIdentifiableInformation",
"FreeOfAdultContent"
]
},
"DataSource": {
"S3DataSource": {
"ManifestS3Uri": "s3://amzn-s3-demo-bucket/manifest.json"
}
}
},
"LabelAttributeName": "Categories",
"LabelCategoryConfigS3Uri": "s3://amzn-s3-demo-bucket/labelcategories.json",
"LabelingJobName": "example-job-name",
"OutputConfig": {
"S3OutputPath": "s3://amzn-s3-demo-bucket/output"
},
"RoleArn": "arn:aws:iam::123456789012:role/service-role/AmazonSageMaker-ExecutionRole",
"StoppingConditions": {
"MaxHumanLabeledObjectCount": 10000,
"MaxPercentageOfInputDatasetLabeled": 100
}
},
"Next": "ValidateOutput"
},
"ValidateOutput": {
"Type": "Choice",
"Choices": [
{
"Next": "Success",
"Condition": "{% $states.input.LabelingJobArn != '' %}"
}
],
"Default": "Fail"
},
"Success": {
"Type": "Succeed"
},
"Fail": {
"Type": "Fail",
"Error": "InvalidOutput",
"Cause": "Output is not what was expected. This could be due to a service outage or a misconfigured service integration."
}
}
}
```
## SageMaker AI 処理ジョブの例
次に示しているのは、Amazon SageMaker AI 処理ジョブを作成する `Task` ステートです。
```
{
"StartAt": "SageMaker CreateProcessingJob Sync",
"TimeoutSeconds": 3600,
"States": {
"SageMaker CreateProcessingJob Sync": {
"Type": "Task",
"Resource": "arn:aws:states:::sagemaker:createProcessingJob.sync",
"Arguments": {
"AppSpecification": {
"ImageUri": "737474898029.dkr.ecr.sa-east-1.amazonaws.com/sagemaker-scikit-learn:0.20.0-cpu-py3"
},
"ProcessingResources": {
"ClusterConfig": {
"InstanceCount": 1,
"InstanceType": "ml.t3.medium",
"VolumeSizeInGB": 10
}
},
"RoleArn": "arn:aws:iam::account-id:role/SM-003-CreateProcessingJobAPIExecutionRole",
"ProcessingJobName.$": "$.id"
},
"Next": "ValidateOutput"
},
"ValidateOutput": {
"Type": "Choice",
"Choices": [
{
"Not": {
"Variable": "$.ProcessingJobArn",
"StringEquals": ""
},
"Next": "Succeed"
}
],
"Default": "Fail"
},
"Succeed": {
"Type": "Succeed"
},
"Fail": {
"Type": "Fail",
"Error": "InvalidConnectorOutput",
"Cause": "Connector output is not what was expected. This could be due to a service outage or a misconfigured connector."
}
}
}
```
## Amazon SageMaker AI の呼び出しに関する IAM ポリシー
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
**注記**
これらの例では、`roleArn` は、SageMaker AI がモデルアーティファクトおよび Docker イメージにアクセスして、ML コンピューティングインスタンスのデプロイ、またはバッチ変換ジョブに使用する IAM ロールの Amazon リソースネーム (ARN) を参照します。詳細については、[Amazon SageMaker ロール](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html)を参照してください。
### `CreateTrainingJob`
静的リソース**
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTrainingJob",
"sagemaker:DescribeTrainingJob",
"sagemaker:StopTrainingJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:training-job/myJobName*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForSageMakerTrainingJobsRule"
]
}
]
}
```
------
#### [ Request Response and Callback (.waitForTaskToken) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTrainingJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:training-job/myJobName*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
}
]
}
```
------
動的リソース**
------
#### [ .sync or .waitForTaskToken ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTrainingJob",
"sagemaker:DescribeTrainingJob",
"sagemaker:StopTrainingJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:training-job/*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForSageMakerTrainingJobsRule"
]
}
]
}
```
------
#### [ Request Response and Callback (.waitForTaskToken) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTrainingJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:training-job/*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
}
]
}
```
------
### `CreateTransformJob`
**注記**
AWS Step Functionsは、SageMaker AI と統合するステートマシンを作成する`CreateTransformJob`ときに、 のポリシーを自動的に作成しません。次のいずれかの IAM の例に基づいて、作成されたロールにインラインポリシーをアタッチする必要があります。
静的リソース**
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTransformJob",
"sagemaker:DescribeTransformJob",
"sagemaker:StopTransformJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:transform-job/myJobName*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForSageMakerTransformJobsRule"
]
}
]
}
```
------
#### [ Request Response and Callback (.waitForTaskToken) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTransformJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:transform-job/myJobName*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
}
]
}
```
------
動的リソース**
------
#### [ Run a Job (.sync) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTransformJob",
"sagemaker:DescribeTransformJob",
"sagemaker:StopTransformJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:transform-job/*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForSageMakerTransformJobsRule"
]
}
]
}
```
------
#### [ Request Response and Callback (.waitForTaskToken) ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sagemaker:CreateTransformJob"
],
"Resource": [
"arn:aws:sagemaker:us-east-1:123456789012:transform-job/*"
]
},
{
"Effect": "Allow",
"Action": [
"sagemaker:ListTags",
"sagemaker:AddTags"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": [
"arn:aws:iam::123456789012:role/MyExampleRole"
],
"Condition": {
"StringEquals": {
"iam:PassedToService": "sagemaker.amazonaws.com"
}
}
}
]
}
```
------
# Step Functions を使用して Amazon SNS トピックにメッセージを発行する
Step Functions を使用して Amazon SNS トピックにメッセージを発行する方法について説明します。このページでは、サポートされている Amazon SNS API アクションを一覧表示し、Amazon SNS にメッセージを公開するための `Task` 状態の例を示します。
Step Functions での AWSサービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
**最適化された Amazon SNS 統合の主な機能**
[レスポンスのリクエスト](connect-to-resource.md#connect-default) または [タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token) 統合パターンに固有の最適化はありません。
以下には、Amazon Simple Notification Service (Amazon SNS) トピックに発行する `Task` 状態が含まれます。
```
{
"StartAt": "Publish to SNS",
"States": {
"Publish to SNS": {
"Type": "Task",
"Resource": "arn:aws:states:::sns:publish",
"Arguments": {
"TopicArn": "arn:aws:sns:region:account-id:myTopic",
"Message": "{% states.input.message %}",
"MessageAttributes": {
"my_attribute_no_1": {
"DataType": "String",
"StringValue": "value of my_attribute_no_1"
},
"my_attribute_no_2": {
"DataType": "String",
"StringValue": "value of my_attribute_no_2"
}
}
},
"End": true
}
}
}
```
**動的な値を渡す**。上記の例を変更して、この JSON ペイロードから属性を動的に渡すことができます。
```
{
"message": "Hello world",
"SNSDetails": {
"attribute1": "some value",
"attribute2": "some other value",
}
}
```
次に示しているのは、`StringValue` フィールドに対して JSONata 式で値を設定する例です。
```
"MessageAttributes": {
"my_attribute_no_1": {
"DataType": "String",
"StringValue": "{% $states.input.SNSDetails.attribute1 %}"
},
"my_attribute_no_2": {
"DataType": "String",
"StringValue": "{% $states.input.SNSDetails.attribute2 %}"
}
```
以下には、Amazon SNS トピックに発行され、その後タスクトークンが返されるまで待機する `Task` 状態が含まれます。「[タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token)」を参照してください。
```
{
"StartAt":"Send message to SNS",
"States":{
"Send message to SNS":{
"Type":"Task",
"Resource":"arn:aws:states:::sns:publish.waitForTaskToken",
"Arguments":{
"TopicArn":"arn:aws:sns:region:account-id:myTopic",
"Message":{
"Input":"{% states.input.message %}",
"TaskToken": "{% $states.context.Task.Token %}"
}
},
"End":true
}
}
}
```
## 最適化された Amazon SNS API
+ [https://docs.aws.amazon.com/sns/latest/api/API_Publish.html](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html)
**Step Functions のパラメータは PascalCase で表されます。**
ネイティブサービス API が、API アクション `startSyncExecution` などの camelCase である場合でも、`StateMachineArn` などの PascalCase でパラメータを指定します。
**入力または結果データのクォータ**
サービス間でデータを送受信する際、タスクの入力または結果の最大サイズは、UTF-8 でエンコードされた文字列で 256 KiB です。「[ステートマシンの実行に関連するクォータ](service-quotas.md#service-limits-state-machine-executions)」を参照してください。
## Amazon SNS を呼び出すための IAM ポリシー
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシーAWS Step Functionsを生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sns:Publish"
],
"Resource": [
"arn:aws:sns:us-east-1:123456789012:myTopicName"
]
}
]
}
```
*パスに基づくリソース、または `TargetArn` か `PhoneNumber` に発行する*
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sns:Publish"
],
"Resource": "*"
}
]
}
```
# Step Functions を使用して Amazon SQS キューにメッセージを送信する
次の Amazon SQS API アクションと、Step Functions ワークフローの `Task` ステートコードの例を使用して、Amazon SQS キューにメッセージを送信できます。
Step Functions での AWS サービスとの統合については、[ サービスとの統合](integrate-services.md)「」および「」を参照してください[Step Functions でサービス API にパラメータを渡す](connect-parameters.md)。
Amazon SQS におけるメッセージの受信の詳細については、*Amazon Simple Queue Service デベロッパーガイド*の[メッセージの受信および削除](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/step-receive-delete-message.html)を参照してください。
次のサンプルには、オプションの **MessageAttributes** を付けて Amazon Simple Queue Service (Amazon SQS) メッセージを送信する `Task` ステート (JSONata) が含まれています。
```
{
"StartAt": "Send to SQS",
"States": {
"Send to SQS": {
"Type": "Task",
"Resource": "arn:aws:states:::sqs:sendMessage",
"Arguments": {
"QueueUrl": "https://sqs.us-east-1.amazonaws.com/account-id/myQueue",
"MessageBody": "{% $states.input.message %}",
"MessageAttributes": {
"my_attribute_no_1": {
"DataType": "String",
"StringValue": "attribute1"
},
"my_attribute_no_2": {
"DataType": "String",
"StringValue": "attribute2"
}
}
},
"End": true
}
}
}
```
次のステートマシンには、Amazon SQS キューにパブリッシュしてから、タスクトークンが返されるのを待機する `Task` ステートが含まれています。「[タスクトークンのコールバックまで待機する](connect-to-resource.md#connect-wait-token)」を参照してください。
```
{
"StartAt":"Send message to SQS",
"States":{
"Send message to SQS":{
"Type":"Task",
"Resource":"arn:aws:states:::sqs:sendMessage.waitForTaskToken",
"Arguments":{
"QueueUrl":"https://sqs.us-east-1.amazonaws.com/account-id/myQueue",
"MessageBody":{
"Input" : "{% $states.input.message %}",
"MyTaskToken" : "{% $states.context.Task.Token %}"
}
},
"End":true
}
}
}
```
## 最適化された Amazon SQS API
+ [https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html)
**Step Functions のパラメータは PascalCase で表されます。**
ネイティブサービス API が、API アクション `startSyncExecution` などの camelCase である場合でも、`StateMachineArn` などの PascalCase でパラメータを指定します。
**入力または結果データのクォータ**
サービス間でデータを送受信する際、タスクの入力または結果の最大サイズは、UTF-8 でエンコードされた文字列で 256 KiB です。「[ステートマシンの実行に関連するクォータ](service-quotas.md#service-limits-state-machine-executions)」を参照してください。
## Amazon SQS を呼び出すための IAM ポリシー
次のサンプルテンプレートは、 がステートマシン定義のリソースに基づいて IAM ポリシー AWS Step Functions を生成する方法を示しています。詳細については、「[Step Functions が統合サービスの IAM ポリシーを生成する方法](service-integration-iam-templates.md)」および「[Step Functions でサービス統合パターンを検出する](connect-to-resource.md)」を参照してください。
静的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sqs:SendMessage"
],
"Resource": [
"arn:aws:sqs:us-east-1:123456789012:myQueueName"
]
}
]
}
```
動的リソース**
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"sqs:SendMessage"
],
"Resource": "*"
}
]
}
```
# 実行中の実行から新しい AWS Step Functions ステートマシンを起動する
Step Functions は、サービス統合として独自の API と統合します。Step Functions を使用して、実行中のタスク状態から直接ステートマシンの新しい実行を開始する方法について説明します。新しいワークフローを構築するときに、[ネストされたワークフロー実行](concepts-nested-workflows.md)を使用して、メインワークフローの複雑さを軽減し、一般的なプロセスを再利用します。
**最適化された Step Functions 統合の主な機能**
[ジョブの実行 (.sync)](connect-to-resource.md#connect-sync) 統合パターンが利用可能です。
詳細については次を参照してください:
+ [Task から開始する](concepts-nested-workflows.md)
+ [ サービスとの統合](integrate-services.md)
+ [Step Functions でサービス API にパラメータを渡す](connect-parameters.md)
## 最適化された Step Functions API
+ [https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html)
## ワークフローの例
以下には、別のステートマシンの実行を開始し、その完了を待機する `Task` 状態が含まれています。
```
{
"Type":"Task",
"Resource":"arn:aws:states:::states:startExecution.sync:2",
"Arguments":{
"Input":{
"Comment": "Hello world!"
},
"StateMachineArn":"arn:aws:states:region:account-id:stateMachine:HelloWorld",
"Name":"ExecutionName"
},
"End":true
}
```
以下には、別のステートマシンの実行を開始する `Task` 状態が含まれています。
```
{
"Type":"Task",
"Resource":"arn:aws:states:::states:startExecution",
"Arguments":{
"Input":{
"Comment": "Hello world!"
},
"StateMachineArn":"arn:aws:states:region:account-id:stateMachine:HelloWorld",
"Name":"ExecutionName"
},
"End":true
}
```
以下には、[コールバック](connect-to-resource.md#connect-wait-token)サービス統合パターンを実行する `Task` の状態が含まれます。
```
{
"Type":"Task",
"Resource":"arn:aws:states:::states:startExecution.waitForTaskToken",
"Arguments":{
"Input":{
"Comment": "Hello world!",
"token": "{% $states.context.Task.Token %}"
},
"StateMachineArn":"arn:aws:states:region:account-id:stateMachine:HelloWorld",
"Name":"ExecutionName"
},
"End":true
}
```
ネストされたワークフロー実行を、それを開始した親実行に関連付けるには、[Context オブジェクト](input-output-contextobject.md)からプルされた実行 ID を含む特別な名前のパラメータを渡します。ネストされた実行を開始するときは、`AWS_STEP_FUNCTIONS_STARTED_BY_EXECUTION_ID` という名前のパラメータを使用します。で実行 ID を渡し、コンテキストオブジェクトの ID を参照します`$states.context.Execution.Id`。詳細については、「[Context オブジェクトへのアクセス](input-output-contextobject.md#contextobject-access)」を参照してください。
```
{
"Type":"Task",
"Resource":"arn:aws:states:::states:startExecution.sync",
"Arguments":{
"Input":{
"Comment": "Hello world!",
"AWS_STEP_FUNCTIONS_STARTED_BY_EXECUTION_ID": "{% $states.context.Execution.Id %}"
},
"StateMachineArn":"arn:aws:states:region:account-id:stateMachine:HelloWorld",
"Name":"ExecutionName"
},
"End":true
}
```
ネストされたステートマシンは、以下を返します。
| [リソース] | Output |
| --- | --- |
| startExecution.sync | String |
| startExecution.sync:2 | JSON |
どちらもネストされたステートマシンが完了するのを待機しますが、異なる `Output` 形式を返します。例えば、オブジェクト `{ "MyKey": "MyValue" }` を返す Lambda 関数を作成すると、次のレスポンスが得られます。
startExecution.sync の場合:
```
{
"Output": "{ \"MyKey\": \"MyValue\" }"
}
```
startExecution.sync:2 の場合:
```
{
"Output": {
"MyKey": "MyValue"
}
}
```
### ネストされたステートマシンの IAM アクセス許可の設定
親ステートマシンは、ポーリングとイベントを使用して子ステートマシンが実行を完了したかどうかを判断します。ポーリングには `states:DescribeExecution` のアクセス許可が必要ですが、EventBridge 経由で Step Functions に送信されるイベントには `events:PutTargets`、`events:PutRule`、`events:DescribeRule` のアクセス許可が必要です。IAM ロールにこれらのアクセス許可がない場合、親ステートマシンが子ステートマシンの実行完了を認識するまで、遅延が発生する可能性があります。
1 つのネストされたワークフロー実行のために `StartExecution` を呼び出すステートマシンの場合は、そのステートマシンへの許可を制限する IIAM ポリシーを使用します。
## ネストされた Step Functions ワークフローを呼び出すための IAM ポリシー
1 つのネストされたワークフロー実行のために `StartExecution` を呼び出すステートマシンの場合は、そのステートマシンへの許可を制限する IIAM ポリシーを使用します。
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"states:StartExecution"
],
"Resource": [
"arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachineName"
]
}
]
}
```
詳細については次を参照してください:
+ [サービスと Step Functions の統合](integrate-services.md)
+ [Step Functions でサービス API にパラメータを渡す](connect-parameters.md)
+ [実行中の実行から新しい AWS Step Functions ステートマシンを起動する](#connect-stepfunctions)
------
#### [ Synchronous ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"states:StartExecution"
],
"Resource": [
"arn:aws:states:us-east-1:123456789012:stateMachine:stateMachineName"
]
},
{
"Effect": "Allow",
"Action": [
"states:DescribeExecution",
"states:StopExecution"
],
"Resource": [
"arn:aws:states:us-east-1:123456789012:execution:myStateMachineName:*"
]
},
{
"Effect": "Allow",
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": [
"arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForStepFunctionsExecutionRule"
]
}
]
}
```
------
#### [ Asynchronous ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"states:StartExecution"
],
"Resource": [
"arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachineName"
]
}
]
}
```
------
**必要な ARN のタイプ**
**Synchronous** に関するポリシーでは、`states:StartExecution` にステートマシン ARN が必要ですが、`states:DescribeExecution` と `states:StopExecution` には実行 ARN が必要であることに注意してください。
誤って 3 つのアクションをすべて組み合わせた場合、JSON は有効ですが、IAM ポリシーは正しくありません。ポリシーが正しくないと、ワークフローの実行中にワークフローがスタックしたり、アクセスの問題が発生したりする可能性があります。
ネストされたワークフロー実行の詳細については、[Step Functions で Task 状態からワークフロー実行を開始する](concepts-nested-workflows.md) を参照してください。