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á. # Aplicativos ApplicationID ## URI `/applications/applicationId` ## Métodos HTTP ### GET **ID da operação:** `GetApplication` Obtém o aplicativo especificado. **Parâmetros de caminho** | Nome | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | applicationId | String | Verdadeiro | O nome de recurso da Amazon (ARN) do aplicativo. | **Parâmetros de consulta** | Nome | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | semanticVersion | String | Falso | A versão semântica do aplicativo a ser obtida. | **Respostas** | Código de status | Modelo de resposta | Description | | --- |--- |--- | | 200 | Application | 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. | | 429 | TooManyRequestsException | O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo. | | 500 | InternalServerErrorException | O AWS Serverless Application Repository serviço encontrou um erro interno. | ### DELETE **ID da operação:** `DeleteApplication` Exclui o aplicativo especificado. **Parâmetros de caminho** | Nome | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | applicationId | String | Verdadeiro | O nome de recurso da Amazon (ARN) do aplicativo. | **Respostas** | Código de status | Modelo de resposta | Description | | --- |--- |--- | | 204 | Nenhum | 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. | | 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 AWS Serverless Application Repository serviço encontrou um erro interno. | ### OPTIONS **Parâmetros de caminho** | Nome | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | applicationId | String | Verdadeiro | O nome de recurso da Amazon (ARN) do aplicativo. | **Respostas** | Código de status | Modelo de resposta | Description | | --- |--- |--- | | 200 | Nenhum | 200 respostas | ### PATCH **ID da operação:** `UpdateApplication` Atualiza o aplicativo especificado. **Parâmetros de caminho** | Nome | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | applicationId | String | Verdadeiro | O nome de recurso da Amazon (ARN) do aplicativo. | **Respostas** | Código de status | Modelo de resposta | Description | | --- |--- |--- | | 200 | Application | 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. | | 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 AWS Serverless Application Repository serviço encontrou um erro interno. | ## Esquemas ### Corpos da solicitação #### Esquema PATCH ``` { "description": "string", "author": "string", "readmeBody": "string", "readmeUrl": "string", "labels": [ "string" ], "homePageUrl": "string" } ``` ### Corpos da resposta #### Esquema 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 } } ``` #### Esquema BadRequestException ``` { "message": "string", "errorCode": "string" } ``` #### Esquema ForbiddenException ``` { "message": "string", "errorCode": "string" } ``` #### Esquema NotFoundException ``` { "message": "string", "errorCode": "string" } ``` #### Esquema ConflictException ``` { "message": "string", "errorCode": "string" } ``` #### Esquema TooManyRequestsException ``` { "message": "string", "errorCode": "string" } ``` #### Esquema InternalServerErrorException ``` { "message": "string", "errorCode": "string" } ``` ## Propriedades ### Application Detalhes sobre o aplicativo. | Propriedade | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | applicationId | string | Verdadeiro | O nome de recurso da Amazon (ARN) do aplicativo do . | | author | string | Verdadeiro | O nome do autor que publica o aplicativo.Comprimento mínimo = 1. Tamanho máximo = 127.Padrão “^ [a-z0-9] (([a-z0-9] \$1- (?\$1 -)) \$1 [a-z0-9])? \$1”; | | creationTime | string | Falso | A data e a hora em que esse recurso foi criado. | | description | string | Verdadeiro | A descrição do aplicativo.Comprimento mínimo = 1. Comprimento máximo = 256 | | homePageUrl | string | Falso | Uma URL com mais informações sobre o aplicativo, por exemplo, a localização do seu GitHub repositório para o aplicativo. | | isVerifiedAuthor | booleano | Falso | 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. | | labels | Matriz do tipo string | Falso | 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: 10Padrão: "^[a-zA-Z0-9\$1\$1\$1-\$1:\$1\$1/@]\$1\$1"; | | licenseUrl | string | Falso | 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 | Verdadeiro | O nome da aplicação.Comprimento mínimo = 1. Comprimento máximo = 140Padrão: "[a-zA-Z0-9\$1\$1-]\$1"; | | readmeUrl | string | Falso | 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 | Falso | Um identificador válido de https://spdx.org/licenses/. | | verifiedAuthorUrl | string | Falso | O URL do perfil público de um autor verificado. Esse URL foi enviado pelo autor. | | version | [Versão](#applications-applicationid-model-version) | Falso | Informações sobre a versão do aplicativo. | ### BadRequestException Um dos parâmetros na solicitação é inválido. | Propriedade | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | errorCode | string | Falso | 400 | | message | string | Falso | 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 | Falso | 409 | | message | string | Falso | O recurso já existe. | ### ForbiddenException O cliente não está autenticado. | Propriedade | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | errorCode | string | Falso | 403 | | message | string | Falso | O cliente não está autenticado. | ### InternalServerErrorException O AWS Serverless Application Repository serviço encontrou um erro interno. | Propriedade | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | errorCode | string | Falso | 500 | | message | string | Falso | O AWS Serverless Application Repository serviço 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 | Falso | 404 | | message | string | Falso | 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 | Falso | Uma expressão regular que representa os padrões a serem permitidos para tipos `String`. | | allowedValues | Matriz do tipo string | Falso | Uma matriz que contém a lista de valores permitidos para o parâmetro. | | constraintDescription | string | Falso | 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 somente 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 | Falso | 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. | | description | string | Falso | Uma sequência de até 4.000 caracteres que descreve o parâmetro. | | maxLength | integer | Falso | Um valor inteiro que determina o maior número de caracteres que você deseja permitir para `String` tipos. | | maxValue | integer | Falso | Um valor numérico que determina o maior valor numérico que você deseja permitir para `Number` tipos. | | minLength | integer | Falso | Um valor inteiro que determina o menor número de caracteres que você deseja permitir para `String` tipos. | | minValue | integer | Falso | Um valor numérico que determina o menor valor numérico que você deseja permitir para `Number` tipos. | | name | string | Verdadeiro | O nome do parâmetro. | | noEcho | booleano | Falso | 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 (\$1\$1\$1\$1\$1). | | referencedByResources | Matriz do tipo string | Verdadeiro | Uma lista de AWS SAM recursos que usam esse parâmetro. | | type | string | Falso | O tipo do parâmetro.Valores válidos: `String \| Number \| List \| CommaDelimitedList` `String`: Uma sequência de caracteres literal.Por exemplo, os usuários podem especificar`"MyUserName"`. `Number`: Um número inteiro ou flutuante. CloudFormation valida o valor do parâmetro como um número. No entanto, quando você usa o parâmetro em outro lugar em seu modelo (por exemplo, usando a função `Ref` intrínseca), o valor do parâmetro se torna uma string.Por exemplo, os usuários podem especificar`"8888"`. `List`: uma matriz de números inteiros ou flutuantes separados por vírgulas. CloudFormation valida o valor do parâmetro como números. No entanto, quando você usa o parâmetro em outro lugar do seu modelo (por exemplo, usando a função `Ref` intrínseca), o valor do parâmetro se torna uma lista de cadeias de caracteres.Por exemplo, os usuários podem especificar “80,20" e, em seguida, resultar em`Ref`. `["80","20"]` `CommaDelimitedList`: uma matriz de cadeias de caracteres literais 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 de membros é cortada com 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. | Propriedade | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | errorCode | string | Falso | 429 | | message | string | Falso | O cliente está enviando mais do que o número permitido de solicitações por unidade de tempo. | ### UpdateApplicationInput Atualize a solicitação do aplicativo. | Propriedade | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | author | string | Falso | O nome do autor que publica o aplicativo.Comprimento mínimo = 1. Tamanho máximo = 127.Padrão “^ [a-z0-9] (([a-z0-9] \$1- (?\$1 -)) \$1 [a-z0-9])? \$1”; | | description | string | Falso | A descrição do aplicativo.Comprimento mínimo = 1. Comprimento máximo = 256 | | homePageUrl | string | Falso | Uma URL com mais informações sobre o aplicativo, por exemplo, a localização do seu GitHub repositório para o aplicativo. | | labels | Matriz do tipo string | Falso | 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: 10Padrão: "^[a-zA-Z0-9\$1\$1\$1-\$1:\$1\$1/@]\$1\$1"; | | readmeBody | string | Falso | Um arquivo readme de texto na linguagem Markdown que contém uma descrição mais detalhada do aplicativo e de como ele funciona.Tamanho máximo 5 MB | | readmeUrl | string | Falso | 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. | Propriedade | Tipo | Obrigatório | Descrição | | --- |--- |--- |--- | | applicationId | string | Verdadeiro | O nome de recurso da Amazon (ARN) do aplicativo do . | | creationTime | string | Verdadeiro | A data e a hora em que esse recurso foi criado. | | parameterDefinitions | Matriz do tipo [ParameterDefinition](#applications-applicationid-model-parameterdefinition) | Verdadeiro | Uma matriz de tipos de parâmetros suportados pelo aplicativo. | | requiredCapabilities | Matriz do tipo [Capability](#applications-applicationid-model-capability) | Verdadeiro | 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 `CAPABILITY_IAM` `CAPABILITY_NAMED_IAM``CAPABILITY_RESOURCE_POLICY`,, `CAPABILITY_AUTO_EXPAND` e.Os recursos a seguir exigem que você especifique `CAPABILITY_IAM` ou`CAPABILITY_NAMED_IAM`: [AWS::IAM::Group[AWS::IAM::InstanceProfile[AWS::IAM::Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html),, [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)e. Se o aplicativo contiver recursos do IAM, você poderá especificar `CAPABILITY_IAM` ou`CAPABILITY_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ê especifique`CAPABILITY_RESOURCE_POLICY`: [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html), [AWS: :iam:policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html),, [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html), e. [AWS::S3::BucketPolicy[AWS::SQS::QueuePolicy[AWS::SNS::TopicPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html)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á. | | resourcesSupported | booliano | Verdadeiro | Se todos os AWS recursos contidos nesse aplicativo são suportados na região em que ele está sendo recuperado. | | semanticVersion | string | Verdadeiro | A versão semântica do aplicativo: [https://semver.org/](https://semver.org/) | | sourceCodeArchiveUrl | string | Falso | 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 | Falso | 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. | | templateUrl | string | Verdadeiro | 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 uma das referências AWS SDKs e linguagens específicas, consulte o seguinte: ### GetApplication + [Interface de linha de comando da AWS V2](/goto/cli2/serverlessrepo-2017-09-08/GetApplication) + [SDK da AWS para .NET V4](/goto/DotNetSDKV4/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK para C\$1\$1](/goto/SdkForCpp/serverlessrepo-2017-09-08/GetApplication) + [SDK da AWS para Go v2](/goto/SdkForGoV2/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK para Java V2](/goto/SdkForJavaV2/serverlessrepo-2017-09-08/GetApplication) + [SDK da AWS para JavaScript V3](/goto/SdkForJavaScriptV3/serverlessrepo-2017-09-08/GetApplication) + [SDK da AWS para Kotlin](/goto/SdkForKotlin/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK para PHP V3](/goto/SdkForPHPV3/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK para Python](/goto/boto3/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK para Ruby V3](/goto/SdkForRubyV3/serverlessrepo-2017-09-08/GetApplication) ### DeleteApplication + [Interface de linha de comando da AWS V2](/goto/cli2/serverlessrepo-2017-09-08/DeleteApplication) + [SDK da AWS para .NET V4](/goto/DotNetSDKV4/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK para C\$1\$1](/goto/SdkForCpp/serverlessrepo-2017-09-08/DeleteApplication) + [SDK da AWS para Go v2](/goto/SdkForGoV2/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK para Java V2](/goto/SdkForJavaV2/serverlessrepo-2017-09-08/DeleteApplication) + [SDK da AWS para JavaScript V3](/goto/SdkForJavaScriptV3/serverlessrepo-2017-09-08/DeleteApplication) + [SDK da AWS para Kotlin](/goto/SdkForKotlin/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK para PHP V3](/goto/SdkForPHPV3/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK para Python](/goto/boto3/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK para Ruby V3](/goto/SdkForRubyV3/serverlessrepo-2017-09-08/DeleteApplication) ### UpdateApplication + [Interface de linha de comando da AWS V2](/goto/cli2/serverlessrepo-2017-09-08/UpdateApplication) + [SDK da AWS para .NET V4](/goto/DotNetSDKV4/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK para C\$1\$1](/goto/SdkForCpp/serverlessrepo-2017-09-08/UpdateApplication) + [SDK da AWS para Go v2](/goto/SdkForGoV2/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK para Java V2](/goto/SdkForJavaV2/serverlessrepo-2017-09-08/UpdateApplication) + [SDK da AWS para JavaScript V3](/goto/SdkForJavaScriptV3/serverlessrepo-2017-09-08/UpdateApplication) + [SDK da AWS para Kotlin](/goto/SdkForKotlin/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK para PHP V3](/goto/SdkForPHPV3/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK para Python](/goto/boto3/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK para Ruby V3](/goto/SdkForRubyV3/serverlessrepo-2017-09-08/UpdateApplication)