Criar sua imagem do AppStream 2.0 de forma programática usando as operações da CLI do Assistente de Imagens - Amazon AppStream 2.0

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á.

Criar sua imagem do AppStream 2.0 de forma programática usando as operações da CLI do Assistente de Imagens

Você pode criar imagens do Amazon AppStream 2.0 conectando-se a um construtor de imagens e usando a interface gráfica de usuário (GUI) ou as operações da interface de linha de comando (CLI) do Assistente de Imagens. As operações da CLI do Image Assistant oferecem funcionalidade semelhante à GUI do Image Assistant. Com essas operações, você pode fazer o seguinte de forma programática:

  • Gerenciar os aplicativos que estão incluídos em uma imagem.

  • Salvar, atualizar e redefinir as configurações do aplicativo padrão.

  • Habilitar ou desabilitar o framework dinâmico de aplicações do AppStream 2.0.

  • Especificar tags.

  • Criar uma imagem.

Você pode usar essas operações para integrar a criação de imagens do AppStream 2.0 ao seu processo de integração contínua ou desenvolvimento de software de implantação.

Para trabalhar com as operações da CLI do Image Assistant, use o shell de linha de comando de sua escolha em um construtor de imagens. Por exemplo, você pode usar o prompt de comando do Windows ou o PowerShell.

nota

O construtor de imagens deve usar uma versão do agente do AppStream 2.0 lançada a partir de 26 de julho de 2019. Se não tiver um construtor de imagens, você deverá criar um. Para obter mais informações, consulte Inicie um criador de imagens para instalar e configurar aplicativos de streaming.

Criação de configurações padrão de aplicativo e do Windows com as operações da CLI do Image Assistant

Você pode criar configurações padrão de aplicativo e do Windows para que os usuários possam começar a usar seus aplicativos rapidamente. Quando você cria essas configurações, o AppStream 2.0 substitui o perfil de usuário padrão do Windows pelo perfil que você configurar. O perfil de usuário padrão do Windows é, então, usado para criar as configurações iniciais para os usuários na instância de frota. Se você criar essas configurações usando as operações da CLI do Image Assistant, seu instalador de aplicativos, ou a automação, deverá modificar o perfil de usuário padrão do Windows diretamente.

Para substituir o perfil de usuário padrão do Windows pelo de outro usuário do Windows, você também pode usar a operação update-default-profile da CLI do Image Assistant.

Para obter mais informações sobre como definir as configurações padrão de aplicação e do Windows, consulte Creating Default Application and Windows Settings for Your AppStream 2.0 Users em aplicativo padrão e configurações do Windows e performance de início da aplicativo.

Como otimizar o desempenho de inicialização dos seus aplicativos com as operações da CLI do Image Assistant

O AppStream 2.0 permite que você otimize a performance de inicialização das suas aplicações para as sessões de streaming dos usuários. Ao fazer isso usando as operações da CLI do Image Assistant, você pode especificar os arquivos a serem otimizados para a inicialização do aplicativo. A adição de arquivos ao manifesto de otimização do aplicativo reduz o tempo necessário para o aplicativo iniciar pela primeira vez em uma nova instância de frota. No entanto, isso também aumenta o tempo necessário para as instâncias de frota serem disponibilizadas aos usuários. O manifesto de otimização é um arquivo de texto delimitado por linha que é exclusivo de cada aplicativo.

nota

Se você integrar os manifestos de otimização de aplicativos usando as operações da CLI do Image Assistant e a GUI do Image Assistant, os manifestos serão mesclados.

Veja a seguir um exemplo de um arquivo de manifesto de otimização de aplicações:

C:\Program Files (x86)\Notepad++\autoCompletion C:\Program Files (x86)\Notepad++\localization C:\Program Files (x86)\Notepad++\plugins C:\Program Files (x86)\Notepad++\themes C:\Program Files (x86)\Notepad++\updater C:\Program Files (x86)\Notepad++\userDefineLangs C:\Program Files (x86)\Notepad++\change.log C:\Program Files (x86)\Notepad++\config.xml C:\Program Files (x86)\Notepad++\contextMenu.xml C:\Program Files (x86)\Notepad++\doLocalConf.xml C:\Program Files (x86)\Notepad++\functionList.xml C:\Program Files (x86)\Notepad++\langs.model.xml C:\Program Files (x86)\Notepad++\license.txt C:\Program Files (x86)\Notepad++\notepad++.exe C:\Program Files (x86)\Notepad++\readme.txt C:\Program Files (x86)\Notepad++\SciLexer.dll C:\Program Files (x86)\Notepad++\shortcuts.xml C:\Program Files (x86)\Notepad++\stylers.model.xml

Para obter mais informações sobre como otimizar o desempenho de inicialização dos seus aplicativos, consulte Otimização do desempenho de inicialização dos seus aplicativos em aplicativo padrão e configurações do Windows e performance de início da aplicativo.

Visão geral do processo de criação de uma imagem do AppStream 2.0 de forma programática

Você pode usar as operações da CLI do Assistente de Imagens com a sua automação de instalação de aplicações para criar um fluxo de trabalho de criação de imagem do AppStream 2.0 totalmente programática. Depois que a sua automação de instalação de aplicativos for concluída, mas antes que a imagem seja criada, use as operações da CLI do Image Assistant para especificar o seguinte:

  • Os arquivos executáveis que os usuários podem iniciar

  • Os manifestos de otimização para seus aplicativos

  • Outros metadados de imagem do AppStream 2.0

A visão geral de alto nível a seguir descreve o processo para criar uma imagem do AppStream 2.0 de forma programática.

  1. Use sua automação de instalação de aplicativos para instalar os aplicativos necessários em seu construtor de imagens. Essa instalação pode incluir os aplicativos que seus usuários iniciarão, quaisquer dependências e aplicativos em segundo plano.

  2. Determine os arquivos e as pastas a serem otimizados.

  3. Se aplicável, use a operação add-application da CLI do Assistente de Imagens para especificar o manifesto de otimização e metadados da aplicação para a imagem do AppStream 2.0.

  4. Para especificar aplicações adicionais para a imagem do AppStream 2.0, repita as etapas de 1 a 3 para cada aplicação, conforme necessário.

  5. Se aplicável, use a operação update-default-profile da CLI do Image Assistant para substituir o perfil padrão do Windows e criar configurações padrão de aplicativo e do Windows para seus usuários.

  6. Use a operação create-image da CLI do Image Assistant para criar a imagem.

Operações da CLI do Assistente de Imagens para criar e gerenciar sua imagem do AppStream 2.0

Esta seção descreve as operações da CLI do Assistente de Imagens que você pode usar para criar e gerenciar sua imagem do AppStream 2.0.

Nos construtores de imagens do Windows, o arquivo executável que inclui a interface de linha de comando está localizado em: C:\Arquivos de Programas\Amazon\Photon\ConsoleImageBuilder\Image-Assistant.exe. Para sua conveniência, esse arquivo executável está incluído na variável PATH do Windows. Isso permite que você chame as operações da CLI do Image Assistant sem especificar o caminho absoluto para o arquivo executável. Para chamar essas operações, digite o comando image-assistant.exe.

Nos construtores de imagens do Linux, a ferramenta de assistente de imagens está localizada em /usr/local/appstream/image-assistant/AppStreamImageAssistant, com um link simbólico em /bin/AppStreamImageAssistant.

Operação do help

Recupera uma lista de todas as operações da CLI do Image Assistant. Para cada operação na lista, é fornecida uma descrição e uma sintaxe de uso. Para exibir a ajuda para uma operação específica, digite o nome da operação e especifique o parâmetro --help. Por exemplo:

add-application --help

Resumo

help

Resultado

Imprime na saída padrão a lista de operações disponíveis com uma descrição de suas funções.

Operação do add-application

Adiciona a aplicação à lista de aplicações para usuários do AppStream 2.0. Os aplicativos nessa lista são incluídos no catálogo de aplicativos. O catálogo de aplicações é exibido aos usuários quando eles fazem login em uma sessão de streaming do AppStream 2.0.

nota

Se você precisar fazer alterações na configuração de uma aplicação, remova a aplicação e adicione-a com as configurações atualizadas.

Resumo

add-application --name <value> --absolute-app-path <value> [--display-name <value>] [--absolute-icon-path <value>] [--working-directory <value>] [--launch-parameters <""-escaped value>] [--absolute-manifest-path <value>]

Opções

--name (string)

Um nome exclusivo para o aplicativo. O tamanho máximo é de 256 caracteres. Você pode adicionar até 50 aplicativos. Você não pode usar caracteres de espaço em branco.

--absolute-app-path (string)

O caminho absoluto para o arquivo executável, o arquivo de lote ou script do aplicativo. O caminho deve apontar para um arquivo válido.

--display-name (string)

O nome para exibição do aplicativo no catálogo de aplicativos. Se você não especificar um nome de exibição, o AppStream 2.0 criará um nome que é derivado do nome de arquivo executável. O nome é criado sem a extensão de arquivo e com sublinhados no lugar de espaços. O tamanho máximo é de 256 caracteres.

--absolute-icon-path (string)

O caminho absoluto para o ícone do aplicativo. O caminho deve apontar para um arquivo de ícone válido que é um dos seguintes tipos: .jpg, .png ou .bmp. As dimensões máximas são: 256 px x 256 px. Se você não especificar um caminho, o ícone padrão do arquivo executável será usado, se disponível. Se um ícone padrão não estiver disponível para o arquivo executável, um ícone padrão da aplicação AppStream 2.0 será usado.

--working-directory (string)

O diretório de trabalho inicial do aplicativo quando o aplicativo é iniciado.

--absolute-manifest-path (string)

O caminho para um novo arquivo de texto delimitado por linha. O arquivo especifica os caminhos absolutos dos arquivos a serem otimizados antes de a instância de frota ser disponibilizada para streaming. O caminho deve apontar para um arquivo de texto válido.

Saída de mensagem

Código de saída Mensagem impressa na saída padrão Descrição
0 {"status": 0, "message": "Success"} O aplicativo foi adicionado com êxito.
1 {"status": 1, "message": "Administrator privileges are required to perform this operation"} São necessários privilégios de administrador para concluir a operação.
1 {"status": 1, "message": "Unable to add more than 50 apps to the catalog."} Não foi possível adicionar a aplicação porque o número máximo de aplicações que podem ser adicionadas ao catálogo de aplicações do AppStream 2.0 é 50.
1 {"status": 1, "message": "Name is not unique"} Já existe uma aplicação com esse nome no catálogo de aplicações do AppStream 2.0.
1 {"status": 1, "message": "File not found (absolute-app-path)"} O arquivo que foi especificado para absolute-app-path não foi encontrado.
1 {"status": 1, "message": "Unsupported file extension"} O parâmetro Absolute-app-path só é compatível com os seguintes tipos de arquivos: .exe e .bat.
1 {"status": 1, "message": "Directory not found (working-directory)" O diretório que foi especificado working-directory não foi encontrado.
1 {"status": 1, "message": "Optimization-manifest not found: <nome do arquivo>"} O arquivo que foi especificado para optimization-manifest não foi encontrado.
1 {"status": 1, "message": "File not found: <nome do arquivo>"} Um arquivo que foi especificado no manifesto de otimização não foi encontrado.
255 {"status": 255, "message": <mensagem de erro>} Ocorreu um erro inesperado. Tente a solicitação novamente. Se o erro persistir, entre em contato com o AWS Support para obter assistência. Para obter mais informações, consulte o AWS Support Center.

Operação do remove-application

Remove uma aplicação da lista de aplicações da imagem do AppStream 2.0. A aplicação não é desinstalada nem modificada, mas os usuários não poderão iniciá-la pelo catálogo de aplicações do AppStream 2.0.

Resumo

remove-application --name <value>

Opções

--name (string)

O identificador exclusivo do aplicativo a ser removido.

Saída de mensagem

Código de saída Mensagem impressa na saída padrão Descrição
0 {"status": 0, "message": "Success"} O aplicativo foi removido com êxito.
1 {"status": 1, "message": "Administrator privileges are required to perform this operation"} São necessários privilégios de administrador para concluir a operação.
1 {"status": 1, "message": "App not found"} A aplicação que foi especificada não foi encontrada no catálogo de aplicações do AppStream 2.0.
255 {"status": 255, "message": <mensagem de erro>} Ocorreu um erro inesperado. Tente a solicitação novamente. Se o erro persistir, entre em contato com o AWS Support para obter assistência. Para obter mais informações, consulte o AWS Support Center.

Operação do list-applications

Lista todos os aplicativos que são especificados no catálogo de aplicativos.

Resumo

list-applications

Saída de mensagem

Código de saída Mensagem impressa na saída padrão Descrição
0 {"status": 0, "message": "Success", "applications": [ {..app1.. }, { ..app2.. }]} Lista de aplicações no catálogo de aplicações do AppStream 2.0.
255 {"status": 255, "message": <mensagem de erro>} Ocorreu um erro inesperado. Tente a solicitação novamente. Se o erro persistir, entre em contato com o AWS Support para obter assistência. Para obter mais informações, consulte o AWS Support Center.

Operação do update-default-profile

Copia o perfil do usuário do Windows especificado para o perfil de usuário padrão do Windows. Os novos usuários que fizerem streaming herdarão as configurações armazenadas no perfil especificado.

nota

Essa operação não é compatível com a ferramenta de CLI do assistente de imagens do Linux.

Resumo

update-default-profile [--profile <value>]

Opções

--profile (string)

O nome do usuário cujo perfil do Windows será copiado para o perfil de usuário padrão do Windows. Use o seguinte formato para o nome:

"<domínio>\<nome de usuário>"

Se o seu construtor de imagens não estiver integrado a um domínio do Microsoft Active Directory, insira um ponto "." para o domínio. Se você não especificar um usuário, a conta de usuário modelo do AppStream 2.0 será usada.

Saída de mensagem

Código de saída Mensagem impressa na saída padrão Descrição
0 {"status": 0, "message": "Success"} As configurações do usuário foram copiados para o perfil padrão do Windows.
1 {"status": 1, "message": "Administrator privileges are required to perform this operation"} São necessários privilégios de administrador para concluir a operação.
1 {"status": 1, "message": "Unable to copy file or folder: <caminho>. <motivo>"} As configurações do usuário não foram copiadas porque um arquivo ou uma pasta estava indisponível.
1 {"status": 1, "message": "Cannot copy a domain user when not joined to a domain""} Um usuário do domínio do Microsoft Active Directory foi especificado, mas o construtor de imagens não está associado a um domínio do Active Directory.
255 {"status": 255, "message": <mensagem de erro>} Ocorreu um erro inesperado. Tente a solicitação novamente. Se o erro persistir, entre em contato com o AWS Support para obter assistência. Para obter mais informações, consulte o AWS Support Center.

Operação do reset-user-profile

Exclui o perfil de usuário do Windows para o usuário especificado.

nota

Essa operação não é compatível com a ferramenta de CLI do assistente de imagens do Linux.

Resumo

reset-user-profile [--profile <value>]

Opções

--profile (string)

O nome do usuário do Windows cujo perfil do Windows será excluído. Use o seguinte formato para o nome:

"<domínio>\<nome de usuário>"

Se o seu construtor de imagens não estiver integrado a um domínio do Microsoft Active Directory, insira um ponto "." para o domínio.

Saída de mensagem

Código de saída Mensagem impressa na saída padrão Descrição
0 {"status": 0, "message": "Success"} As configurações do usuário especificado foram excluídas com êxito.
1 {"status": 1, "message": "Administrator privileges are required to perform this operation"} São necessários privilégios de administrador para concluir a operação.
1 {"status": 1, "message": "Unable to copy file or folder: <caminho>. <motivo>"} As configurações do usuário não puderam ser redefinidas porque um arquivo ou uma pasta estava indisponível.
1 {"status": 1, "message": "Cannot copy a domain user when not joined to a domain""} Um usuário do domínio do Microsoft Active Directory foi especificado, mas o construtor de imagens não está associado a um domínio do Active Directory.
255 {"status": 255, "message": <mensagem de erro>} Ocorreu um erro inesperado. Tente a solicitação novamente. Se o erro persistir, entre em contato com o AWS Support para obter assistência. Para obter mais informações, consulte o AWS Support Center.

Operação do create-image

Inicia o fluxo de trabalho de criação de imagem, o que resulta em uma imagem do AppStream 2.0 que pode ser usada para frotas do AppStream 2.0.

Resumo

create-image --name <value> [--description <value>] [--display-name <value>] [--enable-dynamic-app-catalog] | [--no-enable-dynamic-app-catalog] [--use-latest-agent-version] | [--no-use-latest-agent-version] [--tags <value>] [--dry-run]

Opções

--name (string)

O nome da imagem do AppStream 2.0. O nome deve ser exclusivo na conta da Amazon Web Services e na região da AWS. O tamanho máximo é 100 caracteres. Os caracteres permitidos são:

a–z, A–Z, 0–9, sublinhados (_), hifens (-) e pontos (.)

O nome da imagem não pode começar com nenhum um dos seguintes prefixos: “aws” “appstream” e “amazon”. Esses prefixos são reservados para uso da AWS.

--description (string)

A descrição a ser exibida para a imagem. O tamanho máximo é de 256 caracteres.

--display-name (string)

O nome a ser exibido para a imagem. O tamanho máximo é de 256 caracteres.

--enable-dynamic-app-catalog | --no-enable-dynamic-app-catalog

Habilita ou desabilita o suporte ao framework dinâmico de aplicações do AppStream 2.0. Se você não especificar nenhum parâmetro, o suporte para a estrutura de aplicativos dinâmicos não será habilitado.

O framework dinâmico de aplicações fornece operações em uma instância de streaming do AppStream 2.0 que você pode usar para criar um provedor dinâmico de aplicações. Os provedores de aplicativos dinâmicos podem usar essas operações para modificar o catálogo de aplicativos que os usuários podem acessar em tempo real. Para obter mais informações, consulte Usar o framework dinâmico de aplicações do AppStream 2.0 para criar um provedor dinâmico de aplicações.

--use-latest-agent-version | --no-use-latest-agent-version

Especifica se a imagem deve ser fixada à versão do agente do AppStream 2.0 que está instalada ou se deve ser usada sempre a versão mais recente do agente. Se você não especificar nenhum dos parâmetros, a imagem será fixada à versão do agente do AppStream 2.0 que está instalada. Para obter mais informações, consulte Gerenciar versões do agente do AppStream 2.0.

--tags (string)

As tags a serem associadas à imagem. Uma tag é um par de chave-valor. Use o formato a seguir:

--tags "mykey" "myval" "mykey2" "myval2"

Para ter mais informações sobre tags, consulte Marcar recursos do Amazon AppStream 2.0.

--dry-run (string)

Executa a validação sem criar a imagem. Use esse comando para identificar se sua imagem tem algum problema antes de criá-la.

Saída de mensagem

Código de saída Mensagem impressa na saída padrão Descrição
0 {"status": 0, "message": "Success"} O fluxo de trabalho para criar a imagem foi iniciado com êxito.
1 {"status": 1, "message": "Administrator privileges are required to perform this operation"} São necessários privilégios de administrador para concluir a operação.
1 {"status": 1, "message": "An image with the given name already exists"} Já existe uma imagem com o nome especificado na conta da Amazon Web Services.
1 {"status": 1, "message": "Invalid value (tags)"} As tags especificadas não são válidas.
255 {"status": 255, "message": <mensagem de erro>} Ocorreu um erro inesperado. Tente a solicitação novamente. Se o erro persistir, entre em contato com o AWS Support para obter assistência. Para obter mais informações, consulte o AWS Support Center.