Applications

URI

/applications

HTTP 메소드

GET

작업 ID: ListApplications

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

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

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

POST

작업 ID: CreateApplication

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

응답
상태 코드	응답 모델	설명
`201`	`Application`	Success
`400`	`BadRequestException`	요청의 파라미터 중 하나가 잘못되었습니다.
`403`	`ForbiddenException`	클라이언트가 인증되지 않았습니다.
`409`	`ConflictException`	리소스가 이미 존재합니다.
`429`	`TooManyRequestsException`	클라이언트가 시간 단위당 허용된 요청 수를 초과하여 전송하고 있습니다.
`500`	`InternalServerErrorException`	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).
`작성자`	문자열	True	앱을 게시하는 작성자의 이름입니다. 최소 길이: 1. 최대 길이: 127. 패턴 "^[a-z0-9](([a-z0-9]\|-(?!-))*[a-z0-9])?$";
`creationTime`	문자열	False	이 리소스가 생성된 날짜 및 시간입니다.
`설명`	문자열	True	애플리케이션에 대한 설명입니다. 최소 길이: 1. 최대 길이=256
`homePageUrl`	문자열	False	애플리케이션에 대한 GitHub 리포지토리의 위치와 같은 애플리케이션에 대한 자세한 정보가 포함된 URL입니다.
`isVerifiedAuthor`	boolean	False	이 애플리케이션의 작성자가 확인되었는지 여부를 지정합니다. 즉, AWS 는 합리적이고 신중한 서비스 공급자로서 요청자가 제공한 정보를 성실하게 검토했으며 요청자의 자격 증명이 청구된 대로임을 확인했습니다.
`labels`	유형 string의 배열	False	검색 결과에서 앱 검색을 개선하기 위한 레이블입니다. 최소 길이: 1. 최대 길이: 127. 최대 레이블 수: 10 패턴: "^[a-zA-Z0-9+\\-_:\\/@]+$";
`licenseUrl`	문자열	False	애플리케이션의 spdxLicenseID 값과 일치하는 앱의 라이선스 파일에 대한 링크입니다. 최대 크기 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

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

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

ApplicationSummary

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

속성	유형	필수	설명
`applicationId`	문자열	True	애플리케이션 Amazon 리소스 이름(ARN).
`작성자`	문자열	True	앱을 게시하는 작성자의 이름입니다. 최소 길이: 1. 최대 길이: 127. 패턴 "^[a-z0-9](([a-z0-9]\|-(?!-))*[a-z0-9])?$";
`creationTime`	문자열	False	이 리소스가 생성된 날짜 및 시간입니다.
`설명`	문자열	True	애플리케이션에 대한 설명입니다. 최소 길이: 1. 최대 길이=256
`homePageUrl`	문자열	False	애플리케이션에 대한 GitHub 리포지토리의 위치와 같은 애플리케이션에 대한 자세한 정보가 포함된 URL입니다.
`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

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

속성	유형	필수	설명
`작성자`	문자열	True	앱을 게시하는 작성자의 이름입니다. 최소 길이: 1. 최대 길이: 127. 패턴 "^[a-z0-9](([a-z0-9]\|-(?!-))*[a-z0-9])?$";
`설명`	문자열	True	애플리케이션에 대한 설명입니다. 최소 길이: 1. 최대 길이=256
`homePageUrl`	문자열	False	애플리케이션에 대한 GitHub 리포지토리의 위치와 같은 애플리케이션에 대한 자세한 정보가 포함된 URL입니다.
`labels`	유형 string의 배열	False	검색 결과에서 앱 검색을 개선하기 위한 레이블입니다. 최소 길이: 1. 최대 길이: 127. 최대 레이블 수: 10 패턴: "^[a-zA-Z0-9+\\-_:\\/@]+$";
`licenseBody`	문자열	False	애플리케이션의 spdxLicenseID 값과 일치하는 앱의 라이선스가 포함된 로컬 텍스트 파일입니다. 파일의 형식은 입니다`file://<path>/<filename>`. 최대 크기 5MB `licenseBody` 및 중 하나만 지정할 수 있습니다. `licenseUrl`그렇지 않으면 오류가 발생합니다.
`licenseUrl`	문자열	False	애플리케이션의 spdxLicenseID 값과 일치하는 앱의 라이선스가 포함된 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	애플리케이션의 패키징된 AWS SAM 템플릿이 포함된 S3 객체에 대한 링크입니다. `templateBody` 및 중 하나만 지정할 수 있습니다. 그렇지 `templateUrl`않으면 오류가 발생합니다.

ForbiddenException

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

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

InternalServerErrorException

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

속성	유형	필수	설명
`errorCode`	문자열	False	500
`message`	문자열	False	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	스택 생성 시 지정된 값이 없는 경우에 사용할 템플릿에 적합한 유형의 값입니다. 파라미터에 대한 제약을 정의하는 경우 이러한 제약을 준수하는 값을 지정해야 합니다.
`설명`	문자열	False	파라미터를 설명하는 최대 4,000자의 문자열입니다.
`maxLength`	정수	False	`String` 유형에 허용할 최대 문자 수를 결정하는 정수 값입니다.
`maxValue`	정수	False	`Number` 유형에 허용할 가장 큰 숫자 값을 결정하는 숫자 값입니다.
`minLength`	정수	False	`String` 유형에 허용할 가장 작은 문자 수를 결정하는 정수 값입니다.
`minValue`	정수	False	`Number` 유형에 허용할 가장 작은 숫자 값을 결정하는 숫자 값입니다.
`name`	문자열	True	파라미터의 이름입니다.
`noEcho`	boolean	False	스택을 설명하는 호출을 할 때마다 파라미터 값을 마스킹할지 여부입니다. 값을 true로 설정하면 파라미터 값이 별표(*****)로 마스킹됩니다.
`referencedByResources`	유형 string의 배열	True	이 파라미터를 사용하는 AWS SAM 리소스 목록입니다.
`type`	문자열	False	파라미터의 유형입니다. 유효값: `String \| Number \| List<Number> \| CommaDelimitedList` `String`: 리터럴 문자열입니다. 예를 들어 사용자는를 지정할 수 있습니다`"MyUserName"`. `Number`: 정수 또는 float. AWS CloudFormation valid는 파라미터 값을 숫자로 확인합니다. 그러나 템플릿의 다른 곳에서 파라미터를 사용하는 경우(예: `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`	유형 Capability의 배열	True	특정 애플리케이션을 배포하기 전에 지정해야 하는 값 목록입니다. 일부 애플리케이션에는 AWS 계정의 권한에 영향을 미칠 수 있는 리소스가 포함될 수 있습니다. 예를 들어, 새 AWS Identity and Access Management (IAM) 사용자를 생성해야 합니다. 이러한 애플리케이션의 경우이 파라미터를 지정하여 해당 기능을 명시적으로 승인해야 합니다. 유일하게 유효한 값은 `CAPABILITY_IAM`, `CAPABILITY_RESOURCE_POLICY`, `CAPABILITY_NAMED_IAM`및 입니다`CAPABILITY_AUTO_EXPAND`. 다음 리소스에는 `CAPABILITY_IAM` 또는 `CAPABILITY_NAMED_IAM`을 지정해야 합니다. AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. 애플리케이션에 IAM 리소스가 포함된 경우 `CAPABILITY_IAM` 또는 중 하나를 지정할 수 있습니다`CAPABILITY_NAMED_IAM`. 애플리케이션에 사용자 지정 이름을 가진 IAM 리소스가 포함되어 있는 경우 `CAPABILITY_NAMED_IAM`을 지정해야 합니다. 다음 리소스를 지정해야 합니다`CAPABILITY_RESOURCE_POLICY`. AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::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 템플릿에 대한 링크입니다.

다음 사항도 참조하세요.

언어별 AWS SDKs 및 참조 중 하나에서이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.

ListApplications

CreateApplication

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

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

문서 규칙

리소스

애플리케이션 applicationId