ApplicationID delle applicazioni

URI

/applications/applicationId

Metodi HTTP

GET

ID dell'operazione: GetApplication

Ottiene l'applicazione specificata.

Parametri del percorso
Nome	Type	Campo obbligatorio	Descrizione
ApplicationID	Stringa	True	Il nome della risorsa Amazon (ARN) dell'applicazione.

Parametri di query
Nome	Type	Campo obbligatorio	Descrizione
semanticVersion	Stringa	False	La versione semantica dell'applicazione da ottenere.

Risposte
Codice di stato	Modello di risposta	Descrizione
200	Application	Riuscito
400	BadRequestException	Uno dei parametri della richiesta non è valido.
403	ForbiddenException	Il client non è autenticato.
404	NotFoundException	La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.
429	TooManyRequestsException	Il client invia più del numero consentito di richieste per unità di tempo.
500	InternalServerErrorException	Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.

DELETE

ID dell'operazione: DeleteApplication

Elimina l'applicazione specificata.

Parametri del percorso
Nome	Type	Campo obbligatorio	Descrizione
ApplicationID	Stringa	True	Il nome della risorsa Amazon (ARN) dell'applicazione.

Risposte
Codice di stato	Modello di risposta	Descrizione
204	Nessuno	Riuscito
400	BadRequestException	Uno dei parametri della richiesta non è valido.
403	ForbiddenException	Il client non è autenticato.
404	NotFoundException	La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.
409	ConflictException	La risorsa esiste già.
429	TooManyRequestsException	Il client invia più del numero consentito di richieste per unità di tempo.
500	InternalServerErrorException	Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.

OPTIONS

Parametri del percorso
Nome	Type	Campo obbligatorio	Descrizione
ApplicationID	Stringa	True	Il nome della risorsa Amazon (ARN) dell'applicazione.

Risposte
Codice di stato	Modello di risposta	Descrizione
200	Nessuno	Risposta 200

PATCH

ID dell'operazione: UpdateApplication

Aggiorna l'applicazione specificata.

Parametri del percorso
Nome	Type	Campo obbligatorio	Descrizione
ApplicationID	Stringa	True	Il nome della risorsa Amazon (ARN) dell'applicazione.

Risposte
Codice di stato	Modello di risposta	Descrizione
200	Application	Riuscito
400	BadRequestException	Uno dei parametri della richiesta non è valido.
403	ForbiddenException	Il client non è autenticato.
404	NotFoundException	La risorsa (ad esempio, una dichiarazione sulla politica di accesso) specificata nella richiesta non esiste.
409	ConflictException	La risorsa esiste già.
429	TooManyRequestsException	Il client invia più del numero consentito di richieste per unità di tempo.
500	InternalServerErrorException	Il AWS Serverless Application Repository servizio ha riscontrato un errore interno.

Schemi

Corpi della richiesta

Schema PATCH

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

Corpi della risposta

Schema Application

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

Schema BadRequestException

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

Schema ForbiddenException

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

Schema NotFoundException

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

Schema ConflictException

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

Schema TooManyRequestsException

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

Schema InternalServerErrorException

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

Proprietà

Application

Dettagli sull'applicazione.

Proprietà	Type	Campo obbligatorio	Descrizione
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	Un URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del GitHub repository dell'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	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 Modello: "^[a-zA-Z0-9+\\-_:\\/@]+$";
licenseUrl	string	False	Un link a un file di licenza dell'app che corrisponde al valore spdxLicenseID 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	L'URL del profilo pubblico di un autore verificato. Questo URL è stato inviato dall'autore.
version	Versione	False	Informazioni sulla versione dell'applicazione.

BadRequestException

Uno dei parametri della richiesta non è valido.

Proprietà	Type	Campo obbligatorio	Descrizione
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à	Type	Campo obbligatorio	Descrizione
errorCode	stringa	False	409
message	string	False	La risorsa esiste già.

ForbiddenException

Il client non è autenticato.

Proprietà	Type	Campo obbligatorio	Descrizione
errorCode	stringa	False	403
message	string	False	Il client non è autenticato.

InternalServerErrorException

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

Proprietà	Type	Campo obbligatorio	Descrizione
errorCode	stringa	False	500
message	string	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à	Type	Campo obbligatorio	Descrizione
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à	Type	Campo obbligatorio	Descrizione
allowedPattern	stringa	False	Espressione regolare che rappresenta i modelli da consentire per i tipi String.
allowedValues	Array 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	Array 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à	Type	Campo obbligatorio	Descrizione
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à	Type	Campo obbligatorio	Descrizione
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	Un URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del GitHub repository dell'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 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à	Type	Campo obbligatorio	Descrizione
applicationId	stringa	True	L'applicazione Amazon Resource Name (ARN).
creationTime	string	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 sonoCAPABILITY_IAM, CAPABILITY_NAMED_IAMCAPABILITY_RESOURCE_POLICY, e. CAPABILITY_AUTO_EXPAND Le seguenti risorse richiedono di specificare CAPABILITY_IAM oCAPABILITY_NAMED_IAM: AWS::IAM::GroupAWS::IAM::InstanceProfile, AWS::IAM::Policy, e AWS::IAM::Role. Se l'applicazione contiene risorse IAM, puoi specificare CAPABILITY_IAM oCAPABILITY_NAMED_IAM. Se l'applicazione include risorse IAM con nomi personalizzati, devi specificare CAPABILITY_NAMED_IAM. Le seguenti risorse richiedono di specificareCAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS: :iam:Policy,, AWS::ApplicationAutoScaling::ScalingPolicyAWS::S3::BucketPolicy, AWS::SQS::QueuePolicye. 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 di cui sopra, ti consigliamo di rivedere 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'archivio ZIP del codice sorgente per questa versione dell'applicazione. Dimensione massima 50 MB
sourceCodeUrl	string	False	Un link a un archivio pubblico per il codice sorgente dell'applicazione, ad esempio l'URL di un GitHub commit specifico.
templateUrl	string	True	Un link al AWS SAM modello confezionato dell'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:

GetApplication

• Interfaccia a riga di comando di AWS

• SDK AWS per .NET

• SDK AWS per C++

• SDK AWS per Go v2

• AWS SDK per Java

• SDK AWS per JavaScript V3

• SDK AWS per PHP V3

• SDK AWS per Python

• SDK AWS per Ruby V3

DeleteApplication

• Interfaccia a riga di comando di AWS

• SDK AWS per .NET

• SDK AWS per C++

• SDK AWS per Go v2

• AWS SDK per Java

• SDK AWS per JavaScript V3

• SDK AWS per PHP V3

• SDK AWS per Python

• SDK AWS per Ruby V3

UpdateApplication

• Interfaccia a riga di comando di AWS

• SDK AWS per .NET

• SDK AWS per C++

• SDK AWS per Go v2

• AWS SDK per Java

• SDK AWS per JavaScript V3

• SDK AWS per PHP V3

• SDK AWS per Python

• SDK AWS per Ruby V3