Recuperação de configurações chamando diretamente as APIs

Seu aplicativo recupera os dados de configuração estabelecendo primeiro uma sessão de configuração usando a operação da StartConfigurationSessionAPI. O cliente da sua sessão então faz chamadas periódicas GetLatestConfigurationpara verificar e recuperar os dados mais recentes disponíveis.

Ao chamar StartConfigurationSession, seu código envia as seguintes informações:

• Identificadores (ID ou nome) de um AWS AppConfig aplicativo, ambiente e perfil de configuração que a sessão rastreia.

• (Opcional) O tempo mínimo que o cliente da sessão deve esperar entre chamadas para GetLatestConfiguration.

Em resposta, AWS AppConfig fornece um InitialConfigurationToken a ser entregue ao cliente da sessão e usado na primeira vez em que ele liga GetLatestConfiguration para essa sessão.

Importante

Esse token só deve ser usado uma vez em sua primeira chamada para GetLatestConfiguration. Você deve usar o novo token na resposta GetLatestConfiguration (NextPollConfigurationToken) em cada chamada subseqüente para GetLatestConfiguration. Para oferecer suporte a casos de uso de pesquisas longas, os tokens são válidos por até 24 horas. Se uma chamada GetLatestConfiguration usar um token expirado, o sistema retornará BadRequestException.

Ao chamar GetLatestConfiguration, seu código de cliente envia o valor ConfigurationToken mais recente que ele tem e recebe em resposta:

• NextPollConfigurationToken: o valor ConfigurationToken a ser usado na próxima chamada para GetLatestConfiguration.

• NextPollIntervalInSeconds: o tempo que o cliente deve esperar até fazer sua próxima chamada para GetLatestConfiguration.

• A configuração: os dados mais recentes destinados à sessão. Este pode estar vazio se o cliente já tiver a versão mais recente da configuração.

Importante

Observe as seguintes informações importantes:

• A StartConfigurationSessionAPI só deve ser chamada uma vez por aplicativo, ambiente, perfil de configuração e cliente para estabelecer uma sessão com o serviço. Isso geralmente é feito no startup do aplicativo ou imediatamente antes da primeira recuperação de uma configuração.

• Se sua configuração for implantada usando um KmsKeyIdentifier, sua solicitação para receber a configuração deverá incluir permissão para chamar kms:Decrypt. Para obter mais informações, consulte Descriptografar na Referência da API do AWS Key Management Service .

• A operação da API usada anteriormente para recuperar dados de configuração, GetConfiguration, está obsoleta. A operação GetConfiguration da API não é compatível com configurações criptografadas.

Exemplo de recuperação de uma configuração

O AWS CLI exemplo a seguir demonstra como recuperar dados de configuração usando as operações de AWS AppConfig dados StartConfigurationSession e GetLatestConfiguration API. O primeiro comando inicia uma sessão de configuração. Essa chamada inclui as IDs (ou nomes) do AWS AppConfig aplicativo, do ambiente e do perfil de configuração. A API retorna um InitialConfigurationToken usado para buscar seus dados de configuração.

aws appconfigdata start-configuration-session \
    --application-identifier application_name_or_ID \
    --environment-identifier environment_name_or_ID \
    --configuration-profile-identifier configuration_profile_name_or_ID 

O sistema responde com informações no seguinte formato.

{
   "InitialConfigurationToken": initial configuration token
}

Depois de iniciar uma sessão, use InitialConfigurationTokento call GetLatestConfigurationpara buscar seus dados de configuração. Os dados de configuração são salvos no arquivo mydata.json.

aws appconfigdata get-latest-configuration \
    --configuration-token initial configuration token mydata.json

A primeira chamada para GetLatestConfiguration usa o ConfigurationToken obtido de StartConfigurationSession. As informações a seguir são retornadas.

{
    "NextPollConfigurationToken" : next configuration token,
    "ContentType" : content type of configuration,
    "NextPollIntervalInSeconds" : 60
}  

As chamadas subsequentes para GetLatestConfiguration devem fornecer NextPollConfigurationToken da resposta anterior.

aws appconfigdata get-latest-configuration \
    --configuration-token next configuration token mydata.json

Importante

Observe os detalhes importantes a seguir sobre a operação GetLatestConfiguration da API:

• A resposta GetLatestConfiguration inclui uma seção Configuration que mostra os dados de configuração. A seção Configuration só aparece se o sistema encontrar dados de configuração novos ou atualizados. Se o sistema não encontrar dados de configuração novos ou atualizados, os dados de Configuration estarão vazios.

• Você recebe um novo ConfigurationToken a cada resposta de GetLatestConfiguration.

• Recomendamos ajustar a frequência de pesquisas das chamadas de API GetLatestConfiguration com base no seu orçamento, na frequência esperada de implantações de configuração e no número de destinos para uma configuração.