기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
GetImages
지정된 시간 범위, 샘플링 간격 및 이미지 형식 구성의 각 타임스탬프에 해당하는 이미지 목록을 검색합니다.
참고
먼저 GetDataEndpoint API를 호출하여 엔드포인트를 가져와야 합니다. 그런 다음 GetImages --endpoint-url 파라미터를 사용하여 이 엔드포인트로 요청을 전송합니다.
Request Syntax
POST /getImages HTTP/1.1
Content-type: application/json
{
"EndTimestamp": number,
"Format": "string",
"FormatConfig": {
"string" : "string"
},
"HeightPixels": number,
"ImageSelectorType": "string",
"MaxResults": number,
"NextToken": "string",
"SamplingInterval": number,
"StartTimestamp": number,
"StreamARN": "string",
"StreamName": "string",
"WidthPixels": number
}URI 요청 파라미터
요청은 URI 파라미터를 사용하지 않습니다.
요청 본문
요청은 JSON 형식으로 다음 데이터를 받습니다.
- EndTimestamp
-
생성할 이미지 범위의 종료 타임스탬프입니다. 시간 범위가
StartTimestamp2초에서 300초 이상인StartTimestamp경우 시간 범위를 받게 됩니다.EndTimestampIllegalArgumentException유형: 타임스탬프
필수 여부: 예
- Format
-
이미지를 인코딩하는 데 사용할 형식입니다.
타입: 문자열
유효 값:
JPEG | PNG필수 사항 여부: 예
- FormatConfig
-
이미지 생성 시 적용할 수 있는 추가 매개 변수가 포함된 키-값 쌍 구조의 목록입니다.
FormatConfig키는 이미지를 생성하는JPEGQuality데 사용할 JPEG 품질 키를 나타내는 입니다.FormatConfig값은 1에서 100 사이의 정수를 허용합니다. 값이 1이면 품질이 떨어지고 압축률이 가장 좋은 이미지가 생성됩니다. 값이 100인 경우 이미지는 최상의 품질로 압축률을 낮춘 상태로 생성됩니다. 값을 제공하지 않으면JPEGQuality키의 기본값은 80으로 설정됩니다.유형: 문자열-문자열 맵
맵 항목: 최대 항목 수 1개입니다.
유효한 키:
JPEGQuality값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256.
값 패턴:
^[a-zA-Z_0-9]+필수 여부: 아니요
- HeightPixels
-
WidthPixels매개변수와 함께 사용되는 출력 이미지의 높이입니다.HeightPixels및WidthPixels매개 변수를 모두 제공하면 이미지가 지정된 가로 세로 비율에 맞게 늘어납니다.HeightPixels매개변수만 제공하면 원래 종횡비를 사용하여WidthPixels비율을 계산합니다. 두 매개 변수를 모두 제공하지 않으면 원본 이미지 크기가 반환됩니다.타입: 정수
유효 범위: 최소값 1. 최대값은 2160입니다.
필수 여부: 아니요
- ImageSelectorType
-
이미지 생성에 사용할 서버 또는 프로듀서 타임스탬프의 출처.
타입: 문자열
유효 값:
PRODUCER_TIMESTAMP | SERVER_TIMESTAMP필수 사항 여부: 예
- MaxResults
-
API에서 반환되는 최대 이미지 수입니다.
참고
기본 제한은 API 응답당 25개 이미지입니다. 이 값보다
MaxResults큰 값을 제공하면 페이지 크기가 25가 됩니다. 모든 추가 결과에는 페이지가 매겨집니다.타입: Long
유효 범위: 최소값은 1입니다. 최대값 100.
필수 여부: 아니요
- NextToken
-
다음 이미지 세트의 페이지 매김을 시작할 위치를 지정하는 토큰입니다. 이전에 잘린
GetImages:NextToken응답에서 가져온 것입니다.유형: 문자열
길이 제약: 최소 길이 1. 최대 길이는 4096자입니다.
패턴:
[a-zA-Z0-9+/]+={0,2}Required: No
- SamplingInterval
-
스트림에서 이미지를 생성해야 하는 시간 간격 (밀리초) 입니다. 제공할 수 있는 최소값은 200ms (초당 5개 이미지) 입니다. 타임스탬프 범위가 샘플링 간격보다 작으면 가능한 경우 의 이미지가
startTimestamp반환됩니다.유형: 정수
필수 여부: 예
- StartTimestamp
-
이미지를 생성해야 하는 시작점입니다. 이미지가 반환되는 타임스탬프의 전체 범위 내에
StartTimestamp있어야 합니다.유형: 타임스탬프
필수 여부: 예
- StreamARN
-
이미지를 검색할 스트림의 Amazon 리소스 이름 (ARN). 또는 를 지정해야 합니다.
StreamNameStreamARN유형: 문자열
길이 제약: 최소 길이 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_.-]+Required: No
- WidthPixels
-
HeightPixels매개변수와 함께 사용되는 출력 이미지의 너비입니다.WidthPixels및HeightPixels매개 변수를 모두 제공하면 이미지가 지정된 가로 세로 비율에 맞게 늘어납니다.WidthPixels매개변수만 제공하거나 매개변수만ValidationException제공하면 a가 발생합니다.HeightPixels두 매개 변수를 모두 제공하지 않으면 스트림의 원본 이미지 크기가 반환됩니다.타입: 정수
유효 범위: 최소값 1. 최대값은 3840입니다.
필수 여부: 아니요
응답 구문
HTTP/1.1 200
Content-type: application/json
{
"Images": [
{
"Error": "string",
"ImageContent": "string",
"TimeStamp": number
}
],
"NextToken": "string"
}응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
Errors
모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- ClientLimitExceededException
-
한도를 초과했기 때문에 Kinesis Video Streams가 요청 병목 현상을 일으켰습니다. 나중에 전화를 걸어 보세요. 제한에 대한 자세한 내용은 Kinesis Video Streams 제한을 참조하십시오.
HTTP 상태 코드: 400
- InvalidArgumentException
-
지정된 파라미터는 제한을 초과하거나, 지원되지 않거나, 사용할 수 없습니다.
HTTP 상태 코드: 400
- NotAuthorizedException
-
상태 코드: 403, 호출자가 지정된 스트림에서 작업을 수행할 권한이 없거나 토큰이 만료되었습니다.
HTTP 상태 코드: 401
- ResourceNotFoundException
-
GetImagesKinesis Video Streams에서 지정한 스트림을 찾을 수 없는 경우 이 오류가 발생합니다.GetHLSStreamingSessionURL요청된 시간 범위 내에LIVE_REPLAY프래그먼트가 없는 스트림에 대해 aON_DEMAND또는 f가 있는 세션이 요청되거나 지난 30초 내에LIVE프래그먼트가 없는 스트림에 대해 a가 있는 세션이 요청되면 이GetDASHStreamingSessionURL오류가 발생합니다.PlaybackModePlaybackModeHTTP 상태 코드: 404
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
