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á.
AWS Service Catalog Visão geral da API
Benefícios do uso da API Service Catalog
A AWS Service Catalog API fornece controle programático sobre todas as ações do usuário final como alternativa ao uso do. Console de gerenciamento da AWS Ao usar a API, você pode fazer o seguinte:
-
Crie suas próprias interfaces e aplicativos personalizados
-
Obtenha um controle refinado das operações de provisionamento de produtos do usuário final
-
Integre o provisionamento de recursos em seus pipelines de orquestração
-
Acesse um local central que hospeda seus aplicativos com seus recursos
Access Service Catalog
Para criar aplicativos usando APIs específicas da linguagem, use as bibliotecas, o código de amostra, os tutoriais e outros recursos para desenvolvedores de software. Essas bibliotecas fornecem funções básicas que automatizam tarefas, como assinatura criptografada de suas solicitações, novas tentativas de solicitações e tratamento das respostas de erro, facilitando para que você comece rapidamente. Para começar, abra as Ferramentas para Amazon Web Services
Se preferir usar uma interface de linha de comando, temos as seguintes opções:
- AWS Interface de linha de comando (CLI)
-
Para começar a usar, consulte o Guia do usuário da AWS Command Line Interface. Para obter mais informações sobre os comandos do Service Catalog, consulte servicecatalog na Referência de Comandos.AWS CLI
- AWS Ferramentas para Windows PowerShell
-
Para começar a usar, consulte o Guia do usuário da Ferramentas da AWS para PowerShell. Para obter mais informações sobre os cmdlets do Service Catalog, abra o Ferramentas da AWS para PowerShell Cmdlet Reference e expanda. AWS Service Catalog
A AWS Service Catalog API pode ser dividida logicamente nas seguintes categorias.
Tópicos
Descoberta de produtos
Use essas operações para descobrir ou obter informações sobre produtos e os requisitos de lançamento para eles. Essas operações não criam nem modificam recursos.
- SearchProducts
-
Lista todos os produtos aos quais o chamador tem acesso.
- DescribeProduct
-
Obtenha informações detalhadas sobre um produto.
- DescribeProductView
-
Funcionalmente idêntico
DescribeProduct, exceto pelo fato de usar o ID de uma visualização do produto em vez do ID de um produto. - ListLaunchPaths
-
Lista todas as formas pelas quais o usuário tem acesso a um produto específico, chamadas de caminhos para o produto. O usuário deve selecionar um caminho para provisionar o produto.
- DescribeProvisioningParameters
-
Obtém os parâmetros necessários para provisionar um produto específico e fornece metadados adicionais sobre o que acontecerá quando o produto for provisionado.
Cada um
ProvisioningArtifactParameteré algo que o usuário deve especificar para provisionar o produto com sucesso (por exemplo, o tamanho de uma instância do EC2). OsConstraintSummaryobjetos contêm a lista de valores permitidos e metadados adicionais sobre osProvisioningArtifactParameterobjetos.
Solicitações de provisionamento
Use essas operações para solicitar, atualizar ou encerrar o provisionamento de um produto.
- ProvisionProduct
-
Solicita o provisionamento de um produto. Provisionar um produto é lançar os recursos necessários para colocar esse produto on-line para uso real. Por exemplo, provisionar um produto apoiado por um CloudFormation modelo significa lançar uma CloudFormation pilha e todos os seus recursos subjacentes.
- UpdateProvisionedProduct
-
Atualiza a configuração de um produto provisionado. Por exemplo, um produto apoiado por CloudFormation tem sua CloudFormation pilha subjacente atualizada. O solicitante deve ter permissões de acesso suficientes ao especificado ProvisionedProduct.
- TerminateProvisionedProduct
-
Solicita a rescisão de um produto provisionado. Por exemplo, para um produto apoiado por CloudFormation, isso exclui a CloudFormation pilha subjacente. O solicitante deve ter permissões de acesso suficientes ao produto provisionado especificado.
Produtos provisionados
Use essas operações para obter informações sobre produtos provisionados. Essas operações não criam nem modificam recursos.
- ListRecordHistory
-
Lista todas as solicitações realizadas, mesmo para produtos provisionados encerrados.
- DescribeRecord
-
Obtém informações sobre uma solicitação. Use essa operação após a operação de solicitação para obter
RecordDetailas informações atuais. - SearchProvisionedProducts
-
Obtém informações sobre os produtos provisionados que atendem aos critérios especificados.
- ScanProvisionedProducts
-
Lista os produtos provisionados que não foram encerrados.
- DescribeProvisionedProduct
-
Obtém informações sobre um produto provisionado.
- ImportAsProvisionedProduct
-
Solicita a importação de um recurso como um produto provisionado do Service Catalog que está associado a um produto do Service Catalog e ao artefato de provisionamento. Depois de importadas, todas as ações de governança do Service Catalog suportadas são suportadas no produto provisionado.
- UpdateProvisionedProductProperties
-
Solicita atualizações nas propriedades do produto provisionado especificado.
Planos de produtos provisionados
Use essas operações para gerenciar seus planos de produtos provisionados. Um plano inclui a lista de recursos a serem criados ou modificados quando você executa o plano.
- CreateProvisionedProductPlan
Cria um plano.
- DescribeProvisionedProductPlan
Obtém informações sobre as alterações de recursos de um plano.
- ExecuteProvisionedProductPlan
Provisiona ou modifica um produto com base em um plano.
- ListProvisionedProductPlans
Lista os planos de um produto provisionado.
- DeleteProvisionedProductPlan
Exclui um plano.
Portfólios
Os administradores de catálogos usam essas operações para fornecer todas as operações necessárias para o gerenciamento de portfólio.
- CreatePortfolio
Cria um portfólio.
- DeletePortfolio
Exclui um portfólio.
- DescribePortfolio
Obtém informações detalhadas sobre um portfólio.
- DescribePortfolioShares
Retorna um resumo de cada uma das ações do portfólio que foram criadas para o portfólio especificado.
- ListPortfolios
Lista todos os portfólios no catálogo.
- ListPortfoliosForProduct
Lista todos os portfólios aos quais um produto está associado.
- UpdatePortfolio
Atualiza um portfólio.
- UpdatePortfolioShare
Atualiza um compartilhamento do portfólio.
- CreatePortfolioShare
Compartilha um portfólio com uma AWS conta.
- DeletePortfolioShare
Pára de compartilhar um portfólio.
- AcceptPortfolioShare
Aceita uma oferta para compartilhar um portfólio.
- RejectPortfolioShare
Rejeita uma oferta para compartilhar um portfólio.
- ListAcceptedPortfolioShares
Lista os detalhes de todos os portfólios para os quais o compartilhamento foi aceito por essa conta.
- ListPortfolioAccess
Lista os IDs de conta que têm acesso a um portfólio.
Associação principal
Os administradores de catálogos usam essas operações para fornecer todas as operações necessárias para a associação principal.
- AssociatePrincipalWithPortfolio
Associa um ARN principal a um portfólio.
- DisassociatePrincipalFromPortfolio
Desassocia um ARN principal de um portfólio.
- ListPrincipalsForPortfolio
Lista todos os ARNs principais associados a um portfólio.
Produtos
Os administradores de catálogos usam essas operações para fornecer todas as operações necessárias para o gerenciamento do produto.
- SearchProductsAsAdmin
Obtém informações resumidas e de status dos produtos.
- DescribeProductAsAdmin
Obtém informações sobre um produto.
- CreateProduct
Cria um produto.
- CopyProduct
Copia um produto.
- DescribeCopyProductStatus
Obtém o status de uma operação do produto de cópia.
- UpdateProduct
Atualiza um produto.
- DeleteProduct
Exclui um produto.
- AssociateProductWithPortfolio
Associa um produto a um portfólio.
- DisassociateProductFromPortfolio
Desassocia um produto de um portfólio.
Artefatos de provisionamento
Os administradores de catálogos usam essas operações para gerenciar artefatos de provisionamento (também conhecidos como versões do produto).
- DescribeProvisioningArtifact
Obtém informações sobre um artefato de provisionamento.
- CreateProvisioningArtifact
Cria um artefato de provisionamento para um produto.
- DeleteProvisioningArtifact
Exclui um artefato de provisionamento.
- ListProvisioningArtifacts
Lista todos os artefatos de provisionamento associados a um produto.
- UpdateProvisioningArtifact
Atualiza um artefato de provisionamento.
Restrições
O administrador do catálogo usa essas operações para gerenciar restrições.
- CreateConstraint
Cria uma restrição.
- DeleteConstraint
Exclui uma restrição.
- DescribeConstraint
Obtém informações sobre uma restrição.
- UpdateConstraint
Atualiza uma restrição.
- ListConstraintsForPortfolio
Obtém informações de restrição para o portfólio e o produto.
Ações de serviço
Os administradores de catálogos usam essas operações para gerenciar ações de serviço.
- AssociateServiceActionWithProvisioningArtifact
Associa uma ação de autoatendimento a um artefato de provisionamento.
- CreateServiceAction
Cria uma ação de autoatendimento.
- DeleteServiceAction
Exclui uma ação de autoatendimento.
- DescribeServiceAction
Descreve uma ação de autoatendimento.
- DescribeServiceActionExecutionParameters
Encontra os parâmetros padrão para uma ação de autoatendimento específica em um produto provisionado específico e retorna um mapa dos resultados para o usuário.
- ExecuteProvisionedProductServiceAction
Executa uma ação de autoatendimento em relação a um produto provisionado.
- UpdateServiceAction
Atualiza uma ação de autoatendimento.
TagOptions
Os administradores de catálogos usam essas operações para gerenciar TagOptions.
- CreateTagOption
Cria um TagOption.
- ListTagOptions
Lista o seu TagOptions.
- DescribeTagOption
Descreve um TagOption.
- UpdateTagOption
Atualiza um TagOption.
- AssociateTagOptionWithResource
Associa um a TagOption a um recurso.
- DisassociateTagOptionFromResource
Desassocia um TagOption de um recurso.
- ListResourcesForTagOption
Lista os recursos para um TagOption.
- DeleteTagOption
Exclui um TagOption.
AppRegistry
Serve como um repositório para seus aplicativos, seus recursos e os metadados do aplicativo que você usa em sua empresa.
- AssociateAttributeGroup
Associa um grupo de atributos a um aplicativo para aumentar os metadados do aplicativo com os atributos do grupo.
- AssociateResource
Associa um recurso a um aplicativo.
- CreateApplication
Cria um novo aplicativo que é o nó de nível superior em uma hierarquia de abstrações de recursos de nuvem relacionadas.
- CreateAttributeGroup
Cria um novo grupo de atributos como um contêiner para atributos definidos pelo usuário.
- DeleteApplication
Exclui um aplicativo especificado pelo ID ou nome do aplicativo.
- DeleteAttributeGroup
Exclui um grupo de atributos, especificado pelo ID ou nome do grupo de atributos.
- DisassociateAttributeGroup
Desassocia um grupo de atributos de um aplicativo para remover os atributos extras contidos no grupo de atributos dos metadados do aplicativo.
- DisassociateResource
Desassocia um recurso do aplicativo.
- GetApplication
Recupera informações de metadados sobre um de seus aplicativos.
- GetAssociatedResource
Obtém o recurso associado ao aplicativo.
- GetAttributeGroup
Recupera um grupo de atributos, seja pelo nome ou pelo ID.
- ListApplications
Lista todos os grupos de atributos associados ao aplicativo especificado.
- ListAssociatedAttributeGroups
Lista todos os grupos de atributos associados ao aplicativo especificado.
- ListAssociatedResources
Lista todos os recursos associados ao aplicativo especificado.
- ListAttributeGroups
Lista todos os grupos de atributos aos quais você tem acesso.
- ListAttributeGroupsForApplication
Lista os detalhes de todos os grupos de atributos associados a um aplicativo específico.
- ListTagsForResource
Lista todas as tags no recurso.
- TagResource
Atribui uma ou mais tags (pares de valores-chave) ao recurso especificado.
- SyncResource
Sincroniza o recurso com o que está gravado atualmente. AppRegistry
- UntagResource
Remove etiquetas de um recurso.
- UpdateApplication
Atualiza um aplicativo existente com novos atributos.
- UpdateAttributeGroup
Atualiza um grupo de atributos existente com novos detalhes.
Exemplo de fluxo de trabalho
Nesse cenário, o administrador cria recursos usando AWS Service Catalog e um usuário final encontra quais produtos estão disponíveis e provisiona o produto. Esse é um exemplo de fluxo de trabalho; essa não é a única maneira de usar a AWS Service Catalog API.
Tarefas do administrador
Crie portfólios, visualizações de produtos, produtos, versões de produtos e restrições.
Atribua usuários do IAM aos produtos, o que lhes dá acesso.
Tarefas do usuário final
-
O usuário liga SearchProductssem argumentos. Isso retorna a lista de produtos aos quais o usuário tem acesso, bem como um "SearchDomain" que pode ser usado para definir o escopo dos resultados.
-
O usuário continua ligando SearchProductscom filtros de pesquisa adicionais até que o produto desejado seja encontrado.
-
O usuário liga DescribeProductViewpara encontrar a lista de artefatos de provisionamento (também conhecidos como versões) desse produto. Isso determina o que o usuário realmente provisiona.
-
O usuário liga ListLaunchPathspara encontrar a lista de caminhos desse produto, junto com as restrições de cada caminho. Isso determina qual conjunto de restrições é aplicado ao produto provisionado.
-
Depois de escolher um artefato de provisionamento e um caminho, o usuário liga. DescribeProvisioningParameters Isso retorna a lista de parâmetros que o usuário deve fornecer antes de provisionar um produto usando o artefato e o caminho de provisionamento, junto com quaisquer instruções de uso adicionais que o administrador decida fornecer.
-
O usuário liga ProvisionProduct, especificando o produto, o artefato de provisionamento, o caminho e os parâmetros de entrada. Os parâmetros de entrada são uma lista de pares de valores-chave, em que as chaves são obtidas usando DescribeProvisioningParameterse os valores são fornecidos pelo usuário (por exemplo,).
{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}Isso inicia um fluxo de trabalho para criar os AWS recursos especificados. Ele também cria um detalhe de registro que rastreia a solicitação de aprovisionamento e um objeto de produto provisionado que representa os recursos subjacentes. AWS -
O usuário faz uma pesquisa DescribeRecordpara ver quando o status dos detalhes do registro muda do
IN_PROGRESSestado para um estado concluído (SUCCEEDEDouERROR). -
Quando os detalhes do registro da solicitação estão concluídos, o usuário liga mais DescribeRecorduma vez. As saídas identificam os recursos criados.
-
O usuário liga UpdateProvisionedProductpara atualizar os recursos subjacentes existentes. Dependendo das atualizações específicas solicitadas, essa operação pode ser atualizada sem interrupção, com alguma interrupção, ou substituir totalmente o produto provisionado.
-
Por fim, o usuário liga TerminateProvisionedProductpara encerrar o produto provisionado.
