Aplikasi ApplicationID

URI

/applications/applicationId

Metode HTTP

GET

ID Operasi: GetApplication

Mendapat aplikasi yang ditentukan.

Parameter

Nama	Tipe	Diperlukan	Deskripsi
applicationId	String	True	Amazon Resource Name (ARN) aplikasi.

Parameter kueri

Nama	Tipe	Diperlukan	Deskripsi
semanticVersion	String	False	Versi semantik aplikasi untuk mendapatkan.

Respons

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.

Parameter

Nama	Tipe	Diperlukan	Deskripsi
applicationId	String	True	Amazon Resource Name (ARN) aplikasi.

Respons

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

Parameter

Nama	Tipe	Diperlukan	Deskripsi
applicationId	String	True	Amazon Resource Name (ARN) aplikasi.

Respons

Kode status	Model Respons	Deskripsi
200	Tidak ada	200 Respons

PATCH

ID Operasi: UpdateApplication

Memperbarui aplikasi yang ditentukan.

Parameter

Nama	Tipe	Diperlukan	Deskripsi
applicationId	String	True	Amazon Resource Name (ARN) aplikasi.

Respons

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

Catatan Permintaan

PATCHSkema

{
  "description": "string",
  "author": "string",
  "readmeBody": "string",
  "readmeUrl": "string",
  "labels": [
    "string"
  ],
  "homePageUrl": "string"
}

Badan respons

ApplicationSkema

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

BadRequestExceptionSkema

{
  "message": "string",
  "errorCode": "string"
}

ForbiddenExceptionSkema

{
  "message": "string",
  "errorCode": "string"
}

NotFoundExceptionSkema

{
  "message": "string",
  "errorCode": "string"
}

ConflictExceptionSkema

{
  "message": "string",
  "errorCode": "string"
}

TooManyRequestsExceptionSkema

{
  "message": "string",
  "errorCode": "string"
}

InternalServerErrorExceptionSkema

{
  "message": "string",
  "errorCode": "string"
}

Properti

Application

Detail tentang aplikasi.

Properti	Tipe	Diperlukan	Deskripsi
applicationId	string	True	Amazon Resource Name (ARN) aplikasi.
author	string	True	Nama penulis yang memublikasikan aplikasi. Panjang minimum=1. Panjang maksimum=127. Pola “^ [a-z0-9] () ^ [a-z0-9] ^ [a-z0-9] ^ [a-z0-9] (- 9] ^ [a-z0-9]) Pola -)) * [a-z0-9])? $”;
creationTime	string	False	Tanggal dan waktu saat sebuah sumber dibuat.
description	string	True	Deskripsi aplikasi. Panjang minimum=1. Panjang maksimum=256
homePageUrl	string	False	URL dengan informasi selengkapnya 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 dalam hasil pencarian. Panjang minimum=1. Panjang maksimum=127. Jumlah maksimum label: 10 Pola: “^ [a-zA-Z0-9+\\ -_:\\ /@] +$”;
licenseUrl	string	False	Tautan ke file lisensi aplikasi yang cocok dengan nilai spdxLicenseID aplikasi Anda. Ukuran maksimum 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 lebih detail tentang aplikasi dan cara kerjanya. Ukuran maksimum 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	Versi	False	Versi informasi 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 String tipe.
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 [A-Za-z0-9]+ menampilkan pesan kesalahan berikut ketika pengguna menentukan nilai yang tidak valid: Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+ Dengan menambahkan deskripsi kendala, seperti “hanya boleh berisi huruf besar dan huruf kecil dan angka,” Anda dapat menampilkan pesan kesalahan yang disesuaikan berikut: Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.
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	String hingga 4.000 karakter yang menggambarkan parameter.
maxLength	integer	False	Nilai integer yang menentukan jumlah karakter terbesar dengan String tipe yang ingin Anda izinkan.
maxValue	integer	False	Nilai numerik yang menentukan nilai numerik terbesar dengan Number tipe yang ingin Anda izinkan. Number
minLength	integer	False	Nilai integer yang menentukan jumlah karakter terbesar dengan String tipe yang ingin Anda izinkan.
minValue	integer	False	Nilai numerik yang menentukan nilai numerik terkecil dengan tipe yang ingin Anda izinkan. Number
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: String | Number | List<Number> | CommaDelimitedList String: Sebuah string literal. Misalnya, pengguna dapat menentukan"MyUserName". Number: Sebuah integer atau float. AWS CloudFormation memvalidasi nilai parameter sebagai angka. Namun, ketika Anda menggunakan parameter di tempat lain dalam templat Anda (misalnya, dengan menggunakan fungsi Ref intrinsik), nilai parameter menjadi string. Misalnya, pengguna mungkin menentukan"8888". List<Number>Array bilangan bulat atau pelampung yang dipisahkan dengan koma. AWS CloudFormation memvalidasi nilai parameter sebagai angka. Namun, ketika Anda menggunakan parameter di tempat lain dalam templat Anda (misalnya, dengan menggunakan fungsi Ref intrinsik), nilai parameter menjadi daftar string. Misalnya, pengguna mungkin menentukan “80,20", dan kemudian Ref menghasilkan. ["80","20"] CommaDelimitedListArray string literal yang dipisahkan dengan koma. Jumlah total string harus satu lebih dari jumlah koma. Juga, setiap string anggota dipangkas ruang. Misalnya, pengguna mungkin menentukan “test, dev, prod”, dan kemudian Ref menghasilkan. ["test","dev","prod"]

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 memublikasikan aplikasi. Panjang minimum=1. Panjang maksimum=127. Pola “^ [a-z0-9] () ^ [a-z0-9] ^ [a-z0-9] ^ [a-z0-9] (- 9] ^ [a-z0-9]) Pola -)) * [a-z0-9])? $”;
description	string	False	Deskripsi aplikasi. Panjang minimum=1. Panjang maksimum=256
homePageUrl	string	False	URL dengan informasi selengkapnya tentang aplikasi, misalnya lokasi GitHub repositori Anda untuk aplikasi.
labels	Array tipe string	False	Label untuk meningkatkan penemuan aplikasi dalam hasil pencarian. Panjang minimum=1. Panjang maksimum=127. Jumlah maksimum label: 10 Pola: “^ [a-zA-Z0-9+\\ -_:\\ /@] +$”;
readmeBody	string	False	File readme teks dalam bahasa Markdown yang berisi deskripsi lebih detail tentang aplikasi dan cara kerjanya. Ukuran maksimum 5 MB
readmeUrl	string	False	Tautan ke file readme dalam bahasa Markdown yang berisi deskripsi lebih detail tentang aplikasi dan cara kerjanya. Ukuran maksimum 5 MB

Version

Detail versi aplikasi.

Properti	Tipe	Diperlukan	Deskripsi
applicationId	string	True	Amazon Resource Name (ARN) aplikasi.
creationTime	string	True	Tanggal dan waktu saat sebuah sumber 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 menerapkan aplikasi tertentu. Beberapa aplikasi boleh menyertakan sumber daya yang dapat memengaruhi izin di AWS akun, misalnya, dengan membuat pengguna AWS Identity and Access Management (IAM) baru. Untuk aplikasi-aplikasi tersebut, Anda harus secara eksplisit menerima kemampuannya dengan menentukan parameter ini. Satu-satunya nilai yang valid adalahCAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_RESOURCE_POLICY, danCAPABILITY_AUTO_EXPAND. Sumber daya berikut mengharuskan Anda untuk menentukan CAPABILITY_IAM atauCAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, dan AWS::IAM::Role. Jika aplikasi berisi sumber daya IAM, Anda dapat menentukan salah satu CAPABILITY_IAM atauCAPABILITY_NAMED_IAM. Jika aplikasi berisi nama kustom, Anda harus menentukanCAPABILITY_NAMED_IAM. Sumber daya berikut mengharuskan Anda untuk menentukanCAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS: :iam:policy,, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicydan. AWS::SQS::QueuePolicyAWS::SNS::TopicPolicy Aplikasi yang berisi satu atau lebih aplikasi bersarang mengharuskan Anda untuk menentukanCAPABILITY_AUTO_EXPAND. Jika templat aplikasi berisi sumber daya di atas, sebaiknya 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: https://semver.org/
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 komit tertentu GitHub .
templateUrl	string	True	Sebuah link ke AWS SAM template paket aplikasi Anda.

Lihat juga

Untuk informasi selengkapnya tentang penggunaan API di salah satu bahasa spesifik bahasa AWS SDKs dan referensi, lihat berikut ini:

GetApplication

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK untuk V3 JavaScript

• AWS SDK untuk Kotlin

• AWS SDK for PHP V3

• AWS SDK untuk Python

• AWS SDK for Ruby V3

DeleteApplication

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK untuk V3 JavaScript

• AWS SDK untuk Kotlin

• AWS SDK for PHP V3

• AWS SDK untuk Python

• AWS SDK for Ruby V3

UpdateApplication

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK untuk V3 JavaScript

• AWS SDK untuk Kotlin

• AWS SDK for PHP V3

• AWS SDK untuk Python

• AWS SDK for Ruby V3