Workflows - AWS Glue

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

Workflows

ワークフロー API は、ワークフローの作成、更新、表示に関連するデータ型と API について記述します。AWSGlue です。

データ型

JobNodeDetails 構造

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

Fields

  • JobRunsJobRun オブジェクトの配列。

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

CrawlerNodeDetails 構造

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

Fields

  • CrawlsCrawl オブジェクトの配列。

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

TriggerNodeDetails 構造

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

Fields

  • Trigger - Trigger オブジェクト。

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

Crawl 構造

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

Fields

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

    クローラの状態。

  • StartedOn – タイムスタンプ.

    クロールの開始日時。

  • CompletedOn – タイムスタンプ.

    クロールの完了日時。

  • ErrorMessage - 説明文字列。2,048 バイト長以下。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コンポーネント(トリガー、クローラ、またはジョブ)をワークフローグラフに表示できます。

Fields

  • 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 つのコンポーネント間の有向接続を表します。

Fields

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

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

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

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

Workflow 構造

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

Fields

  • 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 - ブループリントの詳細 オブジェクト。

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

WorkflowGraph 構造

ワークフローグラフは、すべてのAWS Glueコンポーネントと、これらのコンポーネント間のすべての有向接続です。

Fields

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

    のリストAWS Glueコンポーネントは、ノードとして表されるワークフローに属します。

  • EdgesEdge オブジェクトの配列。

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

WorkflowRun 構造

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

Fields

  • 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 文字列。

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

  • Statistics - WorkflowRunStatistics オブジェクト。

    実行の統計。

  • Graph - WorkflowGraph オブジェクト。

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

  • StartingEventBatchCondition - 開始イベントバッチ条件 オブジェクト。

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

WorkflowRunStatistics 構造

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

Fields

  • TotalActions – 数値 (整数)。

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

  • TimeoutActions – 数値 (整数)。

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

  • FailedActions – 数値 (整数)。

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

  • StoppedActions – 数値 (整数)。

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

  • SucceededActions – 数値 (整数)。

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

  • RunningActions – 数値 (整数)。

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

StartEventBatch条件構造

ワークフロー実行の開始したバッチ条件。到着したバッチ・サイズのイベント数(BatchSize Sizeメンバーがゼロ以外の場合)、またはバッチ・ウィンドウが期限切れの場合(BatchWindowメンバーがゼロ以外の場合)のいずれかです。

Fields

  • BatchSize – 数値 (整数)。

    バッチ内のイベント数。

  • BatchWindow – 数値 (整数)。

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

設計図の構造

設計図の詳細。

Fields

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

    設計図の名前。

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

    設計図の説明です。

  • CreatedOn – タイムスタンプ.

    設計図が登録された日時。

  • LastModifiedOn – タイムスタンプ.

    設計図が最後に変更された日時。

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

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

  • BlueprintLocation - UTF-8 文字列。

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

  • BlueprintServiceLocation - UTF-8 文字列。

    を呼び出すときにブループリントがコピーされる Amazon S3 のパスを指定します。CreateBlueprintをクリックしてブループリントをAWS Glue。

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

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

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

    • アクティブ — ブループリントは正常に登録されました。

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

    • [失敗] — ブループリントの登録に失敗しました。

  • ErrorMessage - UTF-8 文字列。

    エラーメッセージ。

  • LastActiveDefinition - 最終アクティブ定義 オブジェクト。

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

ブループリントの詳細構造

設計図の詳細。

Fields

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

    設計図の名前。

  • InstanceName-UTF-8 文字列。1 ~ 128 バイト長。に一致。Custom string pattern #18

    ブループリントインスタンスの名前。

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

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

LastActive定義構造

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

Fields

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

    設計図の説明です。

  • LastModifiedOn – タイムスタンプ.

    設計図が最後に変更された日時。

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

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

  • BlueprintLocation - UTF-8 文字列。

    ブループリントが公開される Amazon S3 のパスを指定します。AWS Glue開発者。

  • BlueprintServiceLocation - UTF-8 文字列。

    ブループリントを作成または更新するときにブループリントをコピーする Amazon S3 のパスを指定します。

ブループリントラン構造

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

Fields

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

    設計図の名前。

  • 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).

    ブループリントの実行の状態。想定される値は次のとおりです。

    • [実行中] — ブループリントの実行が進行中です。

    • [成功] — ブループリントの実行が正常に完了しました。

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

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

  • StartedOn – タイムスタンプ.

    [] 設計図の実行が開始された日時。

  • CompletedOn – タイムスタンプ.

    [] 設計図の実行が完了した日時。

  • ErrorMessage - UTF-8 文字列。

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

  • RollbackErrorMessage - UTF-8 文字列。

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

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

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

  • RoleArn-UTF-8 文字列。1 ~ 1,024 バイト長。に一致。Custom string pattern #17

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

Operations

CreateWorkflow アクション (Python: create_workflow)

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

Request

  • 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 – 数値 (整数)。

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

Response

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

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

Errors

  • AlreadyExistsException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

UpdateWorkflow アクション (Python: update_workflow)

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

Request

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

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

  • Description - UTF-8 文字列。

    ワークフローの説明。

  • DefaultRunProperties - キー/値ペアのマップ配列。

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

    各値は UTF-8 文字列です。

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

  • MaxConcurrentRuns – 数値 (整数)。

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

Response

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

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

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

DeleteWorkflow アクション (Python: delete_workflow)

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

Request

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

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

Response

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

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

Errors

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

GetWorkflow アクション (Python: get_workflow)

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

Request

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

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

  • IncludeGraph – Boolean.

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

Response

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

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

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

ListWorkflows アクション (Python: list_workflows)

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

Request

  • NextToken - UTF-8 文字列。

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

  • MaxResults - 数値 (整数)。1 ~ 1000。

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

Response

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

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

  • NextToken - UTF-8 文字列。

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

Errors

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

BatchGetWorkflows アクション (Python: batch_get_workflows)

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

Request

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

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

  • IncludeGraph – Boolean.

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

Response

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

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

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

    見つからないワークフローの名前のリスト。

Errors

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

GetWorkflowRun アクション (Python: get_workflow_run)

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

Request

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

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

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

    ワークフロー実行の ID。

  • IncludeGraph – Boolean.

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

Response

  • Run - WorkflowRun オブジェクト。

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

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

GetWorkflowRuns アクション (Python: get_workflow_runs)

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

Request

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

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

  • IncludeGraph – Boolean.

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

  • NextToken - UTF-8 文字列。

    レスポンスの最大サイズ。

  • MaxResults - 数値 (整数)。1 ~ 1000。

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

Response

  • Runs— の配列WorkflowRunオブジェクト、1~1000個の構造。

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

  • NextToken - UTF-8 文字列。

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

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

GetWorkflowRunProperties アクション (Python: get_workflow_run_properties)

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

Request

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

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

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

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

Response

  • RunProperties - キー/値ペアのマップ配列。

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

    各値は UTF-8 文字列です。

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

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

PutWorkflowRunProperties アクション (Python: put_workflow_run_properties)

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

Request

  • 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 文字列です。

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

Response

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

Errors

  • AlreadyExistsException

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

CreateBlueprint アクション (Python: create_blueprint)

[] 設計図をAWS Glue。

Request

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

    設計図の名前。

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

    設計図の説明です。

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

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

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

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

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

    この設計図に適用されるタグ。

Response

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

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

Errors

  • AlreadyExistsException

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

  • ResourceNumberLimitExceededException

UpdateBlueprint アクション (Python: update_blueprint)

登録済みの [] 設計図を更新します。

Request

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

    設計図の名前。

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

    設計図の説明です。

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

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

Response

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

    更新された設計図の名前を返します。

Errors

  • EntityNotFoundException

  • ConcurrentModificationException

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

DeleteBluepint アクション (Python: delete_blueprint)

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

Request

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

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

Response

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

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

Errors

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

ListBlueprints アクション (Python: list_blueprints

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

Request

  • NextToken - UTF-8 文字列。

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

  • MaxResults - 数値 (整数)。1 ~ 1000。

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

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

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

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

    リストをAWSリソースタグ。

Response

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

    アカウント内の設計図の名前のリスト。

  • NextToken - UTF-8 文字列。

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

Errors

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

バッチGetBlueprints アクション (Python: batch_get_blueprints)

[] 設計図のリストに関する情報を取得します。

Request

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

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

  • IncludeBlueprint – Boolean.

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

  • IncludeParameterSpec – Boolean.

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

Response

  • Blueprints設計図 オブジェクトの配列。

    [] 設計図のリストをBlueprintsオブジェクト。

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

    のリストを返します。BlueprintNamesが見つかりませんでした。

Errors

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

StartBluePrintTrun アクション (Python: start_blueprint_run)

指定した設計図の新しい実行を開始します。

Request

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

    設計図の名前。

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

    パラメータをBlueprintParametersオブジェクト。

  • RoleArn: 必須 UTF-8 文字列。1 ~ 1,024 バイト長。に一致。Custom string pattern #17

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

Response

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

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

Errors

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

  • ResourceNumberLimitExceededException

  • EntityNotFoundException

GetBluePrintRun アクション (Python: get_blueprint_run)

[] 設計図実行の詳細を取得します。

Request

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

    設計図の名前。

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

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

Response

Errors

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

GetBluePrintTruns アクション (Python: get_blueprint_runs)

指定したブループリントに対して実行されたブループリントの詳細を取得します。

Request

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

    設計図の名前。

  • NextToken - UTF-8 文字列。

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

  • MaxResults - 数値 (整数)。1 ~ 1000。

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

Response

  • BlueprintRunsブループリントラン オブジェクトの配列。

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

  • NextToken - UTF-8 文字列。

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

Errors

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

StartWorkflowRun アクション (Python: start_workflow_run)

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

Request

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

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

Response

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ConcurrentRunsExceededException

StopWorkflowRun アクション (Python: stop_workflow_run)

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

Request

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

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

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

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

Response

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

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • IllegalWorkflowStateException

ResumeWorkflowRun アクション (Python: resume_workflow_run)

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

Request

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

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

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

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

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

    再起動するノードのノード ID のリスト。再起動するノードには、元の実行で実行試行が必要です。

Response

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

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

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

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

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentRunsExceededException

  • IllegalWorkflowStateException