Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
ApplicationId Aplikasi
URI
/applications/
applicationId
Metode HTTP
GET
ID Operasi: GetApplication
Mendapat aplikasi yang ditentukan.
Nama | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
applicationId | String | True | Amazon Resource Name (ARN) aplikasi. |
Nama | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
semanticVersion | String | False | Versi semantik aplikasi untuk mendapatkan. |
Kode status | Model respons | Deskripsi |
---|---|---|
200 | Application | Berhasil |
400 | BadRequestException | Salah satu parameter dalam permintaan tidak valid. |
403 | ForbiddenException | Klien tidak diautentikasi. |
404 | NotFoundException | Sumber daya (misalnya, pernyataan kebijakan akses) yang ditentukan dalam permintaan tidak ada. |
429 | TooManyRequestsException | Klien mengirim lebih dari jumlah permintaan yang diizinkan per unit waktu. |
500 | InternalServerErrorException | AWS Serverless Application Repository Layanan mengalami kesalahan internal. |
DELETE
ID Operasi: DeleteApplication
Menghapus aplikasi yang ditentukan.
Nama | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
applicationId | String | True | Amazon Resource Name (ARN) aplikasi. |
Kode status | Model respons | Deskripsi |
---|---|---|
204 | Tidak ada | Berhasil |
400 | BadRequestException | Salah satu parameter dalam permintaan tidak valid. |
403 | ForbiddenException | Klien tidak diautentikasi. |
404 | NotFoundException | Sumber daya (misalnya, pernyataan kebijakan akses) yang ditentukan dalam permintaan tidak ada. |
409 | ConflictException | Sumber daya sudah ada. |
429 | TooManyRequestsException | Klien mengirim lebih dari jumlah permintaan yang diizinkan per unit waktu. |
500 | InternalServerErrorException | AWS Serverless Application Repository Layanan mengalami kesalahan internal. |
OPTIONS
Nama | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
applicationId | String | True | Amazon Resource Name (ARN) aplikasi. |
Kode status | Model respons | Deskripsi |
---|---|---|
200 | Tidak ada | 200 respon |
PATCH
ID Operasi: UpdateApplication
Memperbarui aplikasi yang ditentukan.
Nama | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
applicationId | String | True | Amazon Resource Name (ARN) aplikasi. |
Kode status | Model respons | Deskripsi |
---|---|---|
200 | Application | Berhasil |
400 | BadRequestException | Salah satu parameter dalam permintaan tidak valid. |
403 | ForbiddenException | Klien tidak diautentikasi. |
404 | NotFoundException | Sumber daya (misalnya, pernyataan kebijakan akses) yang ditentukan dalam permintaan tidak ada. |
409 | ConflictException | Sumber daya sudah ada. |
429 | TooManyRequestsException | Klien mengirim lebih dari jumlah permintaan yang diizinkan per unit waktu. |
500 | InternalServerErrorException | AWS Serverless Application Repository Layanan mengalami kesalahan internal. |
Skema
Permintaan badan
{ "description": "string", "author": "string", "readmeBody": "string", "readmeUrl": "string", "labels": [ "string" ], "homePageUrl": "string" }
Badan respons
{ "applicationId": "string", "name": "string", "description": "string", "author": "string", "isVerifiedAuthor": boolean, "verifiedAuthorUrl": "string", "spdxLicenseId": "string", "licenseUrl": "string", "readmeUrl": "string", "labels": [ "string" ], "creationTime": "string", "homePageUrl": "string", "version": { "applicationId": "string", "semanticVersion": "string", "sourceCodeUrl": "string", "sourceCodeArchiveUrl": "string", "templateUrl": "string", "creationTime": "string", "parameterDefinitions": [ { "name": "string", "defaultValue": "string", "description": "string", "type": "string", "noEcho": boolean, "allowedPattern": "string", "constraintDescription": "string", "minValue": integer, "maxValue": integer, "minLength": integer, "maxLength": integer, "allowedValues": [ "string" ], "referencedByResources": [ "string" ] } ], "requiredCapabilities": [ enum ], "resourcesSupported": boolean } }
Properti
Application
Detail tentang aplikasi.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
applicationId | string | True | Aplikasi Amazon Resource Name (ARN). |
author | string | True | Nama penulis yang menerbitkan aplikasi. Panjang minimum=1. Panjang maksimum=127. Pola “^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? $”; |
creationTime | string | False | Tanggal dan waktu sumber daya ini dibuat. |
description | string | True | Deskripsi aplikasi. Panjang minimum=1. Panjang maksimum = 256 |
homePageUrl | string | False | URL dengan informasi lebih lanjut tentang aplikasi, misalnya lokasi GitHub repositori Anda untuk aplikasi. |
isVerifiedAuthor | boolean | False | Menentukan apakah penulis aplikasi ini telah diverifikasi. Ini berarti bahwa AWS telah melakukan tinjauan itikad baik, sebagai penyedia layanan yang masuk akal dan bijaksana, atas informasi yang diberikan oleh pemohon dan telah mengkonfirmasi bahwa identitas pemohon adalah seperti yang diklaim. |
labels | Array tipe string | False | Label untuk meningkatkan penemuan aplikasi di hasil penelusuran. Panjang minimum=1. Panjang maksimum=127. Jumlah label maksimum: 10 Pola: “^ [A-za-Z0-9+\\ -_:\\ /@] +$”; |
licenseUrl | string | False | Tautan ke file lisensi aplikasi yang cocok dengan nilai SPDXLicenseId aplikasi Anda. Ukuran maksimal 5 MB |
name | string | True | Nama aplikasi. Panjang minimum=1. Panjang maksimum = 140 Pola: “[A-za-Z0-9\\ -] +”; |
readmeUrl | string | False | Tautan ke file readme dalam bahasa Markdown yang berisi deskripsi aplikasi yang lebih rinci dan cara kerjanya. Ukuran maksimal 5 MB |
spdxLicenseId | string | False | Pengidentifikasi yang valid dari https://spdx.org/licenses/. |
verifiedAuthorUrl | string | False | URL ke profil publik penulis terverifikasi. URL ini dikirimkan oleh penulis. |
version | False | Informasi versi tentang aplikasi. |
BadRequestException
Salah satu parameter dalam permintaan tidak valid.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
errorCode | string | False | 400 |
message | string | False | Salah satu parameter dalam permintaan tidak valid. |
Capability
Nilai yang harus ditentukan untuk menyebarkan beberapa aplikasi.
CAPABILITY_IAM
CAPABILITY_NAMED_IAM
CAPABILITY_AUTO_EXPAND
CAPABILITY_RESOURCE_POLICY
ConflictException
Sumber daya sudah ada.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
errorCode | string | False | 409 |
message | string | False | Sumber daya sudah ada. |
ForbiddenException
Klien tidak diautentikasi.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
errorCode | string | False | 403 |
message | string | False | Klien tidak diautentikasi. |
InternalServerErrorException
AWS Serverless Application Repository Layanan mengalami kesalahan internal.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
errorCode | string | False | 500 |
message | string | False | AWS Serverless Application Repository Layanan mengalami kesalahan internal. |
NotFoundException
Sumber daya (misalnya, pernyataan kebijakan akses) yang ditentukan dalam permintaan tidak ada.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
errorCode | string | False | 404 |
message | string | False | Sumber daya (misalnya, pernyataan kebijakan akses) yang ditentukan dalam permintaan tidak ada. |
ParameterDefinition
Parameter yang didukung oleh aplikasi.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
allowedPattern | string | False | Suatu ekspresi reguler yang mewakili pola untuk memungkinkan |
allowedValues | Array tipe string | False | Array yang berisi daftar nilai yang diizinkan untuk parameter. |
constraintDescription | string | False | Suatu string yang menjelaskan kendala ketika ia dilanggar. Sebagai contoh, tanpa deskripsi kendala, parameter yang memiliki pola yang diizinkan
Dengan menambahkan deskripsi kendala, seperti “harus berisi hanya huruf besar dan kecil dan angka,” Anda dapat menampilkan pesan kesalahan yang disesuaikan berikut:
|
defaultValue | string | False | Nilai tipe yang sesuai untuk templat untuk digunakan jika tidak ada nilai yang ditentukan ketika tumpukan dibuat. Jika Anda menentukan kendala untuk parameter, Anda harus menentukan nilai yang mematuhi kendala tersebut. |
description | string | False | Sebuah string hingga 4.000 karakter yang menggambarkan parameter. |
maxLength | integer | False | Nilai integer yang menentukan jumlah karakter terbesar yang ingin Anda izinkan untuk |
maxValue | integer | False | Nilai numerik yang menentukan nilai numerik terbesar yang ingin Anda izinkan untuk |
minLength | integer | False | Nilai integer yang menentukan jumlah karakter terkecil yang ingin Anda izinkan untuk |
minValue | integer | False | Nilai numerik yang menentukan nilai numerik terkecil yang ingin Anda izinkan untuk |
name | string | True | Nama parameter. |
noEcho | boolean | False | Apakah akan menutupi nilai parameter setiap kali ada yang membuat panggilan yang menjelaskan tumpukan. Jika Anda menetapkan nilai ke true, nilai parameter ditutupi dengan tanda bintang (*****). |
referencedByResources | Array tipe string | True | Daftar AWS SAM sumber daya yang menggunakan parameter ini. |
type | string | False | Jenis parameter. Nilai yang valid: Misalnya, pengguna dapat menentukan Misalnya, pengguna mungkin menentukan Misalnya, pengguna mungkin menentukan “80,20", dan kemudian Misalnya, pengguna mungkin menentukan “test, dev, prod”, dan kemudian |
TooManyRequestsException
Klien mengirim lebih dari jumlah permintaan yang diizinkan per unit waktu.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
errorCode | string | False | 429 |
message | string | False | Klien mengirim lebih dari jumlah permintaan yang diizinkan per unit waktu. |
UpdateApplicationInput
Perbarui permintaan aplikasi.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
author | string | False | Nama penulis yang menerbitkan aplikasi. Panjang minimum=1. Panjang maksimum=127. Pola “^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? $”; |
description | string | False | Deskripsi aplikasi. Panjang minimum=1. Panjang maksimum = 256 |
homePageUrl | string | False | URL dengan informasi lebih lanjut tentang aplikasi, misalnya lokasi GitHub repositori Anda untuk aplikasi. |
labels | Array tipe string | False | Label untuk meningkatkan penemuan aplikasi di hasil penelusuran. Panjang minimum=1. Panjang maksimum=127. Jumlah label maksimum: 10 Pola: “^ [A-za-Z0-9+\\ -_:\\ /@] +$”; |
readmeBody | string | False | File readme teks dalam bahasa Markdown yang berisi deskripsi aplikasi yang lebih rinci dan cara kerjanya. Ukuran maksimal 5 MB |
readmeUrl | string | False | Tautan ke file readme dalam bahasa Markdown yang berisi deskripsi aplikasi yang lebih rinci dan cara kerjanya. Ukuran maksimal 5 MB |
Version
Detail versi aplikasi.
Properti | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
applicationId | string | True | Aplikasi Amazon Resource Name (ARN). |
creationTime | string | True | Tanggal dan waktu sumber daya ini dibuat. |
parameterDefinitions | Array tipe ParameterDefinition | True | Array tipe parameter yang didukung oleh aplikasi. |
requiredCapabilities | Array tipe Capability | True | Daftar nilai yang harus Anda tentukan sebelum Anda dapat menyebarkan aplikasi tertentu. Beberapa aplikasi mungkin menyertakan sumber daya yang dapat memengaruhi izin di AWS akun Anda, misalnya, dengan membuat pengguna new AWS Identity and Access Management (IAM). Untuk aplikasi tersebut, Anda harus secara eksplisit mengakui kemampuannya dengan menentukan parameter ini. Satu-satunya nilai yang valid adalah Sumber daya berikut mengharuskan Anda untuk menentukan Sumber daya berikut mengharuskan Anda untuk menentukan Aplikasi yang berisi satu atau lebih aplikasi bersarang mengharuskan Anda untuk menentukan Jika template aplikasi Anda berisi salah satu sumber daya di atas, kami sarankan Anda meninjau semua izin yang terkait dengan aplikasi sebelum menerapkan. Jika Anda tidak menentukan parameter ini untuk aplikasi yang membutuhkan kemampuan, panggilan akan gagal. |
resourcesSupported | boolean | True | Apakah semua sumber AWS daya yang terkandung dalam aplikasi ini didukung di wilayah di mana ia sedang diambil. |
semanticVersion | string | True | Versi semantik aplikasi: |
sourceCodeArchiveUrl | string | False | Tautan ke objek S3 yang berisi arsip ZIP dari kode sumber untuk versi aplikasi Anda ini. Ukuran maksimal 50 MB |
sourceCodeUrl | string | False | Tautan ke repositori publik untuk kode sumber aplikasi Anda, misalnya URL dari komit tertentu GitHub . |
templateUrl | string | True | Sebuah link ke AWS SAM template paket aplikasi Anda. |
Lihat juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs dan referensi, lihat berikut ini: