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 pasar pribadi menggunakanAWS MarketplaceAPI

Anda dapat menggunakan AWS Marketplace Catalog API untuk mengelola pasar pribadi untuk Anda Akun AWS atau organisasi.

Semua jenis perubahan hanya dapat dipanggil dari akun manajemen organisasi atau oleh akun anggota yang merupakan administrator yang didelegasikan untuk pasar pribadi. Jika Anda adalah pelanggan pasar pribadi saat ini tanpa AWS Organizations integrasi untuk pasar pribadi, Anda dapat membuat dan mengelola pasar pribadi dari akun mana pun di organisasi Anda yang memiliki kebijakan AWSPrivateMarketplaceAdminFullAccess IAM.

Untuk informasi selengkapnya tentang pasar pribadi, lihat Pasar pribadi di Panduan AWS Marketplace Pembeli.

Tabel berikut merinci serangkaian tugas untuk mengelola pasar pribadi dan jenis perubahan yang berlaku untuk setiap tugas.

Menciptakan pasar pribadi

Pasar pribadi untuk sebuah Akun AWS dapat dianggap sebagai daftar produk yang diizinkan pengguna untuk membeli di akun itu, dan branding untuk pasar. Dalam organisasi dengan beberapa akun, Anda dapat menggunakan pengelompokan dari unit organisasi (OU) yang AWS Organizations disebut untuk mengasosiasikan pengalaman. Misalnya, Anda dapat memiliki satu set produk yang diizinkan untuk dibeli oleh semua akun di organisasi, atau Anda dapat memiliki daftar produk yang berbeda untuk setiap OU dalam organisasi. Anda juga dapat memiliki daftar produk yang berbeda untuk akun individual di organisasi. Setiap daftar produk dan branding yang disetujui disebut pengalaman pengadaan.

DalamAWS Marketplace Catalog API, empat entitas mewakili pengalaman:

Langkah-langkah untuk menciptakan pengalaman pengadaan adalah sebagai berikut:

Buat Experience entitas

Untuk membuat Experience entitas, gunakan StartChangeSet tindakan dengan CreateExperience nilai untuk ChangeType parameter untuk meminta pengalaman dibuat olehAWS Marketplace. Lihat contoh kode berikut.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateExperience",
      "DetailsDocument":
      {
        "Name": "ExamplePrivateMarketplace"
      },
      "Entity":
      {
        "Type": "Experience@1.0"
      }
    }
  ],
  "ChangeSetName": "Create Private Marketplace Example"
}

Dalam tindakan ini, Entity adalah template untuk entitas yang ingin Anda buat. Itu ditugaskan EntityId ketika dibuat. ChangeSetNamemengidentifikasi perubahan untuk membantu Anda menemukannya nanti.

Respon tersebut terlihat seperti berikut.

{
   "ChangeSetArn": "arn:...:AWSMarketplace/ChangeSet/abcd1234example5678frjzkz",
   "ChangeSetId": "abcd1234example5678frjzkz"
}

Respons termasuk ChangeSetId yang dapat Anda gunakan untuk mendapatkan status permintaan perubahan Anda saat diprosesDescribeChangeSet. Anda juga dapat menggunakan ListEntities untuk menemukan Experience entitas Anda tanpaChangeSetId. Untuk informasi selengkapnya tentang set perubahan, lihatBekerja dengan set perubahan.

ExperienceEntitas yang baru dibuat tidak memiliki kebijakan pengadaan secara default. Itu juga dibuat dengan pengaturan default untuk branding. Untuk informasi selengkapnya tentang setelan merek, termasuk cara menyesuaikannya, lihatMengubah branding pengalaman pasar pribadi.

Buat ProcurementPolicy entitas

Anda harus membuat ProcurementPolicy entitas. Secara default, Experience entitas baru dinonaktifkan, sehingga Anda dapat membuat kebijakan pengadaan sebelum mengaktifkannya.

Untuk mengizinkan dan menolak produk di pasar pribadi Anda, Anda harus membuat kebijakan pengadaan. Untuk melakukan ini, Anda menelepon lagiStartChangeSet, tetapi kali ini dengan ChangeType dariCreateProcurementPolicy. Contoh kode berikut membuat kebijakan pengadaan kosong.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateProcurementPolicy",
      "DetailsDocument":
      {
        "Name": "ExampleProcurementPolicy"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@1"
      }
    }
  ]
}

Yang Entity Anda berikan dalam tindakan ini adalah Experience entitas yang Anda inginkan kebijakan pengadaan dibuat di dalamnya, jadi Anda harus menyertakan pengenal untuk entitas yang Anda buat sebelumnya. Gunakan ListEntities untuk menemukan Experience entitas. Anda juga dapat mengembalikan pengenal DescribeChangeSet dengan menggunakan pengenal set perubahan dari tindakan CreateExperience

Anda dapat kembali menggunakan DescribeChangeSet pada jenis CreateProcurementPolicy perubahan untuk mengikuti pemrosesan permintaan Anda.

Setelah Anda membuat kebijakan pengadaan, pasar pribadi Anda ditampilkan di. AWS Management Console (Anda dapat pergi ke halaman Private Marketplace untuk melihatnya.) Setelah Anda menyelesaikan langkah-langkah ini, pasar pribadi Anda akan dinonaktifkan, memiliki merek default, memiliki kebijakan pengadaan kosong, dan tidak akan dikaitkan dengan prinsip apa pun di organisasi Anda. Anda dapat memperbarui branding dan menambahkan produk apa pun yang Anda inginkan di dalamnya, mengaitkan pengalaman dengan satu atau lebih akun, dan kemudian mengaktifkan pasar pribadi Anda.

Bagian berikut menjelaskan mengelola pasar pribadi Anda dengan. AWS Marketplace Catalog API

Mengubah branding pengalaman pasar pribadi

Anda dapat menyesuaikan tampilan pasar pribadi Anda untuk pengguna Anda. Tanpa kustomisasi, pasar pribadi Anda akan memiliki pengaturan branding default, yang dijelaskan di bawah ini. Aspek branding yang dapat Anda ubah di pasar pribadi meliputi:

Untuk mengatur nilai-nilai ini, Anda harus terlebih dahulu membuat BrandingSettings entitas dengan jenis CreateBrandingSettings perubahan. Anda kemudian dapat meminta UpdateBrandingSettings perubahan untuk mengatur atau mengubah merek. Anda hanya perlu membuat BrandingSettings objek sekali. Untuk membuat objek ini, panggil StartChangeSet dengan jenis CreateBrandingSettings perubahan, seperti yang ditunjukkan dalam contoh kode berikut.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateBrandingSettings",
      "DetailsDocument":
      {
        "Name": "ExampleBrandingSettingsName"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@2"
      }
    }
  ]
}

Contoh ini memodifikasi Experience entitas dengan menambahkan BrandingSettings objek ke dalamnya. Revisi pengenal entitas telah meningkat menjadi. 2 Untuk informasi selengkapnya tentang revisi untuk pengidentifikasi, lihat. Pengidentifikasi

Anda mengubah pengaturan dengan memanggil StartChangeSet dengan jenis UpdateBrandingSettings perubahan. Pengaturan adalah bagian Configuration dari DetailsDocument objek.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateBrandingSettings",
      "DetailsDocument":
      {
        "Name": "ExampleBrandingSettingsName",
        "Description": "Example description",
        "Configuration":
        {
          "Title": "ExampleName",
          "Information": "Example description.",
          "ThemeColor": "#0e7f74",
          "LogoUrl": "https://example.com/path/mylogo.png"
        }
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@3"
      }
    }
  ]
}

Mengaktifkan atau menonaktifkan pengalaman pasar pribadi

Ketika pasar pribadi diaktifkan (dan memiliki kebijakan pengadaan), pengguna di akun terkait hanya dapat membeli produk yang telah Anda setujui. Jika tidak ada pengalaman pasar pribadi yang diaktifkan untuk akun, pengguna dapat membeli produk di seluruh AWS Marketplace katalog lengkap.

Untuk mengaktifkan pasar pribadi, gunakan StartChangeRequest tindakan dengan jenis UpdateExperience perubahan.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateExperience",
      "DetailsDocument":
      {
        "Status": "Enabled"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@4"
      }
    }
  ]
}

Demikian pula, Anda dapat menggunakan tindakan yang sama danChangeType, tetapi ubah DetailsDocument ke Disabled untuk menonaktifkan pasar pribadi. Status

Mengaktifkan atau menonaktifkan permintaan pengguna

Pengguna di organisasi Anda dapat melihat publik penuhAWS Marketplace, tetapi mereka hanya dapat berlangganan produk yang Anda izinkan. Secara default, mereka dapat meminta agar produk yang tidak ada di pasar pribadi ditambahkan ke dalamnya. Permintaan ini muncul di halaman administrator pasar pribadi (Private Marketplace), di mana Anda dapat memutuskan apakah akan menerima atau menolak permintaan (dan apakah akan memblokir permintaan lebih lanjut untuk produk yang sama). Anda tidak dapat melihat atau menanggapi permintaan dengan menggunakan API Katalog.

Anda dapat mengaktifkan atau menonaktifkan kemampuan pengguna untuk membuat permintaan untuk pengalaman pasar pribadi Anda. Gunakan StartChangeSet dengan tipe UpdateProcurementPolicy perubahan. Kemampuan untuk membuat permintaan dinonaktifkan dalam contoh kode berikut.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateProcurementPolicy",
      "DetailsDocument":
      {
        "Configuration":
        {
          "PolicyResourceRequests": "Deny"
        }
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@5"
      }
    }
  ]
}

Untuk mengaktifkan kemampuan permintaan perubahan bagi pengguna, gunakan Allow alih-alih Deny inPolicyResourceRequests.

Untuk mempelajari cara mendapatkan status saat ini dari pengaturan ini, lihat bagian selanjutnya,Mendapatkan daftar produk dalam pengalaman pasar pribadi.

Mendapatkan daftar produk dalam pengalaman pasar pribadi

Produk yang diizinkan (dan ditolak) di pasar swasta adalah bagian dari kebijakan pengadaan di Experience entitas. Untuk mendapatkan rincian tentang kebijakan pengadaan di pasar pribadi, pertama-tama Anda mendapatkan pengidentifikasi kebijakan pengadaan dari Experience entitas, dan kemudian menelepon dengan pengenal itu. DescribeEntity

Untuk mendapatkan pengenal kebijakan pengadaan, gunakan DescribeEntity pada Experience entitas yang Anda minati, seperti yang ditunjukkan pada perintah berikut.

GET /DescribeEntity?catalog=AWSMarketplace&entityId=exp-example01

Berikut adalah respons contohnya:

{
  "Details": "{\"Name\":\"New Private Marketplace\", \"Status\":\"Enabled\", \"ProcurementPolicies\":[\"procpolicy-123example456\"], \"BrandingSettings\":[\"brandsettings-456example123\"]}",
  "DetailsDocument":
  {
    "Name": "New Private Marketplace",
    "Status": "Enabled",
    "ProcurementPolicies":
    [
      "procpolicy-123example456"
    ],
    "BrandingSettings":
    [
      "brandsettings-456example123"
    ]
  },
  "EntityArn": "arn:<...>:AWSMarketplace/Experience/exp-example-01",
  "EntityIdentifier": "exp-example01@6",
  "EntityType": "Experience@1.0",
  "LastModifiedDate": "2021-01-13T20:31:36Z"
}

Anda dapat menggunakan pengembalian EntityId untuk kebijakan pengadaan untuk mendapatkan detailnya, seperti yang ditunjukkan pada perintah berikut.

GET /DescribeEntity?catalog=AWSMarketplace&entityId=procpolicy-123example456

Ini mengembalikan rincian lengkap kebijakan, termasuk produk yang diizinkan dan ditolak. Berikut adalah respons contohnya:

{
  "Details": "{\"Name\":\"ExampleProcurementPolicy\", \"Statements\":[{\"Effect\":\"Allow\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example1-1234-abcd-5678-90abcdef1234\"]},{\"Type\":\"Product\",\"Ids\":[\"example2-2345-bcde-6789-01bcdea2345\"]}]},{\"Effect\":\"Deny\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example3-3456-cdef-7890-12defabc5678\"]}]}],\"Configuration\":{\"PolicyResourceRequests\":\"Allow\"}}",
  "DetailsDocument":
  {
    "Name": "ExampleProcurementPolicy",
    "Statements":
    [
      {
        "Effect": "Allow",
        "Resources":
        [
          {
            "Type": "Product",
            "Ids":
            [
              "example1-1234-abcd-5678-90abcdef1234"
            ]
          },
          {
            "Type": "Product",
            "Ids":
            [
              "example2-2345-bcde-6789-01bcdea2345"
            ]
          }
        ]
      },
      {
        "Effect": "Deny",
        "Resources":
        [
          {
            "Type": "Product",
            "Ids":
            [
              "example3-3456-cdef-7890-12defabc5678"
            ]
          }
        ]
      }
    ],
    "Configuration":
    {
      "PolicyResourceRequests": "Allow"
    }
  },
  "EntityArn": "arn:<...>AWSMarketplace/ProcurementPolicy/procpolicy-123example456",
  "EntityIdentifier": "procpolicy-123example456@4",
  "EntityType": "ProcurementPolicy@1.0",
  "LastModifiedDate": "2020-10-01T12:00:00Z"
}

Dalam contoh ini, kebijakan pengadaan memiliki dua produk yang diizinkan dan satu produk yang ditolak. Kebijakan ini memungkinkan permintaan sumber daya pengguna.

Menambahkan atau menghapus produk dari pasar pribadi

Secara default, pasar pribadi tidak memiliki produk yang disetujui di dalamnya. Gunakan permintaan perubahan untuk menambah atau menghapus produk. Untuk menambahkan produk, gunakan jenis AllowProductProcurement perubahan. Untuk menghapus produk, gunakan jenis DenyProductProcurement perubahan.

Contoh kode berikut menunjukkan jenis AllowProductProcurement perubahan dengan StartChangeSet tindakan untuk menambahkan produk ke pasar pribadi.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AllowProductProcurement",
      "DetailsDocument":
      {
        "Products":
        [
          {
            "Ids":
            [
              "example-1234-abcd-5678-90abcded1234"
            ],
            "Notes": "Useful product"
          }
        ]
      },
      "Entity":
      {
        "Identifier": "exp-1234example@6",
        "Type": "Experience@1.0"
      }
    }
  ]
}

Anda menambahkan produk ke Experience entitas untuk pasar pribadi dengan menggunakanAllowProductProcurement. Sintaks untuk menghapus produk dari pasar pribadi identik, dengan pengecualian bahwa Anda menggunakan DenyProductProcurement ChangeType bukannya. AllowProductProcurement Produk ditambahkan ke daftar izinkan (atau tolak) ProcurementPolicy entitas yang terkandung oleh Experience entitas Anda.

Menemukan produk

Dengan mendapatkan rincian kebijakan pengadaan Anda, Anda dapat menemukan ID produk untuk produk yang sudah ada di pasar pribadi. Namun, AWS Marketplace Catalog API tidak menyediakan cara untuk menemukan ID produk untuk produk lain. Ada dua cara untuk mendapatkan ID produk untuk digunakan dengan layanan API Katalog:

Bekerja dengan pasar pribadi untukAWS Organizations

Apakah Anda bekerja dengan pasar pribadi untuk akun Anda atau organisasi Anda, Anda menggunakan API yang sama. Namun, ada perbedaan saat bekerja di dalam organisasi Anda:

Untuk membuat daftar Experience objek di akun Anda sendiri, panggil ListEntities seperti yang ditunjukkan pada contoh kode berikut.

POST /ListEntities HTTP/1.1
Content-Type: application/json

{
    "Catalog":"AWSMarketplace", 
    "EntityType":"Experience"
}

Namun, untuk mencantumkan entitas yang telah dibagikan dengan Anda, Anda harus menambahkan FilterList dengan Scope dariSharedWithMe, seperti yang ditunjukkan pada contoh kode berikut. Akibatnya, AWS Marketplace cari di luar akun Anda sendiri untuk menemukan entitas yang dibagikan dengan Anda.

POST /ListEntities HTTP/1.1
Content-Type: application/json

{"Catalog":"AWSMarketplace", 
"EntityType":"Experience",
 "FilterList": 
  [{
     "Name": "Scope",
     "ValueList":
      ["SharedWithMe"]
      }]}

Dalam hal ini, hanya entitas di luar akun Anda (yang untuk organisasi Anda) yang dikembalikan.

Demikian pula, untuk memanggilListChangeSets, Anda harus mengatur ruang lingkup, seperti yang ditunjukkan dalam contoh kode berikut.

POST /ListChangeSets HTTP/1.1
Content-Type: application/json

{"Catalog":"AWSMarketplace", 
 "FilterList": 
  [{
     "Name": "Scope",
     "ValueList":
      ["SharedWithMe"]
      }]}

Ini mengembalikan set perubahan yang berlaku untuk pasar pribadi bersama untuk organisasi Anda.

Mengaitkan kepala sekolah dengan pengalaman

Pengalaman pasar pribadi harus memiliki satu atau lebih prinsip yang terkait dengannya untuk memiliki efek apa pun dalam organisasi Anda. Untuk satuAkun AWS, Anda harus mengaitkan akun dengan pengalaman untuk menggunakan pasar pribadi. Dalam suatu organisasi, Anda dapat memiliki banyak pengalaman yang berlaku untuk prinsip yang berbeda.

Untuk mengaitkan prinsipal ke pengalaman, gunakan jenis AssociateAudience perubahan dengan StartChangeSet tindakan, seperti yang ditunjukkan pada contoh kode berikut.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-example01@1"
      },
      "ChangeType": "AssociateAudience",
      "DetailsDocument":
      {
        "Name": "AudienceName",
        "Description": "Audience example.",
        "Principals":
        [
          "012345678901",
          "ou-abcd-01234567",
          "o-0123456789"
        ]
      }
    }
  ],
  "ChangeSetName": "Set Audience for experience 01"
}

Penonton adalah daftar kepala sekolah yang terkait dengan. Experience Prinsipal adalahAkun AWS, unit organisasi, atau organisasi yang ditentukan oleh ID-nya. Principalsadalah daftar, sehingga Anda dapat menyertakan beberapa prinsip untuk dikaitkan dengan pengalaman. Setelah panggilan pertama, panggilan berikutnya ke jenis AssociateAudience perubahan akan menambahkan prinsip ke asosiasi untuk pengalaman tersebut.

Anda juga dapat menghapus akun dari pengalaman. Gunakan jenis DisassociateAudience perubahan untuk melakukan ini, seperti yang ditunjukkan pada contoh kode berikut.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-example01@02"
      },
      "ChangeType": "DisassociateAudience",
      "DetailsDocument":
      {
        "Principals":
        [
          "012345678901",
          "ou-abcd-01234567",
          "o-0123456789"
        ]
      }
    }
  ],
  "ChangeSetName": "Disassociate audience example"
}

Mengarsipkan dan mengaktifkan kembali pengalaman pasar pribadi

Anda dapat menghapus pengalaman pasar pribadi dengan mengarsipkannya. Pengalaman yang diarsipkan tidak dapat diperbarui atau digunakan untuk mengatur akun di organisasi Anda. Jika Anda memiliki audiens yang terkait dengan pengalaman yang diarsipkan, Anda dapat mengaitkannya dengan pengalaman yang berbeda. Jika Anda memutuskan untuk menggunakan pengalaman di lain waktu, Anda selalu dapat mengaktifkannya kembali. Administrator dari akun manajemen atau akun anggota yang merupakan administrator yang didelegasikan untuk pasar pribadi memiliki izin untuk mengarsipkan dan mengaktifkan kembali pengalaman. Jika Anda adalah pelanggan pasar pribadi saat ini tanpa AWS Organizations integrasi untuk pasar pribadi, administrator dari akun yang menciptakan pengalaman memiliki izin untuk mengarsipkan dan mengaktifkan kembali pengalaman.

Untuk mengarsipkan pengalaman, gunakan jenis RestrictExperience perubahan dengan StartChangeSet tindakan, seperti yang ditunjukkan dalam contoh kode berikut.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictExperience",
      "DetailsDocument":
      {},
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example"
      }
    }
  ]
}

Untuk mengaktifkan kembali pengalaman, gunakan jenis ReviveExperience perubahan dengan StartChangeSet tindakan, seperti yang ditunjukkan pada contoh kode berikut.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReviveExperience",
      "DetailsDocument":
      {},
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example"
      }
    }
  ]
}

Kesalahan di API pasar pribadi

Kesalahan berikut khusus untuk tindakan pasar pribadi di API AWS Marketplace Katalog.

Jenis entitas yang ditentukan oleh pasar pribadi

Tabel berikut mencantumkan jenis, tujuan, dan tindakan entitas pasar pribadi yang masing-masing dapat ditentukan. Setiap jenis entitas dapat digunakan untuk menentukan sumber daya Amazon Resource Name (ARN) yang dapat digunakan dalam kebijakan AWS Identity and Access Management (IAM). Untuk detail lebih lanjut tentang format ARN, lihat. Entitas API Katalog