View a markdown version of this page

Uso de AWS Marketplace API de acuerdo - AWS Marketplace

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.

Uso de AWS Marketplace API de acuerdo

AWS Marketplace es un catálogo digital seleccionado que los clientes pueden usar para buscar, comprar, implementar y administrar software, datos y servicios de terceros para crear soluciones y administrar sus negocios. El servicio de AWS Marketplace acuerdos proporciona una interfaz API que ayuda a AWS Marketplace los compradores y vendedores a gestionar sus acuerdos, incluidos los acuerdos de venta, búsqueda y filtrado.

Conceptos clave

En la siguiente tabla se describen los conceptos clave que se utilizan en la API de AWS Marketplace acuerdos.

Concepto Description (Descripción)
Aceptador La parte que acepta todos o un subconjunto de los términos extendidos por el proponente en un acuerdo. En los casos de uso más comunes, los aceptadores son los compradores del producto.
Acuerdo Documento que vincula a dos partes, entre ellas el proponente (habitualmente, el seller/ISV socio del canal) y el aceptante (habitualmente, el comprador), y en el que se definen los términos y condiciones aplicables entre ambas partes.
Solicitud de cancelación del acuerdo Solicitud iniciada por el vendedor (proponente) para cancelar un acuerdo activo. El comprador (aceptante) puede aceptar o rechazar la solicitud de cancelación. Si se acepta, el flujo de trabajo de cancelación del acuerdo se ejecuta de forma asíncrona y el estado del acuerdo cambia a cancelado. Si se rechaza, el acuerdo permanece activo y el vendedor puede enviar una nueva solicitud de cancelación.
Propuesta de acuerdo Entidad que hace referencia al conjunto de terms/offer propuestas por la seller/proposer.
Solicitud de acuerdo Entidad que hace referencia al recurso creado como resultado de la acción del cliente y describe creation/modification los parámetros del acuerdo, el ciclo de vida de la solicitud y el resultado estimado tras la aceptación de la solicitud.
Dimensión facturable Elementos relacionados con el precio del producto. Por ejemplo, instancias de Amazon Elastic Compute Cloud (Amazon EC2) para productos de Amazon Machine Image (AMI) o premium en comparación con usuarios de solo lectura para productos de software como servicio (SaaS).
Socios de canal (CP) Organizaciones que están autorizadas por el propietario del producto (ISV) para revender sus productos en su nombre en. AWS Marketplace
Proveedores de software independientes (ISV) Vendedores que publican y administran sus propios productos en AWS Marketplace.
Intención La intención representa la motivación que tiene el comprador al crear el Acuerdo. Las intenciones admitidas actualmente son las siguientes: Nueva, Modificación y Reemplazo durante el proceso de creación del acuerdo.
Solicitud de pago Solicitud de pago iniciada por el vendedor (proponente) asociada a un acuerdo. El comprador (aceptante) puede aceptar o rechazar la solicitud de pago.
Proponente La parte que amplía el conjunto inicial de condiciones de un acuerdo, por lo general mediante una oferta.
Órdenes de compra Las organizaciones exigen que los compradores utilicen las órdenes de compra para comprar a proveedores aprobados, hagan un seguimiento de lo que compran y se aseguren de que los gastos se pronostican, presupuestan, aprueban y asignan a los centros de costos responsables.
Recurso Unidad o recurso en el que los vendedores pretenden vender AWS Marketplace, lo que suele denominarse producto base. Un producto base no está completo para que lo consuma el comprador hasta que se añada 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 el vendedor pretende vender. El producto debe ir acompañado de una oferta para convertirse en una unidad negociable que pueda ser vendida y utilizada por los compradores. AWS Marketplace
Plazo Unidad incluida en un acuerdo que regula la forma en que se hace cumplir un acuerdo (por ejemplo, los precios).

Punto de conexión

Puede acceder al servicio de AWS Marketplace contratos con los siguientes puntos de conexión:

Punto de conexión Region Protocolos IP compatibles
agreement-marketplace.us-east-1.api.aws Este de EE. UU. (Norte de Virginia) IPv4, IPv6

Permisos

La API de acuerdos utiliza la autenticación estándar de la versión 4 (SiGv4) de AWS firma. Debe tener AWS credenciales válidas y los permisos de IAM adecuados para poder llamar a la API. Para obtener más información, consulte Control de acceso para AWS Marketplace API de acuerdo.

Códigos de error

Los siguientes códigos de error se aplican a las acciones de AWS Marketplace Agreement Service. Es posible que se devuelva un único código de error para varios casos de uso. Consulte las descripciones siguientes para identificar el escenario específico en el que se produce cada código de error. Esta lista no es exhaustiva y puede actualizarse a medida que se publiquen nuevas funciones.

ValidationException

Código de error Description (Descripción)
INVALID_SOURCE_AGREEMENT_IDENTIFIER Se devuelve cuando el identificador del acuerdo de origen no coincide con el formato esperado o cuando se proporciona un identificador de acuerdo de origen para fines que no lo requieren (por ejemplo, NUEVO).
MISSING_SOURCE_AGREEMENT_IDENTIFIER Se devuelve cuando no se proporciona el identificador del acuerdo de origen para una intención que lo requiere (como REPLACE o AMEND).
INVALID_REQUESTED_TERM_CONFIGURATION

Se devuelve cuando la configuración del término solicitada no es válida. Posibles escenarios:

  • Se proporciona una configuración para un término que no la acepta.

  • Falta una configuración obligatoria.

  • El valor del selector no pertenece a la propuesta de acuerdo.

  • Las dimensiones solo pueden contener una dimensión cuando no se permite la selección de varias dimensiones.

  • La clave de dimensión no se reconoce en la propuesta de acuerdo ni en los términos aceptados.

  • El valor de una dimensión solo puede ser 1 si la configuración de cantidad no está habilitada para la dimensión.

  • La configuración contiene claves de dimensión duplicadas.

  • La configuración no difiere del acuerdo de origen.

INVALID_AGREEMENT_PROPOSAL_IDENTIFIER Se devuelve cuando el identificador de la propuesta de acuerdo no coincide con el formato esperado o cuando se proporciona un identificador de la propuesta de acuerdo para fines que no lo requieren (como AMEND).
MISSING_AGREEMENT_PROPOSAL_IDENTIFIER Se devuelve cuando no se proporciona el identificador de la propuesta de acuerdo para una intención que lo requiere (como NEW o REPLACE).
INVALID_FILTER_NAME Se devuelve cuando el nombre del filtro proporcionado no es un filtro reconocido o cuando se incluyen nombres de filtro duplicados en la solicitud.
INVALID_FILTER_VALUES Se devuelve cuando los valores del filtro no son válidos, están duplicados, están vacíos, superan el recuento máximo permitido o cuando un filtro de intervalo de fechas especifica un BeforeEndTime valor que precede al AfterEndTime valor.
INVALID_NEXT_TOKEN Se devuelve cuando el token de paginación tiene un formato incorrecto, ha caducado, no se puede descifrar o cuando los parámetros de la solicitud han cambiado entre las llamadas paginadas.
DUPLICATE_CHARGES Se devuelve cuando la solicitud contiene identificadores de cargo duplicados o cuando se proporcionan valores de pedido de compra diferentes para el mismo identificador de cargo.
UNSUPPORTED_FILTERS Se devuelve cuando no se admite la combinación de filtros proporcionada. Las combinaciones de filtros admitidas varían en función del tipo de grupo. Consulta las combinaciones compatibles en la documentación pública.
INVALID_PURCHASE_ORDER_REFERENCE Se devuelve cuando la referencia del pedido de compra no cumple con los requisitos de formato o cuando no se proporciona el pedido de compra obligatorio tal como lo configuró el administrador de la cuenta.
INVALID_CHARGE_AMOUNT

Se devuelve cuando el importe del cargo no es válido. Posibles escenarios:

  • El importe del cargo supera el importe máximo total del cargo durante el período.

  • El formato del importe del cargo no coincide con los requisitos de divisa (por ejemplo, hay demasiados decimales).

  • No hay ningún importe restante disponible porque el acuerdo ha alcanzado el importe máximo total de cargo.

UNSUPPORTED_ACTION

Se devuelve cuando la operación solicitada no es compatible con el estado actual del recurso. Los escenarios específicos varían según la API:

  • UpdatePurchaseOrders— La fecha de cargo es pasada y la renovación automática está deshabilitada, la fecha de cargo es de 3 horas, el cargo es un cargo de reembolso, la revisión del cargo no es la última, las órdenes de compra no pertenecen todas al mismo acuerdo o el acuerdo no está activo.

  • CreateAgreementRequest— No se admite la modificación de un acuerdo con fecha futura, la combinación de tipo de recurso y tipo de plazo no respalda la intención solicitada, no se permite reemplazar un acuerdo activo por un acuerdo con fecha futura, la duración del acuerdo no se puede cambiar durante la modificación, el acuerdo no se puede actualizar en este momento (por ejemplo, existen derechos pendientes), la propuesta de acuerdo debe hacer referencia al mismo recurso que el acuerdo de origen, la propuesta de acuerdo debe diferir del acuerdo de origen o el tipo de acuerdo no admite esta acción.

  • AcceptAgreementRequest— La combinación de tipo de recurso y tipo de término no admite esta acción, el tipo de acuerdo no admite esta acción, ya existe un acuerdo activo sobre el mismo recurso o el acuerdo no se puede actualizar en este momento.

  • CancelAgreement— El acuerdo tiene derechos pendientes, el tipo de acuerdo no admite la cancelación, un acuerdo con el que no se UsageBasedPricingTerm puede cancelar mientras haya un acuerdo con el mismo recurso ConfigurableUpfrontPricingTerm o que aún PaymentScheduleTerm esté activo en él, o la combinación del tipo de recurso y el tipo de plazo no admite la cancelación.

  • GetBillingAdjustmentRequest— El acuerdo no es de compra o la persona que llama es quien lo acepta.

  • SendAgreementCancellationRequest— El tipo de acuerdo no admite esta acción.

  • AcceptAgreementCancellationRequest— El tipo de acuerdo no admite esta acción.

  • RejectAgreementCancellationRequest— El tipo de acuerdo no admite esta acción.

  • CancelAgreementCancellationRequest— El tipo de acuerdo no admite esta acción.

  • GetAgreementCancellationRequest— El acuerdo es un tipo de acuerdo que no es de compra.

ResourceNotFoundException

Las ResourceNotFoundException inclusiones resourceType y resourceId los campos que identifican el recurso que no se pudo encontrar. En la siguiente tabla se describen los escenarios que pueden provocar esta excepción para cada tipo de recurso.

nota

Por motivos de seguridad, se devuelve el mismo error tanto si un recurso no existe como si la persona que llama no tiene acceso a él. Esto impide la enumeración de identificadores de recursos válidos.

Tipo de recurso Posibles escenarios
AgreementProposal
  • No se ha encontrado ninguna propuesta de acuerdo para el identificador indicado.

  • La oferta no está dirigida al aceptador.

  • La oferta no está disponible en el país del aceptador.

Agreement
  • No se ha encontrado ningún acuerdo para el identificador indicado.

  • La persona que llama no es ni la que acepta ni la que propone el acuerdo.

AgreementRequest
  • No se ha encontrado ninguna solicitud de acuerdo para el identificador indicado.

  • La solicitud de acuerdo pertenece a otra persona que llama.

  • La solicitud de acuerdo ha caducado.

  • La solicitud de acuerdo ha sido sustituida por una solicitud posterior aceptada sobre el mismo producto u oferta.

  • La propuesta de acuerdo quedó inactiva entre las AcceptAgreementRequest convocatorias CreateAgreementRequest y las convocatorias debido a la republicación de la oferta o al vencimiento de la oferta.

Charge
  • No se ha encontrado ningún cargo por el identificador indicado.

  • El cargo no pertenece al acuerdo especificado.

BillingAdjustmentRequest
  • No se ha encontrado ninguna solicitud de ajuste de facturación para el identificador indicado.

  • La persona que llama no acepta ni propone el acuerdo asociado al ajuste.

AgreementCancellationRequest
  • No se ha encontrado ninguna solicitud de cancelación de acuerdo para el identificador indicado.

  • La persona que llama no acepta ni propone el acuerdo asociado a la solicitud de cancelación.

PaymentRequest
  • No se ha encontrado ninguna solicitud de pago para el identificador indicado.

  • La persona que llama no acepta ni propone el acuerdo asociado a la solicitud de pago.