As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

O suporte gerenciado para imagens fornece uma forma totalmente gerenciada de obter imagens dos dados de vídeo transmitidos e armazenados no Kinesis Video Streams. Você pode usar imagens para executar cargas de trabalho de aprendizado de máquina (ML), como detecção de pessoas, animais de estimação ou veículos. As imagens também podem ser usadas para adicionar elementos interativos à reprodução, como visualizações de imagens para eventos de movimento e depuração para um videoclipe. 

GetImages também recupera uma lista de imagens correspondentes a cada registro de data e hora para um determinado intervalo de tempo, intervalo de amostragem e configuração de formato de imagem.

**nota**  
Você deve primeiro chamar a `GetDataEndpoint` API para obter um endpoint. Em seguida, envie as `GetImages` solicitações para esse endpoint usando o parâmetro [--endpoint-url](https://docs.aws.amazon.com/cli/latest/reference/). 

 [Requisitos de faixa de reprodução de vídeo](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html).

## Sintaxe da Solicitação
<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
}
```

## Parâmetros da solicitação de URI
<a name="API_reader_GetImages_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_reader_GetImages_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-EndTimestamp"></a>
A data e hora de término da variedade de imagens a serem geradas. Se o intervalo de tempo entre `StartTimestamp` e `EndTimestamp` for superior a 300 segundos`StartTimestamp`, você receberá um`IllegalArgumentException`.  
Tipo: Timestamp  
Obrigatório: Sim

 ** [Format](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-Format"></a>
O formato que será usado para codificar a imagem.  
Tipo: string  
Valores válidos: `JPEG | PNG`   
Obrigatório: Sim

 ** [FormatConfig](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-FormatConfig"></a>
A lista de uma estrutura de pares de valores-chave que contém parâmetros extras que podem ser aplicados quando a imagem é gerada. A `FormatConfig` chave é a`JPEGQuality`, que indica a chave de qualidade JPEG a ser usada para gerar a imagem. O `FormatConfig` valor aceita ints de 1 a 100. Se o valor for 1, a imagem será gerada com menos qualidade e a melhor compressão. Se o valor for 100, a imagem será gerada com a melhor qualidade e menos compressão. Se nenhum valor for fornecido, o valor padrão da `JPEGQuality` chave será definido como 80.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de um item.  
Chaves válidas: `JPEGQuality`   
Restrições de comprimento do valor: comprimento mínimo de 0. O comprimento máximo é 256.  
Padrão de valor: `^[a-zA-Z_0-9]+`   
Obrigatório: não

 ** [HeightPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-HeightPixels"></a>
A altura da imagem de saída usada em conjunto com o `WidthPixels` parâmetro. Quando os `WidthPixels` parâmetros `HeightPixels` e parâmetros forem fornecidos, a imagem será esticada para se ajustar à proporção especificada. Se somente o `HeightPixels` parâmetro for fornecido, sua proporção original será usada para calcular a `WidthPixels` proporção. Se nenhum parâmetro for fornecido, o tamanho original da imagem será retornado.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 2160.  
Obrigatório: não

 ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-ImageSelectorType"></a>
A origem dos registros de data e hora do servidor ou do produtor a serem usados para gerar as imagens.  
Tipo: string  
Valores válidos: `PRODUCER_TIMESTAMP | SERVER_TIMESTAMP`   
Obrigatório: Sim

 ** [MaxResults](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-MaxResults"></a>
O número máximo de imagens a serem retornadas pela API.   
O limite padrão é de 25 imagens por resposta da API. Fornecer um valor `MaxResults` maior que esse resultará em um tamanho de página de 25. Quaisquer resultados adicionais serão paginados. 
Tipo: longo  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-NextToken"></a>
Um token que especifica por onde começar a paginar o próximo conjunto de imagens. Esse é o `GetImages:NextToken` de uma resposta truncada anteriormente.  
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.  
Padrão: `[a-zA-Z0-9+/]+={0,2}`   
Obrigatório: não

 ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-SamplingInterval"></a>
O intervalo de tempo em milissegundos (ms) no qual as imagens precisam ser geradas a partir do fluxo. O valor mínimo que pode ser fornecido é 200 ms (5 imagens por segundo). Se o intervalo do timestamp for menor que o intervalo de amostragem, a imagem do `startTimestamp` será retornada, se disponível.   
Tipo: inteiro  
Obrigatório: não

 ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StartTimestamp"></a>
O ponto de partida a partir do qual as imagens devem ser geradas. Isso `StartTimestamp` deve estar dentro de um intervalo inclusivo de registros de data e hora para que uma imagem seja retornada.  
Tipo: Timestamp  
Obrigatório: Sim

 ** [StreamARN](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamARN"></a>
O Amazon Resource Name (ARN) do stream do qual recuperar as imagens. Você deve especificar o `StreamName` ou `StreamARN` o.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 1.024.  
Padrão: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Obrigatório: não

 ** [StreamName](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamName"></a>
O nome do fluxo do qual recuperar as imagens. Você deve especificar o `StreamName` ou `StreamARN` o.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z0-9_.-]+`   
Obrigatório: não

 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-WidthPixels"></a>
A largura da imagem de saída usada em conjunto com o `HeightPixels` parâmetro. Quando os `HeightPixels` parâmetros `WidthPixels` e parâmetros forem fornecidos, a imagem será esticada para se ajustar à proporção especificada. Se somente o `WidthPixels` parâmetro for fornecido ou se somente o `HeightPixels` for fornecido, um `ValidationException` será lançado. Se nenhum parâmetro for fornecido, o tamanho original da imagem do stream será retornado.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 3840.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_reader_GetImages_ResponseSyntax"></a>

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

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

## Elementos de resposta
<a name="API_reader_GetImages_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [Images](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-Images"></a>
A lista de imagens geradas a partir do stream de vídeo. Se não houver mídia disponível para o carimbo de data/hora especificado, o `NO_MEDIA` erro será listado na saída. Se ocorrer um erro enquanto a imagem estiver sendo gerada, `MEDIA_ERROR` ele será listado na saída como a causa da imagem ausente.   
Tipo: matriz de objetos [Image](API_reader_Image.md)

 ** [NextToken](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-NextToken"></a>
O token criptografado que foi usado na solicitação para obter mais imagens.  
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.  
Padrão: `[a-zA-Z0-9+/]+={0,2}` 

## Erros
<a name="API_reader_GetImages_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** ClientLimitExceededException **   
O Kinesis Video Streams limitou a solicitação porque você excedeu um limite. Tente fazer a ligação mais tarde. Para obter informações sobre limites, consulte Cotas do [Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).  
Código de status HTTP: 400

 ** InvalidArgumentException **   
Um parâmetro especificado excede suas restrições, não é suportado ou não pode ser usado.  
Código de status HTTP: 400

 ** NoDataRetentionException **   
 `GetImages`foi solicitado para um fluxo que não retém dados (ou seja, tem um `DataRetentionInHours` de 0).   
Código de status HTTP: 400

 ** NotAuthorizedException **   
Código de status: 403, O chamador não está autorizado a realizar uma operação no stream fornecido ou o token expirou.  
Código de status HTTP: 401

 ** ResourceNotFoundException **   
 `GetImages`gerará esse erro quando o Kinesis Video Streams não conseguir encontrar o stream que você especificou.  
 `GetHLSStreamingSessionURL`e `GetDASHStreamingSessionURL` gere esse erro se uma sessão com um `PlaybackMode` de `ON_DEMAND` ou `LIVE_REPLAY` for solicitada para um fluxo que não tem fragmentos dentro do intervalo de tempo solicitado, ou se uma sessão com um `PlaybackMode` of `LIVE` for solicitada para um fluxo que não tem fragmentos nos últimos 30 segundos.  
Código de status HTTP: 404

## Consulte Também
<a name="API_reader_GetImages_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages)