StartEdgeConfigurationUpdate

Uma API assíncrona que atualiza a configuração de borda existente de um stream. O Kinesis Video Stream sincronizará a configuração de borda do stream com o componente Edge Agent IoT Greengrass que é executado em um dispositivo IoT Hub, configurado em suas instalações. O tempo de sincronização pode variar e depende da conectividade do dispositivo hub. Eles SyncStatus serão atualizados assim que a configuração de borda for reconhecida e sincronizada com o Edge Agent.

Se essa API for invocada pela primeira vez, uma nova configuração de borda será criada para o stream e o status de sincronização será definido como. SYNCING Você precisará esperar que o status de sincronização alcance um estado terminal, como: ou IN_SYNCSYNC_FAILED, antes de usar essa API novamente. Se você invocar essa API durante o processo de sincronização, um ResourceInUseException será lançado. A conectividade da configuração de borda do stream e do Edge Agent será testada novamente por 15 minutos. Após 15 minutos, o status passará para o SYNC_FAILED estado.

Para mover uma configuração de borda de um dispositivo para outro, use DeleteEdgeConfiguration para excluir a configuração de borda atual. Em seguida, você pode invocar StartEdgeConfigurationUpdate com um ARN de dispositivo de hub atualizado.

nota

Essa API não está disponível na região AWS África (Cidade do Cabo), af-south-1.

Sintaxe da Solicitação

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

Parâmetros da solicitação de URI

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

Corpo da Solicitação

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

EdgeConfig

Os detalhes da configuração de borda necessários para invocar o processo de atualização.

Tipo: objeto EdgeConfig

Obrigatório: Sim

StreamARN

O Nome de recurso da Amazon (ARN) do fluxo do . Especifique o StreamName ou StreamARN o.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 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

O nome do fluxo cuja configuração de borda você deseja atualizar. Especifique o StreamName ou StreamARN o.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 256.

Padrão: [a-zA-Z0-9_.-]+

Obrigatório: Não

Sintaxe da Resposta

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

Elementos de Resposta

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.

CreationTime

O timestamp no qual a configuração de borda de um riacho foi criada pela primeira vez.

Tipo: Timestamp

EdgeConfig

Uma descrição da configuração de borda do stream que será usada para sincronizar com o componente Edge Agent IoT Greengrass. O componente Edge Agent será executado em um dispositivo Hub IoT configurado em suas instalações.

Tipo: objeto EdgeConfig

FailedStatusDetails

Uma descrição do status de falha gerado.

Tipo: string

LastUpdatedTime

A data e hora em que a configuração de borda de um stream foi atualizada pela última vez.

Tipo: Timestamp

StreamARN

O Nome de recurso da Amazon (ARN) do fluxo do .

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.

Padrão: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

StreamName

O nome do fluxo a partir do qual a configuração de borda foi atualizada.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 256.

Padrão: [a-zA-Z0-9_.-]+

SyncStatus

O status de sincronização atual da configuração de borda do stream. Quando você invoca essa API, o status de sincronização é definido como o SYNCING estado. Use a DescribeEdgeConfiguration API para obter o status mais recente da configuração de borda.

Tipo: strings

Valores Válidos: SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

AccessDeniedException

Você não tem as permissões necessárias para realizar essa operação.

Código de status HTTP: 401

ClientLimitExceededException

O Kinesis Video Streams limitou a solicitação porque você excedeu o limite permitido de chamadas de clientes. Tente fazer a ligação mais tarde.

Código de Status HTTP: 400

InvalidArgumentException

O valor desse parâmetro de entrada é inválido.

Código de Status HTTP: 400

NoDataRetentionException

A retenção de dados do Stream em horas é igual a zero.

Código de Status HTTP: 400

ResourceInUseException

Quando a entrada StreamARN ou ChannelARN a entrada já estiverem mapeadas para um recurso diferente do Kinesis Video Stream, ou se a StreamARN entrada ChannelARN fornecida não estiver no status Ativo, tente uma das seguintes opções: CLOUD_STORAGE_MODE

1. A DescribeMediaStorageConfiguration API para determinar para qual stream determinado canal é mapeado.

2. A DescribeMappedResourceConfiguration API para determinar o canal para o qual o determinado fluxo é mapeado.

3. A DescribeSignalingChannel API DescribeStream ou para determinar o status do recurso.

Código de Status HTTP: 400

ResourceNotFoundException

O Amazon Kinesis Video Streams não consegue encontrar o stream que você especificou.

Código de Status HTTP: 404

Consulte Também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK para Go v2

• AWS SDK para Java V2

• AWS SDK para JavaScript V3

• AWS SDK para PHP V3

• AWS SDK para Python

• AWS SDK para Ruby V3