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 produtos do vendedor

Você pode usar o AWS Marketplace Catalog API para automatizar tarefas de trabalho com produtos do vendedor. Isso inclui a capacidade de criar, atualizar, visualizar, listar e classificar produtos. Isso permite que você automatize o gerenciamento de produtos. Por exemplo, você pode fornecer recursos de publicação por autoatendimento noPortal de gerenciamento do AWS Marketplace.

Um produto é uma unidade ou recurso que você pretende venderAWS Marketplace, geralmente chamado de produto básico. Os compradores não podem consumir um produto básico até que você adicione informações do produto, atributos de implantação e informações de cobrança.

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 você pretende vender. O produto deve ser combinado com uma oferta para se tornar uma unidade transacionável que você possa vender e na qual os compradores possam usar. AWS Marketplace

Você também pode usar o AWS Marketplace Catalog API para:

Cada tipo de produto tem uma entidade de produto diferente. Uma entidade pode ser um produto ou uma oferta deAWS Marketplace. Os seguintes tipos de produtos e entidades são compatíveis:

Os tópicos a seguir pressupõem que você tenha acesso à API e tenha cumprido todos os pré-requisitos do vendedor, conforme descrito em. Controle de acesso para oAWS MarketplaceAPI do Catalog

Consulte os recursos a seguir:

Os tópicos a seguir descrevem como usar a API de catálogo para realizar ações em seus produtos de AMI única, produtos baseados em contêineres ou produtos SaaS.

Crie um produto

Você pode usar a API de catálogo para criar um documento de produto AMI, contêiner, aprendizado de máquina ou SaaS com identificadores (código do produto e ID do produto). AWS Marketplace

Você cria um produto no Draft estado chamando a operação de StartChangeSet API com o tipo de CreateProduct alteração.

Se sua solicitação for processada com sucesso, AWS Marketplace Catalog API gerará um produto em Draft estado para você. Esse é um produto incompleto e não está visível para os compradores emAWS Marketplace.

Em seguida, você usa os tipos de Update alteração para concluir o processo de criação do produto: UpdateInformationUpdateDimensionsUpdateTargeting,, UpdateVisibilitye.

Depois que o produto for concluído, você poderá usar o tipo de ReleaseProductalteração para concluir o processo de criação do produto e, em seguida, liberar a oferta. Esse processo valida todo o produto e move o produto para o Limited estado.

Para criar um produto no Draft estado, chame a operação da StartChangeSet API com o tipo de CreateProduct 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":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

Forneça informações sobre os campos para adicionar o tipo de CreateProduct alteração. Esse tipo de alteração pode receber um ProductTitle atributo, sujeito às mesmas restrições enviadas ao 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.

Você pode verificar o status da solicitação por meio daPortal 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 ProductId será gerada.

Validações síncronas

As seguintes validações de esquema são específicas para CreateProduct 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 CreateProduct das ações noAWS 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.

Atualizar detalhes do produto

Se você já tem um produto emAWS Marketplace, pode usar a API de catálogo para atualizar os detalhes do produto de um produto AMI, contêiner, ML ou SaaS.

Para atualizar os detalhes do produto, chame a operação da StartChangeSet API com o tipo de UpdateInformation alteração e os detalhes que você deseja alterar, 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":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

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.

Para verificar o status da solicitação, use Portal de gerenciamento do AWS Marketplace ou chame a 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. 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 UpdateInformation das ações noAWS 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.

Adicionar dimensões de preço

Você pode usar o AWS Marketplace Catalog Service Actions para adicionar dimensões de preços faturáveis que permitem cobrar dos usuários por produtos de AMI, contêiner ou SaaS.

Uma dimensão de preço é uma unidade de medida que os vendedores definem para cobrar dos compradores. Os vendedores devem configurar essas informações para cobrar dos compradores pelo uso do produto, seja um modelo de preços baseado no uso ou no contrato. O tipo de dimensão depende do modelo de preços do produto.

Para obter mais informações sobre preços de produtos, consulte os seguintes tópicos no Guia do AWS Marketplace vendedor:

Para obter mais informações sobre como adicionar dimensões de preços usando oPortal de gerenciamento do AWS Marketplace, consulte os seguintes tópicos no Guia do AWS Marketplace vendedor:

Para adicionar dimensões de preços, chame a StartChangeSet API com o tipo de AddDimensions 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": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Forneça os seguintes campos para o tipo de AddDimensions 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 daPortal 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 AddDimensions 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 AddDimensions das ações noAWS 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 dimensões de preços

Você pode usar a API de catálogo para atualizar as dimensões de preços existentes de uma AMI, contêiner ou produto SaaS no. AWS Marketplace

Cada dimensão é identificada exclusivamente pela chave de dimensão e pelos tipos de dimensão para realizar a atualização. A atualização de uma dimensão não afeta nenhuma oferta ativa ou clientes que a dimensão original tenha criado.

Para atualizar as dimensões de preços, chame a operação da StartChangeSet API com o tipo de UpdateDimensions 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": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Use os seguintes campos com o tipo de UpdateDimensions 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 incluiu 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 daPortal 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 UpdateDimensions 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 UpdateDimensions das ações noAWS 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.

Restringir dimensões de preços

Você pode usar a API de catálogo para restringir as dimensões de preços existentes de um produto AMI ou SaaS em. AWS Marketplace

Cada dimensão é identificada exclusivamente pela chave de dimensão e pelos tipos de dimensão para realizar a atualização. Restringir uma dimensão não afeta nenhuma oferta ativa ou clientes que a dimensão original tenha criado.

Para restringir as dimensões de preços, chame a StartChangeSet API com o tipo de RestrictDimensions alteração.

O exemplo a seguir mostra como restringir a Entitled dimensão de um produto SaaS.

Sintaxe da solicitação

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Use os seguintes campos com o tipo de RestrictDimensions 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 incluiu 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 doPortal de gerenciamento do AWS Marketplace, ou chamando a DescribeChangeSet API.

Validações síncronas

As seguintes validações de esquema são específicas para RestrictDimensions 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 RestrictDimensions das ações noAWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet enquanto um conjunto de alterações está sendo processado. 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 de catálogo para adicionar Conta da AWS IDs que tenham permissão para visualizar o produto AMI, contêiner, ML ou SaaS AWS Marketplace antes de ser movido para um Public estado chamando o tipo de UpdateTargeting alteração.

As contas de operações gerenciadas de catálogo (MCO) são adicionadas automaticamente à lista de contas permitidas quando novos produtos são criados. Essas contas MCO são visíveis para os vendedores no Portal AWS Marketplace de Gerenciamento (AMMP) ao visualizar as contas permitidas e na Targeting seção da resposta da DescribeEntity API.

Para adicionar Conta da AWS IDs que tenham permissão para visualizar o produto AMI, contêiner, ML ou SaaS, chame a operação de 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": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

Use os campos a seguir com 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 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 incluiu 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.

Para verificar o status da solicitação, use Portal de gerenciamento do AWS Marketplace ou chame a DescribeChangeSet API.

Quando a solicitação for concluída (se Status forSUCCEEDED), uma nova ProductId será gerada.

Validações síncronas

As seguintes validações de esquema são específicas para UpdateTargeting 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 DescribeChangeSet das ações noAWS 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 do produto

Você pode usar a API do Catálogo para atualizar a visibilidade (também conhecida como estado do ciclo de vida) de um produto AMI, contêiner, ML ou SaaS em. AWS Marketplace

Os estados de ciclo de vida alvo permitidos sãoLimited,Public, ou. Restricted

Para atualizar a visibilidade do seu produto, chame a operação da StartChangeSet API com o tipo de UpdateVisibility alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

Para quando TargetVisibility é Public ouLimited.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

Para quando TargetVisibility éRestricted.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

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

Validações síncronas

As seguintes validações de esquema são específicas para UpdateVisibility 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.

Depois de acionar esse tipo de alteração, ele pode levar até 37 dias para ser concluído. Isso inclui o tempo que a equipe de operações do AWS Marketplace vendedor precisa analisar, auditar e aprovar. Ao restringir um produto, você tem 24 horas para mudar de ideia, ligandoCancelChangeSet, antes que a equipe de operações do AWS Marketplace vendedor comece a auditoria. Para obter mais informações, consulte CancelChangeSet.

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 incluiu 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 daPortal 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 ProductId será gerada.

Erros assíncronos

Os erros a seguir são específicos UpdateVisibility das ações noAWS 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.

Publicar um produto

Você pode usar a API de catálogo para publicar um produto Draft AMI, contêiner, ML ou SaaS no Limited estado em. AWS Marketplace

Para publicar um produto, chame a operação da StartChangeSet API com o tipo de ReleaseProduct 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": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

Forneça informações para os campos a serem adicionados ao tipo de ReleaseProduct alteração. Esse tipo de alteração não usa nenhuma carga útil de parâmetro.

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 incluiu 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 daPortal 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 ProductId será gerada.

Erros assíncronos

Os erros a seguir são específicos ReleaseProduct das ações noAWS 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.

Encontre o ID do seu produto

Você deve obter o ID do produto antes de modificá-lo com a API do AWS Marketplace Catálogo. Há duas maneiras de encontrar a ID do produto para produtos de servidor:

Os tópicos a seguir explicam como encontrar um produto filtrando por ID de entidade, título do produto, data da última modificação ou visibilidade.

Encontre um produto com base no título do produto

Solicitação

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

Resposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Encontre um produto com base na data da última modificação

Solicitação

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

Resposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Encontre um produto com base na visibilidade do produto

Solicitação

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

Resposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Encontre um produto com base no título do produto, na data da última modificação e na visibilidade do produto

Solicitação

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

Resposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Obtenha detalhes adicionais sobre um produto

Você pode obter detalhes adicionais sobre o produto usando o ID da entidade com a DescribeEntity ação.

Solicitação

GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

Resposta

HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

Alterar o status e os erros do conjunto

Fazer alterações nos produtos do vendedor na API do AWS Marketplace Catálogo envolve a criação de conjuntos de alterações que descrevem as alterações que você deseja fazer e, em seguida, o uso da StartChangeSet ação para iniciar as alterações. As alterações da solicitação podem levar de minutos a horas ou mais para serem concluídas, dependendo da solicitação. A resposta a essa solicitação é semelhante à seguinte.

{
    "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, incluindo a verificação dos arquivos e das informações para garantir que atenda às AWS Marketplace diretrizes dos produtos. Dependendo das solicitações de alteração, esse processo pode levar de alguns minutos a dias. Você pode verificar o status da solicitação por meio doPortal de gerenciamento do AWS Marketplace, ou na API do Catálogo com a DescribeChangeSet ação. Para obter mais informações sobre conjuntos de alterações, consulte Trabalhando com conjuntos de alterações.

Para verificar o status da sua solicitação, use a DescribeChangeSet ação.

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

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

O resultado dessa chamada é semelhante ao seguinte (nesse caso, para adicionar uma nova versão a um produto de contêiner).

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

O Status campo mostra o status atual da solicitação, nesse caso,SUCCEEDED.

Se houver falhas, o resultado pode incluir dois tipos de erros. Para a maioria dos erros, a mensagem de erro é incluída diretamente. No entanto, os erros encontrados ao escanear o produto em busca de vulnerabilidades de segurança incluem uma URL para um arquivo que lista todos os erros encontrados no ErrorMessage campo. Os erros encontrados durante a digitalização têm o ErrorCode "SCAN_ERROR”.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

Neste exemplo, há um erro diretamente reportado (DUPLICATE_VERSION_TITLE). O outro erro tem um arquivo com mensagens de erro (um único SCAN_ERROR pode ter vários erros encontrados no arquivo vinculado).