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

# GetImages
<a name="API_reader_GetImages"></a>

이미지에 대한 관리형 지원은 Kinesis Video Streams에서 스트리밍되고 저장된 비디오 데이터에서 이미지를 가져올 수 있는 완전 관리형 방법을 제공합니다. 이미지를 사용하여 사람, 반려동물 또는 차량 감지와 같은 기계 학습(ML) 워크로드를 실행할 수 있습니다. 또한 이미지를 사용하여 모션 이벤트에 대한 이미지 미리 보기 및 비디오 클립에 대한 스크러빙과 같은 대화형 요소를 재생에 추가할 수 있습니다.

또한 GetImages는 지정된 시간 범위, 샘플링 간격 및 이미지 형식 구성의 각 타임스탬프에 해당하는 이미지 목록을 검색합니다.

**참고**  
먼저 `GetDataEndpoint` API를 호출하여 엔드포인트를 가져와야 합니다. 그런 다음 [--endpoint-url 파라미터를](https://docs.aws.amazon.com/cli/latest/reference/) 사용하여이 엔드포인트에 `GetImages` 요청을 보냅니다.

 [비디오 재생 트랙 요구 사항](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html).

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

```
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 요청 파라미터
<a name="API_reader_GetImages_RequestParameters"></a>

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

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

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

 ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-EndTimestamp"></a>
생성할 이미지 범위의 종료 타임스탬프입니다. `StartTimestamp` \~ 사이의 시간 범위가 300초를 `EndTimestamp` 초과하는 경우를 받게 `StartTimestamp`됩니다`IllegalArgumentException`.  
유형: 타임스탬프  
필수 항목 여부: 예

 ** [Format](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-Format"></a>
이미지를 인코딩하는 데 사용할 형식입니다.  
타입: 문자열  
유효 값: `JPEG | PNG`   
필수 사항 여부: 예

 ** [FormatConfig](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-FormatConfig"></a>
이미지가 생성될 때 적용할 수 있는 추가 파라미터가 포함된 키-값 페어 구조의 목록입니다. `FormatConfig` 키는 이미지를 생성하는 데 사용할 JPEG 품질 키를 `JPEGQuality`나타내는 입니다. `FormatConfig` 값은 1\~100의 인트를 허용합니다. 값이 1이면 이미지가 더 낮은 품질과 최상의 압축으로 생성됩니다. 값이 100인 경우 최상의 품질과 적은 압축으로 이미지가 생성됩니다. 값이 제공되지 않으면 `JPEGQuality` 키의 기본값이 80으로 설정됩니다.  
유형: 문자열 간 맵  
맵 항목: 최대 항목 수 1개입니다.  
유효한 키: `JPEGQuality`   
값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256.  
값 패턴: `^[a-zA-Z_0-9]+`   
필수 여부: 아니요

 ** [HeightPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-HeightPixels"></a>
`WidthPixels` 파라미터와 함께 사용되는 출력 이미지의 높이입니다. `HeightPixels` 및 `WidthPixels` 파라미터가 모두 제공되면 이미지가 지정된 종횡비에 맞게 늘어납니다. `HeightPixels` 파라미터만 제공된 경우 원래 종횡비를 사용하여 `WidthPixels` 비율을 계산합니다. 파라미터가 제공되지 않으면 원래 이미지 크기가 반환됩니다.  
타입: 정수  
유효 범위: 최소값 1. 최대값은 2160입니다.  
필수 여부: 아니요

 ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-ImageSelectorType"></a>
이미지를 생성하는 데 사용할 서버 또는 생산자 타임스탬프의 오리진입니다.  
타입: 문자열  
유효 값: `PRODUCER_TIMESTAMP | SERVER_TIMESTAMP`   
필수 사항 여부: 예

 ** [MaxResults](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-MaxResults"></a>
API에서 반환할 최대 이미지 수입니다.  
기본 제한은 API 응답당 이미지 25개입니다. 이 값보다 `MaxResults` 큰 값을 제공하면 페이지 크기가 25가 됩니다. 추가 결과는 페이지 매김됩니다.
타입: Long  
유효 범위: 최소값 1. 최댓값은 100입니다.  
필수 여부: 아니요

 ** [NextToken](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-NextToken"></a>
다음 이미지 세트의 페이지 매김을 시작할 위치를 지정하는 토큰입니다. 이는 이전에 잘린 응답에서 도출된 `GetImages:NextToken`입니다.  
유형: 문자열  
길이 제약: 최소 길이 1. 최대 길이는 4096자입니다.  
패턴: `[a-zA-Z0-9+/]+={0,2}`   
필수 여부: 아니요

 ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-SamplingInterval"></a>
스트림에서 이미지를 생성해야 하는 밀리초(ms) 단위의 시간 간격입니다. 제공할 수 있는 최소값은 200ms(초당 이미지 5개)입니다. 타임스탬프 범위가 샘플링 간격보다 작으면 사용 가능한 경우의 이미지가 반환`startTimestamp`됩니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StartTimestamp"></a>
이미지를 생성해야 하는 시작점입니다. 이미지를 반환하려면 타임스탬프의 포함 범위 `StartTimestamp` 내에 있어야 합니다.  
유형: 타임스탬프  
필수 항목 여부: 예

 ** [StreamARN](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-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_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamName"></a>
이미지를 검색할 스트림의 이름입니다. `StreamName` 또는를 지정해야 합니다`StreamARN`.  
유형: 문자열  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.  
패턴: `[a-zA-Z0-9_.-]+`   
필수 여부: 아니요

 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-WidthPixels"></a>
`HeightPixels` 파라미터와 함께 사용되는 출력 이미지의 너비입니다. `WidthPixels` 및 `HeightPixels` 파라미터가 모두 제공되면 이미지가 지정된 종횡비에 맞게 늘어납니다. `WidthPixels` 파라미터만 제공되거나 만 `HeightPixels` 제공되면 `ValidationException`가 발생합니다. 파라미터가 제공되지 않으면 스트림의 원래 이미지 크기가 반환됩니다.  
타입: 정수  
유효 범위: 최소값 1. 최대값은 3840입니다.  
필수 항목 여부: 아니요

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

```
HTTP/1.1 200
Content-type: application/json

{
   "Images": [ 
      { 
         "Error": "string",
         "ImageContent": "string",
         "TimeStamp": number
      }
   ],
   "NextToken": "string"
}
```

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

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

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

 ** [Images](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-Images"></a>
비디오 스트림에서 생성된 이미지 목록입니다. 지정된 타임스탬프에 사용할 수 있는 미디어가 없는 경우 `NO_MEDIA` 오류가 출력에 나열됩니다. 이미지가 생성되는 동안 오류가 발생하면 `MEDIA_ERROR`가 출력에 누락된 이미지의 원인으로 나열됩니다.  
타입: [Image](API_reader_Image.md)객체 배열

 ** [NextToken](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-NextToken"></a>
더 많은 이미지를 가져오기 위해 요청에 사용된 암호화된 토큰입니다.  
유형: 문자열  
길이 제약: 최소 길이 1. 최대 길이는 4096자입니다.  
패턴: `[a-zA-Z0-9+/]+={0,2}` 

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

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류 유형](CommonErrors.md) 섹션을 참조하세요.

 ** ClientLimitExceededException **   
제한을 초과했기 때문에 Kinesis Video Streams에서 요청을 제한했습니다. 나중에 호출해 보십시오. 제한에 대한 자세한 내용은 [Kinesis Video Streams 할당량을 참조하세요](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).  
HTTP 상태 코드: 400

 ** InvalidArgumentException **   
지정된 파라미터가 제한을 초과하거나, 지원되지 않거나, 사용할 수 없습니다.  
HTTP 상태 코드: 400

 ** NoDataRetentionException **   
 `GetImages` 데이터를 보존하지 않는 스트림에 대해가 요청되었습니다(즉, `DataRetentionInHours`의가 0임).  
HTTP 상태 코드: 400

 ** NotAuthorizedException **   
상태 코드: 403, 호출자가 지정된 스트림에서 작업을 수행할 권한이 없거나 토큰이 만료되었습니다.  
HTTP 상태 코드: 401

 ** ResourceNotFoundException **   
 `GetImages` Kinesis Video Streams가 지정한 스트림을 찾을 수 없는 경우에서이 오류가 발생합니다.  
 `GetHLSStreamingSessionURL` 요청된 시간 범위 내에 조각`LIVE_REPLAY`이 없는 스트림에 대해 `ON_DEMAND` 또는 `PlaybackMode`가 있는 세션이 요청되거나 지난 30초 내에 조각이 없는 스트림에 대해 `PlaybackMode`가 있는 세션`LIVE`이 요청되는 경우이 오류가 `GetDASHStreamingSessionURL` 발생합니다.  
HTTP 상태 코드: 404

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

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages)