Applications

URI

/applications

HTTP메서드

GET

작업 ID: ListApplications

요청자가 소유한 애플리케이션을 나열합니다.

쿼리 파라미터
명칭	유형	필수	설명
`maxItems`	String	False	반품할 총 아이템 개수.
`nextToken`	String	False	페이지 매김을 시작할 위치를 지정하기 위한 토큰입니다.

응답
상태 코드	응답 모델	설명
`200`	`ApplicationPage`	Success
`400`	`BadRequestException`	요청의 파라미터 중 하나가 잘못되었습니다.
`403`	`ForbiddenException`	클라이언트가 인증되지 않았습니다.
`404`	`NotFoundException`	요청에 지정된 리소스 (예: 액세스 정책 설명) 가 존재하지 않습니다.
`500`	`InternalServerErrorException`	The AWS Serverless Application Repository 서비스 내부 오류가 발생했습니다.

POST

작업 ID: CreateApplication

선택적으로 다음을 포함하는 애플리케이션을 생성합니다. AWS SAM동일한 호출로 첫 번째 애플리케이션 버전을 생성하기 위한 파일입니다.

응답
상태 코드	응답 모델	설명
`201`	`Application`	Success
`400`	`BadRequestException`	요청의 파라미터 중 하나가 잘못되었습니다.
`403`	`ForbiddenException`	클라이언트가 인증되지 않았습니다.
`409`	`ConflictException`	리소스가 이미 존재합니다.
`429`	`TooManyRequestsException`	클라이언트가 단위 시간당 허용된 요청 수보다 많은 요청을 보내고 있습니다.
`500`	`InternalServerErrorException`	The AWS Serverless Application Repository 서비스 내부 오류가 발생했습니다.

OPTIONS

응답
상태 코드	응답 모델	설명
`200`	None	응답 200개

스키마

요청 본문


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

응답 본문


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


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


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


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


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


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


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

속성

Application

신청서에 대한 세부 정보.

속성	유형	필수	설명
`applicationId`	문자열	True	애플리케이션 Amazon 리소스 이름 (ARN).
`author`	문자열	True	앱을 게시한 작성자의 이름. 최소 길이: 1. 최대 길이: 127. 패턴 “^ [a-z0-9] (([a-z0-9]] \|- (?! -)) * [a-z0-9])? $”;
`creationTime`	문자열	False	이 리소스가 생성된 날짜 및 시간
`description`	문자열	True	애플리케이션에 대한 설명입니다. 최소 길이: 1. 최대 길이=256명
`homePageUrl`	문자열	False	A에는 URL 응용 프로그램에 대한 자세한 정보 (예: 응용 프로그램의 GitHub 저장소 위치) 가 들어 있습니다.
`isVerifiedAuthor`	부울	False	이 응용 프로그램의 작성자가 확인되었는지 여부를 지정합니다. 즉, AWS 합리적이고 신중한 서비스 제공자로서 요청자가 제공한 정보를 선의로 검토하여 요청자의 신원이 주장된 것과 같음을 확인했습니다.
`labels`	유형 배열 string	False	검색 결과에서 앱을 더 쉽게 찾을 수 있게 해주는 라벨. 최소 길이: 1. 최대 길이: 127. 최대 라벨 수: 10개 패턴: "^[a-zA-Z0-9+\\-_:\\/@]+$";
`licenseUrl`	문자열	False	애플리케이션의 spdxLicense ID 값과 일치하는 앱의 라이선스 파일에 대한 링크. 최대 크기: 5MB
`name`	문자열	True	애플리케이션의 이름입니다. 최소 길이: 1. 최대 길이=140입니다. 패턴: "[a-zA-Z0-9\\-]+";
`readmeUrl`	문자열	False	애플리케이션에 대한 자세한 설명과 작동 방식이 들어 있는 마크다운 언어로 된 readme 파일로 연결되는 링크입니다. 최대 크기: 5MB
`spdxLicenseId`	문자열	False	https://spdx.org/licenses/ 에서 가져온 유효한 식별자입니다.
`verifiedAuthorUrl`	문자열	False	검증된 저자의 공개 프로필로. URL 이 URL 문서는 저자가 제출한 것입니다.
`version`	버전	False	애플리케이션에 대한 버전 정보.

ApplicationPage

애플리케이션 세부 정보 목록.

속성	유형	필수	설명
`applications`	유형 배열 ApplicationSummary	True	애플리케이션 요약 배열.
`nextToken`	문자열	False	결과의 다음 번 페이지를 요청하기 위한 토큰.

ApplicationSummary

애플리케이션에 대한 세부 정보 요약.

속성	유형	필수	설명
`applicationId`	문자열	True	애플리케이션 Amazon 리소스 이름 (ARN).
`author`	문자열	True	앱을 게시한 작성자의 이름. 최소 길이: 1. 최대 길이: 127. 패턴 “^ [a-z0-9] (([a-z0-9]] \|- (?! -)) * [a-z0-9])? $”;
`creationTime`	문자열	False	이 리소스가 생성된 날짜 및 시간
`description`	문자열	True	애플리케이션에 대한 설명입니다. 최소 길이: 1. 최대 길이=256명
`homePageUrl`	문자열	False	A에는 URL 응용 프로그램에 대한 자세한 정보 (예: 응용 프로그램의 GitHub 저장소 위치) 가 들어 있습니다.
`labels`	유형 배열 string	False	검색 결과에서 앱을 더 쉽게 찾을 수 있게 해주는 라벨. 최소 길이: 1. 최대 길이: 127. 최대 라벨 수: 10개 패턴: "^[a-zA-Z0-9+\\-_:\\/@]+$";
`name`	문자열	True	애플리케이션의 이름입니다. 최소 길이: 1. 최대 길이=140개 패턴: "[a-zA-Z0-9\\-]+";
`spdxLicenseId`	문자열	False	https://spdx.org/licenses/ 에서 가져온 유효한 식별자입니다.

BadRequestException

요청의 파라미터 중 하나가 잘못되었습니다.

속성	유형	필수	설명
`errorCode`	문자열	False	400
`message`	문자열	False	요청의 파라미터 중 하나가 잘못되었습니다.

Capability

일부 애플리케이션을 배포하기 위해 지정해야 하는 값입니다.

CAPABILITY_IAM
CAPABILITY_NAMED_IAM
CAPABILITY_AUTO_EXPAND
CAPABILITY_RESOURCE_POLICY

ConflictException

리소스가 이미 존재합니다.

속성	유형	필수	설명
`errorCode`	문자열	False	409
`message`	문자열	False	리소스가 이미 존재합니다.

CreateApplicationInput

애플리케이션 요청을 생성합니다.

속성	유형	필수	설명
`author`	문자열	True	앱을 게시한 작성자의 이름. 최소 길이: 1. 최대 길이: 127. 패턴 “^ [a-z0-9] (([a-z0-9]] \|- (?! -)) * [a-z0-9])? $”;
`description`	문자열	True	애플리케이션에 대한 설명입니다. 최소 길이: 1. 최대 길이=256입니다.
`homePageUrl`	문자열	False	A에는 URL 응용 프로그램에 대한 자세한 정보 (예: 응용 프로그램의 GitHub 저장소 위치) 가 들어 있습니다.
`labels`	유형 배열 string	False	검색 결과에서 앱을 더 쉽게 찾을 수 있게 해주는 라벨. 최소 길이: 1. 최대 길이: 127. 최대 라벨 수: 10개 패턴: "^[a-zA-Z0-9+\\-_:\\/@]+$";
`licenseBody`	문자열	False	애플리케이션의 spdxLicense ID 값과 일치하는 앱 라이선스가 포함된 로컬 텍스트 파일입니다. 파일 형식은 다음과 같습니다`file://<path>/<filename>`. 최대 크기: 5MB `licenseBody`및 중 하나만 지정할 수 있으며, `licenseUrl` 그렇지 않으면 오류가 발생합니다.
`licenseUrl`	문자열	False	애플리케이션의 spdxLicense ID 값과 일치하는 앱 라이선스가 포함된 S3 객체에 대한 링크입니다. 최대 크기: 5MB `licenseBody`및 중 하나만 지정할 수 있으며, `licenseUrl` 그렇지 않으면 오류가 발생합니다.
`name`	문자열	True	게시하려는 응용 프로그램의 이름. 최소 길이: 1. 최대 길이=140입니다. 패턴: "[a-zA-Z0-9\\-]+";
`readmeBody`	문자열	False	응용 프로그램 및 작동 방식에 대한 자세한 설명이 들어 있는 마크다운 언어의 로컬 텍스트 추가 정보 파일입니다. 파일 형식은 다음과 같습니다. `file://<path>/<filename>` 최대 크기: 5MB `readmeBody`및 중 하나만 지정할 수 있으며, `readmeUrl` 그렇지 않으면 오류가 발생합니다.
`readmeUrl`	문자열	False	애플리케이션에 대한 자세한 설명과 작동 방식을 포함하는 마크다운 언어의 S3 객체 링크입니다. 최대 크기: 5MB `readmeBody`및 중 하나만 지정할 수 있으며, `readmeUrl` 그렇지 않으면 오류가 발생합니다.
`semanticVersion`	문자열	False	애플리케이션의 시맨틱 버전: https://semver.org/
`sourceCodeArchiveUrl`	문자열	False	이 버전의 애플리케이션에 대한 소스 코드 ZIP 아카이브가 들어 있는 S3 객체에 대한 링크입니다. 최대 크기: 50MB
`sourceCodeUrl`	문자열	False	애플리케이션의 소스 코드 (예: 특정 GitHub 커밋) 를 위한 공개 리포지토리로 연결되는 링크입니다. URL
`spdxLicenseId`	문자열	False	https://spdx.org/licenses/ 에서 가져온 유효한 식별자.
`templateBody`	문자열	False	로컬 원시 패키지 AWS SAM 애플리케이션의 템플릿 파일. 파일 형식은 다음과 같습니다`file://<path>/<filename>`. `templateBody`및 중 하나만 지정할 수 있습니다`templateUrl`. 그렇지 않으면 오류가 발생합니다.
`templateUrl`	문자열	False	패키지가 포함된 S3 객체에 대한 링크 AWS SAM 애플리케이션의 템플릿. `templateBody`및 중 하나만 지정할 수 있습니다`templateUrl`. 그렇지 않으면 오류가 발생합니다.

ForbiddenException

클라이언트가 인증되지 않았습니다.

속성	유형	필수	설명
`errorCode`	문자열	False	403
`message`	문자열	False	클라이언트가 인증되지 않았습니다.

InternalServerErrorException

The AWS Serverless Application Repository 서비스 내부 오류가 발생했습니다.

속성	유형	필수	설명
`errorCode`	문자열	False	500
`message`	문자열	False	The AWS Serverless Application Repository 서비스 내부 오류가 발생했습니다.

NotFoundException

요청에 지정된 리소스 (예: 액세스 정책 설명) 가 존재하지 않습니다.

속성	유형	필수	설명
`errorCode`	문자열	False	404
`message`	문자열	False	요청에 지정된 리소스 (예: 액세스 정책 설명) 가 존재하지 않습니다.

ParameterDefinition

애플리케이션에서 지원하는 매개변수.

속성	유형	필수	설명
`allowedPattern`	문자열	False	`String` 유형에 허용할 패턴을 나타내는 정규식입니다.
`allowedValues`	유형 배열 string	False	파라미터에 허용되는 값 목록을 포함하는 어레이입니다.
`constraintDescription`	문자열	False	제약 위반 시 해당 제약을 설명하는 문자열입니다. 예를 들어 제약 설명이 없으면 `[A-Za-z0-9]+` 패턴이 허용된 파라미터에 사용자가 유효하지 않은 값을 지정할 때 다음과 같은 오류 메시지가 표시됩니다. `Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+` “대문자와 소문자와 숫자만 포함해야 함”과 같은 제약 조건 설명을 추가하여 다음과 같은 사용자 지정 오류 메시지를 표시할 수 있습니다. `Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.`
`defaultValue`	문자열	False	스택 생성 시 지정된 값이 없는 경우에 사용할 템플릿에 적합한 유형의 값입니다. 파라미터에 대한 제약을 정의하는 경우 이러한 제약을 준수하는 값을 지정해야 합니다.
`description`	문자열	False	매개변수를 설명하는 최대 4,000자의 문자열.
`maxLength`	정수	False	유형에 허용하려는 최대 문자 수를 결정하는 정수 값입니다. `String`
`maxValue`	정수	False	유형에 허용하려는 최대 숫자 값을 결정하는 숫자 값입니다. `Number`
`minLength`	정수	False	유형에 허용하려는 최소 문자 수를 결정하는 정수 값입니다. `String`
`minValue`	정수	False	유형에 허용하려는 최소 숫자 값을 결정하는 숫자 값입니다. `Number`
`name`	문자열	True	파라미터의 이름입니다.
`noEcho`	부울	False	스택을 설명하는 호출을 하는 사람이 있을 때마다 매개 변수 값을 마스킹할지 여부. 값을 true로 설정하면 파라미터 값이 별표 (*****) 로 마스킹됩니다.
`referencedByResources`	유형 배열 string	True	목록: AWS SAM 이 파라미터를 사용하는 리소스.
`type`	문자열	False	파라미터 유형. 유효값: `String \| Number \| List<Number> \| CommaDelimitedList` `String`: 리터럴 문자열. 예를 들어, 사용자가 지정할 `"MyUserName"` 수 있습니다. `Number`: 정수 또는 부동 소수점. AWS CloudFormation 파라미터 값을 숫자로 검증합니다. 하지만 템플릿의 다른 곳에서 매개 변수를 사용하면 (예: `Ref` 내장 함수 사용) 매개 변수 값이 문자열이 됩니다. 예를 들어 사용자가 지정할 수 있습니다. `"8888"` `List<Number>`: 쉼표로 구분된 정수 또는 부동 소수점 배열. AWS CloudFormation 파라미터 값을 숫자로 검증합니다. 그러나 템플릿의 다른 곳에서 매개 변수를 사용하는 경우 (예: `Ref` 내장 함수 사용) 에는 매개 변수 값이 문자열 목록이 됩니다. 예를 들어, 사용자가 “80,20"을 지정하면 결과가 나올 수 있습니다. `Ref` `["80","20"]` `CommaDelimitedList`: 쉼표로 구분된 리터럴 문자열의 배열입니다. 총 문자열 수는 총 쉼표 수보다 하나 더 많아야 합니다. 또한 각 멤버 문자열은 공백으로 구분됩니다. 예를 들어 사용자가 “test, dev, prod”를 지정한 다음 결과를 반환할 수 있습니다. `Ref` `["test","dev","prod"]`

TooManyRequestsException

클라이언트가 단위 시간당 허용된 요청 수보다 많은 요청을 보내고 있습니다.

속성	유형	필수	설명
`errorCode`	문자열	False	429
`message`	문자열	False	클라이언트가 단위 시간당 허용된 요청 수보다 많은 요청을 보내고 있습니다.

Version

애플리케이션 버전 세부 정보.

속성	유형	필수	설명
`applicationId`	문자열	True	애플리케이션 Amazon 리소스 이름 (ARN).
`creationTime`	문자열	True	이 리소스가 생성된 날짜 및 시간.
`parameterDefinitions`	유형 배열 ParameterDefinition	True	애플리케이션에서 지원하는 파라미터 유형의 배열.
`requiredCapabilities`	유형의 배열 기능	True	특정 애플리케이션을 배포하기 전에 지정해야 하는 값 목록입니다. 일부 응용 프로그램에는 사용자의 권한에 영향을 줄 수 있는 리소스가 포함되어 있을 수 있습니다. AWS 계정 (예: 새 계정 생성) AWS Identity and Access Management (IAM) 사용자. 이러한 응용 프로그램의 경우 이 매개변수를 지정하여 해당 응용 프로그램의 기능을 명시적으로 확인해야 합니다. 유효한 값은`CAPABILITY_IAM`,, `CAPABILITY_NAMED_IAMCAPABILITY_RESOURCE_POLICY`, 뿐입니다. `CAPABILITY_AUTO_EXPAND` 다음 리소스에서는 `CAPABILITY_IAM` 또는`CAPABILITY_NAMED_IAM`::: AWS: :그룹,IAM::: AWS ::,:IAM:InstanceProfile,AWS: :정책 및 IAMAWS:: :역할을 지정해야 합니다 IAM. 애플리케이션에 IAM 리소스가 포함된 경우 또는 중 하나를 지정할 수 있습니다. `CAPABILITY_IAM` `CAPABILITY_NAMED_IAM` 응용 프로그램에 사용자 지정 이름을 가진 IAM 리소스가 포함된 경우 지정해야 합니다`CAPABILITY_NAMED_IAM`. 다음 리소스에서는:: :Lambda `CAPABILITY_RESOURCE_POLICY`AWS: :권한,: ::정책 ,AWS::::IAM,: AWS :S3 AWS ::,ApplicationAutoScaling:ScalingPolicy::, 및:::: 를 지정해야 합니다 SQS. BucketPolicy AWS QueuePolicy AWS SNS TopicPolicy 중첩 애플리케이션을 한 개 이상 포함하는 애플리케이션은 `CAPABILITY_AUTO_EXPAND`를 지정해야 합니다. 애플리케이션 템플릿에 위의 리소스가 포함되어 있는 경우 배포하기 전에 애플리케이션과 관련된 모든 권한을 검토하는 것이 좋습니다. 기능이 필요한 애플리케이션에 이 매개 변수를 지정하지 않으면 호출이 실패합니다.
`resourcesSupported`	boolean	True	모든 여부 AWS 이 응용 프로그램에 포함된 리소스가 검색되는 지역에서 지원되는지 여부
`semanticVersion`	문자열	True	애플리케이션의 시맨틱 버전: https://semver.org/
`sourceCodeArchiveUrl`	문자열	False	이 버전의 애플리케이션에 대한 소스 코드 ZIP 아카이브가 들어 있는 S3 객체에 대한 링크입니다. 최대 크기: 50MB
`sourceCodeUrl`	문자열	False	애플리케이션의 소스 코드 (예: 특정 GitHub 커밋) 를 위한 공개 리포지토리로 연결되는 링크입니다. URL
`templateUrl`	문자열	True	패키지로 연결되는 링크 AWS SAM 애플리케이션 템플릿.

다음 사항도 참조하세요.

언어별 사용 방법에 대한 자세한 내용은 다음을 참조하십시오. API AWS SDKs및 참고 문헌은 다음을 참조하십시오.

ListApplications

CreateApplication

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

리소스

애플리케이션 applicationId