Aplicaciones applicationId - AWS Serverless Application Repository

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Aplicaciones applicationId

URI

/applications/applicationId

HTTPmétodos

GET

ID de la operación: GetApplication

Obtiene la aplicación especificada.

Parámetros de la ruta
NombreTipoObligatorioDescripción
applicationIdCadenaTrue

El nombre del recurso de Amazon (ARN) de la aplicación.

Parámetros de consulta
NombreTipoObligatorioDescripción
semanticVersionCadenaFalse

La versión semántica de la aplicación que se va a obtener.

Respuestas
Código de estadoModelo de respuestaDescripción
200Application

Success

400BadRequestException

Uno de los parámetros de la solicitud no es válido.

403ForbiddenException

El cliente no está autenticado.

404NotFoundException

El recurso (por ejemplo, una declaración de política de acceso) especificado en la solicitud no existe.

429TooManyRequestsException

El cliente envía más solicitudes por unidad de tiempo de las permitidas.

500InternalServerErrorException

La AWS Serverless Application Repository el servicio ha detectado un error interno.

DELETE

ID de la operación: DeleteApplication

Elimina la aplicación especificada.

Parámetros de la ruta
NombreTipoObligatorioDescripción
applicationIdCadenaTrue

El nombre del recurso de Amazon (ARN) de la aplicación.

Respuestas
Código de estadoModelo de respuestaDescripción
204Ninguna

Success

400BadRequestException

Uno de los parámetros de la solicitud no es válido.

403ForbiddenException

El cliente no está autenticado.

404NotFoundException

El recurso (por ejemplo, una declaración de política de acceso) especificado en la solicitud no existe.

409ConflictException

El recurso ya existe.

429TooManyRequestsException

El cliente envía más solicitudes por unidad de tiempo de las permitidas.

500InternalServerErrorException

La AWS Serverless Application Repository el servicio ha detectado un error interno.

OPTIONS

Parámetros de la ruta
NombreTipoObligatorioDescripción
applicationIdCadenaTrue

El nombre del recurso de Amazon (ARN) de la aplicación.

Respuestas
Código de estadoModelo de respuestaDescripción
200Ninguna

200 respuestas

PATCH

ID de la operación: UpdateApplication

Actualiza la aplicación especificada.

Parámetros de la ruta
NombreTipoObligatorioDescripción
applicationIdCadenaTrue

El nombre del recurso de Amazon (ARN) de la aplicación.

Respuestas
Código de estadoModelo de respuestaDescripción
200Application

Success

400BadRequestException

Uno de los parámetros de la solicitud no es válido.

403ForbiddenException

El cliente no está autenticado.

404NotFoundException

El recurso (por ejemplo, una declaración de política de acceso) especificado en la solicitud no existe.

409ConflictException

El recurso ya existe.

429TooManyRequestsException

El cliente envía más solicitudes por unidad de tiempo de las permitidas.

500InternalServerErrorException

La AWS Serverless Application Repository el servicio ha detectado un error interno.

Schemas

Cuerpos de la solicitud

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

Cuerpos de respuesta

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

Propiedades

Application

Detalles sobre la aplicación.

PropiedadTipoObligatorioDescripción
applicationId

cadena

True

La aplicación Amazon Resource Name (ARN).

author

cadena

True

El nombre del autor que publica la aplicación.

Longitud mínima = 1. Longitud máxima = 127.

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

creationTime

cadena

False

La fecha y la hora en que se creó este recurso.

description

cadena

True

La descripción de la aplicación.

Longitud mínima = 1. Longitud máxima = 256

homePageUrl

cadena

False

A URL con más información sobre la aplicación, por ejemplo, la ubicación del GitHub repositorio de la aplicación.

isVerifiedAuthor

valor booleano

False

Especifica si se ha verificado el autor de esta aplicación. Esto significa que AWS ha revisado de buena fe, como proveedor de servicios razonable y prudente, la información proporcionada por el solicitante y ha confirmado que la identidad del solicitante es la que afirma.

labels

Matriz de tipos string

False

Etiquetas para mejorar la detección de aplicaciones en los resultados de búsqueda.

Longitud mínima = 1. Longitud máxima = 127. Número máximo de etiquetas: 10

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

licenseUrl

cadena

False

Un enlace a un archivo de licencia de la aplicación que coincide con el valor de spdxLicense ID de la aplicación.

Tamaño máximo: 5 MB

name

cadena

True

Nombre de la aplicación.

Longitud mínima = 1. Longitud máxima = 140

Patrón: "[a-zA-Z0-9\\-]+";

readmeUrl

cadena

False

Un enlace al archivo readme en lenguaje Markdown que contiene una descripción más detallada de la aplicación y su funcionamiento.

Tamaño máximo: 5 MB

spdxLicenseId

cadena

False

Un identificador válido de https://spdx.org/licenses/.

verifiedAuthorUrl

cadena

False

Ir URL al perfil público de un autor verificado. URLEsto lo envía el autor.

version

Versión

False

Información sobre la versión de la aplicación.

BadRequestException

Uno de los parámetros de la solicitud no es válido.

PropiedadTipoObligatorioDescripción
errorCode

cadena

False

400

message

cadena

False

Uno de los parámetros de la solicitud no es válido.

Capability

Valores que se deben especificar para poder implementar algunas aplicaciones.

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_AUTO_EXPAND

  • CAPABILITY_RESOURCE_POLICY

ConflictException

El recurso ya existe.

PropiedadTipoObligatorioDescripción
errorCode

cadena

False

409

message

cadena

False

El recurso ya existe.

ForbiddenException

El cliente no está autenticado.

PropiedadTipoObligatorioDescripción
errorCode

cadena

False

403

message

cadena

False

El cliente no está autenticado.

InternalServerErrorException

La AWS Serverless Application Repository el servicio ha detectado un error interno.

PropiedadTipoObligatorioDescripción
errorCode

cadena

False

500

message

cadena

False

La AWS Serverless Application Repository el servicio ha detectado un error interno.

NotFoundException

El recurso (por ejemplo, una declaración de política de acceso) especificado en la solicitud no existe.

PropiedadTipoObligatorioDescripción
errorCode

cadena

False

404

message

cadena

False

El recurso (por ejemplo, una declaración de política de acceso) especificado en la solicitud no existe.

ParameterDefinition

Parámetros compatibles con la aplicación.

PropiedadTipoObligatorioDescripción
allowedPattern

cadena

False

Una expresión regular que representa los patrones que hay que permitir para tipos de String.

allowedValues

Matriz de tipos string

False

Una matriz que contiene la lista de valores permitidos para el parámetro.

constraintDescription

cadena

False

Una cadena que explica una restricción cuando se infringe la restricción. Por ejemplo, sin una descripción de la restricción, un parámetro con un patrón permitido de [A-Za-z0-9]+ muestra el siguiente mensaje de error cuando el usuario especifica un valor no válido:

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

Al agregar una descripción de la restricción, como «debe contener solo letras y números mayúsculas y minúsculas», puede mostrar el siguiente mensaje de error personalizado:

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

defaultValue

cadena

False

Un valor del tipo apropiado para la plantilla que se debe utilizar si no se especifica ningún valor al crear una pila. Si define restricciones para el parámetro, debe especificar un valor que cumpla dichas restricciones.

description

cadena

False

Cadena de hasta 4000 caracteres que describe el parámetro.

maxLength

integer

False

Un valor entero que determina el número máximo de caracteres que desea permitir para los String tipos.

maxValue

integer

False

Un valor numérico que determina el mayor valor numérico que desea permitir para los Number tipos.

minLength

integer

False

Un valor entero que determina el número mínimo de caracteres que desea permitir para los String tipos.

minValue

integer

False

Un valor numérico que determina el valor numérico más pequeño que se desea permitir para los Number tipos.

name

cadena

True

El nombre del parámetro.

noEcho

valor booleano

False

Si se debe enmascarar el valor del parámetro cada vez que alguien realice una llamada que describa la pila. Si establece el valor en verdadero, el valor del parámetro se enmascara con asteriscos (*****).

referencedByResources

Matriz de tipo string

True

Una lista de AWS SAM recursos que utilizan este parámetro.

type

cadena

False

El tipo del parámetro.

Valores válidos: String | Number | List<Number> | CommaDelimitedList

String: cadena literal.

Por ejemplo, los usuarios pueden especificar"MyUserName".

Number: entero o flotante. AWS CloudFormation valida el valor del parámetro como un número. Sin embargo, cuando se utiliza el parámetro en otro lugar de la plantilla (por ejemplo, mediante la función Ref intrínseca), el valor del parámetro se convierte en una cadena.

Por ejemplo, los usuarios pueden especificar"8888".

List<Number>: matriz de números enteros o números flotantes separados por comas. AWS CloudFormation valida el valor del parámetro como números. Sin embargo, cuando se utiliza el parámetro en otro lugar de la plantilla (por ejemplo, mediante la función Ref intrínseca), el valor del parámetro se convierte en una lista de cadenas.

Por ejemplo, los usuarios pueden especificar «80,20" y, a continuación, dar Ref como resultado. ["80","20"]

CommaDelimitedList: matriz de cadenas literales separadas por comas. El número total de cadenas debería ser uno más que el número total de comas. Además, cada cadena de miembros está recortada con espacios.

Por ejemplo, los usuarios pueden especificar «test, dev, prod» y, a continuación, arrojar los resultados. Ref ["test","dev","prod"]

TooManyRequestsException

El cliente envía más solicitudes por unidad de tiempo de las permitidas.

PropiedadTipoObligatorioDescripción
errorCode

cadena

False

429

message

cadena

False

El cliente envía más solicitudes de las permitidas por unidad de tiempo.

UpdateApplicationInput

Actualice la solicitud de solicitud.

PropiedadTipoObligatorioDescripción
author

cadena

False

El nombre del autor que publica la aplicación.

Longitud mínima = 1. Longitud máxima = 127.

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

description

cadena

False

La descripción de la aplicación.

Longitud mínima = 1. Longitud máxima = 256

homePageUrl

cadena

False

A URL con más información sobre la aplicación, por ejemplo, la ubicación del GitHub repositorio de la aplicación.

labels

Matriz de tipos string

False

Etiquetas para mejorar la detección de aplicaciones en los resultados de búsqueda.

Longitud mínima = 1. Longitud máxima = 127. Número máximo de etiquetas: 10

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

readmeBody

cadena

False

Un archivo readme de texto en lenguaje Markdown que contiene una descripción más detallada de la aplicación y su funcionamiento.

Tamaño máximo: 5 MB

readmeUrl

cadena

False

Un enlace al archivo readme en lenguaje Markdown que contiene una descripción más detallada de la aplicación y su funcionamiento.

Tamaño máximo: 5 MB

Version

Detalles de la versión de la aplicación.

PropiedadTipoObligatorioDescripción
applicationId

cadena

True

La aplicación Amazon Resource Name (ARN).

creationTime

cadena

True

La fecha y la hora en que se creó este recurso.

parameterDefinitions

Matriz de tipo ParameterDefinition

True

Conjunto de tipos de parámetros compatibles con la aplicación.

requiredCapabilities

Matriz de tipos Capability

True

Una lista de valores que debe especificar antes de poder implementar determinadas aplicaciones. Algunas aplicaciones pueden incluir recursos que pueden afectar a los permisos de su AWS cuenta, por ejemplo, creando una nueva AWS Identity and Access Management (IAM) usuarios. Para esas aplicaciones, debe reconocer explícitamente sus capacidades especificando este parámetro.

Los únicos valores válidos son CAPABILITY_IAMCAPABILITY_NAMED_IAM,CAPABILITY_RESOURCE_POLICY, yCAPABILITY_AUTO_EXPAND.

Los siguientes recursos requieren que especifique CAPABILITY_IAM oCAPABILITY_NAMED_IAM:: AWS: :Group,IAM: AWS::,:IAM:InstanceProfile,AWS: :Policy yIAM:: AWSIAM: :Role. Si la aplicación contiene IAM recursos, puede especificar una o. CAPABILITY_IAM CAPABILITY_NAMED_IAM Si la aplicación contiene IAM recursos con nombres personalizados, debe especificarlosCAPABILITY_NAMED_IAM.

Los siguientes recursos requieren que especifiqueCAPABILITY_RESOURCE_POLICY:: :LambdaAWS: :Permission,: ::Policy,AWS:::AWS:IAM,,:ApplicationAutoScaling: AWS S3ScalingPolicy::,::, yBucketPolicy: AWS:::SQS:. QueuePolicy AWS SNS TopicPolicy

Las aplicaciones que contienen una o varias aplicaciones anidadas requieren que especifique CAPABILITY_AUTO_EXPAND.

Si la plantilla de la aplicación contiene alguno de los recursos anteriores, le recomendamos que revise todos los permisos asociados a la aplicación antes de implementarla. Si no especifica este parámetro para una aplicación que requiere capacidades, la llamada fallará.

resourcesSupported

booleano

True

Si todos los AWS los recursos contenidos en esta aplicación son compatibles en la región en la que se están recuperando.

semanticVersion

cadena

True

La versión semántica de la aplicación:

https://semver.org/

sourceCodeArchiveUrl

cadena

False

Un enlace al objeto S3 que contiene el ZIP archivo del código fuente de esta versión de la aplicación.

Tamaño máximo: 50 MB

sourceCodeUrl

cadena

False

Un enlace a un repositorio público para el código fuente de tu aplicación, por ejemplo, el URL de una GitHub confirmación específica.

templateUrl

cadena

True

Un enlace al paquete AWS SAM plantilla de su solicitud.

Véase también

Para obtener más información sobre su uso API en uno de los idiomas específicos AWS SDKsy las referencias, consulte lo siguiente:

GetApplication

DeleteApplication

UpdateApplication