翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # DescribeEdgeConfiguration `StartEdgeConfigurationUpdate` API を使用して設定されたストリームのエッジ設定と、エッジエージェントのレコーダーおよびアップローダージョブの最新ステータスについて説明します。この API を使用して設定のステータスを取得し、設定が Edge エージェントと同期しているかどうかを判断します。この API を使用して、エッジエージェントのヘルスを評価します。 **注記** この API は、 AWS アフリカ (ケープタウン) リージョン af-south-1 では利用できません。 ## リクエストの構文 ``` POST /describeEdgeConfiguration HTTP/1.1 Content-type: application/json { "StreamARN": "{{string}}", "StreamName": "{{string}}" } ``` ## URI リクエストパラメータリクエストでは URI パラメータを使用しません。 ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) ** ストリームの Amazon リソースネーム (ARN)。`StreamName`またはを指定します`StreamARN`。タイプ: 文字列長さの制限: 最小長は 1 です。最大長は 1,024 です。パターン: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` 必須: いいえ ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) ** エッジ設定を更新するストリームの名前。`StreamName` またはを指定します`StreamARN`。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 256 です。パターン: `[a-zA-Z0-9_.-]+` 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "EdgeAgentStatus": { "LastRecorderStatus": { "JobStatusDetails": "string", "LastCollectedTime": number, "LastUpdatedTime": number, "RecorderStatus": "string" }, "LastUploaderStatus": { "JobStatusDetails": "string", "LastCollectedTime": number, "LastUpdatedTime": number, "UploaderStatus": "string" } }, "EdgeConfig": { "DeletionConfig": { "DeleteAfterUpload": boolean, "EdgeRetentionInHours": number, "LocalSizeConfig": { "MaxLocalMediaSizeInMB": number, "StrategyOnFullSize": "string" } }, "HubDeviceArn": "string", "RecorderConfig": { "MediaSourceConfig": { "MediaUriSecretArn": "string", "MediaUriType": "string" }, "ScheduleConfig": { "DurationInSeconds": number, "ScheduleExpression": "string" } }, "UploaderConfig": { "ScheduleConfig": { "DurationInSeconds": number, "ScheduleExpression": "string" } } }, "FailedStatusDetails": "string", "LastUpdatedTime": number, "StreamARN": "string", "StreamName": "string", "SyncStatus": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) ** ストリームのエッジ設定が最初に作成されたタイムスタンプ。タイプ: タイムスタンプ ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) ** エッジエージェントのレコーダージョブとアップローダージョブの最新のステータスの詳細を含むオブジェクト。この情報を使用して、エッジエージェントの現在の状態を判断します。型: [EdgeAgentStatus](API_EdgeAgentStatus.md) オブジェクト ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) ** Edge Agent IoT Greengrass コンポーネントとの同期に使用されるストリームのエッジ設定の説明。Edge Agent コンポーネントは、オンプレミスの IoT Hub デバイスのセットアップで実行されます。型: [EdgeConfig](API_EdgeConfig.md) オブジェクト ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) ** 生成された障害ステータスの説明。タイプ: 文字列 ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) ** ストリームのエッジ設定が最後に更新されたタイムスタンプ。タイプ: タイムスタンプ ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) ** ストリームの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最小長は 1 です。最大長は 1,024 です。パターン: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ** [StreamName](#API_DescribeEdgeConfiguration_ResponseSyntax) ** エッジ設定が更新されたストリームの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 256 です。パターン: `[a-zA-Z0-9_.-]+` ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) ** エッジ設定の更新の最新ステータス。型: 文字列有効な値：`SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` ## エラーすべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** この操作を実行するために必要なアクセス許可がありません。 HTTP ステータスコード: 401 ** ClientLimitExceededException ** Kinesis Video Streams は、許可されたクライアントコールの制限を超えているため、リクエストをスロットリングしました。後で呼び出しを試みてください。 HTTP ステータスコード: 400 ** InvalidArgumentException ** この入力パラメータの値は無効です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams は、指定したストリームを見つけることができません。 HTTP ステータスコード: 404 ** StreamEdgeConfigurationNotFoundException ** Amazon Kinesis Video Streams が、指定したストリームのエッジ設定を見つけられないときにレンダリングされる例外。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)