View a markdown version of this page

Adicionar uma nova versão - AWS Marketplace
Sintaxe da solicitaçãoCampos obrigatóriosSintaxe da respostaErros

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

Adicionar uma nova versão

Você pode usar a API do Catálogo ou o Portal AWS Marketplace de Gerenciamento para adicionar uma nova versão a um produto de aprendizado de máquina. Para obter mais informações sobre o uso do portal, consulte Adicionar uma nova versão no Guia do vendedor do AWS Marketplace.

nota

Para produtos de ML, uma versão consiste em uma única opção de entrega, que representa o produto que você está disponibilizando. Na API de catálogo, trabalhar com opções de entrega para produtos de ML modifica efetivamente as versões do seu produto.

Ao adicionar novos tipos de instância, inclua um tipo de UpdatePricingTerms alteração em seu conjunto de alterações para especificar os preços dos novos tipos de instância. Para novos produtos, UpdatePricingTerms deve abranger todos os tipos de instância compatíveis. UpdatePricingDimensionsnão é obrigatório nem compatível com produtos de ML, pois as dimensões são geradas automaticamente para todos os tipos de instância compatíveis. Para obter mais informações, consulte Atualizar dimensões de preços.

Usando StartChangeSetpara adicionar uma versão

Para adicionar uma nova versão, chame a StartChangeSet operação com o tipo de AddDeliveryOptions alteração:

  1. Para validar sua chamada de API sem criar uma versão, Intent defina VALIDATE como.

  2. Para criar a versão real, Intent defina comoAPPLY.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
    "Catalog": "AWSMarketplace",
    "ChangeSet": [{
        "ChangeType": "AddDeliveryOptions",
        "Entity": {
            "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
            "Type": "MachineLearningProduct@1.0"
        },
        "DetailsDocument": {
            "Version": {
                "VersionTitle": "version 1.1",
                "ReleaseNotes": "Patch update for small bugfix in version 1.0"
            },
            "DeliveryOptions": [{
                "Details": {
                    "SageMakerAlgorithmDeliveryOptionDetails": {
                       "SageMakerAlgorithmArn": "arn:aws:sagemaker:us-east-2:605142612156:algorithm/scikit-decision-trees-1552343220",
                       "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceSageMakerIngestion",
                        "UsageInstructions":"This is how you use your algorithm", 
                       "SampleNotebookUrl": "https://www.amazon.com",
                        "RepositoryUrl": "https://www,amazon.com",
                        "InputProperties": {
                            "Description": "Input should have all columns in the train/test file except for 'is_fraud' column.",
                            "Limitations": "Can predict on 1 input in the CSV only at a time",
                           "SampleInput": {
                                "RealtimeInferenceText": "{\"prompt\":\"Write summary\",
                                                            \"maxTokens\": 1 }",
                                "BatchTransformUrl": "https://www.sampleData.com",
                            },
                           "Parameters": [{
                                    "Name": "prompt",
                                    "Description": "Represents the instruct-style prompt for the model. DataType is String",
                                    "Constraints": "Minimum length should be 1",
                                    "Required": true
                                },
                                {
                                    "Name": "maxTokens",
                                    "Description": "Denotes the number of tokens to predict per generation. See BPE Tokens for more details.",
                                    "Constraints": "Minvalue: 1, MaxValue: 30"
                                }
                            ],
                            "SageMakerCustomAttributes": [{
                                    "Name": "threshold",
                                    "Description": "Threshold of the confidence score of the detected object",
                                    "Constraints": "Should be an Integer"
                            }]
                    },
                    "OutputProperties": {
                        "Description": "The output is a JSON object that has the generated text along with likelihoods of tokens, if requested. See example json.",
                       "SampleOutput": {
                            "RealtimeInferenceUrl": "https://www.sampledata.com",
                            "BatchTransformUrl": "https://www.sampleData.com",
                        },
                       "Parameters": [{
                                "Name": "id",
                                "Description": "An identifier for response"
                                "AlwaysReturned": true
                            },
                            {
                                "Name": "generations",
                                "Description": "The generated text along with the likelihoods for tokens requested.",
                            }
                        ],
                    },
                   "RecommendedInstanceTypes": {
                        "BatchTransform": "ml.m4.large",
                        "RealtimeInference": "ml.m4.large",
                        "Training": "ml.m4.large"
                   }
                }
            }]
        }
    }],
    "Intent": "APPLY"
}

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.

    • Type(string) — obrigatório

      Especifica o método de entrega (tipo de produto). Deve ser MachineLearningProduct@1.0.

  • DetailsDocument(objeto) — obrigatório

    Contém todos os detalhes sobre a nova versão do seu produto.

    • Version(objeto) — obrigatório

      Detalhes sobre a versão que está sendo adicionada.

      • VersionTitle(string) — obrigatório

        O título da versão, como “Versão 1.1" ou “1.1". Os compradores selecionam versões desses títulos.

      • ReleaseNotes(string) — obrigatório

        Notas detalhadas sobre esta versão. Deve ter menos de 30.000 caracteres.

    • DeliveryOptions(matriz) — obrigatório

      Variedade de métodos de entrega para a versão do seu produto. Limitado a uma opção de entrega por versão.

      • Details(objeto) — obrigatório

        • SagemakerModelPackageDeliveryOptionDetailsou SageMakerAlgorithmDeliveryOptionDetails (objeto)

          • SageMakerModelPackageArnou SageMakerAlgorithmArn (string) — obrigatório

            Nome de recurso da Amazon (ARN) do seu pacote de modelo ou algoritmo.

          • AccessRoleArn(string) — obrigatório

            ARN da função do IAM para o AWS Marketplace acessar o SageMaker recurso.

          • SampleNotebookUrl(string) — obrigatório

            Link para um exemplo de caderno Jupyter com código de uso. Para obter mais informações, consulte um exemplo de modelo de caderno em GitHub.

          • RepositoryUrl(string) — obrigatório

            URL do repositório Git para acesso a notebooks e dados de amostra. Para obter mais informações, consulte um exemplo de repositório Git em. GitHub

          • UsageInstructions(string) — obrigatório

            Informações de treinamento para algoritmos ou detalhes de uso de modelos.

          • InputProperties(objeto) — obrigatório

            • Description(string) — obrigatório

              Descrição das model/algorithm entradas

            • Limitations (string)

              Limitações de entrada

            • SampleInput(objeto) — obrigatório

              RealtimeInferenceUrl (string) | RealtimeInferenceText (string) | BatchTransformUrl (string) | BatchTransformText (string)

            • Parameters(Matriz<Object>)

              Nome (string) —obrigatório | Descrição (string) —Obrigatório | Restrições (string) | Obrigatório (booleano)

            • SageMakerCustomAttributes(Matriz<Object>)

              Descreve qualquer um CustomAttributescompatível com seu modelo.

              Name(string) —obrigatório | Description (string) —Obrigatório | Constraints (string) | Required (booleano)

          • OutputProperties(objeto) — obrigatório

            • Description(string) — obrigatório

            • SampleOutput(Array<Object>) — obrigatório

              RealtimeInferenceUrl (string) | RealtimeInferenceText (string) | BatchTransformUrl (string) | BatchTransformText (string)

            • Parameters(Matriz)

              Nome (string) —obrigatório | Descrição (string) —obrigatório | AlwaysReturned (boolean)

          • RecommendedInstanceTypes(objeto) — obrigatório

            • BatchTransform(string) — Obrigatório

            • RealtimeInference(string) — Obrigatório

            • Training(string) — Obrigatório somente para SageMaker algoritmos

Sintaxe da resposta

Quando você envia a solicitação, um conjunto de alterações é criado e a API retorna:

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
Processamento do conjunto de alterações

A solicitação de alteração entra em uma fila de processamento, na qual passa por várias etapas:

  1. Validação: o sistema verifica se todas as informações atendem às AWS Marketplace diretrizes.

  2. Monitoramento de status: você pode verificar o status da solicitação de duas maneiras.

    • Por meio do portal de gerenciamento do AWS Marketplace

    • Como usar a operação DescribeChangeSet

  3. Conclusão: Quando aprovada, a nova versão é adicionada.

Erros

Erros assíncronos

Os erros a seguir são específicos de AddDeliveryOptions ações na API AWS Marketplace de catálogo. Esses erros aparecem quando você liga DescribeChangeSet enquanto um conjunto de alterações está sendo processado. Para obter mais informações sobre como usar DescribeChangeSet para verificar o status de uma solicitação de alteração, consulte Como trabalhar com conjuntos de alterações.

Código de erro Mensagem de erro
STATUS DE PRODUTO_INCOMPATÍVEL Não foi possível localizar o produto fornecido. Forneça um produto válido.
TÍTULO DA VERSÃO_DUPLICADO O título da versão fornecida já está em uso. Crie um título de versão exclusivo.
TIPO_DE_INSTÂNCIA_RECOMENDADA_INVÁLIDA_RECOMENDADA Você não forneceu um tipo de instância válido para [x]. Insira um tipo de instância válido e tente novamente. Os tipos válidos são: [valids]
OPÇÕES_DE ENTREGA INCOMPATÍVEIS A opção de entrega que você forneceu não corresponde à sua seleção anterior: [seleção anterior]. Atualize sua opção de entrega e tente novamente.
ASSET_ARN INVÁLIDO Você não forneceu um ARN válido para. SageMakerAlgorithmDeliveryOption Insira um ARN válido e tente novamente.
ATIVO_DUPLICADO Você não forneceu um ARN exclusivo para este produto. Insira um ARN exclusivo e tente novamente.
ATIVO NÃO ENCONTRADO Não foi possível localizar o ARN que você forneceu. Verifique se o ARN está correto e tem as permissões necessárias.
EXCEÇÃO_VALIDAÇÃO_DE ATIVOS Não é possível ingerir SagemakerModelArn/SagemakerAlgorithmArn [x] na conta do AWS Sagemaker
FUNÇÃO_DE ACESSO INVÁLIDA Não foi possível localizar o ARN da função do IAM que você forneceu. Verifique se o ARN está correto e tente novamente.
ATUALIZAÇÃO_PRECIFICAÇÃO_NECESSÁRIA UpdatePricingTerms é obrigatório.