A referência de 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 ofertas privadas usando o AWS Marketplace APIs

Você pode usar o AWS Marketplace Catalog API para automatizar tarefas para trabalhar com ofertas.

Enquanto o produto descreve o que está sendo vendido AWS Marketplace, a oferta descreve os termos e regras de como um produto é comprado e consumido. AWS Marketplace os produtos podem ter várias ofertas vendidas por vendedores diferentes. Cada AWS Marketplace oferta, no entanto, só pode ser criada para um produto. Uma oferta contém uma coleção de termos de contrato entre duas partes. Os termos da oferta aceitos são traduzidos em um contrato como prova de uma transação.

Há dois tipos de ofertas:

Consulte os recursos a seguir:

Os tópicos a seguir descrevem como usar a API Catalog para criar e atualizar ofertas:

Crie uma oferta

Você pode usar a API Catalog para criar uma nova oferta em AWS Marketplace. Se sua solicitação for processada com sucesso, AWS Marketplace Catalog API criará umaDraft, que é uma oferta incompleta que é invisível para os compradores. Para concluir uma oferta, use o tipo de Update alteração. Quando a oferta for concluída, use o tipo de ReleaseOffer alteração para criá-la e lançá-la. O lançamento de uma oferta a valida e a torna visível para os compradores. AWS Marketplace

Para criar uma nova oferta, chame a operação da StartChangeSet API com o tipo de CreateOffer 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": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer",
        "OfferSetId": "offerset-b3f9EXAMPLE27"
      }
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Se Status forSUCCEEDED, então um novo OfferId é gerado.

A resposta é semelhante à seguinte.

{
  "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": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer"
      },
      "ErrorDetailList": []
    }
  ]
}

Validações síncronas

As validações de esquema a seguir são específicas CreateOffer das ações no. AWS Marketplace Catalog API Essas 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 CreateOffer 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.

Crie uma oferta de substituição

Você pode usar a API Catalog para criar uma oferta de substituição (também conhecida como oferta baseada em contrato) em. AWS Marketplace

Se sua solicitação tiver sido processada com sucesso, uma oferta Draft estadual AWS Marketplace Catalog API será gerada para você, que é uma oferta incompleta e não visível para os compradores AWS Marketplace. Você usará os tipos de Update alteração para concluir a oferta. Depois que a oferta for concluída, você usará o tipo de ReleaseOffer alteração para concluir o processo de criação da oferta e liberar a oferta, o que validará toda a oferta e a tornará visível para os compradores. AWS Marketplace A partir daí, o comprador tem a opção de aceitar a oferta de substituição ou continuar operando de acordo com o contrato original.

Para criar uma oferta de substituição, chame a operação da StartChangeSet API com o tipo de CreateReplacementOffer alteração e forneça um ID de contrato preexistente, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateReplacementOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "AgreementId": "agmt-12345",
        "Name": "Offer name"
      }
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas CreateReplacementOffer das ações no. AWS Marketplace Catalog API Essas 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 CreateReplacementOffer 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 as informações da oferta

Você pode usar a API Catalog para atualizar as informações da oferta em AWS Marketplace.

Para atualizar as informações da oferta, chame a operação da StartChangeSet API com o tipo de UpdateInformation alteração, conforme mostrado no exemplo a seguir. Todas as outras informações permanecerão inalteradas.

Sintaxe da solicitação

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateInformation",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Name": "New offer name",
        "Description": "New offer description",
        "PreExistingAgreement": {
          "AcquisitionChannel": "External",
          "PricingModel": "Contract"
        }
      }
    }
  ]
}

Forneça informações para 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 o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdateInformation das ações no. AWS Marketplace Catalog API Essas 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 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, consulteTrabalhando com conjuntos de alterações.

Atualizar configuração de segmentação

Você pode usar a API Catalog para atualizar a configuração de segmentação da sua oferta em AWS Marketplace.

Todas as opções de segmentação existentes que não estão incluídas na solicitação mais recente e serão removidas da oferta.

Para atualizar a configuração de segmentação da sua oferta, chame a operação da StartChangeSet API com o tipo de UpdateTargeting 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": "UpdateTargeting",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "111122223333"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      }
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdateTargeting das ações no. AWS Marketplace Catalog API Essas 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 UpdateTargeting 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 política de reembolso

Você pode usar a API Catalog para atualizar a política de reembolso da sua oferta em AWS Marketplace.

Essa alteração não afeta os contratos existentes. Os termos de suporte que não estão incluídos na solicitação mais recente serão removidos da oferta.

Para atualizar a política de reembolso, chame a operação da StartChangeSet API com o tipo de UpdateSupportTerms 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": "UpdateSupportTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "SupportTerm",
            "RefundPolicy": "Updated refund policy description"
          }
        ]
      }
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdateSupportTerms das ações no. AWS Marketplace Catalog API Essas 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 UpdateSupportTerms 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 Catalog para substituir os documentos legais existentes, como um contrato de licença de usuário final (EULA). Os termos legais que não estão incluídos na solicitação mais recente serão removidos da oferta.

Para atualizar os recursos legais da sua oferta, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "LegalTerm",
            "Documents": [
              {
                "Type": "CustomEula",
                "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações para 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 o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdateLegalTerms das ações no. AWS Marketplace Catalog API Essas 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 UpdateLegalTerms 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 preços

Você pode usar a API Catalog para substituir completamente os termos de preços existentes. Os termos de preço que não estão incluídos na solicitação mais recente serão removidos da oferta.

Para atualizar os termos de preços da sua oferta, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PricingModel": "Usage",
        "Terms": [
          {
            "Type": "UsageBasedPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "0.10"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "0.20"
                  }
                ]
              }
            ]
          },
          {
            "Type": "ConfigurableUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "Selector": {
                  "Type": "Duration",
                  "Value": "P365D"
                },
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "300"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "400"
                  }
                ],
                "Constraints": {
                  "MultipleDimensionSelection": "Allowed",
                  "QuantityConfiguration": "Allowed"
                }
              }
            ]
          },
          {
            "Type": "ByolPricingTerm"
          },
          {
            "Type": "RecurringPaymentTerm",
            "CurrencyCode": "USD",
            "BillingPeriod": "Monthly",
            "Price": "100.0"
          },
          {
            "Type": "FixedUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "Price": "200.00",
            "Grants": [
              {
                "DimensionKey": "Users",
                "MaxQuantity": 10
              }
            ]
          },
          {
            "Type": "FreeTrialPricingTerm",
            "Duration": "P30D",
            "Grants": [
              {
                "DimensionKey": "m3.xlarge",
                "MaxQuantity": 10
              },
              {
                "DimensionKey": "m4.xlarge",
                "MaxQuantity": 10
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações para 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 o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdatePricingTerms das ações no. AWS Marketplace Catalog API Essas 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 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.

Atualize a visibilidade da oferta

Você pode usar a API Catalog para controlar a visibilidade de sua oferta em AWS Marketplace.

Você pode escolher definir uma data específica no futuro para restringir a visibilidade de sua oferta ou no passado para expirar sua oferta. O tipo de UpdateAvailability alteração não afeta os contratos existentes.

Para controlar a visibilidade de sua oferta, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "AvailabilityEndDate": "2024-05-31"
      }
    }
  ]
}

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

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

Sintaxe de resposta

{
  "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. Inclui informações de validação para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos. Você pode verificar o status da solicitação por meio da API do Portal de gerenciamento do AWS Marketplace catálogo ou na API do catálogo com a DescribeChangeSet ação.

Validações síncronas

As validações de esquema a seguir são específicas UpdateAvailability das ações no. AWS Marketplace Catalog API Essas 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 UpdateAvailability 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.

Defina a data de expiração dos contratos criados usando a oferta

Você pode usar a API Catalog para definir os detalhes da data de expiração dos contratos criados usando a oferta em AWS Marketplace.

Esse tipo de alteração não afeta os contratos existentes.

Para definir os detalhes da data de expiração dos contratos criados usando a oferta, chame a operação da StartChangeSet API com o tipo de UpdateValidityTerms 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": "UpdateValidityTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "ValidityTerm",
            "AgreementDuration": "P12M",
            "AgreementStartDate": "2021-08-01",
            "AgreementEndDate": "2022-08-01"
          }
        ]
      }
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdateValidityTerms das ações no. AWS Marketplace Catalog API Essas 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 UpdateValidityTerms 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 detalhes do cronograma de pagamento

Você pode usar a API Catalog para atualizar os detalhes do cronograma de pagamento da sua oferta, como o cronograma de pagamento flexível, em AWS Marketplace.

Para atualizar os detalhes do cronograma de pagamento da sua oferta, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "PaymentScheduleTerm",
            "Schedule": [
              {
                "ChargeDate": "2021-12-01",
                "ChargeAmount": "200.00"
              },
              {
                "ChargeDate": "2022-03-01",
                "ChargeAmount": "250.00"
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações para 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 o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdatePaymentScheduleTerms das ações no. AWS Marketplace Catalog API Essas 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 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, consulteTrabalhando com conjuntos de alterações.

Atualizar as condições de pagamento líquido

Você pode usar a API Catalog para definir as condições de pagamento líquido da sua oferta em AWS Marketplace. Um prazo de pagamento líquido é um prazo em que você especifica o número de dias após a emissão da fatura pelo qual o pagamento é devido.

Para definir o prazo de pagamento líquido da sua oferta, chame a operação da StartChangeSet API com o tipo de UpdateNetPaymentTerms 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": "UpdateNetPaymentTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "NetPaymentTerm",
            "PaymentDuePeriod": "P30D"
          }
        ]
      }
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdateNetPaymentTerms das ações no. AWS Marketplace Catalog API Essas 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 UpdateNetPaymentTerms 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.

Modificar as opções de renovação

Você pode usar a API Catalog para controlar as opções de renovação dos contratos criados usando essa oferta em AWS Marketplace.

Para ofertas criadas por meio da API Catalog, a renovação automática permanece desativada por padrão até que você chame o tipo de UpdateRenewalTerms alteração para permitir a renovação automática. Essa alteração não afeta os contratos existentes.

Para controlar as opções de renovação dos contratos criados usando essa oferta, chame a operação da StartChangeSet API com o tipo de UpdateRenewalTerms 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": "UpdateRenewalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "RenewalTerm"
          }
        ]
      }
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas UpdateRenewalTerms das ações no. AWS Marketplace Catalog API Essas 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 UpdateRenewalTerms 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.

Publique uma oferta

Você pode usar a API Catalog para mesclar as informações coletadas de todos os tipos de alteração de atualização e, em seguida, publicar a oferta.

As ofertas permanecem em um Draft estado até serem ReleaseOffer convocadas. Depois que a oferta for lançada, ela poderá ser descoberta em AWS Marketplace.

Para publicar sua oferta, chame a operação da StartChangeSet API com o tipo de ReleaseOffer 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": "ReleaseOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

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

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o 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 de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar alguns minutos.

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

Validações síncronas

As validações de esquema a seguir são específicas ReleaseOffer das ações no. AWS Marketplace Catalog API Essas 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 ReleaseOffer 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.

Descreva os detalhes da oferta existente

Você pode usar a API Catalog para descrever os detalhes da oferta existente em AWS Marketplace.

Para descrever os detalhes da oferta existente, chame a operação da DescribeEntity API com o tipo de Offer@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 para 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": "Offer@1.0",
  "EntityIdentifier": "offer-ad8EXAMPLE51@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/Offer/offer-ad8EXAMPLE51",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "DetailsDocument": {
    "Id": "offer-3rEXAMPLErn",
    "State": "Released",
    "Name": "Test Offer",
    "Description": "Worldwide offer for Test Product",
    "PreExistingAgreement": {
      "AcquisitionChannel": "External",
      "PricingModel": "Contract"
    },
    "ProductId": "prod-ad8EXAMPLE51",
    "OfferSetId": "offerset-b3f9EXAMPLE27",
    "Terms": [
      {
        "Type": "SupportTerm",
        "RefundPolicy": "If you need to request a refund for software sold by Amazon Web Services, LLC, please contact AWS Customer Service."
      },
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "FreeTrialPricingTerm",
        "Duration": "P30D",
        "Grants": [
          {
            "DimensionKey": "m3.xlarge",
            "MaxQuantity": 10
          },
          {
            "DimensionKey": "m4.xlarge",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P365D"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "FixedUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "Price": "200.00",
        "Grants": [
          {
            "DimensionKey": "Users",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "RecurringPaymentTerm",
        "CurrencyCode": "USD",
        "BillingPeriod": "Monthly",
        "Price": "100.0"
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00.000Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00.000Z",
            "ChargeAmount": "1250.00"
          }
        ]
      },
      {
        "Type": "ByolPricingTerm"
      },
      {
        "Type": "RenewalTerm"
      },
      {
        "Type": "NetPaymentTerm",
        "PaymentDuePeriod": "P30D"
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "444455556666"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2024-08-30T01:56:03.000Z"
      }
    ]
  }
}

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