Se reestructuró la referencia de API de AWS Marketplace. Para obtener más información sobre las operaciones de API compatibles, consulte la referencia de API de AWS Marketplace.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Trabaja con productos de vendedores

Puedes utilizarla AWS Marketplace Catalog API para automatizar las tareas de trabajo con los productos de los vendedores. Esto incluye la posibilidad de crear, actualizar, ver, enumerar y ordenar productos. Esto le permite automatizar la gestión de los productos. Por ejemplo, puede proporcionar funciones de publicación de autoservicio en el AWS Marketplace Management Portal.

Un producto es una unidad o un recurso en el que se pretende vender AWS Marketplace, lo que suele denominarse producto base. Los compradores no pueden consumir un producto base hasta que añadas la información del producto, los atributos de despliegue y la información de facturación.

Un producto describe la información del producto, los atributos de implementación del software y el mecanismo de facturación del anuncio que pretendes vender. El producto debe ir acompañado de una oferta para convertirse en una unidad negociable que puedas vender y que los compradores puedan utilizar. AWS Marketplace

También puedes utilizarla para: AWS Marketplace Catalog API

Cada tipo de producto tiene una entidad de producto diferente. Una entidad puede ser un producto o una oferta AWS Marketplace. Se admiten los siguientes tipos de productos y entidades:

En los siguientes temas se presupone que tienes acceso a la API y que has cumplido todos los requisitos previos para vender, tal y como se describe enControl de acceso para AWS Marketplace API del catálogo.

Consulte los siguientes recursos:

En los siguientes temas se describe cómo utilizar la API de catálogo para realizar acciones en sus productos de una sola AMI, productos basados en contenedores o productos SaaS.

Cree un producto

Puede usar la API del catálogo para crear un documento de AMI, contenedor, aprendizaje automático o SaaS con identificadores (código de producto e ID de producto). AWS Marketplace

Para crear un producto en Draft estado, llame a la operación de la StartChangeSet API con el tipo de CreateProduct cambio.

Si tu solicitud se procesa correctamente, AWS Marketplace Catalog API generará un producto en ese Draft estado para ti. Se trata de un producto incompleto y los compradores no lo pueden ver en él AWS Marketplace.

A continuación, utilizas los tipos de Update cambios para completar el proceso de creación del producto: UpdateInformationUpdateDimensions, UpdateTargeting, y UpdateVisibility.

Una vez completado el producto, puedes usar el tipo de ReleaseProductcambio para completar el proceso de creación del producto y, a continuación, lanzar la oferta. Este proceso valida todo el producto y lo traslada al Limited estado.

Para crear un producto en Draft estado, llama a la operación de StartChangeSet API con el tipo de CreateProduct cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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"
     }
  }
]
}

Proporcione información sobre los campos para añadir el tipo de CreateProduct cambio. Este tipo de cambio puede incluir un ProductTitle atributo, sujeto a las mismas restricciones que el que se envía al tipo de UpdateInformation cambio.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa.

Puede comprobar el estado de la solicitud a través de la API del AWS Marketplace Management Portal catálogo o directamente a través de la operación de la DescribeChangeSet API.

Cuando se completa la solicitud (si lo Status estáSUCCEEDED), ProductId se genera una nueva.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. CreateProduct AWS Marketplace Catalog API Estas validaciones se realizan cuando llamas. StartChangeSet Si la solicitud no cumple los siguientes requisitos, fallará y generará una respuesta HTTP.

Errores asíncronos

Los siguientes errores son específicos de las CreateProduct acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Actualiza los detalles del producto

Si ya tienes un producto AWS Marketplace, puedes usar la API de catálogo para actualizar los detalles del producto de un producto de AMI, contenedor, ML o SaaS.

Para actualizar los detalles del producto, llama a la operación de la StartChangeSet API con el tipo de UpdateInformation cambio y los detalles que deseas cambiar, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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"
        ]
      }
    }
  ]
}

Proporciona información sobre los campos para añadir el tipo de UpdateInformation cambio:

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa.

Para comprobar el estado de la solicitud, usa la DescribeChangeSet API AWS Marketplace Management Portal o llama a ella.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. UpdateInformation AWS Marketplace Catalog API Estas validaciones se realizan cuando llamas. StartChangeSet Si la solicitud no cumple los siguientes requisitos, fallará y generará una respuesta HTTP.

Errores asíncronos

Los siguientes errores son específicos de las UpdateInformation acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Adición de dimensiones de precios

Puede utilizar las acciones del servicio de catálogo de AWS Marketplace para añadir dimensiones de precios facturables que le permitan cobrar a los usuarios por productos AMI, contenedores o SaaS.

Una dimensión de precios es una unidad de medida que los vendedores definen para cobrar a los compradores. Los vendedores deben configurar esta información para facturar a los compradores por el uso del producto, tanto si se trata de un modelo de precios basado en el uso como en un modelo de precios basado en un contrato. El tipo de dimensión depende del modelo de precios del producto.

Para obtener más información sobre los precios de los productos, consulta los siguientes temas de la Guía del AWS Marketplace vendedor:

Para obtener más información sobre cómo añadir dimensiones de precios mediante el AWS Marketplace Management Portal, consulta los siguientes temas de la Guía del AWS Marketplace vendedor:

Para añadir dimensiones de precios, llama a la StartChangeSet API con el tipo de AddDimensions cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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"
      }
    }
  ]
}

Proporcione los siguientes campos para el tipo de AddDimensions cambio.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluye validar la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puede comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API del catálogo o directamente mediante la operación de la DescribeChangeSet API.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. AddDimensions AWS Marketplace Catalog API Estas validaciones se realizan cuando llamas. StartChangeSet Si la solicitud no cumple los siguientes requisitos, fallará y generará una respuesta HTTP.

Errores asíncronos

Los siguientes errores son específicos de las AddDimensions acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Actualización de las dimensiones de precios

Puede usar la API de catálogo para actualizar las dimensiones de precios existentes de una AMI, un contenedor o un producto SaaS en. AWS Marketplace

Cada dimensión se identifica de forma única mediante la clave de dimensión y los tipos de dimensiones para realizar la actualización. La actualización de una dimensión no afecta a ninguna oferta activa ni a los clientes que haya creado la dimensión original.

Para actualizar las dimensiones de los precios, llama a la operación de la StartChangeSet API con el tipo de UpdateDimensions cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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"
      }
    }
  ]
}

Usa los siguientes campos con el tipo de UpdateDimensions cambio:

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumpla con las AWS Marketplace pautas. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puede comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API del catálogo o directamente mediante la operación de la DescribeChangeSet API.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. UpdateDimensions AWS Marketplace Catalog API Estas validaciones se realizan cuando llamas. StartChangeSet Si la solicitud no cumple los siguientes requisitos, fallará y generará una respuesta HTTP.

Errores asíncronos

Los siguientes errores son específicos de las UpdateDimensions acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Restricción de dimensiones de precios

Puede utilizar la API de catálogo para restringir las dimensiones de precios existentes de un producto AMI o SaaS. AWS Marketplace

Cada dimensión se identifica de forma única mediante la clave de dimensión y los tipos de dimensiones para realizar la actualización. La restricción de una dimensión no afecta a ninguna oferta activa ni a los clientes que haya creado la dimensión original.

Para restringir las dimensiones de precios, llama a la StartChangeSet API con el tipo de RestrictDimensions cambio.

El siguiente ejemplo muestra cómo restringir la Entitled dimensión de un producto SaaS.

Sintaxis de la solicitud

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"
      }
    }
  ]
}

Utilice los siguientes campos con el tipo de RestrictDimensions cambio:

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumpla con las AWS Marketplace pautas. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management PortalDescribeChangeSet API o llamando a ella.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. RestrictDimensions AWS Marketplace Catalog API Estas validaciones se realizan cuando llamas. StartChangeSet Si la solicitud no cumple los siguientes requisitos, fallará y generará una respuesta HTTP.

Errores asíncronos

Los siguientes errores son específicos de las RestrictDimensions acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet mientras se está procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Actualice la configuración de segmentación

Puede usar la API de catálogo para agregar Cuenta de AWS ID que permitan ver la AMI, el contenedor, el ML o el producto SaaS AWS Marketplace antes de que se traslade a un Public estado llamando al tipo de UpdateTargeting cambio.

Las cuentas de Managed Catalog Operations (MCO) se añaden automáticamente a la lista de cuentas permitidas cuando se crean nuevos productos. Los vendedores pueden ver estas cuentas de MCO en el portal AWS Marketplace de administración (AMMP) al consultar las cuentas permitidas y en la Targeting sección de respuesta de la DescribeEntity API.

Para agregar Cuenta de AWS identificadores que permitan ver la AMI, el contenedor, el ML o el producto SaaS, llame a la operación de StartChangeSet API con el tipo de UpdateTargeting cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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"
          ]
        }
      }
    }
  ]
}

Utilice los siguientes campos con el tipo de UpdateTargeting cambio.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumpla con las AWS Marketplace pautas. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Para comprobar el estado de la solicitud, usa la DescribeChangeSet API AWS Marketplace Management Portal o llama a ella.

Cuando se completa la solicitud (si lo Status estáSUCCEEDED), ProductId se genera una nueva.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. UpdateTargeting AWS Marketplace Catalog API Estas validaciones se realizan cuando llamas. StartChangeSet Si la solicitud no cumple los siguientes requisitos, fallará y generará una respuesta HTTP.

Errores asíncronos

Los siguientes errores son específicos de las DescribeChangeSet acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Actualice la visibilidad del producto

Puede usar la API de catálogo para actualizar la visibilidad (también conocida como estado del ciclo de vida) de un producto AMI, contenedor, ML o SaaS. AWS Marketplace

Los estados del ciclo de vida objetivo permitidos son LimitedPublic, oRestricted.

Para actualizar la visibilidad de tu producto, llama a la operación de StartChangeSet API con el tipo de UpdateVisibility cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

Para cuándo TargetVisibility es Public oLimited.

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 cuando TargetVisibility esRestricted.

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"
      }
    }
  ]
}

Proporcione información sobre los campos para agregar el tipo de UpdateVisibility cambio.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. UpdateVisibility AWS Marketplace Catalog API Estas validaciones se realizan cuando llamas. StartChangeSet Si la solicitud no cumple los siguientes requisitos, fallará y generará una respuesta HTTP.

Tras activar este tipo de cambio, puede tardar hasta 37 días en completarse. Esto incluye el tiempo que el AWS Marketplace equipo de operaciones de venta necesita para revisar, auditar y aprobar. Al restringir un producto, dispones de 24 horas para cambiar de opinión y llamar CancelChangeSet al equipo de operaciones de venta antes de que el equipo AWS Marketplace de operaciones de venta comience la auditoría. Para obtener más información, consulte CancelChangeSet.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumpla con las AWS Marketplace pautas. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puede comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API del catálogo o directamente mediante la operación de la DescribeChangeSet API.

Cuando se completa la solicitud (si lo Status estáSUCCEEDED), ProductId se genera una nueva.

Errores asíncronos

Los siguientes errores son específicos de las UpdateVisibility acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Publicar un producto

Puede usar la API de catálogo para publicar un producto de Draft AMI, contenedor, ML o SaaS en Limited State in. AWS Marketplace

Para publicar un producto, llame a la operación de StartChangeSet API con el tipo de ReleaseProduct cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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

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

Proporcione información sobre los campos que desee añadir al tipo de ReleaseProduct cambio. Este tipo de cambio no utiliza ninguna carga útil de parámetros.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumpla con las AWS Marketplace pautas. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puede comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API del catálogo o directamente mediante la operación de la DescribeChangeSet API.

Cuando se completa la solicitud (si lo Status estáSUCCEEDED), ProductId se genera una nueva.

Errores asíncronos

Los siguientes errores son específicos de las ReleaseProduct acciones de. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Encuentra el identificador de tu producto

Debes obtener el identificador de producto de tu producto antes de poder modificarlo con la API del AWS Marketplace catálogo. Hay dos formas de encontrar el identificador de producto de los productos de servidor:

En los siguientes temas se explica cómo encontrar un producto filtrando por identificador de entidad, título del producto, fecha de la última modificación o visibilidad.

Busca un producto en función del título del producto

Solicitud

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

Respuesta

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": "" 
}

Busca un producto según la fecha de la última modificación

Solicitud

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"
                }
            }
        }
    }
}

Respuesta

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": "" 
}

Busca un producto en función de la visibilidad del producto

Solicitud

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

Respuesta

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": "" 
}

Busca un producto en función del título del producto, la fecha de la última modificación y la visibilidad del producto

Solicitud

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"
                ]
            }
        }
    }
}

Respuesta

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": "" 
}

Obtén detalles adicionales sobre un producto

Para obtener detalles adicionales sobre el producto, utiliza el identificador de entidad incluido en la DescribeEntity acción.

Solicitud

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

Respuesta

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",
}

Cambia el estado y los errores del conjunto

Para realizar cambios en los productos de los vendedores en la API de AWS Marketplace catálogo, es necesario crear conjuntos de cambios que describan los cambios que deseas realizar y, a continuación, utilizar la StartChangeSet acción para iniciar los cambios. Los cambios de la solicitud pueden tardar minutos, horas o más en completarse, en función de la solicitud. La respuesta a esta solicitud es similar a la siguiente.

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

La solicitud de cambio se agrega a una cola y se procesa, lo que incluye el escaneo de los archivos y la información para garantizar que cumple con las AWS Marketplace pautas de los productos. En función de las solicitudes de cambio, este proceso puede tardar de unos minutos a días. Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API del catálogo o en la API del catálogo con la DescribeChangeSet acción. Para obtener más información sobre los conjuntos de cambios, consulte Trabajar con conjuntos de cambios.

Para comprobar el estado de la solicitud, usa la DescribeChangeSet acción.

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

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

El resultado de esta llamada es el siguiente (en este caso, para añadir una nueva versión a un producto contenedor).

{
  "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":
      []
    }
  ]
}

El Status campo muestra el estado actual de la solicitud, en este caso,SUCCEEDED.

Si hay errores, el resultado puede incluir dos tipos de errores. Para la mayoría de los errores, el mensaje de error se incluye directamente. Sin embargo, los errores detectados al escanear el producto en busca de vulnerabilidades de seguridad incluyen, en cambio, la URL de un archivo que muestra todos los errores encontrados en el ErrorMessage campo. Los errores detectados al escanear tienen el ErrorCode signo "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"
        }
      ]
    }
  ]
}

En este ejemplo, se informa directamente de un error (DUPLICATE_VERSION_TITLE). El otro error tiene un archivo con mensajes de error (uno SCAN_ERROR puede tener varios errores encontrados en el archivo vinculado).