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.

Trabaje con ofertas privadas utilizando el AWS Marketplace API

Puedes utilizarlas AWS Marketplace Catalog API para automatizar las tareas de trabajo con las ofertas.

Si bien el producto describe en qué se vende AWS Marketplace, la oferta describe los términos y reglas que rigen la compra y el consumo de un producto. AWS Marketplace los productos pueden tener varias ofertas vendidas por distintos vendedores. Sin embargo, cada AWS Marketplace oferta solo se puede crear para un producto. Una oferta contiene un conjunto de condiciones acordadas entre dos partes. Los términos de la oferta aceptados se traducen en un acuerdo como prueba de la transacción.

Existen dos tipos de ofertas:

Consulte los siguientes recursos:

En los siguientes temas se describe cómo utilizar la API del catálogo para crear y actualizar ofertas:

Crea una oferta

Puedes usar la API de catálogo para crear una nueva oferta en AWS Marketplace. Si tu solicitud se procesa correctamenteDraft, se AWS Marketplace Catalog API crea una oferta incompleta que los compradores no ven. Para completar una oferta, usa el tipo de Update cambio. Cuando la oferta esté completa, usa el tipo de ReleaseOffercambio para crearla y publicarla. Publicar una oferta la valida y la hace visible para los compradores. AWS Marketplace

Para crear una oferta nueva, llama a la operación de StartChangeSet API con el tipo de CreateOffer 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": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer",
        "OfferSetId": "offerset-b3f9EXAMPLE27"
      }
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de CreateOffer 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.

Si Status es asíSUCCEEDED, OfferId se genera una nueva.

La respuesta tiene este aspecto:

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2021-05-27T22:21:26Z",
  "EndTime": "2021-05-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet": [
    {
      "ChangeType": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer"
      },
      "ErrorDetailList": []
    }
  ]
}

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. CreateOffer 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 CreateOffer 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.

Crea una oferta de reemplazo

Puedes usar la API del catálogo para crear una oferta de reemplazo (también conocida como oferta basada en acuerdos) en. AWS Marketplace

Si tu solicitud se ha procesado correctamente, se AWS Marketplace Catalog API generará una oferta en Draft estado para ti, que es una oferta incompleta que los compradores no podrán ver en ella. AWS Marketplace Utilizarás los tipos de Update cambio para completar la oferta. Una vez finalizada la oferta, utilizarás el tipo de ReleaseOffercambio para completar el proceso de creación de la oferta y publicarla. De este modo, se validará toda la oferta y los compradores podrán verla AWS Marketplace. A partir de ahí, el comprador tiene la opción de aceptar la oferta de reemplazo o de seguir operando según el acuerdo original.

Para crear una oferta de reemplazo, llama a la operación de la StartChangeSet API con el tipo de CreateReplacementOffer cambio y proporciona un identificador de acuerdo preexistente, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateReplacementOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "AgreementId": "agmt-12345",
        "Name": "Offer name"
      }
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de CreateReplacementOffer 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.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. CreateReplacementOffer 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 CreateReplacementOffer 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 la información de la oferta

Puedes usar la API del catálogo para actualizar la información de la oferta en AWS Marketplace.

Para actualizar la información de la oferta, llama a la operación de la StartChangeSet API con el tipo de UpdateInformation cambio, como se muestra en el siguiente ejemplo. El resto de la información permanecerá sin cambios.

Sintaxis de la solicitud

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateInformation",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Name": "New offer name",
        "Description": "New offer description",
        "PreExistingAgreement": {
          "AcquisitionChannel": "External",
          "PricingModel": "Contract"
        }
      }
    }
  ]
}

Proporcione 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. Esto incluye la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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

Actualiza la configuración de segmentación

Puedes usar la API del catálogo para actualizar la configuración de segmentación de tu oferta en AWS Marketplace.

Todas las opciones de segmentación existentes que no se incluyeron en la última solicitud y que se eliminarán de la oferta.

Para actualizar la configuración de segmentación de tu oferta, llama a la operación de la 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "111122223333"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      }
    }
  ]
}

Proporciona información sobre los campos para añadir 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 incluye la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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. 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 UpdateTargeting 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 política de devoluciones

Puedes usar la API del catálogo para actualizar la política de reembolsos de tu oferta en AWS Marketplace.

Este cambio no afecta a los acuerdos existentes. Los términos de soporte que no estén incluidos en la última solicitud se eliminarán de la oferta.

Para actualizar la política de reembolsos, llama a la operación de la StartChangeSet API con el tipo de UpdateSupportTerms 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": "UpdateSupportTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "SupportTerm",
            "RefundPolicy": "Updated refund policy description"
          }
        ]
      }
    }
  ]
}

Proporciona información sobre los campos para añadir el tipo de UpdateSupportTerms 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 la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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. UpdateSupportTerms 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 UpdateSupportTerms 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 recursos legales

Puede usar la API del catálogo para reemplazar los documentos legales existentes, como un acuerdo de licencia de usuario final (EULA). Los términos legales que no estén incluidos en la última solicitud se eliminarán de la oferta.

Para actualizar los recursos legales de tu oferta, llama a la operación de la StartChangeSet API con el tipo de UpdateLegalTerms 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": "UpdateLegalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "LegalTerm",
            "Documents": [
              {
                "Type": "CustomEula",
                "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Proporciona información sobre los campos para añadir el tipo de UpdateLegalTerms 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 la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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

Actualizar los precios

Puedes usar la API del catálogo para reemplazar por completo las condiciones de precios existentes. Los términos de precios que no estén incluidos en la última solicitud se eliminarán de la oferta.

Para actualizar las condiciones de precios de tu oferta, llama a la operación de la StartChangeSet API con el tipo de UpdatePricingTerms 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": "UpdatePricingTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PricingModel": "Usage",
        "Terms": [
          {
            "Type": "UsageBasedPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "0.10"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "0.20"
                  }
                ]
              }
            ]
          },
          {
            "Type": "ConfigurableUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "Selector": {
                  "Type": "Duration",
                  "Value": "P365D"
                },
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "300"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "400"
                  }
                ],
                "Constraints": {
                  "MultipleDimensionSelection": "Allowed",
                  "QuantityConfiguration": "Allowed"
                }
              }
            ]
          },
          {
            "Type": "ByolPricingTerm"
          },
          {
            "Type": "RecurringPaymentTerm",
            "CurrencyCode": "USD",
            "BillingPeriod": "Monthly",
            "Price": "100.0"
          },
          {
            "Type": "FixedUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "Price": "200.00",
            "Grants": [
              {
                "DimensionKey": "Users",
                "MaxQuantity": 10
              }
            ]
          },
          {
            "Type": "FreeTrialPricingTerm",
            "Duration": "P30D",
            "Grants": [
              {
                "DimensionKey": "m3.xlarge",
                "MaxQuantity": 10
              },
              {
                "DimensionKey": "m4.xlarge",
                "MaxQuantity": 10
              }
            ]
          }
        ]
      }
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de UpdatePricingTerms 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 la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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. UpdatePricingTerms 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 UpdatePricingTerms 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 de la oferta

Puedes usar la API del catálogo para controlar la visibilidad de tu oferta. AWS Marketplace

Puedes elegir establecer una fecha específica en el futuro para restringir la visibilidad de tu oferta o en el pasado para que caduque tu oferta. El tipo de UpdateAvailability cambio no afecta a los acuerdos existentes.

Para controlar la visibilidad de tu oferta, llama a la operación de la StartChangeSet API con el tipo de UpdateAvailability 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": "UpdateAvailability",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "AvailabilityEndDate": "2024-05-31"
      }
    }
  ]
}

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

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona el ID y el ARN del conjunto de cambios y tiene el siguiente aspecto.

Sintaxis de respuesta

{
  "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. Incluye la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos. 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.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones de. UpdateAvailability 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 UpdateAvailability 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.

Defina la fecha de caducidad de los acuerdos creados con la oferta

Puede utilizar la API del catálogo para definir los detalles de la fecha de caducidad de los acuerdos creados con la oferta de AWS Marketplace.

Este tipo de cambio no afecta a los acuerdos existentes.

Para definir los detalles de la fecha de caducidad de los acuerdos creados con la oferta, llama a la operación de StartChangeSet API con el tipo de UpdateValidityTerms 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": "UpdateValidityTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "ValidityTerm",
            "AgreementDuration": "P12M",
            "AgreementStartDate": "2021-08-01",
            "AgreementEndDate": "2022-08-01"
          }
        ]
      }
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de UpdateValidityTerms 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 la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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

Actualizar los detalles del calendario de pagos

Puedes usar la API del catálogo para actualizar los detalles del calendario de pagos de tu oferta, como un calendario de pagos flexible, en AWS Marketplace.

Para actualizar los detalles del calendario de pagos de tu oferta, llama a la operación de la StartChangeSet API con el tipo de UpdatePaymentScheduleTerms 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": "UpdatePaymentScheduleTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "PaymentScheduleTerm",
            "Schedule": [
              {
                "ChargeDate": "2021-12-01",
                "ChargeAmount": "200.00"
              },
              {
                "ChargeDate": "2022-03-01",
                "ChargeAmount": "250.00"
              }
            ]
          }
        ]
      }
    }
  ]
}

Proporciona información sobre los campos para añadir el tipo de UpdatePaymentScheduleTerms 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 la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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

Modifique las opciones de renovación

Puedes usar la API del catálogo para controlar las opciones de renovación de los acuerdos que se creen con esta oferta en AWS Marketplace.

En el caso de las ofertas creadas a través de la API de catálogo, la renovación automática permanece desactivada de forma predeterminada hasta que se active el tipo de UpdateRenewalTerms cambio para permitir la renovación automática. Este cambio no afecta a los acuerdos existentes.

Para controlar las opciones de renovación de los acuerdos que se crean con esta oferta, llama a la operación de StartChangeSet API con el tipo de UpdateRenewalTerms 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": "UpdateRenewalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "RenewalTerm"
          }
        ]
      }
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de UpdateRenewalTerms 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 la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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

Publica una oferta

Puedes usar la API del catálogo para combinar la información recopilada de todos los tipos de cambios de actualización y, a continuación, publicar la oferta.

Las ofertas permanecen en un Draft estado hasta que ReleaseOffer se cancelen. Una vez publicada la oferta, se podrá encontrar en AWS Marketplace.

Para publicar tu oferta, llama a la operación de la StartChangeSet API con el tipo de ReleaseOffer 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": "ReleaseOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Proporciona información sobre los campos para añadir el tipo de ReleaseOffer 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 la validación de la información para garantizar que cumpla con las AWS Marketplace directrices. El proceso de validación puede tardar unos minutos.

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

Describa los detalles de la oferta existente

Puedes usar la API del catálogo para describir los detalles de las ofertas existentes en AWS Marketplace.

Para describir los detalles de la oferta existente, llama a la operación de la DescribeEntity API con el tipo de Offer@1.0 entidad, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1

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

Sintaxis de respuesta

La respuesta a esta solicitud proporciona los detalles de la oferta y tiene el siguiente aspecto.

{
  "EntityType": "Offer@1.0",
  "EntityIdentifier": "offer-ad8EXAMPLE51@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/Offer/offer-ad8EXAMPLE51",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "DetailsDocument": {
    "Id": "offer-3rEXAMPLErn",
    "State": "Released",
    "Name": "Test Offer",
    "Description": "Worldwide offer for Test Product",
    "PreExistingAgreement": {
      "AcquisitionChannel": "External",
      "PricingModel": "Contract"
    },
    "ProductId": "prod-ad8EXAMPLE51",
    "OfferSetId": "offerset-b3f9EXAMPLE27",
    "Terms": [
      {
        "Type": "SupportTerm",
        "RefundPolicy": "If you need to request a refund for software sold by Amazon Web Services, LLC, please contact AWS Customer Service."
      },
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "FreeTrialPricingTerm",
        "Duration": "P30D",
        "Grants": [
          {
            "DimensionKey": "m3.xlarge",
            "MaxQuantity": 10
          },
          {
            "DimensionKey": "m4.xlarge",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P365D"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "FixedUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "Price": "200.00",
        "Grants": [
          {
            "DimensionKey": "Users",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "RecurringPaymentTerm",
        "CurrencyCode": "USD",
        "BillingPeriod": "Monthly",
        "Price": "100.0"
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00.000Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00.000Z",
            "ChargeAmount": "1250.00"
          }
        ]
      },
      {
        "Type": "ByolPricingTerm"
      },
      {
        "Type": "RenewalTerm"
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "444455556666"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2024-08-30T01:56:03.000Z"
      }
    ]
  }
}

La siguiente es información sobre los campos que ves en la DescribeEntity respuesta.