applicationId de aplicativos - AWS Serverless Application Repository

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

applicationId de aplicativos

URI

/applications/applicationId

Métodos HTTP

GET

ID da operação:GetApplication

Obtém o aplicativo especificado.

Parâmetros de caminho
Name (Nome)TypeObrigatórioDescrição
applicationIdStringTrue

O nome de recurso da Amazon (ARN) do aplicativo.

Parâmetros de consulta
Name (Nome)TypeObrigatórioDescrição
Versão semânticaStringFalse

A versão semântica da aplicação a ser obtida.

Respostas
Código de statusModelo de respostaDescrição
200Application

Bem-sucedida

400BadRequestException

Um dos parâmetros na solicitação é inválido.

403ForbiddenException

O cliente não está autenticado.

404NotFoundException

O recurso (por exemplo, uma declaração de política de acesso) especificado na solicitação não existe.

429TooManyRequestsException

O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo.

500InternalServerErrorException

O serviço AWS Serverless Application Repository encontrou um erro interno.

DELETE

ID da operação:DeleteApplication

Exclui o aplicativo especificado.

Parâmetros de caminho
Name (Nome)TypeObrigatórioDescrição
applicationIdStringTrue

O nome de recurso da Amazon (ARN) do aplicativo.

Respostas
Código de statusModelo de respostaDescrição
204None

Bem-sucedida

400BadRequestException

Um dos parâmetros na solicitação é inválido.

403ForbiddenException

O cliente não está autenticado.

404NotFoundException

O recurso (por exemplo, uma declaração de política de acesso) especificado na solicitação não existe.

409ConflictException

O recurso já existe.

429TooManyRequestsException

O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo.

500InternalServerErrorException

O serviço AWS Serverless Application Repository encontrou um erro interno.

PATCH

ID da operação:UpdateApplication

Atualiza o aplicativo especificado.

Parâmetros de caminho
Name (Nome)TypeObrigatórioDescrição
applicationIdStringTrue

O nome de recurso da Amazon (ARN) do aplicativo.

Respostas
Código de statusModelo de respostaDescrição
200Application

Bem-sucedida

400BadRequestException

Um dos parâmetros na solicitação é inválido.

403ForbiddenException

O cliente não está autenticado.

404NotFoundException

O recurso (por exemplo, uma declaração de política de acesso) especificado na solicitação não existe.

409ConflictException

O recurso já existe.

429TooManyRequestsException

O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo.

500InternalServerErrorException

O serviço AWS Serverless Application Repository encontrou um erro interno.

Esquemas

Os órgãos da solicitação

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

Response bodies

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

Propriedades

Application

Detalhes sobre o aplicativo.

PropriedadeTypeObrigatórioDescrição
applicationId

string

True

O nome de recurso da Amazon (ARN) do aplicativo do .

autora

string

True

O nome do autor que está publicando o app.

Comprimento mínimo = 1. Tamanho máximo = 127.

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

creationTime

string

False

A data e a hora em que o recurso foi criado.

descrição

string

True

A descrição do aplicativo.

Comprimento mínimo = 1. Comprimento máximo = 256

homePageUrl

string

False

Um URL com mais informações sobre o aplicativo, por exemplo, a localização do seu GitHub repositório para o aplicativo.

isVerifiedAuthor

booleano

False

Especifica se o autor desse aplicativo foi verificado. Isso significa queAWS fez uma análise de boa fé, como prestadora de serviços razoável e prudente, das informações fornecidas pelo solicitante e confirmou que a identidade do solicitante é a alegada.

rótulos

Matriz de tipostring

False

Etiquetas para melhorar a descoberta de aplicativos nos resultados da pesquisa.

Comprimento mínimo = 1. Tamanho máximo = 127. Número máximo de etiquetas: 10

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

URL da licença

string

False

Um link para um arquivo de licença do aplicativo que corresponde ao valor spdxLicenseID do seu aplicativo.

Tamanho máximo 5 MB

name

string

True

O nome da aplicação.

Comprimento mínimo = 1. Comprimento máximo = 140

Padrão: "[a-zA-Z0-9\\-]+";

URL Leia-me

string

False

Um link para o arquivo readme na linguagem Markdown que contém uma descrição mais detalhada do aplicativo e de como ele funciona.

Tamanho máximo 5 MB

spdxLicenseId

string

False

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

verifiedAuthorUrl

string

False

O URL do perfil público de um autor verificado. Esse URL é enviado pelo autor.

versionamento

Versão

False

Informações de versão sobre a aplicação.

BadRequestException

Um dos parâmetros na solicitação é inválido.

PropriedadeTypeObrigatórioDescrição
errorCode

string

False

400

mensagem

string

False

Um dos parâmetros na solicitação é inválido.

Capability

Valores que devem ser especificados para implantar alguns aplicativos.

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_AUTO_EXPAND

  • CAPABILITY_RESOURCE_POLICY

ConflictException

O recurso já existe.

PropriedadeTypeObrigatórioDescrição
errorCode

string

False

409

mensagem

string

False

O recurso já existe.

ForbiddenException

O cliente não está autenticado.

PropriedadeTypeObrigatórioDescrição
errorCode

string

False

403

mensagem

string

False

O cliente não está autenticado.

InternalServerErrorException

O serviço AWS Serverless Application Repository encontrou um erro interno.

PropriedadeTypeObrigatórioDescrição
errorCode

string

False

500

mensagem

string

False

O serviço AWS Serverless Application Repository encontrou um erro interno.

NotFoundException

O recurso (por exemplo, uma declaração de política de acesso) especificado na solicitação não existe.

PropriedadeTypeObrigatórioDescrição
errorCode

string

False

404

mensagem

string

False

O recurso (por exemplo, uma declaração de política de acesso) especificado na solicitação não existe.

ParameterDefinition

Parâmetros suportados pelo aplicativo.

PropriedadeTypeObrigatórioDescrição
allowedPattern

string

False

Uma expressão regular que representa os padrões a serem permitidos para tipos String.

allowedValues

Matriz de tipostring

False

Uma matriz que contém a lista de valores permitidos para o parâmetro.

Descrição da restrição

string

False

Uma sequência que explica uma restrição quando a restrição é violada. Por exemplo, sem uma descrição da restrição, um parâmetro que tem um padrão permitido de [A-Za-z0-9]+ exibe a seguinte mensagem de erro quando o usuário especifica um valor inválido:

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

Ao adicionar uma descrição de restrição, como “deve conter apenas letras maiúsculas e minúsculas e números”, você pode exibir a seguinte mensagem de erro personalizada:

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

defaultValue

string

False

Um valor do tipo apropriado para o modelo a ser usado se nenhum valor for especificado quando uma pilha é criada. Se definir restrições para o parâmetro, você deverá especificar um valor que esteja de acordo com essas restrições.

descrição

string

False

Uma sequência de até 4000 caracteres que descreve o parâmetro.

Comprimento máximo

integer

False

Um valor inteiro que determina o maior número de caracteres que você deseja permitir paraString tipos.

Valor máximo

integer

False

Um valor numérico que determina o maior valor numérico que você deseja permitir paraNumber tipos.

Comprimento mínimo

integer

False

Um valor inteiro que determina o menor número de caracteres que você deseja permitir paraString tipos.

Valor mínimo

integer

False

Um valor numérico que determina o menor valor numérico que você deseja permitir paraNumber tipos.

name

string

True

O nome do parâmetro.

NoEcho

booleano

False

Se deve mascarar o valor do parâmetro sempre que alguém fizer uma chamada que descreva a pilha. Se você definir o valor como verdadeiro, o valor do parâmetro será mascarado com asteriscos (*****).

referencedByResources

Matriz de tipostring

True

Uma lista deAWS SAM recursos que usam esse parâmetro.

type

string

False

O tipo do parâmetro.

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

String: Uma sequência de caracteres literal.

Por exemplo, os usuários podem especificar"MyUserName".

Number: Um número inteiro ou flutuante. AWS CloudFormationvalida o valor do parâmetro como um número. No entanto, quando você usar o parâmetro em outro lugar no modelo (por exemplo, usando a funçãoRef intrínseca), o valor do parâmetro se tornará uma sequência.

Por exemplo, os usuários podem especificar"8888".

List<Number>: uma matriz de números inteiros ou flutuantes que são separados por vírgulas. AWS CloudFormationvalida o valor do parâmetro como números. No entanto, quando você usar o parâmetro em outro lugar no modelo (por exemplo, usando a funçãoRef intrínseca), o valor do parâmetro se tornará uma lista de sequência.

Por exemplo, os usuários podem especificar “80,20" e, em seguida,Ref resultar em["80","20"].

CommaDelimitedList: Uma matriz de sequências literais que são separadas por vírgulas. O total de sequências deve ser um número a mais que o número total de vírgulas. Além disso, cada sequência membro é truncado por espaço.

Por exemplo, os usuários podem especificar “test, dev, prod” e, em seguida,Ref resultar em["test","dev","prod"].

TooManyRequestsException

O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo.

PropriedadeTypeObrigatórioDescrição
errorCode

string

False

429

mensagem

string

False

O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo.

UpdateApplicationInput

Atualizar a solicitação de aplicação.

PropriedadeTypeObrigatórioDescrição
autora

string

False

O nome do autor que está publicando o app.

Comprimento mínimo = 1. Tamanho máximo = 127.

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

descrição

string

False

A descrição do aplicativo.

Comprimento mínimo = 1. Comprimento máximo = 256

homePageUrl

string

False

Um URL com mais informações sobre o aplicativo, por exemplo, a localização do seu GitHub repositório para o aplicativo.

rótulos

Matriz de tipostring

False

Etiquetas para melhorar a descoberta de aplicativos nos resultados da pesquisa.

Comprimento mínimo = 1. Tamanho máximo = 127. Número máximo de etiquetas: 10

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

Leia-me Body

string

False

Um arquivo de texto readme na linguagem Markdown que contém uma descrição mais detalhada do aplicativo e de como ele funciona.

Tamanho máximo 5 MB

URL Leia-me

string

False

Um link para o arquivo readme na linguagem Markdown que contém uma descrição mais detalhada do aplicativo e de como ele funciona.

Tamanho máximo 5 MB

Version

Detalhes da versão do aplicativo.

PropriedadeTypeObrigatórioDescrição
applicationId

string

True

O nome de recurso da Amazon (ARN) do aplicativo do .

creationTime

string

True

A data e a hora em que o recurso foi criado.

Definições de parâmetros

Matriz de tipoParameterDefinition

True

Uma variedade de tipos de parâmetros suportados pelo aplicativo.

requiredCapabilities

Matriz de tipoCapability

True

Uma lista de valores que você especificar antes que você especificar certos aplicativos. Alguns aplicativos podem incluir recursos que podem afetar permissões naAWS conta, por exemplo, criando novos usuários doAWS Identity and Access Management (IAM). Para esses aplicativos, você deve reconhecer explicitamente seus recursos especificando esse parâmetro.

Os únicos valores válidos sãoCAPABILITY_IAMCAPABILITY_NAMED_IAMCAPABILITY_RESOURCE_POLICY,,CAPABILITY_AUTO_EXPAND e.

Os recursos a seguir exigem que você especifiqueCAPABILITY_IAM ouCAPABILITY_NAMED_IAM: AWS::IAM::GroupAWS::IAM::InstanceProfileAWS::IAM::Policy,, AWS::IAM::Rolee. Se o aplicativo contiver recursos do IAM, você especificar uma dessasCAPABILITY_IAM capacidadesCAPABILITY_NAMED_IAM. Se o aplicativo contém recursos do IAM com nomes personalizados, você deverá especificar CAPABILITY_NAMED_IAM.

Os recursos a seguir exigem que você especifiqueCAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS: :iam:policy AWS::ApplicationAutoScaling::ScalingPolicyAWS::S3::BucketPolicy, AWS::SQS::QueuePolicy,, AWS::SNS::TopicPolicye.

Os aplicativos que contêm um ou mais aplicativos aninhados exigem que você especifique CAPABILITY_AUTO_EXPAND.

Se seu modelo de aplicativo contiver algum dos recursos acima, recomendamos que você revise todas as permissões associadas ao aplicativo antes da implantação. Se você não especificar esse parâmetro para um aplicativo que requer recursos, a chamada falhará.

Recursos suportados

booleano

True

Se todos osAWS recursos contidos nesse aplicativo são suportados na região em que ele está sendo recuperado.

Versão semântica

string

True

A versão semântica da aplicação:

https://semver.org/

sourceCodeArchiveURL

string

False

Um link para o objeto S3 que contém o arquivo ZIP do código-fonte dessa versão do seu aplicativo.

Tamanho máximo 50 MB

sourceCodeUrl

string

False

Um link para um repositório público para o código-fonte do seu aplicativo, por exemplo, o URL de um GitHub commit específico.

URL do modelo

string

True

Um link para oAWS SAM modelo empacotado do seu aplicativo.

Consulte também

Para obter mais informações sobre como usar essa API em uma dessas referências eAWS SDKs específicos de linguagem, consulte o seguinte:

GetApplication

DeleteApplication

UpdateApplication