Configurar o modelo de preço gratuito para produtos SaaS Opções de inicialização rápida de SaaS Adicionar opções de entrega SaaSUrlDeliveryOption

Trabalhe com produtos SaaS usando o AWS Marketplace APIs

Você pode usar o AWS Marketplace Catalog API para automatizar tarefas para trabalhar com SaaS-based produtos. Para obter informações sobre a criação de SaaS-based produtos, consulteCrie um produto. Os tópicos a seguir descrevem como realizar ações da API Catalog:

Tópicos

Configurar o modelo de preço gratuito para produtos SaaS
Opções de inicialização rápida de SaaS
Adicionar opções de entrega
SaaSUrlDeliveryOption

Configurar o modelo de preço gratuito para produtos SaaS

Os produtos SaaS podem ser oferecidos com um modelo de preço gratuito, que permite que os compradores usem seu produto sem nenhum custo. Ao usar o modelo de preço gratuito para produtos SaaS, você deve configurar as dimensões de preços com preços de zero dólar em um ou. UsageBasedPricingTerm ConfigurableUpfrontPricingTerm

nota

O requisito do modelo de preço gratuito para produtos SaaS é exclusivo. Para produtos SaaS com preços gratuitos, você deve criar pelo menos uma dimensão com UsageBasedPricingTerm ou ConfigurableUpfrontPricingTerm, e todas as dimensões devem ter o preço de USD 0,00. Esse requisito não se aplica a produtos de AMI, contêiner ou aprendizado de máquina.

Para configurar preços gratuitos para um produto SaaS:

Crie dimensões de preços para seu produto usando o tipo de AddDimensions alteração. Para obter mais informações, consulte Adicionar dimensões de preço a documentação dos produtos do vendedor.
Crie uma oferta com o PricingModel conjunto Free e inclua um UsageBasedPricingTerm ou ConfigurableUpfrontPricingTerm com todos os preços de dimensão definidos como 0,00 USD. Para obter mais informações sobre a criação de ofertas, consulteTrabalhe com ofertas usando o AWS Marketplace APIs.

Ao configurar a oferta, certifique-se de que:

Todos os preços das tabelas de tarifas UsageBasedPricingTerm estão definidos como “0,00" (formato de string)
Todos os valores de cobrança ConfigurableUpfrontPricingTerm estão definidos como “0,00" (formato de string)
Pelo menos uma dimensão com preço de USD 0,00 está incluída

Opções de inicialização rápida de SaaS

Para obter informações sobre as opções de Início Rápido, consulte os seguintes recursos:

(Compradores) Para opções de lançamento rápido para produtos SaaS, consulte Configuração e lançamento de produtos SaaS usando o Início rápido no Guia do AWS Marketplace comprador.
(Vendedores) Para ver as opções de Início Rápido de produtos SaaS, consulte Configurar o Início Rápido no Guia do AWS Marketplace Vendedor.
Para um workshop de lançamento rápido de produtos SaaS, consulte Laboratório: habilitar o lançamento rápido de SaaS no workshop do AWS Marketplace vendedor.

Adicionar opções de entrega

Você pode usar a API Catalog para adicionar opções de entrega para um produto SaaS em AWS Marketplace. As opções de entrega de API permitem que os vendedores ofereçam API-based serviços que se integram a AWS serviços como o Amazon Bedrock para fluxos de trabalho de agentes de IA.

Para adicionar opções de entrega da API, chame a operação da StartChangeSet API com o tipo de AddDeliveryOptions alteração para adicionar detalhes de entrega, conforme mostrado no exemplo a seguir.

Os tópicos a seguir explicam como adicionar as ApiDeliveryOptionDetails SaaSUrlDeliveryOptionDetails opções de uso e.

Tópicos

ApiDeliveryOptionDetails
Atualizar as opções de entrega
Atualizar a visibilidade da opção de entrega

ApiDeliveryOptionDetails

O exemplo nesta seção oferece suporte ao tipo de opção de ApiDeliveryOptionDetails entrega, que permite especificar endpoints de API, métodos de autenticação e protocolos de integração para seu produto SaaS.

Sintaxe da solicitação


POST /StartChangeSet HTTP/1.1 
Content-type: application/json
   {
  "ChangeType": "AddDeliveryOptions",
  "Entity": {
    "Identifier": "prod-1234567890123",
    "Type": "SaaSProduct@1.0"
  },
  "Details": {
    "DeliveryOptions": [
      {
        "Details": {
          "ApiDeliveryOptionDetails": {
            "ApiType": "AGENT",
            "QuickLaunchEnabled": true,
            "FulfillmentUrl": "https://example.com/fulfillment",
            "UsageInstructions": "# Getting Started\\n\\nTo use this API:\\n1. Register for an API key\\n2. Configure your endpoint\\n3. Start making requests",
            "CompatibleServices": ["Bedrock-AgentCore"],
            "Endpoints": [
              {
                "Name": "GenerateContent",
                "EndpointUrl": "https://api.example.com/v1/{tenantId}/generate",
                "EndpointType": "DYNAMIC",
                "EndpointUrlParameters": [
                  {
                    "Name": "tenantId",
                    "Description": "The unique identifier for the buyer's tenant",
                    "DefaultValue": "default"
                  }
                ],
                "Description": "Generate content using AI models",
                "AuthorizationTypes": ["API_KEY"],
                "Schemas": [{
                  "Type": "OPEN_API",
                  "SchemaUrl": "https://example.com/schemas/example-schema.json"
                }],
                "IntegrationProtocols": [
                  {
                    "Type": "MCP",
                    "UsageInstructions": "Connect using Model Context Protocol for seamless integration"
                  }
                ]
              }
            ]
          }
        }
      }
    ]
  }
}

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

Entity(objeto) (obrigatório) — Seu SaaS-based produto.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) - O tipo é baseado no método de entrega (tipo de produto) que seu produto usará:SaaSProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação.
- DeliveryOptions(matriz) — Detalhes das opções de entrega da API que estão sendo adicionadas.
  - Details(objeto) — Contém a opção ApiDeliveryOptionDetails de entrega a ser adicionada.
    
    ApiDeliveryOptionDetails(objeto) — Contém os detalhes da opção de entrega da API para um produto SaaS.
    
    ApiType(string) (obrigatório) — Tipo de oferta de API. Valores válidos: MCP_SERVER, KNOWLEDGE_BASE, AGENT, GUARDRAIL, OTHER.
    
    QuickLaunchEnabled(boolean) (obrigatório) — Determina se os compradores podem usar o Quick Launch para configurar e iniciar o software.
    
    FulfillmentUrl(string) (obrigatório) — O URL da página inicial de registro do software do vendedor.
    
    UsageInstructions(string) (obrigatório) — Instruções para usar essa opção de entrega da API. Suporta formatação markdown. Máximo de 30.000 caracteres.
    
    CompatibleServices(matriz) (opcional) — Serviços da AWS compatíveis com essa opção de entrega. Atualmente suportaBedrock-AgentCore.
    
    Endpoints(array) (obrigatório) — Os endpoints da API disponíveis para essa oferta. Deve conter exatamente um endpoint.
    
    Name(string) (opcional) — O nome do endpoint da API. Deve corresponder ao padrão^[A-Za-z][a-zA-Z0-9-]+$. Máximo de 100 caracteres.
    
    EndpointUrl(string) (obrigatório) — O URL do endpoint da API. Deve ser um URL HTTPS válido. Pode conter parâmetros de espaço reservado usando a {paramName} sintaxe when EndpointType is. DYNAMIC
    
    EndpointType(string) (opcional) — O tipo de endpoint. Valores válidos: STATIC, DYNAMIC. Use DYNAMIC para endpoints com parâmetros de espaço reservado que resolvem valores específicos do comprador. Requer EndpointUrlParameters e QuickLaunchEnabled configurado comotrue.
    
    EndpointUrlParameters(array) (opcional) — Os parâmetros do espaço reservado em um URL de endpoint dinâmico. Obrigatório quando EndpointType éDYNAMIC. Limitado a 1-5 parâmetros.
    
    Name(string) (obrigatório) — O nome do parâmetro. Deve corresponder a um {paramName} espaço reservado noEndpointUrl. Deve corresponder ao padrão^[a-zA-Z][a-zA-Z0-9_]*$. Máximo de 100 caracteres.
    
    Description(string) (opcional) — Uma descrição do parâmetro. Máximo de 1.000 caracteres.
    
    DefaultValue(string) (opcional) — O valor padrão do parâmetro até que o vendedor forneça um valor. Deve corresponder ao padrão^[a-zA-Z0-9._~-]+$. Máximo de 256 caracteres.
    
    Description(string) (opcional) — Uma descrição do endpoint da API e de sua funcionalidade. Máximo de 4.000 caracteres.
    
    AuthorizationTypes(array) (obrigatório) — Os tipos de autorização necessários para acessar o endpoint da API. Valores válidos: API_KEY, OAUTH2. Deve conter de 1 a 2 valores exclusivos.
    
    Schemas(array) (opcional) — As especificações do esquema para o endpoint da API. Máximo de 1 esquema.
    
    Type(string) (obrigatório) — Tipo de esquema. Valor válido: OPEN_API.
    
    SchemaUrl(string) (obrigatório) — O URL S3 do esquema que foi ingerido em um bucket S3 de propriedade do Marketplace.
    
    IntegrationProtocols(array) (opcional) — Tipos de protocolo suportados pelo endpoint. Máximo de 2 protocolos.
    
    Type(string) (obrigatório) — Identificador de protocolo. Valores válidos: MCP, A2A.
    
    UsageInstructions(string) (obrigatório) — Instruções adicionais para utilizar o protocolo com o endpoint. Máximo de 30.000 caracteres.

Sintaxe de resposta

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


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

Validações síncronas

Condição de erro	Mensagem	Código HTTP
Tipo de API inválido	Você forneceu um tipo de API inválido. Os valores válidos são: MCP_SERVER, KNOWLEDGE_BASE, AGENT, GUARDRAIL, OTHER.	422
URL de preenchimento inválida	Forneça um URL de atendimento válido começando com “https://”.	422
Campos obrigatórios ausentes	O parâmetro necessário está ausente. Você deve fornecer ApiType, QuickLaunchEnabled, FulfillmentUrl UsageInstructions, e Endpoints.	422
URL de endpoint inválida	Forneça um URL de endpoint válido começando com “https://”.	422
Tipos de autorização ausentes	Você deve fornecer pelo menos um tipo de autorização. Os valores válidos são: API_KEY, OAUTH2.	422
Tipos de autorização inválidos	Você forneceu tipos de autorização inválidos. Os valores válidos são: API_KEY, OAUTH2.	422
Muitos endpoints	Você não pode fornecer mais de um endpoint para opções de entrega de API.	422
Tipo de endpoint inválido	EndpointType deve ser ESTÁTICO ou DINÂMICO.	422
Parâmetros de URL do endpoint obrigatórios	EndpointUrlParameters é necessário quando EndpointType é DINÂMICO.	422
Parâmetros de URL do endpoint proibidos	EndpointUrlParameters não é permitido quando EndpointType está estático ou ausente.	422
Contagem inválida de parâmetros de URL de endpoint	EndpointUrlParameters deve conter entre 1 e 5 parâmetros.	422
Parâmetro de URL de endpoint inválido	EndpointUrlParameters contém uma entrada inválida. Verifique se o nome começa com uma letra (somente letras, dígitos, sublinhados) e DefaultValue usa somente caracteres não reservados.	422
Nomes de parâmetros de URL de endpoint duplicados	EndpointUrlParameters não deve conter nomes de parâmetros duplicados.	422
O endpoint dinâmico exige um lançamento rápido	QuickLaunchEnabled deve ser verdadeiro quando EndpointType é DINÂMICO.	422
Serviços compatíveis inválidos	Você forneceu serviços compatíveis inválidos. Os valores válidos são: Bedrock-AgentCore.	422
Tipo de esquema inválido	Você forneceu um tipo de esquema inválido. O valor válido é: OPEN_API.	422
URL de esquema inválida	Forneça um URL de esquema válido que aponte para um bucket do S3 de propriedade do Marketplace.	422
Protocolo de integração inválido	Você forneceu um tipo de protocolo de integração inválido. Os valores válidos são: MCP, A2A.	422
Muitos protocolos de integração	Você não pode fornecer mais de dois protocolos de integração.	422
Instruções de uso inválidas	As instruções de uso excedem o tamanho máximo de 30.000 caracteres.	422

Erros assíncronos

Código de erro	Mensagem de erro
OPÇÕES_DE_ENTREGA DUPLICADAS	Você forneceu um ou mais tipos de opções de entrega que já existem para este produto. Forneça um tipo de opção de entrega exclusivo ou use `UpdateDeliveryOptions` se você pretende alterar uma opção de entrega existente.
INVALID_FULFILLMENT_URL	O URL que você forneceu retornou o código de status HTTP [x]. Forneça um URL de atendimento que seja renderizado com 200.
URL_DO_ENDPOINT INVÁLIDO	O URL que você forneceu retornou o código de status HTTP [x]. Forneça um URL de endpoint que seja renderizado com 200.
URL_DO_ESQUEMA INVÁLIDO	O URL do esquema que você forneceu é inválido ou está inacessível. Forneça um URL de esquema válido que aponte para um bucket do Amazon S3 de propriedade da. AWS Marketplace

Atualizar as opções de entrega

Você pode usar a API Catalog para atualizar as opções de entrega de um produto SaaS no AWS Marketplace.

Para atualizar as opções de entrega, chame a operação da StartChangeSet API com o tipo de UpdateDeliveryOptions alteração, conforme mostrado no exemplo a seguir.

nota

Isso suporta o tipo ApiDeliveryOptionDetails de opção de entrega. Você deve fornecer o ID da opção de entrega para identificar qual opção atualizar.

Sintaxe da solicitação


POST /StartChangeSet HTTP/1.1 
Content-type: application/json
{
    "Catalog": "AWSMarketplace",
    "ChangeSet": [
        {
            "ChangeType": "UpdateDeliveryOptions",
            "Entity": {
                "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
                "Type": "SaaSProduct@1.0"
            },
            "DetailsDocument": {
                "DeliveryOptions": [
                    {
                        "Id": "do-1234567891234567891234",
                        "Details": {
                            "ApiDeliveryOptionDetails": {
                                "ApiType": "AGENT",
                                "QuickLaunchEnabled": true,
                                "FulfillmentUrl": "https://example.com/fulfillment-updated",
                                "UsageInstructions": "# Updated Getting Started\\n\\nTo use this updated API:\\n1. Register for an API key\\n2. Configure your endpoint\\n3. Start making requests",
                                "CompatibleServices": ["Bedrock-AgentCore"],
                                "Endpoints": [
                                    {
                                        "Name": "GenerateContent",
                                        "EndpointUrl": "https://api.example.com/v2/{tenantId}/generate",
                                        "EndpointType": "DYNAMIC",
                                        "EndpointUrlParameters": [
                                            {
                                                "Name": "tenantId",
                                                "Description": "The unique identifier for the buyer's tenant",
                                                "DefaultValue": "default"
                                            }
                                        ],
                                        "Description": "Generate content using updated AI models",
                                        "AuthorizationTypes": ["API_KEY", "OAUTH2"],
                                        "Schemas": [{
                                            "Type": "OPEN_API",
                                            "SchemaUrl": "https://example.com/schemas/updated-schema.json"
                                        }],
                                        "IntegrationProtocols": [
                                            {
                                                "Type": "MCP",
                                                "UsageInstructions": "Connect using Model Context Protocol for seamless integration"
                            }
                                        ]
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

Forneça informações para os campos para atualizar o tipo de UpdateDeliveryOptions alteração com as opções de entrega da API:

Entity(objeto) (obrigatório) — Seu SaaS-based produto.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) - O tipo é baseado no método de entrega (tipo de produto) que seu produto usará:SaaSProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação.
- DeliveryOptions(matriz) — Contém os detalhes das opções de entrega da API que estão sendo atualizadas.
  - Id(string) (obrigatório) — Identificador exclusivo para DeliveryOption o. (Obtenha o identificador exclusivo do DeliveryOption chamando a DescribeEntity ação no produto que você está atualizando.)
  - Details(objeto) — Contém a opção ApiDeliveryOptionDetails de entrega a ser atualizada.
    
    ApiDeliveryOptionDetails(objeto) — Contém os detalhes da opção de entrega da API para o produto SaaS.
    
    ApiType(string) (obrigatório) — Tipo de oferta de API. Valores válidos: MCP_SERVER, KNOWLEDGE_BASE, AGENT, GUARDRAIL, OTHER.
    
    QuickLaunchEnabled(boolean) (obrigatório) — Determina se os compradores podem usar o Quick Launch para configurar e iniciar o software.
    
    FulfillmentUrl(string) (obrigatório) — O URL a ser atualizado para o produto SaaS.
    
    UsageInstructions(string) (obrigatório) — Instruções para usar essa opção de entrega da API. Suporta formatação markdown. Máximo de 30.000 caracteres.
    
    CompatibleServices(matriz) (opcional) — Serviços da AWS compatíveis com essa opção de entrega. Atualmente suportaBedrock-AgentCore.
    
    Endpoints(array) (obrigatório) — Os endpoints da API disponíveis para essa oferta. Deve conter exatamente um endpoint.
    
    Name(string) (opcional) — O nome do endpoint da API.
    
    EndpointUrl(string) (obrigatório) — O URL do endpoint da API a ser atualizado. Pode conter parâmetros de espaço reservado usando a {paramName} sintaxe when EndpointType is. DYNAMIC
    
    EndpointType(string) (opcional) — O tipo de endpoint. Valores válidos: STATIC, DYNAMIC. Use DYNAMIC para endpoints com parâmetros de espaço reservado que resolvem valores específicos do comprador. Requer EndpointUrlParameters.
    
    EndpointUrlParameters(array) (opcional) — Os parâmetros do espaço reservado em um URL de endpoint dinâmico. Obrigatório quando EndpointType éDYNAMIC. Limitado a 1-5 parâmetros.
    
    Name(string) (obrigatório) — O nome do parâmetro. Deve corresponder a um {paramName} espaço reservado noEndpointUrl. Deve corresponder ao padrão^[a-zA-Z][a-zA-Z0-9_]*$. Máximo de 100 caracteres.
    
    Description(string) (opcional) — Uma descrição do parâmetro. Máximo de 1.000 caracteres.
    
    DefaultValue(string) (opcional) — O valor padrão do parâmetro até que o vendedor forneça um valor. Deve corresponder ao padrão^[a-zA-Z0-9._~-]+$. Máximo de 256 caracteres. Obrigatório para qualquer parâmetro que seja novo ou que tenha tido um DefaultValue e que não tenha mais, se o produto já for público. Isso protege os compradores existentes de um parâmetro obrigatório sem valor padrão.
    
    Description(string) (opcional) — Uma descrição do endpoint da API e de sua funcionalidade.
    
    AuthorizationTypes(array) (obrigatório) — Os tipos de autorização necessários para acessar o endpoint da API. Valores válidos: API_KEY, OAUTH2.
    
    Schemas(array) (opcional) — As especificações do esquema para o endpoint da API.
    
    Type(string) (obrigatório) — Tipo de esquema. Valor válido: OPEN_API.
    
    SchemaUrl(string) (obrigatório) — O URL S3 do esquema atualizado.
    
    IntegrationProtocols(array) (opcional) — Tipos de protocolo suportados pelo endpoint.
    
    Type(string) (obrigatório) — Identificador de protocolo. Valores válidos: MCP, A2A.
    
    UsageInstructions(string) (obrigatório) — Instruções adicionais para utilizar o protocolo com o endpoint.

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. Isso inclui a validação de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas. Você pode verificar o status da solicitação por meio da 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

Condição de erro	Mensagem	Código HTTP
IDs de opção de entrega vazios	Os detalhes fornecidos não são válidos. A string "em/DeliveryOptions/0/Idnão corresponde à regex de esquema exigida, '^do- [a-z] +$' A-Z0-9	422
IDs de opções de entrega ausentes	Os detalhes fornecidos não são válidos. O JSON em/DeliveryOptions/0 não possui as propriedades obrigatórias: ['Id'].	422
IDs de opção de entrega duplicados	Forneça IDs de opções de entrega exclusivas.	422
URL de preenchimento inválida	Forneça um URL de atendimento válido começando com “https://”.	422
IDs de opção de entrega inválidos	Forneça os IDs das opções de entrega que podem ser encontrados no produto. IDs não encontrados: [x]	422
Várias opções de entrega de URL	Você forneceu mais de uma opção de entrega de URL. Forneça uma opção de entrega de URL.	422
IDs de opções de entrega ausentes	O ID da opção de entrega está ausente. Forneça uma ou mais IDs de opção de entrega válidas que você deseja atualizar ou use `AddDeliveryOptions` se quiser adicionar uma nova opção de entrega.	422
URL de lançamento inválida	Forneça um URL de lançamento válido começando com “https://”.	422
URL de lançamento ausente	O parâmetro necessário `LaunchUrl` está ausente. Você deve fornecer um`LaunchUrl`.	422
Modelos de implantação ausentes	O modelo de implantação está ausente. Forneça pelo menos um modelo de implantação.	422
Muitos modelos de implantação	Você não pode fornecer mais de 20 modelos de implantação.	422
URL de modelo inválida	O URL de início rápido é inválido. Forneça o URL do modelo de implantação que é publicado pela AWS QuickStarts para o Amazon S3. URL de modelos de implantação inválida: [x]	422
Nome inválido da pilha de modelos de implantação	O nome da pilha do modelo de implantação é inválido. Forneça um nome de pilha válido usando somente caracteres alfanuméricos e hífens. Ele deve começar com um caractere alfabético e não pode ter mais de 128 caracteres.	422
Título do modelo de implantação duplicado	Você forneceu títulos de modelos de implantação duplicados. Forneça títulos exclusivos de modelos de implantação.	422
URL do modelo de implantação duplicado	Você forneceu URLs de modelo de implantação duplicados. Forneça URLs de modelo de implantação exclusivos.	422
Tipo de modelo de implantação inválido	O tipo de modelo de implantação é inválido. Forneça um tipo de modelo de implantação válido. Os valores suportados são [” CloudFormation @1 .0"].	422
Política de IAM do modelo de implantação inválido	A política do IAM do modelo de implantação é inválida. Forneça uma política de IAM válida.	422
Instruções de uso inválidas	As imagens não são suportadas pelas instruções de uso. Remova a imagem [x]. Você forneceu um link para um URL inválido nas instruções de uso: [x]. Forneça um URL válido. Você forneceu um link com um esquema de URI não suportado nas instruções de uso. Use um esquema compatível: ["http”, “https”, “tel”, “mailto"].	422

Erros assíncronos

Código de erro	Mensagem de erro
IDS_OPÇÕES_DE_ENTREGA INVÁLIDAS	`Forneça os IDs das opções de entrega que podem ser encontrados no produto. IDs não encontrados: [x]`
ERRO_DE_AUDITORIA	`AWS Lista de auditorias do catálogo MP - equipe CQ`
INVALID_FULFILLMENT_URL	`O URL que você forneceu retornou o código de status HTTP [x]. Forneça um URL de atendimento que seja renderizado com 200.`
URL_DE_LANÇAMENTO INVÁLIDA	`O URL que você forneceu retornou o código de status HTTP [x]. Forneça um URL de lançamento que seja renderizado com 200.`
URL_DO_PREDEFINIÇÃO_INVÁLIDA	`O URL de início rápido é inválido. Forneça o URL do modelo de implantação que é publicado no Amazon S3. AWS QuickStarts URL de modelos de implantação inválida: [x]`
VALOR_DEFAULT_REQUIRED_FOR_NEW_PARAMETER	`O endpoint '[x]' tem o parâmetro '[x]' sem nenhum DefaultValue. A DefaultValue é necessário quando o produto já é público e essa atualização introduz o parâmetro ou remove um parâmetro que DefaultValue o parâmetro tinha anteriormente. Forneça um DefaultValue para o parâmetro.`

Atualizar a visibilidade da opção de entrega

Você pode usar a API Catalog para configurar permissões para que somente alguns usuários possam alterar a visibilidade de um produto SaaS em AWS Marketplace.

Para configurar as permissões para que somente alguns usuários possam alterar a visibilidade de um produto SaaS, chame a operação da StartChangeSet API com o tipo de UpdateDeliveryOptionsVisibility alteração, conforme mostrado no exemplo a seguir.

nota

Isso só é compatível com uma opção de entrega:SaaSUrlDeliveryOptionDetails.

Sintaxe da solicitação


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          },
          {
            "Id": "do-43210987654321",
            "TargetVisibility": "Limited",
            "Targeting":
            {
              "PositiveTargeting":
              {
                "BuyerAccounts":
                [
                  "123456789012"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

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

Entity(objeto) (obrigatório) — Seu SaaS-based produto.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usará:SaaSProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação.
- DeliveryOptions(array) — Lista de DeliveryOptions a serem atualizadas.
  - TargetVisibility(string) — O ID da opção de entrega a ser atualizado.
  - TargetVisibility(string) — A nova visibilidade pretendida da opção de entrega.
    
    Valores possíveis: Limited, Public e Unavailable.
    
    nota
    Sempre há exatamente uma opção Public de entrega e no máximo uma opção de Limited entrega.
  - Targeting(objeto) opcional — Segmentação da opção de entrega, usada em conjunto com o status de Limited visibilidade para poder testar a nova opção de entrega antes de alterar a visibilidade para. Public
    
    PositiveTargeting(object) — Especificação de segmentação inclusiva.
    
    BuyerAccounts(matriz de sequências de caracteres) — A lista de Conta da AWS IDs de compradores que poderão usar a nova opção de entrega.
    
    Tamanho mínimo: 0. Tamanho máximo: 100.

Sintaxe de resposta


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

Validações síncronas

Condição de erro	Mensagem	Código HTTP
IDs de opções de entrega ausentes	O ID da opção de entrega está ausente. Forneça uma ou mais IDs de opção de entrega válidas que você deseja atualizar ou use `AddDeliveryOptions` se quiser adicionar uma nova opção de entrega.	422
Visibilidade inválida	Você forneceu uma opção inválida para`TargetVisibility`. As opções permitidas são:`Limited`,`Public`,`Unavailable`.	422
Segmentação inválida	Você forneceu uma opção inválida para`PositiveTargeting`. Você deve fornecer um parâmetro válido para`BuyerAccounts`.	422
Visibilidade e segmentação ausentes	Você forneceu detalhes de visibilidade da opção de entrega inválidos. Você deve fornecer um parâmetro válido para pelo menos um dos `TargetVisibility` ou`Targeting`.	422
Muitas Conta da AWS crianças	Você não pode fornecer mais de 100 contas de compradores direcionados.	422

Erros assíncronos

Código de erro	Mensagem de erro
IDS_OPÇÕES_DE_ENTREGA INVÁLIDAS	`Você forneceu detalhes inválidos da opção de entrega. Forneça os IDs das opções de entrega que podem ser encontrados no produto. IDs não encontrados: [x]`
VISIBILIDADE_INVÁLIDA	`Você forneceu mais de uma opção de entrega para o estado público. Forneça apenas uma opção de entrega pública.`
VISIBILIDADE_INVÁLIDA	`Você não forneceu uma opção de entrega pública. Forneça uma opção de entrega pública.`
ERRO_DE_AUDITORIA	`Varia de acordo com a revisão manual do MCO.`

SaaSUrlDeliveryOption

O exemplo a seguir mostra como usar o SaaSUrlDeliveryOptionDetails para atualizar FulfillmentUrl o.

Sintaxe da solicitação


POST /StartChangeSet HTTP/1.1 
Content-type: application/json
     
{
    "Catalog": "AWSMarketplace",
    "ChangeSet": [
        {
            "ChangeType": "UpdateDeliveryOptions",
            "Entity": {
                "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
                "Type": "SaaSProduct@1.0"
            },
            "DetailsDocument": {
                "DeliveryOptions": [
                    {
                        "Id": "do-1234567891234567891234",
                        "Details": {
                            "SaaSUrlDeliveryOptionDetails": {
                                "FulfillmentUrl": "https://www.aws.amazon.com/marketplace/management",
                                "LaunchUrl": "URL",
                                "UsageInstructions": "Instructions",
                                "DeploymentTemplates": [
                                    {
                                        "Title": "CloudFormation Template 123",
                                        "Description": "CloudFormation description",
                                        "IamPolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:Get*\",\"s3:List*\"],\"Resource\":\n[\"arn:aws:s3:::amzn-s3-demo-bucket\",\"arn:aws:s3:::amzn-s3-demo-bucket/*\"]}]}"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

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

Entity(objeto) (obrigatório) — Seu SaaS-based produto.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usará:SaaSProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação.
- DeliveryOptions(matriz) — Contém os detalhes das opções de entrega que estão sendo atualizadas.
  - TargetVisibility(string) — Identificador exclusivo para DeliveryOption o. (Obtenha o identificador exclusivo do DeliveryOption chamando a DescribeEntity ação no produto que você está atualizando.)
  - Details(objeto) — Contém a opção SaaSUrlDeliveryOptionDetails de entrega a ser atualizada.
    
    SaaSUrlDeliveryOptionDetails(objeto) — Contém a opção FulfillmentUrl de entrega de um produto SaaS.
    
    FulfillmentUrl(string) — O URL a ser atualizado para o produto SaaS.
    
    LaunchUrl(string) — O URL da página de destino do seu produto SaaS. Isso será obrigatório se QuickLaunchEnabled estiver definido como True.
    
    UsageInstructions(string) — Instruções para usar essa opção de entrega. Inclua documentação com etapas manuais para clientes que não usarãoDeploymentTemplates.
    
    DeploymentTemplates(matriz) — Modelos de implantação que os clientes podem usar para instalar e configurar o produto SaaS e quaisquer recursos relacionados. AWS
    
    Title(string) — O nome de exibição do modelo de implantação.
    
    Description(string) — Uma descrição do que o modelo de implantação contém.
    
    IamPolicy(string) — Uma política do IAM que descreve as permissões necessárias para implantar o modelo. Os compradores podem usar essa política do IAM para implantar rapidamente o modelo.
    
    CloudFormationDetails(objeto) — Os detalhes de um CloudFormation modelo.
    
    TemplateUrl(string) — A URL do modelo de implantação.
    
    DefaultStackName(string) — O nome padrão usado CloudFormation quando o cliente cria o modelo.

Sintaxe de resposta


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

Validações síncronas

Condição de erro	Mensagem	Código HTTP
IDs de opção de entrega vazios	Os detalhes fornecidos não são válidos. A string "em/DeliveryOptions/0/Idnão corresponde à regex de esquema exigida, '^do- [a-z] +$' A-Z0-9	422
IDs de opções de entrega ausentes	Os detalhes fornecidos não são válidos. O JSON em/DeliveryOptions/0 não possui as propriedades obrigatórias: ['Id'].	422
IDs de opção de entrega duplicados	Forneça IDs de opções de entrega exclusivas.	422
URL de preenchimento inválida	Forneça um URL de atendimento válido começando com “https://”.	422
IDs de opção de entrega inválidos	Forneça os IDs das opções de entrega que podem ser encontrados no produto. IDs não encontrados: [x]	422
Várias opções de entrega de URL	Você forneceu mais de uma opção de entrega de URL. Forneça uma opção de entrega de URL.	422
IDs de opções de entrega ausentes	O ID da opção de entrega está ausente. Forneça uma ou mais IDs de opção de entrega válidas que você deseja atualizar ou use `AddDeliveryOptions` se quiser adicionar uma nova opção de entrega.	422
URL de lançamento inválida	Forneça um URL de lançamento válido começando com “https://”.	422
URL de lançamento ausente	O parâmetro necessário `LaunchUrl` está ausente. Você deve fornecer um`LaunchUrl`.	422
Modelos de implantação ausentes	O modelo de implantação está ausente. Forneça pelo menos um modelo de implantação.	422
Muitos modelos de implantação	Você não pode fornecer mais de 20 modelos de implantação.	422
URL de modelo inválida	O URL de início rápido é inválido. Forneça o URL do modelo de implantação que é publicado pela AWS QuickStarts para o Amazon S3. URL de modelos de implantação inválida: [x]	422
Nome inválido da pilha de modelos de implantação	O nome da pilha do modelo de implantação é inválido. Forneça um nome de pilha válido usando somente caracteres alfanuméricos e hífens. Ele deve começar com um caractere alfabético e não pode ter mais de 128 caracteres.	422
Título do modelo de implantação duplicado	Você forneceu títulos de modelos de implantação duplicados. Forneça títulos exclusivos de modelos de implantação.	422
URL do modelo de implantação duplicado	Você forneceu URLs de modelo de implantação duplicados. Forneça URLs de modelo de implantação exclusivos.	422
Tipo de modelo de implantação inválido	O tipo de modelo de implantação é inválido. Forneça um tipo de modelo de implantação válido. Os valores suportados são [” CloudFormation @1 .0"].	422
Política de IAM do modelo de implantação inválido	A política do IAM do modelo de implantação é inválida. Forneça uma política de IAM válida.	422
Instruções de uso inválidas	As imagens não são suportadas pelas instruções de uso. Remova a imagem [x]. Você forneceu um link para um URL inválido nas instruções de uso: [x]. Forneça um URL válido. Você forneceu um link com um esquema de URI não suportado nas instruções de uso. Use um esquema compatível: ["http”, “https”, “tel”, “mailto"].	422

Erros assíncronos

Código de erro	Mensagem de erro
IDS DE OPÇÃO_DE_ENTREGA INVÁLIDOS	`Forneça os IDs das opções de entrega que podem ser encontrados no produto. IDs não encontrados: [x]`
ERRO_DE_AUDITORIA	`AWS Lista de auditorias do catálogo MP - equipe CQ`
INVALID_FULFILLMENT_URL	`O URL que você forneceu retornou o código de status HTTP [x]. Forneça um URL de atendimento que seja renderizado com 200.`
URL_DE_LANÇAMENTO INVÁLIDA	`O URL que você forneceu retornou o código de status HTTP [x]. Forneça um URL de lançamento que seja renderizado com 200.`
URL_DO_MODELO INVÁLIDO	`O URL de início rápido é inválido. Forneça o URL do modelo de implantação que é publicado no Amazon S3. AWS QuickStarts URL de modelos de implantação inválida: [x]`

Atualizar a visibilidade da opção de entrega

Você pode usar a API Catalog para configurar permissões para que somente alguns usuários possam alterar a visibilidade de um produto SaaS em AWS Marketplace.

Para fazer isso, chame a operação da StartChangeSet API com o tipo de UpdateDeliveryOptionsVisibility alteração, conforme mostrado no exemplo a seguir.

nota

Isso só é compatível com uma opção de entrega:SaaSUrlDeliveryOptionDetails.

Sintaxe da solicitação


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          },
          {
            "Id": "do-43210987654321",
            "TargetVisibility": "Limited",
            "Targeting":
            {
              "PositiveTargeting":
              {
                "BuyerAccounts":
                [
                  "123456789012"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

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

Entity(objeto) (obrigatório) — Seu SaaS-based produto.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usará:SaaSProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação.
- DeliveryOptions(array) — Lista de DeliveryOptions a serem atualizadas.
  - TargetVisibility(string) — O ID da opção de entrega a ser atualizado.
  - TargetVisibility(string) — A nova visibilidade pretendida da opção de entrega.
    
    Valores possíveis: Limited, Public e Unavailable.
    
    nota
    Sempre há exatamente uma opção Public de entrega e no máximo uma opção de Limited entrega.
  - Targeting(objeto) opcional — Segmentação da opção de entrega, usada em conjunto com o status de Limited visibilidade para poder testar a nova opção de entrega antes de alterar a visibilidade para. Public
    
    PositiveTargeting(object) — Especificação de segmentação inclusiva.
    
    BuyerAccounts(matriz de sequências de caracteres) — A lista de Conta da AWS IDs de compradores que poderão usar a nova opção de entrega.
    
    Tamanho mínimo: 0. Tamanho máximo: 100.

Sintaxe de resposta


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

Validações síncronas

Condição de erro	Mensagem	Código HTTP
IDs de opções de entrega ausentes	O ID da opção de entrega está ausente. Forneça uma ou mais IDs de opção de entrega válidas que você deseja atualizar ou use `AddDeliveryOptions` se quiser adicionar uma nova opção de entrega.	422
Visibilidade inválida	Você forneceu uma opção inválida para`TargetVisibility`. As opções permitidas são:`Limited`,`Public`,`Unavailable`.	422
Segmentação inválida	Você forneceu uma opção inválida para`PositiveTargeting`. Você deve fornecer um parâmetro válido para`BuyerAccounts`.	422
Visibilidade e segmentação ausentes	Você forneceu detalhes de visibilidade da opção de entrega inválidos. Você deve fornecer um parâmetro válido para pelo menos um dos `TargetVisibility` ou`Targeting`.	422
Muitas Conta da AWS crianças	Você não pode fornecer mais de 100 contas de compradores direcionados.	422

Erros assíncronos

Código de erro	Mensagem de erro
IDS DE OPÇÃO_DE_ENTREGA INVÁLIDOS	`Você forneceu detalhes inválidos da opção de entrega. Forneça os IDs das opções de entrega que podem ser encontrados no produto. IDs não encontrados: [x]`
VISIBILIDADE_INVÁLIDA	`Você forneceu mais de uma opção de entrega para o estado público. Forneça apenas uma opção de entrega pública.`
VISIBILIDADE_INVÁLIDA	`Você não forneceu uma opção de entrega pública. Forneça uma opção de entrega pública.`
ERRO_DE_AUDITORIA	`Varia de acordo com a revisão manual do MCO.`

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Trabalhe com produtos à base de contêineres

Trabalhe com produtos de aprendizado de máquina