Referensi API AWS Marketplace direstrukturisasi. Untuk informasi selengkapnya tentang operasi API yang didukung, lihat Referensi API AWS Marketplace.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Bekerja dengan penawaran pribadi menggunakanAWS MarketplaceAPI

Anda dapat menggunakan AWS Marketplace Catalog API untuk mengotomatiskan tugas untuk bekerja dengan penawaran.

Sementara produk menggambarkan apa yang dijualAWS Marketplace, penawaran tersebut menjelaskan syarat dan aturan tentang bagaimana suatu produk dibeli dan dikonsumsi. AWS Marketplaceproduk dapat memiliki beberapa penawaran yang dijual oleh penjual yang berbeda. Namun, setiap AWS Marketplace penawaran hanya dapat dibuat untuk satu produk. Penawaran berisi kumpulan ketentuan perjanjian antara dua pihak. Ketentuan penawaran yang diterima diterjemahkan ke dalam perjanjian sebagai bukti transaksi.

Ada dua jenis penawaran:

Lihat sumber daya berikut:

Topik berikut menjelaskan cara menggunakan API Katalog untuk membuat dan memperbarui penawaran:

Buat penawaran

Anda dapat menggunakan API Katalog untuk membuat penawaran baru diAWS Marketplace. Jika permintaan Anda berhasil diproses, AWS Marketplace Catalog API menciptakanDraft, yang merupakan penawaran tidak lengkap yang tidak terlihat oleh pembeli. Untuk menyelesaikan penawaran, gunakan jenis Update perubahan. Saat penawaran selesai, gunakan jenis ReleaseOfferperubahan untuk membuat dan melepaskannya. Melepaskan penawaran memvalidasinya dan membuatnya terlihat oleh pembeli. AWS Marketplace

Untuk membuat penawaran baru, panggil operasi StartChangeSet API dengan jenis CreateOffer perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis CreateOffer perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Jika Status yaSUCCEEDED, maka yang baru OfferId dihasilkan.

Respon tersebut terlihat seperti berikut.

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

Validasi sinkron

Validasi skema berikut khusus untuk CreateOffer tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk CreateOffer tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Buat penawaran pengganti

Anda dapat menggunakan API Katalog untuk membuat penawaran pengganti (juga dikenal sebagai penawaran berbasis perjanjian) di. AWS Marketplace

Jika permintaan Anda telah berhasil diproses, AWS Marketplace Catalog API akan memiliki penawaran dalam Draft keadaan yang dibuat untuk Anda, yang merupakan penawaran yang tidak lengkap dan tidak terlihat oleh pembeli diAWS Marketplace. Anda akan menggunakan jenis Update perubahan untuk menyelesaikan penawaran. Setelah penawaran selesai, Anda akan menggunakan jenis ReleaseOfferperubahan untuk menyelesaikan proses pembuatan penawaran dan merilis penawaran, yang akan memvalidasi seluruh penawaran dan membuat penawaran Anda terlihat oleh pembeli. AWS Marketplace Dari sana, pembeli memiliki opsi untuk menerima tawaran penggantian atau untuk terus beroperasi berdasarkan perjanjian awal.

Untuk membuat penawaran pengganti, panggil operasi StartChangeSet API dengan tipe CreateReplacementOffer perubahan dan berikan id perjanjian yang sudah ada sebelumnya, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis CreateReplacementOffer perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk CreateReplacementOffer tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk CreateReplacementOffer tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Perbarui informasi penawaran

Anda dapat menggunakan API Katalog untuk memperbarui informasi penawaran diAWS Marketplace.

Untuk memperbarui informasi penawaran, panggil operasi StartChangeSet API dengan jenis UpdateInformation perubahan, seperti yang ditunjukkan pada contoh berikut. Semua informasi lainnya akan tetap tidak berubah.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdateInformation perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateInformation tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateInformation tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Perbarui konfigurasi penargetan

Anda dapat menggunakan API Katalog untuk memperbarui konfigurasi penargetan penawaran Anda diAWS Marketplace.

Semua opsi penargetan yang ada yang tidak termasuk dalam permintaan terbaru dan akan dihapus dari penawaran.

Untuk memperbarui konfigurasi penargetan penawaran Anda, panggil operasi StartChangeSet API dengan jenis UpdateTargeting perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdateTargeting perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateTargeting tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateTargeting tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Perbarui kebijakan pengembalian dana

Anda dapat menggunakan API Katalog untuk memperbarui kebijakan pengembalian dana penawaran Anda diAWS Marketplace.

Perubahan ini tidak mempengaruhi perjanjian yang ada. Ketentuan dukungan yang tidak termasuk dalam permintaan terbaru akan dihapus dari penawaran.

Untuk memperbarui kebijakan pengembalian dana, panggil operasi StartChangeSet API dengan jenis UpdateSupportTerms perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdateSupportTerms perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateSupportTerms tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateSupportTerms tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Perbarui sumber daya hukum

Anda dapat menggunakan API Katalog untuk mengganti dokumen hukum yang ada, seperti perjanjian lisensi pengguna akhir (EULA). Ketentuan hukum yang tidak termasuk dalam permintaan terbaru akan dihapus dari penawaran.

Untuk memperbarui sumber daya hukum penawaran Anda, hubungi operasi StartChangeSet API dengan jenis UpdateLegalTerms perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdateLegalTerms perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateLegalTerms tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateLegalTerms tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Perbarui harga

Anda dapat menggunakan API Katalog untuk mengganti persyaratan harga yang ada sepenuhnya. Ketentuan harga yang tidak termasuk dalam permintaan terbaru akan dihapus dari penawaran.

Untuk memperbarui ketentuan harga penawaran Anda, hubungi operasi StartChangeSet API dengan jenis UpdatePricingTerms perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdatePricingTerms perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdatePricingTerms tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdatePricingTerms tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Perbarui kemampuan penemuan penawaran

Anda dapat menggunakan API Katalog untuk mengontrol kemampuan penemuan penawaran Anda di. AWS Marketplace

Anda dapat memilih untuk menetapkan tanggal tertentu di masa depan untuk membatasi penemuan penawaran Anda atau di masa lalu untuk kedaluwarsa penawaran Anda. Jenis UpdateAvailability perubahan tidak memengaruhi perjanjian yang ada.

Untuk mengontrol kemampuan penemuan penawaran Anda, panggil operasi StartChangeSet API dengan jenis UpdateAvailability perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdateAvailability perubahan:

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ID dan ARN untuk set perubahan dan terlihat seperti berikut.

Sintaks Respon

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit. Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau di API Katalog dengan DescribeChangeSet tindakan.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateAvailability tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateAvailability tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk detail selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Tentukan tanggal kedaluwarsa perjanjian yang dibuat menggunakan penawaran

Anda dapat menggunakan API Katalog untuk menentukan rincian tanggal kedaluwarsa perjanjian yang dibuat menggunakan penawaran di. AWS Marketplace

Jenis perubahan ini tidak memengaruhi perjanjian yang ada.

Untuk menentukan detail tanggal kedaluwarsa perjanjian yang dibuat menggunakan penawaran, panggil operasi StartChangeSet API dengan jenis UpdateValidityTerms perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdateValidityTerms perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateValidityTerms tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateValidityTerms tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Perbarui detail jadwal pembayaran

Anda dapat menggunakan API Katalog untuk memperbarui detail jadwal pembayaran untuk penawaran Anda, seperti jadwal pembayaran yang fleksibel, diAWS Marketplace.

Untuk memperbarui detail jadwal pembayaran untuk penawaran Anda, hubungi operasi StartChangeSet API dengan jenis UpdatePaymentScheduleTerms perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdatePaymentScheduleTerms perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdatePaymentScheduleTerms tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdatePaymentScheduleTerms tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Memodifikasi opsi perpanjangan

Anda dapat menggunakan API Katalog untuk mengontrol opsi perpanjangan perjanjian yang dibuat menggunakan penawaran ini diAWS Marketplace.

Untuk penawaran yang dibuat melalui API Katalog, perpanjangan otomatis tetap dinonaktifkan secara default hingga Anda memanggil jenis UpdateRenewalTerms perubahan untuk mengizinkan perpanjangan otomatis. Perubahan ini tidak mempengaruhi perjanjian yang ada.

Untuk mengontrol opsi perpanjangan perjanjian yang dibuat menggunakan penawaran ini, panggil operasi StartChangeSet API dengan jenis UpdateRenewalTerms perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis UpdateRenewalTerms perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateRenewalTerms tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateRenewalTerms tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk detail selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Publikasikan penawaran

Anda dapat menggunakan API Katalog untuk menggabungkan informasi yang dikumpulkan dari semua jenis perubahan pembaruan, lalu mempublikasikan penawaran.

Penawaran tetap dalam Draft keadaan, sampai ReleaseOffer dipanggil. Setelah penawaran dirilis, itu dapat ditemukan di. AWS Marketplace

Untuk memublikasikan penawaran Anda, panggil operasi StartChangeSet API dengan jenis ReleaseOffer perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "ReleaseOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis ReleaseOffer perubahan:

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

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

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu beberapa menit.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk ReleaseOffer tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Kesalahan Asinkron

Kesalahan berikut khusus untuk ReleaseOffer tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Jelaskan detail penawaran yang ada

Anda dapat menggunakan API Katalog untuk menjelaskan detail penawaran yang ada diAWS Marketplace.

Untuk menjelaskan detail penawaran yang ada, panggil operasi DescribeEntity API dengan tipe Offer@1.0 entitas, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

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

Berikan informasi untuk bidang untuk menambahkan jenis DescribeEntity perubahan:

Sintaks Respon

Tanggapan atas permintaan ini memberi Anda detail penawaran dan terlihat seperti berikut ini.

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

Berikut ini adalah informasi tentang bidang yang Anda lihat dalam DescribeEntity respons.