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](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html).

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

# Restringir uma versão
<a name="ml-restrict-version"></a>

 Você pode usar a API de catálogo para restringir uma versão do seu produto de aprendizado de máquina em AWS Marketplace. Quando restrito, novos compradores não podem acessar essa versão. Os assinantes existentes mantêm o acesso às versões restritas. AWS Marketplace as diretrizes exigem suporte contínuo para compradores existentes por 90 dias após a restrição. 

**Importante**  
 Pelo menos uma versão irrestrita deve permanecer disponível. Você não pode restringir a última versão disponível publicamente de um produto. 

**Para restringir uma versão:**
+  Para restringir uma versão, chame a `StartChangeSet` operação com o tipo de `RestrictDeliveryOptions` alteração. 

## Sintaxe da solicitação
<a name="ml-restrict-version-request-syntax"></a>

```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12@1}}",
        "Type": "MachineLearningProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "{{example1-2222-cccc-2222-cccccccccccc}}"
        ]
      }
    }
  ]
}
```

## Campos obrigatórios
<a name="ml-restrict-version-required-fields"></a>

**Campos obrigatórios**
+  `Entity`(objeto) — obrigatório 

  Contém informações sobre seu produto de ML.
  +  `Identifier`(string) — obrigatório 

    O ID do seu produto. Para obter mais informações, consulte [Identificador](https://docs.aws.amazon.com/marketplace/latest/APIReference/catalog-apis.html#identifier).
  +  `Type`(string) — obrigatório 

    Especifica o método de entrega (tipo de produto). Deve ser `MachineLearningProduct@1.0`.
+  `DetailsDocument`(objeto) — obrigatório 

   Contém as informações da versão atualizada. 
  + `DeliveryOptionIds`(matriz de objetos) — obrigatório

    Lista de DeliveryOption IDs para as versões que você deseja restringir. Recupere o identificador exclusivo de cada um DeliveryOption chamando a DescribeEntity ação na versão que você está restringindo.

## Sintaxe da resposta
<a name="ml-restrict-version-response-syntax"></a>

Uma solicitação bem-sucedida retorna:

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

1. Validação: o sistema verifica se todas as informações atendem às AWS Marketplace diretrizes.
   +  Tempo de processamento: alguns minutos a várias horas 
   +  Para erros de validação, consulte [Status e erros do conjunto de alterações](https://docs.aws.amazon.com/marketplace/latest/APIReference/work-with-seller-products.html#seller-product-change-set-errors). 

1.  Monitoramento de status: você pode verificar o status da solicitação de duas maneiras. 
   + Por meio do Portal AWS Marketplace de Gerenciamento
   + Como usar a operação `DescribeChangeSet`

1.  Conclusão: Quando aprovada, a nova versão é restrita. 

## Erros
<a name="ml-restrict-version-errors"></a>

**Erros assíncronos**  
Os seguintes erros podem ocorrer durante o processamento do conjunto de alterações e podem ser recuperados usando a `DescribeChangeSet` operação:


| Código de erro | Mensagem de erro | 
| --- | --- | 
| STATUS DE PRODUTO\_INCOMPATÍVEL | Use um produto público ou limitado existente | 
| IDS\_OPTION\_DE\_DELIVERY AUSENTES | Forneça a opção de entrega a partir da lista existente de IDs. | 
| IDS\_OPTION\_DE\_DELIVERY INVÁLIDOS | Forneça IDs de opção de entrega que possam ser encontrados no produto. IDs não encontrados: [x] | 
| STATUS DA OPÇÃO\_DE\_ENTREGA INVÁLIDA | Os IDs da opção de entrega [invalid\_ids] são inválidos. Forneça opções de entrega no estado público. | 
| TODAS AS OPÇÕES\_DE ENTREGA RESTRITAS | Forneça menos opções de entrega para restringir, pois pelo menos uma deve permanecer em estado público. |