기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# DescribeEdgeConfiguration
<a name="API_DescribeEdgeConfiguration"></a>

`StartEdgeConfigurationUpdate` API를 사용하여 설정된 스트림의 엣지 구성과 엣지 에이전트의 레코더 및 업로더 작업의 최신 상태를 설명합니다. 이 API를 사용하여 구성의 상태를 가져와 구성이 Edge 에이전트와 동기화되어 있는지 확인합니다. 이 API를 사용하여 Edge 에이전트의 상태를 평가합니다.

**참고**  
 AWS 아프리카(케이프타운) 리전인 af-south-1에서는이 API를 사용할 수 없습니다.

## Request Syntax
<a name="API_DescribeEdgeConfiguration_RequestSyntax"></a>

```
POST /describeEdgeConfiguration HTTP/1.1
Content-type: application/json

{
   "StreamARN": "{{string}}",
   "StreamName": "{{string}}"
}
```

## URI 요청 파라미터
<a name="API_DescribeEdgeConfiguration_RequestParameters"></a>

요청은 URI 파라미터를 사용하지 않습니다.

## 요청 본문
<a name="API_DescribeEdgeConfiguration_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamARN"></a>
스트림의 Amazon 리소스 이름(ARN)입니다. `StreamName`또는를 지정합니다`StreamARN`.  
유형: 문자열  
길이 제약: 최소 길이 1. 최대 길이는 1024입니다.  
패턴: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
필수 여부: 아니요

 ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamName"></a>
엣지 구성을 업데이트하려는 스트림의 이름입니다. `StreamName` 또는를 지정합니다`StreamARN`.  
유형: 문자열  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.  
패턴: `[a-zA-Z0-9_.-]+`   
필수 여부: 아니요

## 응답 구문
<a name="API_DescribeEdgeConfiguration_ResponseSyntax"></a>

```
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"
}
```

## 응답 요소
<a name="API_DescribeEdgeConfiguration_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-CreationTime"></a>
스트림의 엣지 구성이 처음 생성된 타임스탬프입니다.  
유형: 타임스탬프

 ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeAgentStatus"></a>
엣지 에이전트의 레코더 및 업로더 작업에 대한 최신 상태 세부 정보가 포함된 객체입니다. 이 정보를 사용하여 엣지 에이전트의 현재 상태를 확인합니다.  
유형: [EdgeAgentStatus](API_EdgeAgentStatus.md)객체

 ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeConfig"></a>
Edge Agent IoT Greengrass 구성 요소와 동기화하는 데 사용할 스트림의 엣지 구성에 대한 설명입니다. Edge Agent 구성 요소는 온프레미스의 IoT Hub 디바이스 설정에서 실행됩니다.  
유형: [EdgeConfig](API_EdgeConfig.md)객체

 ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-FailedStatusDetails"></a>
생성된 실패 상태에 대한 설명입니다.  
유형: 문자열

 ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-LastUpdatedTime"></a>
스트림의 엣지 구성이 마지막으로 업데이트된 타임스탬프입니다.  
유형: 타임스탬프

 ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamARN"></a>
스트림의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
길이 제약: 최소 길이 1. 최대 길이는 1024입니다.  
패턴: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` 

 ** [StreamName](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamName"></a>
엣지 구성이 업데이트된 스트림의 이름입니다.  
유형: 문자열  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.  
패턴: `[a-zA-Z0-9_.-]+` 

 ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-SyncStatus"></a>
엣지 구성 업데이트의 최신 상태입니다.  
타입: 문자열  
유효 값: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

## 오류
<a name="API_DescribeEdgeConfiguration_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류 유형](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 Stream이 지정한 스트림의 엣지 구성을 찾을 수 없을 때 렌더링되는 예외입니다.  
HTTP 상태 코드: 404

## 참고
<a name="API_DescribeEdgeConfiguration_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS .NET V4용 SDK](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 Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS Java V2용 SDK](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 PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS Python용 SDK](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)