Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Applicazioni
URI
/applications
Metodi HTTP
GET
ID dell'operazione: ListApplications
Elenca le applicazioni di proprietà del richiedente.
| Nome | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
maxItems | Stringa | False | Il numero totale di articoli da restituire. |
nextToken | Stringa | False | Token per specificare dove iniziare l'impaginazione. |
| Codice di stato | Modello di risposta | Description |
|---|---|---|
200 | ApplicationPage | Completato |
400 | BadRequestException | Uno dei parametri della richiesta non è valido. |
403 | ForbiddenException | Il cliente non è autenticato. |
404 | NotFoundException | La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste. |
500 | InternalServerErrorException | Il AWS Serverless Application Repository servizio ha riscontrato un errore interno. |
POST
ID dell'operazione: CreateApplication
Crea un'applicazione, includendo facoltativamente un file AWS SAM per creare la prima versione dell'applicazione nella stessa chiamata.
| Codice di stato | Modello di risposta | Description |
|---|---|---|
201 | Application | Completato |
400 | BadRequestException | Uno dei parametri della richiesta non è valido. |
403 | ForbiddenException | Il client non è autenticato. |
409 | ConflictException | La risorsa esiste già. |
429 | TooManyRequestsException | Il client invia un numero di richieste superiore a quello consentito per unità di tempo. |
500 | InternalServerErrorException | Il AWS Serverless Application Repository servizio ha riscontrato un errore interno. |
OPTIONS
| Codice di stato | Modello di risposta | Description |
|---|---|---|
200 | Nessuno | Risposta 200 |
Schemi
Corpi della richiesta
{ "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" }
Corpi della risposta
{ "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 } }
Properties
Applicazione
Dettagli sull'applicazione.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
applicationId | stringa | True | L'applicazione Amazon Resource Name (ARN). |
author | stringa | True | Il nome dell'autore che pubblica l'app. Lunghezza minima = 1. Lunghezza massima = 127. Schema «^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? «$»; |
creationTime | stringa | False | La data e l'ora di creazione di questa risorsa. |
description | stringa | True | Descrizione dell'applicazione. Lunghezza minima = 1. Lunghezza massima=256 |
homePageUrl | stringa | False | Un URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del GitHub repository per l'applicazione. |
isVerifiedAuthor | booleano | False | Specifica se l'autore di questa applicazione è stato verificato. Ciò significa che AWS ha esaminato in buona fede, in qualità di fornitore di servizi ragionevole e prudente, le informazioni fornite dal richiedente e ha confermato che l'identità del richiedente è quella dichiarata. |
labels | Array di tipo string | False | Etichette per migliorare la scoperta delle app nei risultati di ricerca. Lunghezza minima = 1. Lunghezza massima = 127. Numero massimo di etichette: 10 Motivo: «^ [a-z A-Z0-9 +\\ -_:\\ /@] +$»; |
licenseUrl | stringa | False | Un collegamento a un file di licenza dell'app che corrisponde al valore spdxLicenseID dell'applicazione. Dimensione massima 5 MB |
name | stringa | True | Il nome dell'applicazione. Lunghezza minima = 1. Lunghezza massima=140 Motivo: «[a-zA-Z0-9\\ -] +»; |
readmeUrl | stringa | False | Un collegamento al file readme in linguaggio Markdown che contiene una descrizione più dettagliata dell'applicazione e del suo funzionamento. Dimensione massima 5 MB |
spdxLicenseId | stringa | False | Un identificatore valido da https://spdx.org/licenses/. |
verifiedAuthorUrl | stringa | False | L'URL del profilo pubblico di un autore verificato. Questo URL è inviato dall'autore. |
version | False | Informazioni sulla versione dell'applicazione. |
ApplicationPage
Un elenco di dettagli dell'applicazione.
| Proprietà | Tipo | Campo obbligatorio | Description |
|---|---|---|---|
applications | Array di tipo ApplicationSummary | True | Una serie di riepiloghi delle applicazioni. |
nextToken | stringa | False | Il token per richiedere la pagina successiva dei risultati. |
ApplicationSummary
Riepilogo dei dettagli sull'applicazione.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
applicationId | stringa | True | L'applicazione Amazon Resource Name (ARN). |
author | stringa | True | Il nome dell'autore che pubblica l'app. Lunghezza minima = 1. Lunghezza massima = 127. Schema «^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? «$»; |
creationTime | stringa | False | La data e l'ora di creazione di questa risorsa. |
description | stringa | True | Descrizione dell'applicazione. Lunghezza minima = 1. Lunghezza massima=256 |
homePageUrl | stringa | False | Un URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del GitHub repository per l'applicazione. |
labels | Array di tipo string | False | Etichette per migliorare la scoperta delle app nei risultati di ricerca. Lunghezza minima = 1. Lunghezza massima = 127. Numero massimo di etichette: 10 Motivo: «^ [a-z A-Z0-9 +\\ -_:\\ /@] +$»; |
name | stringa | True | Il nome dell'applicazione. Lunghezza minima = 1. Lunghezza massima=140 Motivo: «[a-zA-Z0-9\\ -] +»; |
spdxLicenseId | stringa | False | Un identificatore valido da. https://spdx.org/licenses/ |
BadRequestException
Uno dei parametri della richiesta non è valido.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
errorCode | stringa | False | 400 |
message | stringa | False | Uno dei parametri della richiesta non è valido. |
Funzionalità
Valori che devono essere specificati per distribuire alcune applicazioni.
CAPABILITY_IAMCAPABILITY_NAMED_IAMCAPABILITY_AUTO_EXPANDCAPABILITY_RESOURCE_POLICY
ConflictException
La risorsa esiste già.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
errorCode | stringa | False | 409 |
message | stringa | False | La risorsa esiste già. |
CreateApplicationInput
Crea una richiesta di applicazione.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
author | stringa | True | Il nome dell'autore che pubblica l'app. Lunghezza minima = 1. Lunghezza massima = 127. Schema «^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? «$»; |
description | stringa | True | Descrizione dell'applicazione. Lunghezza minima = 1. Lunghezza massima=256 |
homePageUrl | stringa | False | Un URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del GitHub repository per l'applicazione. |
labels | Array di tipo string | False | Etichette per migliorare la scoperta delle app nei risultati di ricerca. Lunghezza minima = 1. Lunghezza massima = 127. Numero massimo di etichette: 10 Motivo: «^ [a-z A-Z0-9 +\\ -_:\\ /@] +$»; |
licenseBody | stringa | False | Un file di testo locale che contiene la licenza dell'app che corrisponde al valore spdxLicenseID dell'applicazione. Il file ha il formato. Dimensione massima 5 MB È possibile specificare solo uno tra |
licenseUrl | stringa | False | Un collegamento all'oggetto S3 che contiene la licenza dell'app che corrisponde al valore spdxLicenseID dell'applicazione. Dimensione massima 5 MB È possibile specificare solo uno tra |
name | stringa | True | Il nome dell'applicazione che si desidera pubblicare. Lunghezza minima = 1. Lunghezza massima=140 Motivo: «[a-zA-Z0-9\\ -] +»; |
readmeBody | stringa | False | Un file readme di testo locale in linguaggio Markdown che contiene una descrizione più dettagliata dell'applicazione e del suo funzionamento. Il file ha il formato. Dimensione massima 5 MB È possibile specificare solo uno tra |
readmeUrl | stringa | False | Un collegamento all'oggetto S3 in linguaggio Markdown che contiene una descrizione più dettagliata dell'applicazione e del suo funzionamento. Dimensione massima 5 MB È possibile specificare solo uno tra |
semanticVersion | stringa | False | La versione semantica dell'applicazione: |
sourceCodeArchiveUrl | stringa | False | Un link all'oggetto S3 che contiene l'archivio ZIP del codice sorgente per questa versione dell'applicazione. Dimensione massima 50 MB |
sourceCodeUrl | stringa | False | Un collegamento a un archivio pubblico per il codice sorgente dell'applicazione, ad esempio l'URL di un GitHub commit specifico. |
spdxLicenseId | stringa | False | Un identificatore valido da. https://spdx.org/licenses/ |
templateBody | stringa | False | Il file AWS SAM modello non elaborato locale dell'applicazione. Il file ha il formato È possibile specificare solo uno tra |
templateUrl | stringa | False | Un link all'oggetto S3 contenente il AWS SAM modello impacchettato dell'applicazione. È possibile specificare solo uno tra |
ForbiddenException
Il client non è autenticato.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
errorCode | stringa | False | 403 |
message | stringa | False | Il client non è autenticato. |
InternalServerErrorException
Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
errorCode | stringa | False | 500 |
message | stringa | False | Il AWS Serverless Application Repository servizio ha riscontrato un errore interno. |
NotFoundException
La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
errorCode | stringa | False | 404 |
message | stringa | False | La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste. |
ParameterDefinition
Parametri supportati dall'applicazione.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
allowedPattern | stringa | False | Espressione regolare che rappresenta i modelli da consentire per i tipi |
allowedValues | Array di tipo string | False | Matrice contenente l’elenco dei valori consentiti per il parametro. |
constraintDescription | stringa | False | Stringa che illustra un vincolo in caso di violazione del vincolo. Ad esempio, senza una descrizione del vincolo, un parametro associato al modello consentito
Aggiungendo una descrizione del vincolo, ad esempio «deve contenere solo lettere e numeri maiuscoli e minuscoli», è possibile visualizzare il seguente messaggio di errore personalizzato:
|
defaultValue | stringa | False | Valore del tipo appropriato per il modello da utilizzare se non viene specificato alcun valore al momento della creazione di uno stack. Se per il parametro definisci vincoli, devi specificare un valore conforme a tali vincoli. |
description | stringa | False | Una stringa composta da un massimo di 4.000 caratteri che descrive il parametro. |
maxLength | intero | False | Un valore intero che determina il numero massimo di caratteri che si desidera consentire per |
maxValue | intero | False | Un valore numerico che determina il valore numerico massimo che si desidera consentire per i tipi. |
minLength | intero | False | Un valore intero che determina il numero minimo di caratteri che si desidera consentire per i tipi. |
minValue | intero | False | Un valore numerico che determina il valore numerico più piccolo che si desidera consentire per i tipi. |
name | stringa | True | Nome del parametro. |
noEcho | booleano | False | Se mascherare il valore del parametro ogni volta che qualcuno effettua una chiamata che descrive lo stack. Se si imposta il valore su true, il valore del parametro viene mascherato da asterischi (*****). |
referencedByResources | Array di tipo string | True | Un elenco di AWS SAM risorse che utilizzano questo parametro. |
type | stringa | False | Il tipo di parametro. Valori validi: Ad esempio, gli utenti possono specificare Ad esempio, gli utenti potrebbero specificare. Ad esempio, gli utenti possono specificare «80,20" e quindi ottenere. Ad esempio, gli utenti possono specificare «test, dev, prod» e quindi inserire i risultati. |
TooManyRequestsException
Il client sta inviando un numero di richieste superiore a quello consentito per unità di tempo.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
errorCode | stringa | False | 429 |
message | stringa | False | Il client sta inviando un numero di richieste superiore a quello consentito per unità di tempo. |
Versione
Dettagli sulla versione dell'applicazione.
| Proprietà | Tipo | Campo obbligatorio | Descrizione |
|---|---|---|---|
applicationId | stringa | True | L'applicazione Amazon Resource Name (ARN). |
creationTime | stringa | True | La data e l'ora di creazione di questa risorsa. |
parameterDefinitions | Array di tipo ParameterDefinition | True | Una serie di tipi di parametri supportati dall'applicazione. |
requiredCapabilities | Array di tipo Capability | True | Un elenco di valori che è necessario specificare prima di poter distribuire determinate applicazioni. Alcune applicazioni potrebbero includere risorse che possono influire sulle autorizzazioni AWS dell'account, ad esempio creando nuovi AWS Identity and Access Management (IAM) utenti. Per tali applicazioni, è necessario riconoscerne esplicitamente le funzionalità specificando questo parametro. Gli unici valori validi sono Le seguenti risorse richiedono di specificare Le seguenti risorse richiedono di specificare Le applicazioni che includono una o più applicazioni nidificate richiedono di specificare Se il modello di applicazione contiene una delle risorse sopra indicate, ti consigliamo di esaminare tutte le autorizzazioni associate all'applicazione prima della distribuzione. Se non specifichi questo parametro per un'applicazione che richiede funzionalità, la chiamata avrà esito negativo. |
resourcesSupported | booleano | True | Se tutte le AWS risorse contenute in questa applicazione sono supportate nella regione in cui viene recuperata. |
semanticVersion | stringa | True | La versione semantica dell'applicazione: |
sourceCodeArchiveUrl | stringa | False | Un link all'oggetto S3 che contiene l'archivio ZIP del codice sorgente per questa versione dell'applicazione. Dimensione massima 50 MB |
sourceCodeUrl | stringa | False | Un collegamento a un archivio pubblico per il codice sorgente dell'applicazione, ad esempio l'URL di un GitHub commit specifico. |
templateUrl | stringa | True | Un link al AWS SAM modello preconfezionato della tua applicazione. |
Consulta anche
Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK e dei riferimenti specifici della lingua, consulta quanto segue: