StartEdgeConfigurationUpdate - Amazon Kinesis Video Streams
Request SyntaxURI 요청 파라미터요청 본문응답 구문응답 요소Errors참고

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

StartEdgeConfigurationUpdate

스트림의 기존 에지 구성을 업데이트하는 비동기 API입니다. Kinesis Video Stream은 스트림의 에지 구성을 사내에 설정된 IoT Hub 디바이스에서 실행되는 Edge Agent IoT Greengrass 구성 요소와 동기화합니다. 동기화 시간은 허브 디바이스의 연결 상태에 따라 달라질 수 있습니다. 에지 구성이 승인되고 Edge Agent와 SyncStatus 동기화되면 가 업데이트됩니다.

이 API를 처음 호출하면 스트림에 대한 새 에지 구성이 생성되고 동기화 상태가 로 설정됩니다. SYNCING 이 API를 다시 사용하려면 동기화 상태가 다음과 같은 터미널 상태 (예: IN_SYNC 또는SYNC_FAILED) 에 도달할 때까지 기다려야 합니다. 동기화 프로세스 중에 이 API를 ResourceInUseException 호출하면 a가 발생합니다. 스트림의 에지 구성과 Edge Agent의 연결은 15분 동안 재시도됩니다. 15분 후 상태가 SYNC_FAILED 상태로 전환됩니다.

한 장치에서 다른 장치로 에지 구성을 이동하려면 DeleteEdgeConfiguration 를 사용하여 현재 에지 구성을 삭제합니다. 그런 다음 업데이트된 허브 디바이스 StartEdgeConfigurationUpdate ARN으로 호출할 수 있습니다.

참고

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

Request Syntax

POST /startEdgeConfigurationUpdate HTTP/1.1
Content-type: application/json

{
   "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"
         }
      }
   },
   "StreamARN": "string",
   "StreamName": "string"
}

URI 요청 파라미터

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

요청 본문

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

EdgeConfig

업데이트 프로세스를 호출하는 데 필요한 엣지 구성 세부 정보.

유형: EdgeConfig객체

필수 여부: 예

StreamARN

스트림의 Amazon 리소스 이름(ARN)입니다. StreamName또는 를 지정합니다. StreamARN

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 1024입니다.

패턴: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Required: No

StreamName

엣지 구성을 업데이트하려는 스트림의 이름. StreamName또는 를 지정합니다StreamARN.

유형: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.

패턴: [a-zA-Z0-9_.-]+

필수 여부: 아니요

응답 구문

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "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

스트림의 에지 구성이 처음 생성된 시점의 타임스탬프입니다.

유형: 타임스탬프

EdgeConfig

Edge Agent IoT Greengrass 구성 요소와 동기화하는 데 사용할 스트림의 에지 구성에 대한 설명입니다. Edge Agent 구성 요소는 온프레미스의 IoT Hub 장치 설정에서 실행됩니다.

유형: EdgeConfig객체

FailedStatusDetails

생성된 장애 상태에 대한 설명.

타입: 문자열

LastUpdatedTime

스트림의 에지 구성이 마지막으로 업데이트된 시점의 타임스탬프입니다.

유형: 타임스탬프

StreamARN

스트림의 Amazon 리소스 이름(ARN)입니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 1024입니다.

패턴: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

StreamName

에지 구성이 업데이트된 스트림의 이름.

유형: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.

패턴: [a-zA-Z0-9_.-]+

SyncStatus

스트림 에지 구성의 현재 동기화 상태. 이 API를 호출하면 동기화 상태가 SYNCING 상태로 설정됩니다. DescribeEdgeConfigurationAPI를 사용하여 에지 구성의 최신 상태를 가져올 수 있습니다.

타입: 문자열

유효 값: SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

Errors

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.

AccessDeniedException

이 작업을 수행하는 데 필요한 권한은 없습니다.

HTTP 상태 코드: 401

ClientLimitExceededException

허용된 클라이언트 호출 한도를 초과했기 때문에 Kinesis Video Streams가 요청 병목 현상을 일으켰습니다. 나중에 전화를 걸어 보세요.

HTTP 상태 코드: 400

InvalidArgumentException

이 입력 매개변수의 값이 유효하지 않습니다.

HTTP 상태 코드: 400

NoDataRetentionException

스트림 데이터 보존 시간 단위는 0입니다.

HTTP 상태 코드: 400

ResourceInUseException

입력 StreamARN 또는 ChannelARN CLOUD_STORAGE_MODE 입력이 이미 다른 Kinesis Video Stream 리소스에 매핑되어 있거나 제공된 StreamARN 입력 ChannelARN 또는 입력이 활성 상태가 아닌 경우 다음 중 하나를 시도해 보십시오.

  1. 해당 스트림의 채널이 매핑되는 대상을 결정하는 DescribeMediaStorageConfiguration API입니다.

  2. 지정된 스트림이 매핑되는 채널을 결정하는 DescribeMappedResourceConfiguration API입니다.

  3. 리소스 상태를 확인하기 위한 DescribeStream 또는 DescribeSignalingChannel API입니다.

HTTP 상태 코드: 400

ResourceNotFoundException

Amazon Kinesis Video Streams에서 지정한 스트림을 찾을 수 없습니다.

HTTP 상태 코드: 404

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.