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.

Kontrol akses untukAWS MarketplaceAPI Katalog

Anda dapat menggunakan AWS Marketplace Catalog API untuk mengelola produk penjual di AWS Marketplace atau pengalaman di pasar pribadi. Namun, pertama-tama pastikan pengguna atau peran Anda dapat mengakses fungsionalitas API yang ingin Anda panggil.

Gunakan AWS Identity and Access Management (IAM) untuk membuat pengguna dan peran serta menetapkan kebijakan yang memberikan izin terbatas kepada pengguna akhir. Kebijakan menentukan tindakan yang dapat diambil pengguna atau peran terhadap sumber daya Anda melaluiAWS Marketplace Catalog API.

Misalnya, Anda dapat menentukan peran seperti teknik, pemasaran, dan penetapan harga. Kemudian, Anda dapat menambahkan pengguna di organisasi Anda ke peran teknik. Dalam peran itu, mereka mungkin diberikan izin untuk memulai permintaan perubahan untuk mempublikasikan versi baru produk penjual Anda. Namun, peran teknik tidak memungkinkan pengguna untuk membuat daftar semua set perubahan.

Anda dapat menggunakan kebijakan AWS terkelola, atau Anda dapat membuat kebijakan IAM Anda sendiri untuk memiliki kontrol yang lebih terperinci daripada yang tersedia dalam kebijakan AWS terkelola. Untuk detail tentang pendekatan ini, lihat topik berikut.

Mengizinkan tindakan denganAWSkebijakan terkelola

Anda dapat menggunakan kebijakan yang dikelola oleh AWS untuk memberikan izin kepada pengguna atau peran Anda.

Untuk bekerja dengan produk yang Anda jualAWS Marketplace, Anda dapat menggunakan kebijakan terkelola AWSMarketplaceSellerFullAccess IAM, yang memiliki akses penuh ke AWS Marketplace Catalog API selain izin lainnya. Anda dapat memberikan akses hanya-baca untuk API Katalog dengan kebijakan tersebut. AWSMarketplaceSellerProductsReadOnly Untuk informasi selengkapnya, lihat Mengontrol akses ke Portal Manajemen AWS Marketplace, Kebijakan, dan izin untuk AWS Marketplace penjual, dan kebijakan terkelola AWS untuk AWS Marketplace penjual di Panduan AWS Marketplace Penjual.

Untuk mengelola pasar pribadi, Anda dapat menggunakan kebijakan terkelola AWSPrivateMarketplaceAdminFullAccess IAM, yang memiliki akses penuh untuk membuat dan mengedit pasar pribadi untuk akun atau AWS organisasi Anda. Untuk informasi selengkapnya, lihat Mengontrol akses ke AWS Marketplace langganan, Membuat administrator pasar pribadi, dan kebijakan terkelola AWS untuk AWS Marketplace pembeli di Panduan AWS Marketplace Pembeli.

Atau, Anda dapat membuat kebijakan IAM Anda sendiri untuk memiliki kontrol yang lebih terperinci daripada yang tersedia dalam kebijakan AWS terkelola. Gunakan topik berikut untuk membuat kebijakan IAM Anda sendiri.

Mengizinkan tindakan pada semua sumber daya

Sumber daya adalah objek yang dapat ditindaklanjuti oleh tindakan. Tidak semua jenis sumber daya dapat ditentukan dengan setiap tindakan. Beberapa jenis sumber daya hanya berfungsi dengan tindakan tertentu. Untuk informasi selengkapnya, lihat Kunci tindakan, sumber daya, dan kondisi untuk AWS Marketplace Katalog dalam Referensi Otorisasi Layanan.

Ada dua jenis sumber daya di API Katalog:

Untuk mengizinkan pengguna atau peran izin untuk membuat perubahan pada semua entitas dalam sebuahAkun AWS, Anda dapat menambahkan kebijakan IAM berikut. Dengan kebijakan ini, pengguna atau peran dapat menggunakan StartChangeSet tindakan pada semua sumber daya ("*").

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:StartChangeSet"
      ],
      "Resource": "*"
    }
  ]
}

Untuk informasi tentang semua tindakan yang tersedia untuk API Katalog, lihat Tindakan, sumber daya, dan kunci kondisi untuk AWS Marketplace Katalog di Referensi Otorisasi Layanan.

Mengizinkan tindakan pada sumber daya tertentu

Alih-alih mengizinkan perubahan pada semua sumber daya, Anda dapat menggunakan izin tingkat sumber daya untuk mengizinkan perubahan pada sumber daya tertentu.

Misalnya, Anda dapat mengizinkan perubahan pada produk penjual tertentu di Akun AWS alih-alih ke semua produk penjual. Anda melakukan ini dengan menentukan Nama Sumber Daya Amazon (ARN) dari produk penjual dalam kebijakan Resource IAM.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:StartChangeSet"
      ],
      "Resource": [
        "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example1-abcd-1234-5ef6-7890abcdef12",
        "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/*"
      ]
    }
  ]
}

Sebagai contoh lain, Anda dapat mengizinkan perubahan pada pengalaman tertentu di pasar pribadi, bukan untuk semua pengalaman. Anda melakukan ini dengan menentukan ARN pengalaman dalam kebijakan Resource IAM.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:StartChangeSet"
      ],
      "Resource": [
        "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Experience/exp-example12345",
        "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/*"
      ]
    }
  ]
}

Mengizinkan tindakan dengan spesifik ChangeType kunci kondisi

Tindakan API Katalog StartChangeSet memiliki beberapa jenis perubahan yang berbeda. Anda dapat mengizinkan akses hanya ke jenis perubahan tertentu.

Misalnya, Anda mungkin hanya ingin mengizinkan perubahan pada metadata produk penjual, seperti judul produk, dan tidak mengizinkan penambahan versi produk baru. Dalam contoh ini, jenis perubahan UpdateInformation memungkinkan mengubah metadata produk penjual, termasuk judul. Untuk informasi selengkapnya tentang berbagai jenis perubahan, lihat Bekerja dengan produk penjual dan Bekerja dengan pasar pribadi di AWS Marketplace Catalog APIReferensi.

Untuk membatasi tindakan ke satu atau beberapa jenis perubahan, tentukan tombol kondisi. ChangeType Dalam contoh berikut kebijakan IAM, operator kondisi StringEquals menentukan bahwa tindakan hanya diperbolehkan jika cocok. ChangeType UpdateInformation Untuk informasi selengkapnya tentang kunci kondisi, lihat Operator kondisi di Panduan Pengguna AWS Identity and Access Management.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:StartChangeSet"
      ],
      "Resource": [
        "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example1-abcd-1234-5ef6-7890abcdef12",
        "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/*"
      ],
      "Condition": {
        "StringEquals": {
          "catalog:ChangeType": "UpdateInformation"
        }
      }
    }
  ]
}

Mengizinkan tindakan dengan spesifik aws: ResourceTag kunci kondisi

Anda dapat mengizinkan tindakan pada sekelompok entitas tanpa harus terus memperbarui kebijakan dan menentukan daftar ARN entitas yang mungkin terus bertambah. Anda dapat melakukan ini dengan penandaan sumber daya. Menambahkan tag ke sumber daya memungkinkan Anda mengontrol akses ke sumber daya tersebut berdasarkan tag mereka. Misalnya, Anda mungkin ingin mengizinkan mendeskripsikan sekelompok produk penjual tanpa menentukan ARN individu untuk setiap produk penjual.

Misalnya, kebijakan IAM berikut memungkinkan DescribeEntity tindakan pada setiap resource entitas ("*") yang memiliki kunci tag product-team dan nilai tag dariteam-xyz.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:DescribeEntity"
      ],
      "Resource": "*",
      "Condition": {
        "StringEquals": {
          "aws:ResourceTag/product-team": "team-xyz"
        }
      }
    }
  ]
}

Anda juga dapat mengizinkan mendeskripsikan dan membatalkan set perubahan yang dibuat dengan tag tertentu.

Misalnya, kebijakan IAM berikut memungkinkan DescribeChangeSet dan CancelChangeSet tindakan pada setiap perubahan set resource ("*") yang memiliki kunci tag product-team dan nilai team-xyz tag.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:DescribeChangeSet",
        "aws-marketplace:CancelChangeSet"
      ],
      "Resource": "*",
      "Condition": {
        "StringEquals": {
          "aws:ResourceTag/product-team": "team-xyz"
        }
      }
    }
  ]
}

Selain itu, Anda dapat mengizinkan set perubahan awal pada entitas hanya jika entitas tersebut memiliki tag tertentu. Misalnya, Anda dapat mengizinkan perubahan pada produk penjual dengan tag tertentu.

Misalnya, kebijakan IAM berikut memungkinkan StartChangeSet tindakan pada setiap resource entitas ("*") yang memiliki kunci tag product-team dan nilai tag dariteam-xyz. Selain itu, TagResource tindakan diperlukan sehingga ketika set perubahan dibuat, itu ditandai dengan kunci tag dan nilai yang sama.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:StartChangeSet",
        "aws-marketplace:TagResource"
      ],
      "Resource": "*",
      "Condition": {
        "StringEquals": {
          "aws:ResourceTag/product-team": "team-xyz"
        }
      }
    }
  ]
}

Membuat peran IAM khusus

Pelanggan yang ingin menggunakan Otorisasi Penjualan Kembali ChangeType atau CPPO ChangeType perlu membuat peran kustom AWS Identity and Access Management (IAM). Ini akan mendukung pembuatan siklus hidup produk Otorisasi Penjualan Kembali.

Mengelola tag pada sumber daya

Anda dapat menambahkan, membuat daftar, dan menghapus tag dari entitas yang ada atau mengubah set.

Menambahkan tanda ke sumber daya

Untuk menambahkan tag ke entitas atau set perubahan, gunakan tindakan TagResource API.

Permintaan

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

{
  "Catalog": "AWSMarketplace",
  "ResourceArn": "string",
  "Tags": [
    {
      "Key": "string",
      "Value": "string"
    }
    ...
  ]
}

Parameter permintaan meliputi:

Respons

{}

Hapus tag dari sumber daya

Untuk menghapus tag atau daftar tag dari entitas atau set perubahan, gunakan tindakan UntagResource API.

Permintaan

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

{
  "Catalog": "AWSMarketplace",
  "ResourceArn": "string",
  "TagKeys": [
    "string"
    ...
  ]
}

Parameter permintaan meliputi:

Respons

{}

Daftar semua tag pada sumber daya

Untuk mencantumkan semua tag yang telah ditambahkan dan belum dihapus dari kumpulan perubahan atau entitas, gunakan tindakan ListTagsForResource API.

Permintaan

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

{
  "Catalog": "AWSMarketplace",
  "ResourceArn": "string"
}

Parameter permintaan meliputi:

Respons

{
  "ResourceArn": "string",
  "Tags": [
    {
      "Key": "string",
      "Value": "string"
    }
    ...
  ]
}

Mengelola tag saat meminta perubahan pada sumber daya

Anda dapat menambahkan tag saat entitas atau set perubahan dibuat.

Contoh: Menambahkan tag ke set perubahan saat membuat set perubahan

Berikut ini adalah contoh StartChangeSet permintaan yang memperbarui metadata produk untuk produk penjual. Permintaan ini menambahkan tag ke set perubahan yang dibuat dengan permintaan ini dengan menyertakan tag di ChangeSetTags properti.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [ 
    { 
      "ChangeType":"UpdateInformation",
      "Entity": {
        "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
        "Type":"AmiProduct@1.0"
      },
      "Details": "{\"ProductTitle\":\"My updated title\"}"
    }
  ],
  "ChangeSetTags": [
    {
      "Key": "product-team",
      "Value": "team-xyz"
    }
  ]
}

Untuk informasi selengkapnya tentang mengelola produk penjual, lihat Bekerja dengan produk penjual di AWS Marketplace Catalog APIReferensi.

Contoh: Menambahkan tag ke entitas dan mengubah set selama pembuatan

Berikut ini adalah contoh StartChangeSet permintaan yang menciptakan entitas pengalaman pasar pribadi. Permintaan menambahkan tag ke sumber daya entitas dan mengubah sumber daya set yang dibuat dengan permintaan ini dengan menyertakan tag dalam ChangeSetTags properti EntityTags dan. Dengan tag ini, kebijakan izin pengguna atau peran dapat ditentukan untuk hanya mengizinkan mendeskripsikan atau membatalkan set perubahan yang dibuat permintaan ini atau hanya mengizinkan pembuatan set perubahan lebih lanjut pada entitas yang dibuat permintaan ini. Untuk informasi selengkapnya, lihat Memberikan izin untuk membuat entitas dan mengubah set hanya dengan tag.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [ 
    { 
      "ChangeType": "CreateExperience",
      "Entity": { 
        "Type": "Experience@1.0"
      },
      "Details": "{\"Name\": \"ExamplePrivateMarketplace\"}",
      "EntityTags": [
        {
          "Key": "product-team",
          "Value": "team-xyz"
        }
      ]
    }
  ],
  "ChangeSetTags": [
    {
      "Key": "product-team",
      "Value": "team-xyz"
    }
  ]
}

Untuk informasi selengkapnya tentang mengelola pasar pribadi, lihat Bekerja dengan pasar pribadi di AWS Marketplace Catalog APIReferensi.

Memberikan izin untuk mengelola tag pada sumber daya

Untuk mengizinkan pengguna atau peran menambahkan, menghapus, dan mencantumkan tag pada semua entitas atau set perubahan, mereka memerlukan kebijakan IAM berikut.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:TagResource",
        "aws-marketplace:UntagResource",
        "aws-marketplace:ListTagsForResource"
      ],
      "Resource": "*"
    }
  ]
}

Memberikan izin untuk mengelola tag pada sumber daya hanya jika sumber daya tersebut memiliki tag tertentu

Anda dapat mengizinkan pengguna atau peran untuk menambahkan, menghapus, dan mencantumkan tag pada entitas atau mengubah set yang memiliki tag tertentu. Kebijakan IAM berikut memungkinkan tindakan tersebut pada setiap resource entitas ("*") yang memiliki kunci tag product-team dan nilai tag dari. team-xyz

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:TagResource",
        "aws-marketplace:UntagResource",
        "aws-marketplace:ListTagsForResource"
      ],
      "Resource": "*",
      "Condition": {
        "StringEquals": {
          "aws:ResourceTag/product-team": "team-xyz"
        }
      }
    }
  ]
}

Memberikan izin untuk membuat entitas dan mengubah set hanya dengan tag

Anda dapat menerapkan penandaan saat entitas atau set perubahan dibuat. Tambahkan kebijakan berikut untuk mengizinkan StartChangeSet dan TagResource tindakan, dengan kondisi yang menentukan kecocokan kunci tag product-team dan nilai tag cocokteam-xyz. Kondisi kebijakan ini harus cocok dengan tag pada entitas yang baru dibuat dan tag pada set perubahan yang baru dibuat yang dihasilkan dari permintaan pembuatan. Untuk contoh penandaan entitas pada pembuatan, lihatContoh: Menambahkan tag ke entitas dan mengubah set selama pembuatan.

Untuk entitas yang ada, kebijakan ini juga memberlakukan set perubahan penandaan saat meminta perubahan pada entitas tersebut. Ini juga mengharuskan entitas yang ada memiliki tag yang ada ini. Ini karena kondisi kebijakan harus cocok dengan tag pada entitas yang ada dan set perubahan yang baru dibuat yang dihasilkan dari permintaan perubahan. Untuk contoh menambahkan tag untuk mengubah permintaan, lihatContoh: Menambahkan tag ke set perubahan saat membuat set perubahan.

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "aws-marketplace:StartChangeSet",
        "aws-marketplace:TagResource"
      ],
      "Resource": "*",
      "Condition": {
        "StringEquals": {
          "aws:ResourceTag/product-team": "team-xyz"
        }
      }
    }
  ]
}