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

Trabalhe com autorizações de revenda usando o AWS Marketplace APIs

Você pode usar o AWS Marketplace Catalog API para automatizar tarefas para trabalhar com autorizações de revenda.

Embora o produto descreva o que está sendo vendido AWS Marketplace, a Autorização de Revenda (também conhecida como oportunidade) descreve os termos e regras sobre como esse produto está autorizado a ser revendido. AWS Marketplace O CPPO é o alvo da Autorização de Revenda.

Uma autorização de revenda tem um conjunto de termos e regras a serem aceitos para um contrato de revenda entre fabricantes e parceiros de canal. Aceitar os termos da Autorização de Revenda permite que o revendedor crie ofertas para o produto de acordo com as condições expressas nos termos.

Há dois tipos de regras em uma autorização de revenda:

Consulte os recursos a seguir:

Os tópicos a seguir descrevem como usar a API de catálogo para criar e atualizar autorizações de revenda:

Pré-requisitos de autorização de revenda

Para usar a Autorização de Revenda, tanto os fornecedores independentes de software (ISVs) quanto os parceiros de AWS Marketplace canal devem criar uma função vinculada ao serviço que forneça permissões de compartilhamento de recursos para. AWS Se os dois grupos não cumprirem esse pré-requisito, não AWS poderão compartilhar o recurso de autorização do ISV com o parceiro de canal. AWS Marketplace Para obter mais informações, consulte Uso de funções para autorização de revenda AWS Marketplace no Guia do AWS Marketplace vendedor.

Criar uma nova autorização de revenda

Você pode usar a API do Catálogo para criar uma nova Autorização de Revenda em AWS Marketplace.

Se sua solicitação for processada com sucesso, AWS Marketplace Catalog API gerará uma Autorização de Revenda no Draft estado para você. É uma autorização de revenda incompleta e não está visível para os parceiros de canal em AWS Marketplace.

Use os tipos de Update alteração para concluir a Autorização de Revenda. Depois que a Autorização de Revenda for concluída, use o tipo de ReleaseResaleAuthorization alteração para concluir o processo de criação da Autorização de Revenda e liberar a Autorização de Revenda, que validará toda a Autorização de Revenda e a tornará visível para os parceiros de canal em. AWS Marketplace

Para criar uma autorização de revenda no Draft estado, chame a operação da StartChangeSet API com o tipo de CreateResaleAuthorization alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1 
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateResaleAuthorization",
      "ChangeName": "xyz",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0"
      },
      "DetailsDocument":
      {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test ResaleAuthorization",
        "Description": "Worldwide ResaleAuthorization for Test Product",
        "ResellerAccountId": "777788889999"
      }
    }
  ]
}

Forneça informações sobre os campos de entrada para adicionar o tipo de CreateResaleAuthorization alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Quando a solicitação for concluída (se Status forSUCCEEDED), uma nova ResaleAuthorization será gerada. Embora o SUCCEEDED status indique que a chamada do tipo de CreateResaleAuthorization alteração foi concluída, o ResaleAuthorization status ainda está no Draft estado.

Veja a seguir a resposta da operação DescribeChangeSetda API.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2021-05-27T22:21:26Z",
  "EndTime": "2021-05-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateResaleAuthorization",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument":
      {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test ResaleAuthorization",
        "Description": "Worldwide ResaleAuthorization for Test Product",
        "ResellerAccountId": "777788889999",
        "BulkRequestId": "84977023-5093-4a66-8b24-ef2c5a2f8b1f"
      },
      "ErrorDetailList":
      []
    }
  ]
}

Validações síncronas

As validações do esquema são específicas para CreateResaleAuthorization ações no. AWS Marketplace Catalog API As validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos CreateResaleAuthorization das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar a segmentação de compradores

Você pode usar a API do Catálogo para atualizar os compradores que direcionam sua Autorização de Revenda em. AWS Marketplace

Todas as opções de segmentação existentes que não estejam incluídas na solicitação mais recente são removidas da Autorização de Revenda. Esse tipo de alteração é opcional para a liberação da Autorização de Revenda.

Para atualizar os compradores que visam sua autorização de revenda, chame a operação da StartChangeSet API com o tipo de UpdateBuyerTargetingTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
   "Catalog": "AWSMarketplace",
   "ChangeSet": [        
      {
         "ChangeType":"UpdateBuyerTargetingTerms",
         "Entity":{
            "Type": "ResaleAuthorization@1.0", 
            "Identifier": "resaleauthz-123456789"
         },
         "DetailsDocument":
         {
           "Terms":
           [
             {
               "Type": "BuyerTargetingTerm",
               "PositiveTargeting":
               {
                 "BuyerAccounts":
                 [
                  "123456789012"
                 ]
               }
             }
           ]
         }
      }
   ]
}

Forneça informações sobre os campos para adicionar o tipo de UpdateBuyerTargetingTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações com a equipe de operações do AWS Marketplace vendedor para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As validações do esquema são específicas para UpdateBuyerTargetingTerms ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateBuyerTargetingTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Disponibilidade da atualização

Você pode usar a API do Catálogo para limitar a disponibilidade de quantas ofertas privadas são criadas ou até o momento específico em que uma oferta privada pode ser criada.

Por padrão, o valor é o uso ilimitado dessa Autorização de Revenda, embora você possa verificar a disponibilidade na lista de regras.

Para controlar a disponibilidade e a usabilidade da sua Autorização de Revenda, chame a operação da StartChangeSet API com o tipo de UpdateAvailability alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateAvailability",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument":
      {
        "AvailabilityEndDate": "2022-05-31",
        "OffersMaxQuantity": 1
      }
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de UpdateAvailability alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações com a equipe de operações do AWS Marketplace vendedor para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As validações do esquema são específicas para UpdateAvailability ações no. AWS Marketplace Catalog API As validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP

Erros assíncronos

Os erros a seguir são específicos de UpdateAvailability ações na API do AWS Marketplace Catalog. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar a validade de um contrato com data futura

Você pode usar a API de catálogo para modificar e controlar uma data futura de início do serviço em AWS Marketplace.

Esse conjunto de alterações não é obrigatório para liberar uma autorização de revenda.

Para modificar e controlar a duração do contrato de produto de sua Autorização de Revenda, chame a operação da StartChangeSet API com o tipo de UpdateBuyerValidityTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateBuyerValidityTerms",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument":
      {
        "Terms":
        [
          {
            "Type": "BuyerValidityTerm",
            "MaximumAgreementStartDate": "2024-05-31"
          }
        ]
      }
    }
  ]
}

Forneça informações sobre os campos de entrada para adicionar o tipo de UpdateBuyerValidityTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações com a equipe de operações do AWS Marketplace vendedor para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As validações do esquema são específicas para UpdateBuyerValidityTerms ações no. AWS Marketplace Catalog API As validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateBuyerValidityTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar recursos legais

Você pode usar a API de catálogo para substituir completamente os termos legais existentes em AWS Marketplace.

Os termos legais que não estão incluídos na solicitação mais recente serão removidos da Autorização de Revenda. BuyerLegalTermcontém o EULA que será incluído no contrato final do comprador e LegalTerm inclui o Contrato de Revendedor, que será incluído no contrato de revenda entre o parceiro de canal e o ISV.

Para atualizar seus termos legaisResaleAuthorization, chame a operação da StartChangeSet API com o tipo de UpdateLegalTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1 
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateLegalTerms",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument":
      {
        "Terms":
        [
          {
            "Type": "BuyerLegalTerm",
            "Documents":
            [
              {
                "Type": "CustomEula",
                "Url": "https://my-public-bucket.s3.amazonaws.com/eula-example12345.txt"
              }
            ]
          },
          {
            "Type": "ResaleLegalTerm",
            "Documents":
            [
              {
                "Type": "CustomResellerContract",
                "Url": "https://my-public-bucket.s3.amazonaws.com/reseller-example12345.txt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de UpdateLegalTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As validações do esquema são específicas para UpdateLegalTerms ações no. AWS Marketplace Catalog API As validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateLegalTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você ligaDescribeChangeSet, após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar preços

Você pode usar a API de catálogo para substituir completamente os termos de preços existentes AWS Marketplace.

Os termos de preços que não estão incluídos na solicitação mais recente serão removidos da Autorização de Revenda. Você pode atualizar os preços com desconto do seu produto por meio dessa API.

Para atualizar os detalhes de preços de suas autorizações de revenda, chame a operação da StartChangeSet API com o tipo de UpdatePricingTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdatePricingTerms",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument":
      {
        "PricingModel": "Contract",
        "Terms":
        [
          {
            "Type": "ResaleUsageBasedPricingTerm",
            "CurrencyCode": "USD",
            "RateCards":
            [
              {
                "RateCard":
                [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "0.10"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "0.20"
                  }
                ]
              }
            ]
          },
          {
            "Type": "ResaleConfigurableUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "RateCards":
            [
              {
                "Selector":
                {
                  "Type": "Duration",
                  "Value": "P12M"
                },
                "RateCard":
                [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "300"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "400"
                  }
                ],
                "Constraints":
                {
                  "MultipleDimensionSelection": "Allowed",
                  "QuantityConfiguration": "Allowed"
                }
              }
            ]
          },
          {
            "Type": "ResaleFixedUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "Duration": "P2M",
            "Price": "200.0",
            "Grants":
            [
              {
                "DimensionKey": "Users",
                "MaxQuantity": 10
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de UpdatePricingTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As seguintes validações de esquema são específicas para UpdatePricingTerms ações na API do AWS Marketplace Catalog. As validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdatePricingTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar o cronograma de pagamento

Você pode usar a API do Catálogo para alterar os detalhes associados ao pagamento, como um cronograma de pagamento flexível, em. AWS Marketplace

Para atualizar os detalhes associados ao pagamento da sua Autorização de Revenda, chame a operação da StartChangeSet API com o tipo de UpdatePaymentScheduleTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1 
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdatePaymentScheduleTerms",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument":
      {
        "Terms":
        [
          {
            "Type": "ResalePaymentScheduleTerm",
            "CurrencyCode": "USD",
            "Schedule":
            [
              {
                "ChargeDate": "2021-12-01",
                "ChargeAmount": "200.00"
              },
              {
                "ChargeDate": "2022-03-01",
                "ChargeAmount": "250.00"
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de UpdatePaymentScheduleTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As validações do esquema são específicas para UpdatePaymentScheduleTerms ações no. AWS Marketplace Catalog API As validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdatePaymentScheduleTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulte. Trabalhando com conjuntos de alterações

Atualizar detalhes da autorização de revenda

Você pode usar a API do Catálogo para atualizar os detalhes da Autorização de Revenda em AWS Marketplace.

Para atualizar os detalhes da autorização de revenda, chame a operação da StartChangeSet API com o tipo de UpdateInformation alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument":
      {
        "Name": "TestResaleAuthorization",
        "Description": "Worldwide ResaleAuthorization for Test Product",
        "PreExistingBuyerAgreement":
        {
          "AcquisitionChannel": "AwsMarketplace",
          "PricingModel": "Contract"
        }
      }
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de UpdateInformation alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As seguintes validações de esquema são específicas para UpdateInformation ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet, e a solicitação falhará com um erro HTTP se a entrada não atender aos seguintes requisitos.

Erros assíncronos

Os erros a seguir são específicos UpdateInformation das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulte. Trabalhando com conjuntos de alterações

Restringir uma autorização de revenda

Você pode usar a API de catálogo para definir regras de restrição para uma autorização de revenda em AWS Marketplace.

Uma autorização de revenda restrita não pode mais ser usada por um parceiro de canal para criar uma oferta privada. Uma oferta privada existente não será afetada.

Para restringir sua autorização de revenda, chame a operação da StartChangeSet API com o tipo de RestrictResaleAuthorization alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "RestrictResaleAuthorization",
      "Entity": {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de RestrictResaleAuthorization alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As validações do esquema são específicas para RestrictResaleAuthorization ações na API do AWS Marketplace Catalog. Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos RestrictResaleAuthorization das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulte. Trabalhando com conjuntos de alterações

Libere uma autorização de revenda e torne-a visível para um parceiro de canal

Você pode usar a API de catálogo para iniciar seu caminho ResaleAuthorization para um Active estado.

ReleaseResaleAuthorizationativa sua Autorização de Revenda para que um Parceiro de Canal possa usar sua Autorização de Revenda para criar ofertas privadas.

Para liberar sua autorização de revenda, chame a operação da StartChangeSet API com o tipo de ReleaseResaleAuthorization alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseResaleAuthorization",
      "Entity":
      {
        "Type": "ResaleAuthorization@1.0",
        "Identifier": "resaleauthz-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de ReleaseResaleAuthorization alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

As validações do esquema são específicas para ReleaseResaleAuthorization ações no. AWS Marketplace Catalog API As validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos ReleaseResaleAuthorization das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais detalhes sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Descrever uma autorização de revenda existente

Para descrever os detalhes da autorização de revenda, chame a operação da DescribeEntity API com o tipo de ResaleAuthorization@1.0 entidade, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1

Forneça informações sobre os campos para adicionar o tipo de DescribeEntity alteração:

Sintaxe de resposta

A resposta a essa solicitação fornece os detalhes da oferta e tem a seguinte aparência.

{
  "EntityType": "ResaleAuthorization@1.0",
  "EntityIdentifier": "resaleauthz-123456789",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/ResaleAuthorization/resaleauthz-123456789",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "DetailsDocument": {
    "Name": "TestResaleAuthorization",
    "Description": "ResaleAuthorization for Test Product",
    "ProductId": "prod-ad8EXAMPLE51",
    "ProductName": "TestProduct",
    "Status": "Active", /*Draft, Active, Restricted*/
    "PreExistingBuyerAgreement": {
      "AcquisitionChannel": "Unknown",
      "PricingModel": "Unknown"
    },
    "CreatedDate": "2023-07-18T16:39:31.335Z",
    "ManufacturerLegalName": "ChannelCAPI.Inc",
    "ManufacturerAccountId": "123456789012",
    "Dimensions": [
      {
        "Name": "Protected Resources",
        "Description": "Additional 100 protected resources",
        "Key": "hundredresources",
        "Unit": "Units",
        "Types": [
          "Entitled"
        ]
      }
    ],
    "OfferDetails": {
      "OfferExtendedStatus": "Not Started", /* Not Started, Completed-Used, Completed-Usable*/
      "OfferCreatedCount": 0
    },
    "Terms": [
      {
        "Type": "ResaleUsageBasedPricingTerm",
        "Id": "term_id_placeholder",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "resource_number",
                "Price": "0.05"
              },
              {
                "DimensionKey": "scanned_data",
                "Price": "0.05"
              }
            ]
          }
        ]
      },
      {
        "Type": "ResaleConfigurableUpfrontPricingTerm",
        "Id": "term_id_placeholder",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P24M"
            },
            "RateCard": [
              {
                "DimensionKey": "hundredresources",
                "Price": "0.04"
              },
              {
                "DimensionKey": "tenTBData",
                "Price": "0.03"
              },
              {
                "DimensionKey": "channel_custom",
                "Price": "0.02"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "ResaleFixedUpfrontPricingTerm",
        "Id": "term-sdh27fb2",
        "CurrencyCode": "USD",
        "Duration": "P180D",
        "Price": "0.0",
        "Grants": [
          {
            "DimensionKey": "sdf73rbns93nl120d10xm1",
            "MaxQuantity": 1
          }
        ]
      },
      {
        "Type": "ResalePaymentScheduleTerm",
        "Id": "term-sdh27fb2",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2018-07-01T00:00:00.000Z",
            "ChargeAmount": "200.00"
          },
          {
            "ChargeDate": "2019-05-01T00:00:00.000Z",
            "ChargeAmount": "200.00"
          }
        ]
      },
      {
        "Type": "BuyerLegalTerm",
        "Id": "term_id_placeholder",
        "Documents": [
          {
            "Type": "StandardEula",
            "Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/a85cace8-6d9d-40ca-a053-78fc265479bf?isSigned=yes"
          }
        ]
      },
      {
        "Type": "ResaleLegalTerm",
        "Id": "term_id_placeholder",
        "Documents": [
          {
            "Type": "StandardResellerContract",
            "Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/bed55b56-7ab4-4c4c-b633-3bf4f6efcb98?isSigned=yes"
          }
        ]
      },
      {
        "Type": "BuyerValidityTerm",
        "Id": "term_id_placeholder",
        "MaximumAgreementStartDate": "2023-09-25T23:59:59.000Z"
      },
      {
        "Type": "BuyerTargetingTerm",
        "Id": "term_id_placeholder",
        "PositiveTargeting": {
          "BuyerAccounts": [
            {
              "AwsAccountId": "444455556666"
            }
          ]
        }
      }
    ],
    "Rules": [
      {
        "Type": "AvailabilityRule",
        "Id": "availability_rule_id_placeholder",
        /* If the AvailabilityEndDate and OffersMaxQuantity not present Usage will be Unlimited*/
        "Usage": "Limited",
        "AvailabilityEndDate": "2022-05-31T23:59:59Z",
        "OffersMaxQuantity": 1
      },
      {
        "Type": "PartnerTargetingRule",
        "Id": "partner_targeting_rule_id_placeholder",
        "ResellerAccountId": "777777777777",
        "ResellerLegalName": "ChannelCAPICP.Inc"
      }
    ]
  }
}

A seguir estão as informações sobre os campos que você vê na DescribeEntity resposta.