Applications - AWS Serverless Application Repository
URIMetode HTTPSkemaPropertiLihat juga

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

Applications

URI

/applications

Metode HTTP

GET

ID Operasi: ListApplications

Daftar aplikasi yang dimiliki oleh pemohon.

Parameter kueri
NamaJenisDiperlukanDeskripsi
maxItemsStringFalse

Jumlah total item yang akan dikembalikan.

nextTokenStringFalse

Token untuk menentukan di mana harus memulai paginating.

Respons
Kode statusModel responsDeskripsi
200ApplicationPage

Berhasil

400BadRequestException

Salah satu parameter dalam permintaan tidak valid.

403ForbiddenException

Klien tidak diautentikasi.

404NotFoundException

Sumber daya (misalnya, pernyataan kebijakan akses) yang ditentukan dalam permintaan tidak ada.

500InternalServerErrorException

AWS Serverless Application Repository Layanan mengalami kesalahan internal.

POST

ID Operasi: CreateApplication

Membuat aplikasi, secara opsional termasuk file AWS SAM untuk membuat versi aplikasi pertama dalam panggilan yang sama.

Respons
Kode statusModel responsDeskripsi
201Application

Berhasil

400BadRequestException

Salah satu parameter dalam permintaan tidak valid.

403ForbiddenException

Klien tidak diautentikasi.

409ConflictException

Sumber daya sudah ada.

429TooManyRequestsException

Klien mengirim lebih dari jumlah permintaan yang diizinkan per unit waktu.

500InternalServerErrorException

AWS Serverless Application Repository Layanan mengalami kesalahan internal.

OPTIONS

Respons
Kode statusModel responsDeskripsi
200Tidak ada

200 respon

Skema

Permintaan badan

{
  "name": "string",
  "description": "string",
  "author": "string",
  "spdxLicenseId": "string",
  "licenseBody": "string",
  "licenseUrl": "string",
  "readmeBody": "string",
  "readmeUrl": "string",
  "labels": [
    "string"
  ],
  "homePageUrl": "string",
  "semanticVersion": "string",
  "templateBody": "string",
  "templateUrl": "string",
  "sourceCodeUrl": "string",
  "sourceCodeArchiveUrl": "string"
}

Badan respons

{
  "applications": [
    {
      "applicationId": "string",
      "name": "string",
      "description": "string",
      "author": "string",
      "spdxLicenseId": "string",
      "labels": [
        "string"
      ],
      "creationTime": "string",
      "homePageUrl": "string"
    }
  ],
  "nextToken": "string"
}
{
  "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
  }
}
{
  "message": "string",
  "errorCode": "string"
}
{
  "message": "string",
  "errorCode": "string"
}
{
  "message": "string",
  "errorCode": "string"
}
{
  "message": "string",
  "errorCode": "string"
}
{
  "message": "string",
  "errorCode": "string"
}
{
  "message": "string",
  "errorCode": "string"
}

Properti

Application

Detail tentang aplikasi.

PropertiTipeDiperlukanDeskripsi
applicationId

string

True

Aplikasi Amazon Resource Name (ARN).

author

string

True

Nama penulis 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

Versi

False

Informasi versi tentang aplikasi.

ApplicationPage

Daftar detail aplikasi.

PropertiTipeDiperlukanDeskripsi
applications

Array tipe ApplicationSummary

True

Sebuah array ringkasan aplikasi.

nextToken

string

False

Token untuk meminta halaman hasil berikutnya.

ApplicationSummary

Ringkasan detail tentang aplikasi.

PropertiTipeDiperlukanDeskripsi
applicationId

string

True

Aplikasi Amazon Resource Name (ARN).

author

string

True

Nama penulis 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.

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+\\ -_:\\ /@] +$”;

name

string

True

Nama aplikasi.

Panjang minimum=1. Panjang maksimum = 140

Pola: “[A-za-Z0-9\\ -] +”;

spdxLicenseId

string

False

Pengidentifikasi yang valid dari https://spdx.org/licenses/.

BadRequestException

Salah satu parameter dalam permintaan tidak valid.

PropertiTipeDiperlukanDeskripsi
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.

PropertiTipeDiperlukanDeskripsi
errorCode

string

False

409

message

string

False

Sumber daya sudah ada.

CreateApplicationInput

Buat permintaan aplikasi.

PropertiTipeDiperlukanDeskripsi
author

string

True

Nama penulis menerbitkan aplikasi.

Panjang minimum=1. Panjang maksimum=127.

Pola “^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? $”;

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.

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+\\ -_:\\ /@] +$”;

licenseBody

string

False

File teks lokal yang berisi lisensi aplikasi yang cocok dengan nilai SPDXLicenseId aplikasi Anda. File tersebut memiliki formatfile://<path>/<filename>.

Ukuran maksimal 5 MB

Anda dapat menentukan hanya satu dari licenseBody danlicenseUrl; jika tidak, hasil kesalahan.

licenseUrl

string

False

Tautan ke objek S3 yang berisi lisensi aplikasi yang cocok dengan nilai SPDXLicenseId aplikasi Anda.

Ukuran maksimal 5 MB

Anda dapat menentukan hanya satu dari licenseBody danlicenseUrl; jika tidak, hasil kesalahan.

name

string

True

Nama aplikasi yang ingin Anda terbitkan.

Panjang minimum=1. Panjang maksimum = 140

Pola: “[A-za-Z0-9\\ -] +”;

readmeBody

string

False

File readme teks lokal dalam bahasa Markdown yang berisi deskripsi aplikasi yang lebih rinci dan cara kerjanya. File tersebut memiliki formatfile://<path>/<filename>.

Ukuran maksimal 5 MB

Anda dapat menentukan hanya satu dari readmeBody danreadmeUrl; jika tidak, hasil kesalahan.

readmeUrl

string

False

Tautan ke objek S3 dalam bahasa Markdown yang berisi deskripsi aplikasi yang lebih rinci dan cara kerjanya.

Ukuran maksimal 5 MB

Anda dapat menentukan hanya satu dari readmeBody danreadmeUrl; jika tidak, hasil kesalahan.

semanticVersion

string

False

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 dari komit tertentu GitHub .

spdxLicenseId

string

False

Pengidentifikasi yang valid dari https://spdx.org/licenses/.

templateBody

string

False

File AWS SAM template paket mentah lokal dari aplikasi Anda. File tersebut memiliki formatfile://<path>/<filename>.

Anda dapat menentukan hanya satu dari templateBody dantemplateUrl; jika tidak, hasil kesalahan.

templateUrl

string

False

Sebuah link ke objek S3 yang berisi AWS SAM template paket aplikasi Anda.

Anda dapat menentukan hanya satu dari templateBody dantemplateUrl; jika tidak, hasil kesalahan.

ForbiddenException

Klien tidak diautentikasi.

PropertiTipeDiperlukanDeskripsi
errorCode

string

False

403

message

string

False

Klien tidak diautentikasi.

InternalServerErrorException

AWS Serverless Application Repository Layanan mengalami kesalahan internal.

PropertiTipeDiperlukanDeskripsi
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.

PropertiTipeDiperlukanDeskripsi
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.

PropertiTipeDiperlukanDeskripsi
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 “harus berisi hanya huruf besar dan 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

Sebuah string hingga 4.000 karakter yang menggambarkan parameter.

maxLength

integer

False

Nilai integer yang menentukan jumlah karakter terbesar yang ingin Anda izinkan untuk String tipe.

maxValue

integer

False

Nilai numerik yang menentukan nilai numerik terbesar yang ingin Anda izinkan untuk Number tipe.

minLength

integer

False

Nilai integer yang menentukan jumlah karakter terkecil yang ingin Anda izinkan untuk String tipe.

minValue

integer

False

Nilai numerik yang menentukan nilai numerik terkecil yang ingin Anda izinkan untuk Number tipe.

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 di template Anda (misalnya, dengan menggunakan fungsi Ref intrinsik), nilai parameter menjadi string.

Misalnya, pengguna mungkin menentukan"8888".

List<Number>: Sebuah array bilangan bulat atau float yang dipisahkan oleh koma. AWS CloudFormation memvalidasi nilai parameter sebagai angka. Namun, ketika Anda menggunakan parameter di tempat lain di template Anda (misalnya, dengan menggunakan fungsi Ref intrinsik), nilai parameter menjadi daftar string.

Misalnya, pengguna mungkin menentukan “80,20", dan kemudian Ref menghasilkan. ["80","20"]

CommaDelimitedList: Sebuah array string literal yang dipisahkan oleh koma. Jumlah total string harus satu lebih dari jumlah koma. Juga, setiap string anggota dipangkas spasi.

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.

PropertiTipeDiperlukanDeskripsi
errorCode

string

False

429

message

string

False

Klien mengirim lebih dari jumlah permintaan yang diizinkan per unit waktu.

Version

Detail versi aplikasi.

PropertiTipeDiperlukanDeskripsi
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 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 sumber daya IAM dengan nama khusus, 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 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:

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 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:

ListApplications

CreateApplication