View a markdown version of this page

Usar o AWS Marketplace API do contrato - AWS Marketplace
Principais conceitosEndpointPermissões

A referência da API do AWS Marketplace foi reestruturada. Para obter mais informações sobre as operações de API suportadas, consulte a Referência de API do AWS Marketplace.

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

Usar o AWS Marketplace API do contrato

AWS Marketplace é um catálogo digital com curadoria que os clientes podem usar para encontrar, comprar, implantar e gerenciar software, dados e serviços de terceiros para criar soluções e administrar seus negócios. O Serviço de AWS Marketplace Contrato fornece uma interface de API que ajuda AWS Marketplace compradores e vendedores a gerenciar seus contratos, incluindo listagem, pesquisa e filtragem de contratos.

Principais conceitos

A tabela a seguir descreve os principais conceitos usados na API do AWS Marketplace Contrato.

Conceito Description
Aceitador A parte que aceita todos ou um subconjunto dos termos estendidos pelo proponente em um contrato. Para os casos de uso mais comuns, os aceitantes são os compradores do produto.
Contrato Um documento que vincula duas partes, incluindo o proponente (geralmente, o parceiro de canal seller/ISV ou parceiro de canal) e o aceitante (geralmente, o comprador) e define os termos e condições aplicáveis entre eles.
Solicitação de cancelamento do contrato Uma solicitação iniciada pelo vendedor (proponente) para cancelar um contrato ativo. O comprador (aceitante) pode aceitar ou rejeitar a solicitação de cancelamento. Se aceito, o fluxo de trabalho de cancelamento do contrato é executado de forma assíncrona e o status do contrato muda para cancelado. Se rejeitado, o contrato permanece ativo e o vendedor pode enviar uma nova solicitação de cancelamento.
Proposta de acordo Entidade referente ao conjunto de terms/offer propostas pelo seller/proposer.
Solicitação de contrato Entidade referente ao recurso criado como resultado da ação do cliente, descrevendo creation/modification os parâmetros do contrato, o ciclo de vida da solicitação e o resultado estimado após a aceitação da solicitação.
Dimensão faturável Elementos relacionados ao preço do produto. Por exemplo, instâncias do Amazon Elastic Compute Cloud (Amazon EC2) para produtos Amazon Machine Image (AMI) ou premium em comparação com usuários somente de leitura para produtos de software como serviço (SaaS).
Parceiros de canal (CP) Organizações autorizadas pelo proprietário do produto (ISV) a revender seus produtos em seu nome em. AWS Marketplace
Fornecedores independentes de software (ISVs) Vendedores que listam e gerenciam seus próprios produtos em AWS Marketplace.
Intenção A intenção representa a motivação do comprador ao criar o Contrato. As intenções atualmente aceitas são Nova, Alterar e Substituir durante o fluxo de criação do contrato.
Solicitação de pagamento Uma solicitação iniciada pelo vendedor (proponente) para pagamento associada a um contrato. O comprador (aceitante) pode aceitar ou rejeitar a solicitação de pagamento.
Proponente A parte que estende o conjunto inicial de termos em um contrato, geralmente usando uma oferta.
Ordens de compra As organizações exigem que os compradores usem pedidos de compra para comprar de fornecedores aprovados, monitorar o que compram e garantir que os gastos sejam previstos, orçados, aprovados e atribuídos ao (s) centro (s) de custo responsável (s).
Recurso Uma unidade ou recurso que os vendedores pretendem vender AWS Marketplace, geralmente chamada de produto básico. Um produto básico não está completo para consumo do comprador até que as informações do produto, os atributos de implantação e as informações de cobrança sejam adicionadas. Um produto descreve as informações do produto, os atributos de implantação do software e o mecanismo de cobrança do anúncio que o vendedor pretende vender. O produto deve ser combinado com uma oferta para se tornar uma unidade transacionável que pode ser vendida e usada pelos compradores em. AWS Marketplace
Prazo Uma unidade dentro de um contrato que rege a forma como um contrato é aplicado (por exemplo, preços).

Endpoint

Você pode acessar o Serviço de AWS Marketplace Contrato com os seguintes endpoints:

Endpoint Região Protocolos IP suportados
agreement-marketplace.us-east-1.api.aws Leste dos EUA (Norte da Virgínia) IPv4, IPv6

Permissões

A API de Acordos usa a AWS autenticação padrão Signature Version 4 (SigV4). Você deve ter AWS credenciais válidas e as permissões apropriadas do IAM para chamar a API. Para obter detalhes, consulte Controle de acesso para o AWS Marketplace API do contrato.

Códigos de erro

Os códigos de erro a seguir se aplicam às ações AWS Marketplace do Serviço de Contrato. Um único código de erro pode ser retornado para vários casos de uso. Consulte as descrições abaixo para identificar o cenário específico em que cada código de erro ocorre. Essa lista não é exaustiva e pode ser atualizada à medida que novos recursos são lançados.

ValidationException

Código de erro Description
INVALID_SOURCE_AGREEMENT_IDENTIFIER Retornado quando o identificador do contrato de origem não corresponde ao formato esperado ou quando um identificador do contrato de origem é fornecido para uma intenção que não exige um (como NOVO).
MISSING_SOURCE_AGREEMENT_IDENTIFIER Retornado quando o identificador do contrato de origem não é fornecido para uma intenção que exija um (como REPLACE ou AMEND).
INVALID_REQUESTED_TERM_CONFIGURATION

Retornado quando a configuração do termo solicitado não é válida. Cenários possíveis:

  • É fornecida uma configuração para um termo que não aceita uma.

  • Falta uma configuração necessária.

  • O valor do seletor não pertence à proposta de contrato.

  • As dimensões só podem conter uma dimensão quando a seleção de várias dimensões não é permitida.

  • Uma chave de dimensão não é reconhecida na proposta de contrato ou nos termos aceitos.

  • Um valor de dimensão só pode ser 1 quando a configuração de quantidade não está habilitada para a dimensão.

  • A configuração contém chaves de dimensão duplicadas.

  • A configuração não difere do contrato de origem.
INVALID_AGREEMENT_PROPOSAL_IDENTIFIER Retornado quando o identificador da proposta de contrato não corresponde ao formato esperado ou quando um identificador de proposta de contrato é fornecido para uma intenção que não exige uma (como EMEND).
MISSING_AGREEMENT_PROPOSAL_IDENTIFIER Retornado quando o identificador da proposta de contrato não é fornecido para uma intenção que exija uma (como NEW ou REPLACE).
INVALID_FILTER_NAME Retornado quando o nome do filtro fornecido não é um filtro reconhecido ou quando nomes de filtro duplicados são incluídos na solicitação.
INVALID_FILTER_VALUES Retornado quando os valores do filtro são inválidos, duplicados, vazios, excedem a contagem máxima permitida ou quando um filtro de intervalo de datas especifica um BeforeEndTime valor que precede o valor. AfterEndTime
INVALID_NEXT_TOKEN Retornado quando o token de paginação está malformado, expira, não pode ser descriptografado ou quando os parâmetros da solicitação são alterados entre as chamadas paginadas.
DUPLICATE_CHARGES Retornada quando a solicitação contém identificadores de cobrança duplicados ou quando valores diferentes da ordem de compra são fornecidos para o mesmo identificador de cobrança.
UNSUPPORTED_FILTERS Retornado quando a combinação de filtros fornecida não é suportada. As combinações de filtros suportadas variam de acordo com o tipo de grupo. Verifique as combinações suportadas na documentação pública.
INVALID_PURCHASE_ORDER_REFERENCE Devolvida quando a referência do pedido de compra não atende aos requisitos de formato ou quando um pedido de compra obrigatório não é fornecido conforme configurado pelo administrador da conta.
INVALID_CHARGE_AMOUNT

Devolvido quando o valor da cobrança não é válido. Cenários possíveis:

  • O valor da cobrança excede o valor máximo total da cobrança para o período.

  • O formato do valor da cobrança não corresponde aos requisitos monetários (por exemplo, muitas casas decimais).

  • Nenhum valor restante está disponível porque o contrato atingiu o valor máximo total da cobrança.
UNSUPPORTED_ACTION

Retornado quando a operação solicitada não é compatível com o estado atual do recurso. Os cenários específicos variam de acordo com a API:

  • UpdatePurchaseOrders— A data da cobrança está no passado e a renovação automática está desativada, a data da cobrança está dentro de 3 horas, a cobrança é uma cobrança de reembolso, a revisão da cobrança não é a mais recente, os pedidos de compra não pertencem todos ao mesmo contrato ou o contrato não está ativo.

  • CreateAgreementRequest— A alteração de um contrato com data futura não é suportada, a combinação de tipo de recurso e tipo de termo não suporta a intenção solicitada, a substituição de um contrato ativo por um contrato com data futura não é permitida, a duração do contrato não pode ser alterada durante a emenda, o contrato não pode ser atualizado no momento (por exemplo, existem direitos pendentes), a proposta de contrato deve se referir ao mesmo recurso do contrato de origem, a proposta de contrato deve ser diferente do contrato de origem, ou o tipo de contrato não suporta essa ação.

  • AcceptAgreementRequest— A combinação de tipo de recurso e tipo de termo não oferece suporte a essa ação, o tipo de contrato não oferece suporte a essa ação, já existe um contrato ativo no mesmo recurso ou o contrato não pode ser atualizado no momento.

  • CancelAgreement— O contrato tem direitos pendentes, o tipo de contrato não suporta cancelamento, um contrato com não UsageBasedPricingTerm pode ser cancelado enquanto um contrato com ConfigurableUpfrontPricingTerm ou ainda PaymentScheduleTerm estiver ativo no mesmo recurso, ou a combinação de tipo de recurso e tipo de termo não oferece suporte ao cancelamento.

  • GetBillingAdjustmentRequest— O contrato é do tipo contrato de não compra ou o chamador é o aceitante do contrato.

  • SendAgreementCancellationRequest— O tipo de contrato não suporta essa ação.

  • AcceptAgreementCancellationRequest— O tipo de contrato não suporta essa ação.

  • RejectAgreementCancellationRequest— O tipo de contrato não suporta essa ação.

  • CancelAgreementCancellationRequest— O tipo de contrato não suporta essa ação.

  • GetAgreementCancellationRequest— O contrato é do tipo contrato de não compra.

ResourceNotFoundException

As ResourceNotFoundException resourceType inclusões e resourceId os campos que identificam o recurso que não foi encontrado. A tabela a seguir descreve os cenários que podem causar essa exceção para cada tipo de recurso.

nota

Por motivos de segurança, o mesmo erro é retornado se um recurso não existir ou se o chamador não tiver acesso a ele. Isso evita a enumeração de identificadores de recursos válidos.

Tipo de atributo Cenários possíveis
AgreementProposal

  • Nenhuma proposta de acordo encontrada para o identificador fornecido.

  • A oferta não é direcionada ao aceitante.

  • A oferta não está disponível no país do aceitante.
Agreement

  • Nenhum acordo encontrado para o identificador fornecido.

  • O chamador não é o aceitante nem o proponente do contrato.
AgreementRequest

  • Nenhuma solicitação de acordo encontrada para o identificador fornecido.

  • A solicitação de contrato pertence a outro chamador.

  • A solicitação de contrato expirou.

  • A solicitação de contrato foi substituída por uma solicitação aceita posteriormente sobre o mesmo produto ou oferta.

  • A proposta de contrato ficou inativa entre CreateAgreementRequest e AcceptAgreementRequest chamadas devido à republicação da oferta ou à expiração da oferta.
Charge

  • Nenhuma cobrança foi encontrada para o identificador fornecido.

  • A cobrança não pertence ao contrato especificado.
BillingAdjustmentRequest

  • Nenhuma solicitação de ajuste de faturamento foi encontrada para o identificador fornecido.

  • O chamador não é o aceitante nem o proponente do acordo associado ao ajuste.
AgreementCancellationRequest

  • Nenhuma solicitação de cancelamento de contrato foi encontrada para o identificador fornecido.

  • O chamador não é o aceitante nem o proponente do contrato associado à solicitação de cancelamento.
PaymentRequest

  • Nenhuma solicitação de pagamento encontrada para o identificador fornecido.

  • O chamador não é o aceitante nem o proponente do contrato associado à solicitação de pagamento.