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á.
Applications
URI
/applications
Métodos HTTP
GET
ID da operação: ListApplications
Lista os aplicativos de propriedade do solicitante.
Parâmetros de consulta | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nome | Type | Obrigatório | Descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Máximo de itens | String | False | O número total de itens a serem devolvidos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | Um token para especificar por onde começar a paginar. |
Respostas | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Código de status | Modelo de resposta | Descrição | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | ApplicationPage | Bem-sucedida | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestException | Um dos parâmetros na solicitação é inválido. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ForbiddenException | O cliente não está autenticado. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundException | O recurso (por exemplo, uma declaração de política de acesso) especificado na solicitação não existe. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServerErrorException | O serviço AWS Serverless Application Repository encontrou um erro interno. |
POST
ID da operação: CreateApplication
Cria um aplicativo, incluindo opcionalmente um arquivo AWS SAM para criar a primeira versão do aplicativo na mesma chamada.
Respostas | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Código de status | Modelo de resposta | Descrição | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Application | Bem-sucedida | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestException | Um dos parâmetros na solicitação é inválido. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ForbiddenException | O cliente não está autenticado. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ConflictException | O recurso já existe. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | TooManyRequestsException | O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServerErrorException | O serviço AWS Serverless Application Repository encontrou um erro interno. |
OPTIONS
Respostas | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Código de status | Modelo de resposta | Descrição | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 200 respostas |
Esquemas
Corpos da solicitação
{ "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" }
Corpos da resposta
{ "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 } }
Propriedades
Application
Detalhes sobre o aplicativo.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
applicationId | string | True | O nome de recurso da Amazon (ARN) do aplicativo do . |
autor | string | True | O nome do autor que publica o aplicativo. 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 esse recurso foi criado. |
descrição | string | True | A descrição do aplicativo. Comprimento mínimo = 1. Comprimento máximo = 256 |
homePageUrl | string | False | Uma 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 que AWS fez uma análise de boa fé, como prestador de serviços razoável e prudente, das informações fornecidas pelo solicitante e confirmou que a identidade do solicitante é a reivindicada. |
rótulos | Matriz do tipo string | False | Rótulos para melhorar a descoberta de aplicativos nos resultados de 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 do ReadMe | 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 foi enviado pelo autor. |
version | False | Informações sobre a versão do aplicativo. |
ApplicationPage
Uma lista dos detalhes do aplicativo.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
applications | Matriz do tipo ApplicationSummary | True | Uma série de resumos de aplicativos. |
nextToken | string | False | O token para solicitar a próxima página de resultados. |
ApplicationSummary
Resumo dos detalhes sobre o aplicativo.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
applicationId | string | True | O nome de recurso da Amazon (ARN) do aplicativo do . |
autor | string | True | O nome do autor que publica o aplicativo. 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 esse recurso foi criado. |
descrição | string | True | A descrição do aplicativo. Comprimento mínimo = 1. Comprimento máximo = 256 |
homePageUrl | string | False | Uma URL com mais informações sobre o aplicativo, por exemplo, a localização do seu GitHub repositório para o aplicativo. |
rótulos | Matriz do tipo string | False | Rótulos para melhorar a descoberta de aplicativos nos resultados de pesquisa. Comprimento mínimo = 1. Tamanho máximo = 127. Número máximo de etiquetas: 10 Padrão: "^[a-zA-Z0-9+\\-_:\\/@]+$"; |
name | string | True | O nome da aplicação. Comprimento mínimo = 1. Comprimento máximo = 140 Padrão: "[a-zA-Z0-9\\-]+"; |
spdxLicenseId | string | False | Um identificador válido de https://spdx.org/licenses/ |
BadRequestException
Um dos parâmetros na solicitação é inválido.
Propriedade | Tipo | Obrigatório | Descriçã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.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
errorCode | string | False | 409 |
mensagem | string | False | O recurso já existe. |
CreateApplicationInput
Crie uma solicitação de aplicativo.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
autor | string | True | O nome do autor que publica o aplicativo. Comprimento mínimo = 1. Tamanho máximo = 127. Padrão “^ [a-z0-9] (([a-z0-9] |- (?! -)) * [a-z0-9])? $”; |
descrição | string | True | A descrição do aplicativo. Comprimento mínimo = 1. Comprimento máximo = 256 |
homePageUrl | string | False | Uma URL com mais informações sobre o aplicativo, por exemplo, a localização do seu GitHub repositório para o aplicativo. |
rótulos | Matriz do tipo string | False | Rótulos para melhorar a descoberta de aplicativos nos resultados de pesquisa. Comprimento mínimo = 1. Tamanho máximo = 127. Número máximo de etiquetas: 10 Padrão: "^[a-zA-Z0-9+\\-_:\\/@]+$"; |
Órgão de licença | string | False | Um arquivo de texto local que contém a licença do aplicativo que corresponde ao valor SPDXLicenseID do seu aplicativo. O arquivo tem o formato Tamanho máximo 5 MB Você pode especificar somente um dos |
URL da licença | string | False | Um link para o objeto S3 que contém a licença do aplicativo que corresponde ao valor SPDXLicenseID do seu aplicativo. Tamanho máximo 5 MB Você pode especificar somente um dos |
name | string | True | O nome do aplicativo que você deseja publicar. Comprimento mínimo = 1. Comprimento máximo = 140 Padrão: "[a-zA-Z0-9\\-]+"; |
ReadMeBody | string | False | Um arquivo readme de texto local na linguagem Markdown que contém uma descrição mais detalhada do aplicativo e de como ele funciona. O arquivo tem o formato Tamanho máximo 5 MB Você pode especificar somente um dos |
URL do ReadMe | string | False | Um link para o objeto S3 na linguagem Markdown que contém uma descrição mais detalhada do aplicativo e de como ele funciona. Tamanho máximo 5 MB Você pode especificar somente um dos |
Versão semântica | string | False | A versão semântica do aplicativo: |
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. |
spdxLicenseId | string | False | Um identificador válido de https://spdx.org/licenses/ |
templateBody | string | False | O arquivo de AWS SAM modelo empacotado bruto local do seu aplicativo. O arquivo tem o formato Você pode especificar somente um dos |
URL do modelo | string | False | Um link para o objeto S3 contendo o AWS SAM modelo empacotado do seu aplicativo. Você pode especificar somente um dos |
ForbiddenException
O cliente não está autenticado.
Propriedade | Tipo | Obrigatório | Descriçã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.
Propriedade | Tipo | Obrigatório | Descriçã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.
Propriedade | Tipo | Obrigatório | Descriçã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.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
allowedPattern | string | False | Uma expressão regular que representa os padrões a serem permitidos para tipos |
allowedValues | Matriz do tipo string | 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
Ao adicionar uma descrição de restrição, como “deve conter somente letras maiúsculas e minúsculas e números”, você pode exibir a seguinte mensagem de erro personalizada:
|
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é 4.000 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 para |
Valor máximo | integer | False | Um valor numérico que determina o maior valor numérico que você deseja permitir para |
Comprimento mínimo | integer | False | Um valor inteiro que determina o menor número de caracteres que você deseja permitir para |
Valor mínimo | integer | False | Um valor numérico que determina o menor valor numérico que você deseja permitir para |
name | string | True | O nome do parâmetro. |
Um eco | booleano | False | Se o valor do parâmetro deve ser mascarado 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 do tipo string | True | Uma lista de AWS SAM recursos que usam esse parâmetro. |
tipo | string | False | O tipo do parâmetro. Valores válidos: Por exemplo, os usuários podem especificar Por exemplo, os usuários podem especificar Por exemplo, os usuários podem especificar “80,20" e, em seguida, resultar em Por exemplo, os usuários podem especificar “test, dev, prod” e, em seguida, |
TooManyRequestsException
O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo.
Propriedade | Tipo | Obrigatório | Descriçã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. |
Version
Detalhes da versão do aplicativo.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
applicationId | string | True | O nome de recurso da Amazon (ARN) do aplicativo do . |
creationTime | string | True | A data e a hora em que esse recurso foi criado. |
Definições de parâmetros | Matriz do tipo ParameterDefinition | True | Uma matriz de tipos de parâmetros suportados pelo aplicativo. |
requiredCapabilities | Matriz do tipo Capability | True | Uma lista de valores que você deve especificar antes de poder implantar determinados aplicativos. Alguns aplicativos podem incluir recursos que podem afetar as permissões em sua AWS conta, por exemplo, criando novos usuários AWS Identity and Access Management (IAM). Para esses aplicativos, você deve reconhecer explicitamente seus recursos especificando esse parâmetro. Os únicos valores válidos são Os recursos a seguir exigem que você especifique Os recursos a seguir exigem que você especifique Os aplicativos que contêm um ou mais aplicativos aninhados exigem que você especifique 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 os AWS 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 do aplicativo: |
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 o AWS SAM modelo empacotado do seu aplicativo. |
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs e referências de uma linguagem específica, consulte o seguinte: