ワークフロー

ワークフロー API では、AWS Glue でのワークフローの作成、更新、表示に関連するデータ型と API について説明します。ジョブ実行履歴には、ワークフローとジョブ実行のために 90 日間アクセスできます。

データ型

• JobNodeDetails の構造

• CrawlerNodeDetails 構造

• TriggerNodeDetails 構造

• Crawl 構造

• Node 構造

• Edge 構造

• Workflow 構造

• WorkflowGraph 構造

• WorkflowRun 構造

• WorkflowRunStatistics 構造

• StartingEventBatchCondition 構造

• Blueprint 構造

• BlueprintDetails 構造

• LastActiveDefinition 構造

• BlueprintRun 構造

JobNodeDetails の構造

ワークフロー内のジョブノードの詳細。

フィールド

• JobRuns – JobRun オブジェクトの配列。

  ジョブノードが表すジョブ実行に関する情報。

CrawlerNodeDetails 構造

ワークフロー内に存在するクローラノードの詳細。

フィールド

• Crawls – Crawl オブジェクトの配列。

  クロールノードが表すクロールのリスト。

TriggerNodeDetails 構造

ワークフロー内に存在するトリガーノードの詳細。

フィールド

• Trigger – Trigger トリガー) オブジェクト。

  トリガーノードが表すトリガーの情報。

Crawl 構造

ワークフロー内のクロールの詳細。

フィールド

• State - UTF-8 文字列 (有効値: RUNNING | CANCELLING | CANCELLED | SUCCEEDED | FAILED | ERROR).。

  クローラの状態。

• StartedOn – タイムスタンプ。

  クロールが開始された日時。

• CompletedOn – タイムスタンプ。

  クロールが完了した日時。

• ErrorMessage – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

  クロールに関連付けられたエラーメッセージ。

• LogGroup - UTF-8 文字列。1 ～ 512 バイト長。Log group string pattern に一致。

  クロールに関連付けられたロググループ。

• LogStream - UTF-8 文字列。1 ～ 512 バイト長。Log-stream string pattern に一致。

  クロールに関連付けられたログストリーム。

Node 構造

ノードは、ワークフローグラフ上で、AWS Glue コンポーネント (トリガー、クローラ、またはジョブ) を表しています。

フィールド

• Type – UTF-8 文字列 (有効な値: CRAWLER | JOB | TRIGGER)。

  ノードが表す AWS Glue コンポーネントのタイプ。

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  ノードが表す AWS Glue コンポーネントの名前。

• UniqueId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  ワークフロー内のノードに割り当てられた一意の ID。

• TriggerDetails – TriggerNodeDetails オブジェクト。

  ノードがトリガーを表すときのトリガーの詳細。

• JobDetails – JobNodeDetails オブジェクト。

  ノードがジョブを表すときのジョブの詳細。

• CrawlerDetails – CrawlerNodeDetails オブジェクト。

  ノードがクローラを表すときのクローラの詳細。

Edge 構造

エッジは、エッジが属するワークフローの一部である 2 つの AWS Glue コンポーネント間の有向接続を表します。

フィールド

• SourceId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  エッジの始点となるワークフロー内のノードの一意の ID。

• DestinationId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  エッジの終点となるワークフロー内のノードの一意の ID。

Workflow 構造

ワークフローは、複雑な ETL タスクを完了するために実行される複数の関連する AWS Glue ジョブとクローラのコレクションです。ワークフローは、それに含まれるすべてのジョブとクローラの実行とモニタリングを管理します。

フィールド

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  ワークフローの名前。

• Description – UTF-8 文字列。

  ワークフローの説明。

• DefaultRunProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、Single-line string pattern に一致します。

  各値は UTF-8 文字列。

  ワークフローの各実行の一部として使用されるプロパティのコレクション。実行プロパティは、ワークフローの各ジョブで使用できるようになっています。ジョブは、フロー内の次のジョブのためにプロパティを変更できます。

• CreatedOn – タイムスタンプ。

  ワークフローが作成された日時。

• LastModifiedOn – タイムスタンプ。

  ワークフローが最終に変更された日時。

• LastRun – WorkflowRun オブジェクト。

  ワークフローの最終の実行に関する情報。

• Graph – WorkflowGraph オブジェクト。

  ワークフローに属するすべての AWS Glue コンポーネントをノードとして表し、これらのコンポーネント間の有向接続をエッジとして表すグラフ。

• CreationStatus – UTF-8 文字列 (有効な値: CREATING | CREATED | CREATION_FAILED)。

  ワークフローの作成ステータス。

• MaxConcurrentRuns – 数値 (整数)。

  このパラメータを使用すると、データが不必要に複数回更新されないようにしたり、コストを管理したり、場合によってはコンポーネントジョブの同時実行の最大数を超えないようにしたりできます。このパラメータを空白のままにした場合、ワークフロー実行の数に制限はありません。

• BlueprintDetails – BlueprintDetails オブジェクト。

  この構造は、この特定のワークフローの作成元となるブループリントの詳細を示します。

WorkflowGraph 構造

ワークフローグラフは、ワークフロー内に存在するすべての AWS Glue コンポーネントと、これらのコンポーネント間のすべての有向接続を含むワークフロー全体を表します。

フィールド

• Nodes – ノード オブジェクトの配列。

  ワークフロー内でノードとして表される AWS Glue コンポーネントのリスト。

• Edges – Edge オブジェクトの配列。

  ワークフローに属するノード間のすべての有向接続のリスト。

WorkflowRun 構造

ワークフロー実行は、すべてのランタイム情報を提供するワークフローの実行です。

フィールド

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  実行されたワークフローの名前。

• WorkflowRunId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  このワークフロー実行の ID。

• PreviousRunId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  前回のワークフロー実行の ID。

• WorkflowRunProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、Single-line string pattern に一致します。

  各値は UTF-8 文字列。

  実行中に設定されたワークフロー実行のプロパティ。

• StartedOn – タイムスタンプ。

  ワークフロー実行の開始日時。

• CompletedOn – タイムスタンプ。

  ワークフロー実行の完了日時。

• Status – UTF-8 文字列 (有効な値: RUNNING | COMPLETED | STOPPING | STOPPED | ERROR)。

  ワークフロー実行のステータス。

• ErrorMessage – UTF-8 文字列。

  このエラーメッセージは、ワークフローの実行の開始時に発生した可能性のあるエラーを示します。現在のところ、唯一のエラーメッセージは「Concurrent runs exceeded for workflow: foo」(ワークフローの同時実行数を超えました: ) のみです。

• Statistics – WorkflowRunStatistics オブジェクト。

  実行の統計情報。

• Graph – WorkflowGraph オブジェクト。

  ワークフローに属するすべての AWS Glue コンポーネントをノードとして表し、これらのコンポーネント間の有向接続をエッジとして表すグラフ。

• StartingEventBatchCondition – StartingEventBatchCondition オブジェクト。

  ワークフロー実行を開始したバッチ条件。

WorkflowRunStatistics 構造

ワークフロー実行の統計は、ワークフロー実行に関する統計情報を提供します。

フィールド

• TotalActions – 数値 (整数)。

  ワークフロー実行のアクションの合計数。

• TimeoutActions – 数値 (整数)。

  タイムアウトしたアクションの合計数。

• FailedActions – 数値 (整数)。

  失敗したアクションの合計数。

• StoppedActions – 数値 (整数)。

  停止したアクションの合計数。

• SucceededActions – 数値 (整数)。

  成功したアクションの合計数。

• RunningActions – 数値 (整数)。

  実行中状態のアクションの合計数。

• ErroredActions – 数値 (整数)。

  ワークフロー実行で ERROR 状態のジョブ実行数を示します。

• WaitingActions – 数値 (整数)。

  ワークフロー実行で WAITING 状態のジョブ実行数を示します。

StartingEventBatchCondition 構造

ワークフロー実行を開始したバッチ条件。到着したイベント数がバッチサイズに到達したか (BatchSize メンバーがゼロ以外の場合)、バッチウィンドウの時間が経過したか (BatchWindow メンバーがゼロ以外の場合) のいずれかです。

フィールド

• BatchSize – 数値 (整数)。

  バッチ内のイベント数。

• BatchWindow – 数値 (整数)。

  バッチウィンドウの持続時間 (秒単位)。

Blueprint 構造

ブループリントの詳細。

フィールド

• Name – UTF-8 文字列。1～128 バイト長。Custom string pattern #27 に一致。

  ブループリントの名前。

• Description – UTF-8 文字列。1～512 バイト長。

  ブループリントの説明。

• CreatedOn – タイムスタンプ。

  ブループリントが登録された日時。

• LastModifiedOn – タイムスタンプ。

  ブループリントの最終変更日時。

• ParameterSpec – UTF-8 文字列。1～131072 バイト長。

  ブループリントのパラメータ仕様のリストを示す JSON 文字列。

• BlueprintLocation – UTF-8 文字列。

  ブループリントを公開する Simple Storage Service (Amazon S3) のパスを指定します。

• BlueprintServiceLocation – UTF-8 文字列。

  CreateBlueprint/UpdateBlueprint を呼び出してブループリントを AWS Glue に登録するときに、ブループリントがコピーされる Simple Storage Service (Amazon S3) のパスを指定します。

• Status – UTF-8 文字列 (有効な値: CREATING | ACTIVE | UPDATING | FAILED)。

  ブループリント登録のステータス。

  • Creating – ブループリントの登録が進行中です。

  • Active – ブループリントは正常に登録されました。

  • Updating – ブループリント登録の更新が進行中です。

  • Failed – ブループリントの登録に失敗しました。

• ErrorMessage – UTF-8 文字列。

  エラーメッセージ。

• LastActiveDefinition – LastActiveDefinition オブジェクト。

  ブループリントに複数のバージョンがあり、最新バージョンに何らかのエラーがある場合、この属性は、サービスで使用できる正常な最後のブループリント定義を示します。

BlueprintDetails 構造

ブループリントの詳細。

フィールド

• BlueprintName – UTF-8 文字列。1～128 バイト長。Custom string pattern #27 に一致。

  ブループリントの名前。

• RunId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  このブループリントの実行 ID。

LastActiveDefinition 構造

ブループリントに複数のバージョンがあり、最新バージョンに何らかのエラーがある場合、この属性は、サービスで使用できる正常な最後のブループリント定義を示します。

フィールド

• Description – UTF-8 文字列。1～512 バイト長。

  ブループリントの説明。

• LastModifiedOn – タイムスタンプ。

  ブループリントの最終変更日時。

• ParameterSpec – UTF-8 文字列。1～131072 バイト長。

  ブループリントのパラメータを指定する JSON 文字列。

• BlueprintLocation – UTF-8 文字列。

  AWS Glue デベロッパーによってブループリントが公開される Simple Storage Service (Amazon S3) 内のパスを指定します。

• BlueprintServiceLocation – UTF-8 文字列。

  ブループリントの作成または更新時にコピーされる Simple Storage Service (Amazon S3) 内のパスを指定します。

BlueprintRun 構造

ブループリントの実行の詳細。

フィールド

• BlueprintName – UTF-8 文字列。1～128 バイト長。Custom string pattern #27 に一致。

  ブループリントの名前。

• RunId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  このブループリント実行の実行 ID。

• WorkflowName – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  ブループリントが正常に実行された結果として作成されるワークフローの名前。ブループリントの実行にエラーがある場合、ワークフローは作成されません。

• State – UTF-8 文字列 (有効な値: RUNNING | SUCCEEDED | FAILED | ROLLING_BACK)。

  ブループリントの実行の状態。可能な値は以下のとおりです。

  • Running – ブループリントの実行が進行中です。

  • Succeeded – ブループリントの実行が正常に完了しました。

  • Failed – ブループリントの実行が失敗し、ロールバックが完了しました。

  • Rolling Back – ブループリントの実行が失敗し、ロールバックが進行中です。

• StartedOn – タイムスタンプ。

  ブループリントの実行が開始された日時。

• CompletedOn – タイムスタンプ。

  ブループリントの実行が完了した日時。

• ErrorMessage – UTF-8 文字列。

  ブループリントの実行中に発生したエラーを示します。

• RollbackErrorMessage – UTF-8 文字列。

  ワークフローのエンティティの作成中にエラーが発生した場合は、作成されたエンティティをその時点までロールバックして削除を試みます。この属性は、作成されたエンティティを削除しようとしたときにエラーが発生したことを示します。

• Parameters – UTF-8 文字列。1～131072 バイト長。

  文字列のブループリントパラメータです。Blueprint$ParameterSpec で定義されているパラメータ仕様から必要な各キーの値を指定する必要があります。

• RoleArn – UTF-8 文字列。1～1024 バイト長。Custom string pattern #26 に一致。

  ロール ARN｡ このロールは、AWS Glue サービスが継承し、ワークフローとワークフローの他のエンティティを作成するために使用されます。

操作

• CreateWorkflow アクション (Python: create_workflow)

• UpdateWorkflow アクション (Python: update_workflow)

• DeleteWorkflow アクション (Python: delete_workflow)

• GetWorkflow アクション (Python: get_workflow)

• ListWorkflows アクション (Python: list_workflows)

• BatchGetWorkflows アクション (Python: batch_get_workflows)

• GetWorkflowRun アクション (Python: get_workflow_run)

• GetWorkflowRuns アクション (Python: get_workflow_runs)

• GetWorkflowRunProperties アクション (Python: get_workflow_run_properties)

• PutWorkflowRunProperties アクション (Python: put_workflow_run_properties)

• CreateBlueprint アクション (Python: create_blueprint)

• UpdateBlueprint アクション (Python: update_blueprint)

• DeleteBlueprint アクション (Python: delete_blueprint)

• ListBlueprints アクション (Python: list_blueprints)

• BatchGetBlueprints アクション (Python: batch_get_blueprints)

• StartBlueprintRun アクション (Python: start_blueprint_run)

• GetBlueprintRun アクション (Python: get_blueprint_run)

• GetBlueprintRuns アクション (Python: get_blueprint_runs)

• StartWorkflowRun アクション (Python: start_workflow_run)

• StopWorkflowRun アクション (Python: stop_workflow_run)

• ResumeWorkflowRun アクション (Python: resume_workflow_run)

CreateWorkflow アクション (Python: create_workflow)

新しいワークフローを作成します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  ワークフローに割り当てる名前。アカウント内で一意である必要があります。

• Description – UTF-8 文字列。

  ワークフローの説明。

• DefaultRunProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、Single-line string pattern に一致します。

  各値は UTF-8 文字列。

  ワークフローの各実行の一部として使用されるプロパティのコレクション。

• Tags – キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、256 バイト長以下です。

  このワークフローで使用するタグ。

• MaxConcurrentRuns – 数値 (整数)。

  このパラメータを使用すると、データが不必要に複数回更新されないようにしたり、コストを管理したり、場合によってはコンポーネントジョブの同時実行の最大数を超えないようにしたりできます。このパラメータを空白のままにした場合、ワークフロー実行の数に制限はありません。

レスポンス

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  リクエストの一部として指定されたワークフローの名前。

エラー

• AlreadyExistsException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

UpdateWorkflow アクション (Python: update_workflow)

既存のワークフローを更新します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  更新するワークフローの名前。

• Description – UTF-8 文字列。

  ワークフローの説明。

• DefaultRunProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、Single-line string pattern に一致します。

  各値は UTF-8 文字列。

  ワークフローの各実行の一部として使用されるプロパティのコレクション。

• MaxConcurrentRuns – 数値 (整数)。

  このパラメータを使用すると、データが不必要に複数回更新されないようにしたり、コストを管理したり、場合によってはコンポーネントジョブの同時実行の最大数を超えないようにしたりできます。このパラメータを空白のままにした場合、ワークフロー実行の数に制限はありません。

レスポンス

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  入力で指定されたワークフローの名前。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• ConcurrentModificationException

DeleteWorkflow アクション (Python: delete_workflow)

ワークフローを削除します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  削除するワークフローの名前。

レスポンス

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  入力で指定されたワークフローの名前。

エラー

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ConcurrentModificationException

GetWorkflow アクション (Python: get_workflow)

ワークフローのリソースメタデータを取得します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  取得するワークフローの名前。

• IncludeGraph – ブール。

  ワークフローのリソースメタデータを返すときに、グラフを含めるかどうかを指定します。

レスポンス

• Workflow – ワークフロー オブジェクト。

  ワークフローのリソースメタデータ。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

ListWorkflows アクション (Python: list_workflows)

アカウントで作成されたワークフローの名前を一覧表示します。

リクエスト

• NextToken – UTF-8 文字列。

  継続トークン (これが継続リクエストの場合)。

• MaxResults – 1 未満または 25 を超えない数値 (整数)。

  返されるリストの最大サイズ。

レスポンス

• Workflows – UTF-8 文字列の配列。1～25 個の文字列。

  アカウント内のワークフローの名前のリスト。

• NextToken – UTF-8 文字列。

  継続トークン (一部のワークフロー名が返されていない場合)。

エラー

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

BatchGetWorkflows アクション (Python: batch_get_workflows)

特定のワークフロー名のリストに対応するリソースメタデータのリストを返します。ListWorkflows オペレーションを呼び出した後で、このオペレーションを呼び出すことで、アクセス許可が付与されているデータにアクセスできます。このオペレーションは、タグを使用するアクセス許可条件を含め、すべての IAM のアクセス許可をサポートします。

リクエスト

• Names – 必須: UTF-8 文字列の配列。1 ～ 25 個の文字列。

  ワークフロー名のリスト。これらの名前は ListWorkflows オペレーションから返される場合があります。

• IncludeGraph – ブール。

  ワークフローのリソースメタデータを返すときに、グラフを含めるかどうかを指定します。

レスポンス

• Workflows – ワークフロー オブジェクトの配列。1～25 個の構造。

  ワークフローのリソースメタデータのリスト。

• MissingWorkflows – UTF-8 文字列の配列。1～25 個の文字列。

  検出されなかったワークフロー名のリスト。

エラー

• InternalServiceException

• OperationTimeoutException

• InvalidInputException

GetWorkflowRun アクション (Python: get_workflow_run)

特定のワークフロー実行のメタデータを取得します。ジョブ実行履歴には、ワークフローとジョブ実行のために 90 日間アクセスできます。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  実行中のワークフローの名前。

• RunId – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  ワークフロー実行の ID。

• IncludeGraph – ブール。

  レスポンスにワークフローグラフを含めるかどうかを指定します。

レスポンス

• Run – WorkflowRun オブジェクト。

  リクエストされたワークフロー実行のメタデータ。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

GetWorkflowRuns アクション (Python: get_workflow_runs)

特定のワークフローのすべての実行のメタデータを取得します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  返すべき実行のメタデータが属するワークフローの名前。

• IncludeGraph – ブール。

  レスポンスにワークフローグラフを含めるかどうかを指定します。

• NextToken – UTF-8 文字列。

  応答の最大サイズ。

• MaxResults – 1～1000 の数値 (整数)。

  レスポンスに含めるワークフロー実行の最大数。

レスポンス

• Runs – WorkflowRun オブジェクトの配列。1～1000 個の構造体。

  ワークフロー実行のメタデータオブジェクトのリスト。

• NextToken – UTF-8 文字列。

  継続トークン (リクエストしたワークフロー実行の一部が返されていない場合)。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

GetWorkflowRunProperties アクション (Python: get_workflow_run_properties)

実行中に設定されたワークフロー実行のプロパティを取得します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  実行されたワークフローの名前。

• RunId – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  返す必要がある実行プロパティが属するワークフロー実行の ID。

レスポンス

• RunProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、Single-line string pattern に一致します。

  各値は UTF-8 文字列。

  指定した実行の進行中に設定されたワークフロー実行のプロパティ。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

PutWorkflowRunProperties アクション (Python: put_workflow_run_properties)

特定のワークフロー実行に対して、指定されたワークフロー実行プロパティを挿入します。指定された実行内に該当するプロパティが既に存在する場合は、既存の値が上書きされます。それ以外の場合は、既存のプロパティにプロパティが追加されます。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  実行されたワークフローの名前。

• RunId – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  実行プロパティを更新する対象のワークフロー実行の ID。

• RunProperties – 必須: キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、Single-line string pattern に一致します。

  各値は UTF-8 文字列。

  指定された実行に対して挿入するプロパティ。

レスポンス

• 応答パラメータはありません。

エラー

• AlreadyExistsException

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

CreateBlueprint アクション (Python: create_blueprint)

ブループリントを AWS Glue に登録します。

リクエスト

• Name – 必須: UTF-8 文字列。1～128 バイト長。Custom string pattern #27 に一致。

  ブループリントの名前。

• Description – UTF-8 文字列。1～512 バイト長。

  ブループリントの説明。

• BlueprintLocation – 必須: UTF-8 文字列。1～8192 バイト長。Custom string pattern #28 に一致。

  ブループリントを公開する Amazon S3 のパスを指定します。

• Tags – キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、256 バイト長以下です。

  このブループリントに適用されるタグ。

レスポンス

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  登録されたブループリントの名前を返します。

エラー

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• ResourceNumberLimitExceededException

UpdateBlueprint アクション (Python: update_blueprint)

登録済みのブループリントを更新します。

リクエスト

• Name – 必須: UTF-8 文字列。1～128 バイト長。Custom string pattern #27 に一致。

  ブループリントの名前。

• Description – UTF-8 文字列。1～512 バイト長。

  ブループリントの説明。

• BlueprintLocation – 必須: UTF-8 文字列。1～8192 バイト長。Custom string pattern #28 に一致。

  ブループリントを公開する Amazon S3 のパスを指定します。

レスポンス

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  更新されたブループリントの名前を返します。

エラー

• EntityNotFoundException

• ConcurrentModificationException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• IllegalBlueprintStateException

DeleteBlueprint アクション (Python: delete_blueprint)

既存のブループリントを削除します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  削除するブループリントの名前。

レスポンス

• Name – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  削除されたブループリントの名前を返します。

エラー

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

ListBlueprints アクション (Python: list_blueprints)

アカウント内のすべてのブループリント名をリスト表示します。

リクエスト

• NextToken – UTF-8 文字列。

  継続トークン (これが継続リクエストの場合)。

• MaxResults – 1 未満または 25 を超えない数値 (整数)。

  返されるリストの最大サイズ。

• Tags – キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、256 バイト長以下です。

  リストを AWS リソースタグでフィルタリングします。

レスポンス

• Blueprints – UTF-8 文字列の配列。

  アカウント内のブループリントの名前のリスト。

• NextToken – UTF-8 文字列。

  継続トークン (返されていないワークフロー名がある場合)。

エラー

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

BatchGetBlueprints アクション (Python: batch_get_blueprints)

ブループリントのリストに関する情報を取得します。

リクエスト

• Names – 必須: UTF-8 文字列の配列。1 ～ 25 個の文字列。

  ブループリント名のリスト。

• IncludeBlueprint – ブール。

  レスポンスにブループリントを含めるかどうかを指定します。

• IncludeParameterSpec – ブール。

  レスポンスにブループリントのパラメータを JSON 文字列として含めるかどうかを指定します。

レスポンス

• Blueprints – Blueprint オブジェクトの配列。

  ブループリントのリストを Blueprints オブジェクトとして返します。

• MissingBlueprints – UTF-8 文字列の配列。

  検出されなかった BlueprintNames のリストを返します。

エラー

• InternalServiceException

• OperationTimeoutException

• InvalidInputException

StartBlueprintRun アクション (Python: start_blueprint_run)

指定したブループリントの新しい実行を開始します。

リクエスト

• BlueprintName – 必須: UTF-8 文字列。1～128 バイト長。Custom string pattern #27 に一致。

  ブループリントの名前。

• Parameters – UTF-8 文字列。1～131072 バイト長。

  パラメータを BlueprintParameters オブジェクトとして指定します。

• RoleArn – 必須: UTF-8 文字列。1 ～ 1024 バイト長。Custom string pattern #26 に一致。

  ワークフローの作成に使用される IAM ロールを指定します。

レスポンス

• RunId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  このブループリント実行の実行 ID。

エラー

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• ResourceNumberLimitExceededException

• EntityNotFoundException

• IllegalBlueprintStateException

GetBlueprintRun アクション (Python: get_blueprint_run)

ブループリント実行の詳細を取得します。

リクエスト

• BlueprintName – 必須: UTF-8 文字列。1～128 バイト長。Custom string pattern #27 に一致。

  ブループリントの名前。

• RunId – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  取得するブループリント実行の実行 ID。

レスポンス

• BlueprintRun – BlueprintRun オブジェクト。

  BlueprintRun オブジェクトを返します。

エラー

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

GetBlueprintRuns アクション (Python: get_blueprint_runs)

指定したブループリントでのブループリント実行の詳細を取得します。

リクエスト

• BlueprintName – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  ブループリントの名前。

• NextToken – UTF-8 文字列。

  継続トークン (これが継続リクエストの場合)。

• MaxResults – 1～1000 の数値 (整数)。

  返されるリストの最大サイズ。

レスポンス

• BlueprintRuns – BlueprintRun オブジェクトの配列。

  BlueprintRun オブジェクトのリストを返します。

• NextToken – UTF-8 文字列。

  継続トークン (一部のブループリント実行が返されていない場合)。

エラー

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• InvalidInputException

StartWorkflowRun アクション (Python: start_workflow_run)

指定したワークフローの新しい実行を開始します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  開始するワークフローの名前。

• RunProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、Single-line string pattern に一致します。

  各値は UTF-8 文字列。

  新しいワークフロー実行のためのワークフロー実行プロパティ。

レスポンス

• RunId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  新しい実行の ID。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentRunsExceededException

StopWorkflowRun アクション (Python: stop_workflow_run)

指定したワークフロー実行の実行を停止します。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  停止するワークフローの名前。

• RunId – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  停止するワークフロー実行の ID。

レスポンス

• 応答パラメータはありません。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• IllegalWorkflowStateException

ResumeWorkflowRun アクション (Python: resume_workflow_run)

以前に部分的に完了したワークフロー実行から一部のノードを再起動し、ワークフロー実行を再開します。選択したノードと、選択したノードの下流にあるすべてのノードが実行されます。

リクエスト

• Name – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  再開するワークフローの名前。

• RunId – 必須: UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  再開するワークフロー実行の ID。

• NodeIds – 必須: UTF-8 文字列の配列。

  再起動するノードのノード ID のリスト。再起動するノードは、元の実行で実行を試行したことがなければなりません。

レスポンス

• RunId – UTF-8 文字列、1～255 バイト長、Single-line string pattern に一致。

  再開されたワークフロー実行に割り当てられた新しい ID。ワークフロー実行を再開するたびに、新しい実行 ID が割り当てられます。

• NodeIds – UTF-8 文字列の配列。

  実際に再起動されたノードのノード ID のリスト。

エラー

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• ConcurrentRunsExceededException

• IllegalWorkflowStateException