applicazioni applicationId - AWS Serverless Application Repository

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 applicationId

URI

/applications/applicationId

HTTPmetodi

GET

ID dell'operazione: GetApplication

Ottiene l'applicazione specificata.

Parametri del percorso
NomeTipoCampo obbligatorioDescrizione
applicationIdStringaTrue

L'Amazon Resource Name (ARN) dell'applicazione.

Parametri di query
NomeTipoCampo obbligatorioDescrizione
semanticVersionStringaFalse

La versione semantica dell'applicazione da scaricare.

Risposte
Codice di statoModello di rispostaDescrizione
200Application

Riuscito

400BadRequestException

Uno dei parametri della richiesta non è valido.

403ForbiddenException

Il client non è autenticato.

404NotFoundException

La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.

429TooManyRequestsException

Il client invia più del numero consentito di richieste per unità di tempo.

500InternalServerErrorException

Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.

DELETE

ID dell'operazione: DeleteApplication

Elimina l'applicazione specificata.

Parametri del percorso
NomeTipoCampo obbligatorioDescrizione
applicationIdStringaTrue

L'Amazon Resource Name (ARN) dell'applicazione.

Risposte
Codice di statoModello di rispostaDescrizione
204Nessuno

Riuscito

400BadRequestException

Uno dei parametri della richiesta non è valido.

403ForbiddenException

Il client non è autenticato.

404NotFoundException

La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.

409ConflictException

La risorsa esiste già.

429TooManyRequestsException

Il client invia più del numero consentito di richieste per unità di tempo.

500InternalServerErrorException

Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.

OPTIONS

Parametri del percorso
NomeTipoCampo obbligatorioDescrizione
applicationIdStringaTrue

L'Amazon Resource Name (ARN) dell'applicazione.

Risposte
Codice di statoModello di rispostaDescrizione
200Nessuno

200 risposte

PATCH

ID dell'operazione: UpdateApplication

Aggiorna l'applicazione specificata.

Parametri del percorso
NomeTipoCampo obbligatorioDescrizione
applicationIdStringaTrue

L'Amazon Resource Name (ARN) dell'applicazione.

Risposte
Codice di statoModello di rispostaDescrizione
200Application

Riuscito

400BadRequestException

Uno dei parametri della richiesta non è valido.

403ForbiddenException

Il client non è autenticato.

404NotFoundException

La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.

409ConflictException

La risorsa esiste già.

429TooManyRequestsException

Il client invia più del numero consentito di richieste per unità di tempo.

500InternalServerErrorException

Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.

Schemi

Corpi della richiesta

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

Corpi della risposta

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

Proprietà

Application

Dettagli sull'applicazione.

ProprietàTipoCampo obbligatorioDescrizione
applicationId

stringa

True

L'applicazione Amazon Resource Name (ARN).

author

string

True

Il nome dell'autore che pubblica l'app.

Lunghezza minima = 1. Lunghezza massima = 127.

Modello «^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? $»;

creationTime

string

False

La data e l'ora di creazione di questa risorsa.

description

string

True

Descrizione dell'applicazione.

Lunghezza minima = 1. Lunghezza massima = 256

homePageUrl

string

False

A URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del GitHub repository per l'applicazione.

isVerifiedAuthor

booleano

False

Speciifica 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 corrisponde a quella dichiarata.

labels

Matrice 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

Modello: "^[a-zA-Z0-9+\\-_:\\/@]+$";

licenseUrl

string

False

Un link a un file di licenza dell'app che corrisponde al valore spdxLicense ID dell'applicazione.

Dimensione massima 5 MB

name

string

True

Il nome dell'applicazione.

Lunghezza minima = 1. Lunghezza massima = 140

Modello: "[a-zA-Z0-9\\-]+";

readmeUrl

string

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

string

False

Un identificatore valido proveniente da https://spdx.org/licenses/.

verifiedAuthorUrl

string

False

Vai URL al profilo pubblico di un autore verificato. Questo URL è inviato dall'autore.

version

Versione

False

Informazioni sulla versione dell'applicazione.

BadRequestException

Uno dei parametri della richiesta non è valido.

ProprietàTipoCampo obbligatorioDescrizione
errorCode

stringa

False

400

message

string

False

Uno dei parametri della richiesta non è valido.

Capability

Valori che devono essere specificati per distribuire alcune applicazioni.

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_AUTO_EXPAND

  • CAPABILITY_RESOURCE_POLICY

ConflictException

La risorsa esiste già.

ProprietàTipoCampo obbligatorioDescrizione
errorCode

stringa

False

409

message

string

False

La risorsa esiste già.

ForbiddenException

Il client non è autenticato.

ProprietàTipoCampo obbligatorioDescrizione
errorCode

stringa

False

403

message

string

False

Il client non è autenticato.

InternalServerErrorException

Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.

ProprietàTipoCampo obbligatorioDescrizione
errorCode

stringa

False

500

message

string

False

Il AWS Serverless Application Repository servizio ha rilevato un errore interno.

NotFoundException

La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.

ProprietàTipoCampo obbligatorioDescrizione
errorCode

stringa

False

404

message

string

False

La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.

ParameterDefinition

Parametri supportati dall'applicazione.

ProprietàTipoCampo obbligatorioDescrizione
allowedPattern

stringa

False

Espressione regolare che rappresenta i modelli da consentire per i tipi String.

allowedValues

Matrice di tipo string

False

Matrice contenente l'elenco dei valori consentiti per il parametro.

constraintDescription

string

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 [A-Za-z0-9]+ restituisce il seguente messaggio di errore quando l'utente specifica un valore non valido:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

Aggiungendo una descrizione del vincolo, ad esempio «deve contenere solo lettere e numeri maiuscoli e minuscoli», è possibile visualizzare il seguente messaggio di errore personalizzato:

Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.

defaultValue

string

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

string

False

Una stringa di massimo 4.000 caratteri che descrive il parametro.

maxLength

integer

False

Un valore intero che determina il maggior numero di caratteri che si desidera consentire per String i tipi.

maxValue

integer

False

Un valore numerico che determina il valore numerico massimo consentito per i tipi. Number

minLength

integer

False

Un valore intero che determina il numero minimo di caratteri che si desidera consentire per i tipi. String

minValue

integer

False

Un valore numerico che determina il valore numerico più piccolo che si desidera consentire per i tipi. Number

name

string

True

Nome del parametro.

noEcho

booleano

False

Indica se mascherare il valore del parametro ogni volta che qualcuno effettua una chiamata che descrive lo stack. Se impostate il valore su true, il valore del parametro viene mascherato da asterischi (*****).

referencedByResources

Matrice di tipo string

True

Un elenco di AWS SAM risorse che utilizzano questo parametro.

type

string

False

Il tipo di parametro.

Valori validi: String | Number | List<Number> | CommaDelimitedList

String: Una stringa letterale.

Ad esempio, gli utenti possono specificare"MyUserName".

Number: Un numero intero o float. AWS CloudFormation convalida il valore del parametro come numero. Tuttavia, quando si utilizza il parametro altrove nel modello (ad esempio, utilizzando la funzione Ref intrinseca), il valore del parametro diventa una stringa.

Ad esempio, gli utenti potrebbero specificare. "8888"

List<Number>: Una matrice di numeri interi o float separati da virgole. AWS CloudFormation convalida il valore del parametro come numeri. Tuttavia, quando si utilizza il parametro altrove nel modello (ad esempio, utilizzando la funzione Ref intrinseca), il valore del parametro diventa un elenco di stringhe.

Ad esempio, gli utenti potrebbero specificare «80,20" e quindi ottenere il risultato. Ref ["80","20"]

CommaDelimitedList: matrice di stringhe letterali separate da virgole. Il numero totale di stringhe deve corrispondere al numero totale di virgole più uno. Inoltre, ogni stringa membro è limitata a spazi.

Ad esempio, gli utenti potrebbero specificare «test, dev, prod» e quindi ottenere risultati. Ref ["test","dev","prod"]

TooManyRequestsException

Il client invia un numero di richieste superiore a quello consentito per unità di tempo.

ProprietàTipoCampo obbligatorioDescrizione
errorCode

stringa

False

429

message

string

False

Il client invia più del numero consentito di richieste per unità di tempo.

UpdateApplicationInput

Aggiorna la richiesta di applicazione.

ProprietàTipoCampo obbligatorioDescrizione
author

stringa

False

Il nome dell'autore che pubblica l'app.

Lunghezza minima = 1. Lunghezza massima = 127.

Modello «^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? $»;

description

string

False

Descrizione dell'applicazione.

Lunghezza minima = 1. Lunghezza massima = 256

homePageUrl

string

False

A URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del GitHub repository per l'applicazione.

labels

Matrice di tipi string

False

Etichette per migliorare la scoperta delle app nei risultati di ricerca.

Lunghezza minima = 1. Lunghezza massima = 127. Numero massimo di etichette: 10

Modello: "^[a-zA-Z0-9+\\-_:\\/@]+$";

readmeBody

string

False

Un file readme di testo in linguaggio Markdown che contiene una descrizione più dettagliata dell'applicazione e del suo funzionamento.

Dimensione massima 5 MB

readmeUrl

string

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

Version

Dettagli sulla versione dell'applicazione.

ProprietàTipoCampo obbligatorioDescrizione
applicationId

stringa

True

L'applicazione Amazon Resource Name (ARN).

creationTime

string

True

La data e l'ora di creazione di questa risorsa.

parameterDefinitions

Matrice di tipo ParameterDefinition

True

Una serie di tipi di parametri supportati dall'applicazione.

requiredCapabilities

Matrice di tipo Funzionalità

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 sonoCAPABILITY_IAM, CAPABILITY_NAMED_IAMCAPABILITY_RESOURCE_POLICY, e. CAPABILITY_AUTO_EXPAND

Le seguenti risorse richiedono di specificare CAPABILITY_IAM orCAPABILITY_NAMED_IAM::: AWSIAM: :Group, AWS:::: IAMAWS: InstanceProfile,, :Policy eIAM:: AWSIAM: :Role. Se l'applicazione contiene IAM risorse, è possibile specificare o. CAPABILITY_IAM CAPABILITY_NAMED_IAM Se l'applicazione contiene IAM risorse con nomi personalizzati, è necessario specificareCAPABILITY_NAMED_IAM.

Le seguenti risorse richiedono di specificareCAPABILITY_RESOURCE_POLICY:: :LambdaAWS: :Permission,: ::Policy,AWS::::IAM, AWS :S3 AWS ApplicationAutoScaling::, ScalingPolicy::: e:::: eBucketPolicy: AWS::SQS:. QueuePolicy AWS SNS TopicPolicy

Le applicazioni che includono una o più applicazioni nidificate richiedono di specificare CAPABILITY_AUTO_EXPAND.

Se il modello di applicazione contiene una delle risorse precedenti, si consiglia di esaminare tutte le autorizzazioni associate all'applicazione prima della distribuzione. Se non si specifica 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

string

True

La versione semantica dell'applicazione:

https://semver.org/

sourceCodeArchiveUrl

string

False

Un link all'oggetto S3 che contiene l'ZIParchivio del codice sorgente per questa versione dell'applicazione.

Dimensione massima 50 MB

sourceCodeUrl

string

False

Un collegamento a un archivio pubblico per il codice sorgente dell'applicazione, ad esempio il codice URL di un GitHub commit specifico.

templateUrl

string

True

Un collegamento al AWS SAM modello confezionato dell'applicazione.

Consulta anche

Per ulteriori informazioni sull'utilizzo di questa opzione API in uno dei riferimenti specifici della lingua, AWS SDKs consultate quanto segue:

GetApplication

DeleteApplication

UpdateApplication