제품 검색 프로비저닝 요청 프로비저닝된 제품 프로비저닝된 제품 계획 포트폴리오 보안 주체 연결 Products 아티팩트 프로비저닝 제약 조건 서비스 작업 TagOption AppRegistry 워크플로 예제

AWS Service Catalog API 개요

Service Catalog API 사용의 이점

AWS Service Catalog API는를 사용하는 대신 모든 최종 사용자 작업에 대한 프로그래밍 방식의 제어를 제공합니다 AWS Management Console. API를 사용할 때 다음을 수행할 수 있습니다.

자체 사용자 지정 인터페이스 및 앱 작성
최종 사용자 제품 프로비저닝 작업에 대한 세분화된 제어 확보
리소스 프로비저닝을 오케스트레이션 파이프라인에 통합
리소스를 사용하여 애플리케이션을 호스팅하는 중앙 위치에 액세스

Service Catalog 액세스

언어별 APIs 사용하여 애플리케이션을 빌드하려면 소프트웨어 개발자를 위한 라이브러리, 샘플 코드, 자습서 및 기타 리소스를 사용합니다. 이 라이브러리는 HTTP/HTTPS 요청에 암호화된 사인하기, 다시 요청을 보내기, 오류 응답 처리하기 등의, 작업을 자동화할 수 있는 기본적인 기능을 제공합니다. 시작하려면 Amazon Web Services용 도구를 열고 SDK에서 원하는 SDKs를 찾습니다.

명령줄 인터페이스를 선호하는 고객의 경우 다음과 같은 옵션이 있습니다.

AWS 명령줄 인터페이스(CLI): 시작하려면 AWS Command Line Interface 사용 설명서를 참조하세요. Service Catalog의 명령에 대한 자세한 내용은 명령 참조의 servicecatalog를 AWS CLI 참조하세요.
AWS Windows PowerShell용 도구: 시작하려면 AWS Tools for PowerShell 사용 설명서를 참조하세요. Service Catalog용 cmdlet에 대한 자세한 내용은 AWS Tools for PowerShell Cmdlet 참조를 열고를 확장합니다AWS Service Catalog.

AWS Service Catalog API는 논리적으로 다음 범주로 나눌 수 있습니다.

제품 검색

이러한 작업을 사용하여 제품 및 제품의 시작 요구 사항에 대한 정보를 검색하거나 가져옵니다. 이러한 작업은 리소스를 생성하거나 수정하지 않습니다.

SearchProducts

호출자가 액세스할 수 있는 모든 제품을 나열합니다.

DescribeProduct

제품에 대한 자세한 정보를 가져옵니다.

DescribeProductView

제품의 ID 대신 제품 보기의 ID를 사용한다는 점을 DescribeProduct제외하면와 기능적으로 동일합니다.

ListLaunchPaths

사용자가 지정된 제품에 액세스할 수 있는 모든 방법을 나열합니다. 이를 제품 경로라고 합니다. 사용자가 제품을 프로비저닝하려면 경로를 선택해야 합니다.

DescribeProvisioningParameters

지정된 제품을 프로비저닝하는 데 필요한 파라미터를 가져오고 제품이 프로비저닝될 때 발생하는 상황에 대한 추가 메타데이터를 제공합니다.

각 ProvisioningArtifactParameter는 사용자가 제품을 성공적으로 프로비저닝하기 위해 지정해야 하는 항목입니다(예: EC2 인스턴스의 크기). ConstraintSummary 객체에는 허용 가능한 값 목록과 ProvisioningArtifactParameter 객체에 대한 추가 메타데이터가 포함됩니다.

프로비저닝 요청

이러한 작업을 사용하여 제품에 대한 프로비저닝을 요청, 업데이트 또는 종료합니다.

ProvisionProduct: 제품에 대한 프로비저닝을 요청합니다. 제품을 프로비저닝하려면 실제 사용을 위해 해당 제품을 온라인 상태로 만드는 데 필요한 리소스를 시작합니다. 예를 들어 CloudFormation 템플릿으로 지원되는 제품을 프로비저닝하면 CloudFormation 스택과 모든 기본 리소스가 시작됩니다.
UpdateProvisionedProduct: 프로비저닝된 제품의 구성을 업데이트합니다. 예를 들어에서 지원하는 제품은 기본 CloudFormation 스택을 업데이트 CloudFormation 합니다. 요청자는 지정된 ProvisionedProduct에 대한 충분한 액세스 권한이 있어야 합니다.
TerminateProvisionedProduct: 프로비저닝된 제품의 종료를 요청합니다. 예를 들어에서 지원하는 제품의 경우 기본 CloudFormation 스택이 CloudFormation삭제됩니다. 요청자는 지정된 프로비저닝된 제품에 대한 충분한 액세스 권한이 있어야 합니다.

프로비저닝된 제품

이러한 작업을 사용하여 프로비저닝된 제품에 대한 정보를 가져옵니다. 이러한 작업은 리소스를 생성하거나 수정하지 않습니다.

ListRecordHistory: 종료된 프로비저닝된 제품에 대해서도 수행된 모든 요청을 나열합니다.
DescribeRecord: 요청에 대한 정보를 가져옵니다. 요청 작업 후이 작업을 사용하여 현재 RecordDetail 정보를 가져옵니다.
SearchProvisionedProducts: 지정된 기준을 충족하는 프로비저닝된 제품에 대한 정보를 가져옵니다.
ScanProvisionedProducts: 종료되지 않은 프로비저닝된 제품을 나열합니다.
DescribeProvisionedProduct: 프로비저닝된 제품에 대한 정보를 가져옵니다.
ImportAsProvisionedProduct: Service Catalog 제품 및 프로비저닝 아티팩트와 연결된 Service Catalog 프로비저닝된 제품으로 리소스 가져오기를 요청합니다. 가져온 후에는 지원되는 모든 Service Catalog 거버넌스 작업이 프로비저닝된 제품에서 지원됩니다.
UpdateProvisionedProductProperties: 지정된 프로비저닝된 제품의 속성에 대한 업데이트를 요청합니다.

프로비저닝된 제품 계획

이러한 작업을 사용하여 프로비저닝된 제품 계획을 관리합니다. 계획에는 계획을 실행할 때 생성하거나 수정할 리소스 목록이 포함됩니다.

CreateProvisionedProductPlan: 계획을 생성합니다.
DescribeProvisionedProductPlan: 계획의 리소스 변경 사항에 대한 정보를 가져옵니다.
ExecuteProvisionedProductPlan: 계획을 기반으로 제품을 프로비저닝하거나 수정합니다.
ListProvisionedProductPlans: 프로비저닝된 제품에 대한 계획을 나열합니다.
DeleteProvisionedProductPlan: 계획을 삭제합니다.

포트폴리오

카탈로그 관리자는 이러한 작업을 사용하여 포트폴리오 관리에 필요한 모든 작업을 제공합니다.

CreatePortfolio: 포트폴리오를 생성합니다.
DeletePortfolio: 포트폴리오를 삭제합니다.
DescribePortfolio: 포트폴리오에 대한 자세한 정보를 가져옵니다.
DescribePortfolioShares: 지정된 포트폴리오에 대해 생성된 각 포트폴리오 공유의 요약을 반환합니다.
ListPortfolios: 카탈로그의 모든 포트폴리오를 나열합니다.
ListPortfoliosForProduct: 제품이 연결된 모든 포트폴리오를 나열합니다.
UpdatePortfolio: 포트폴리오를 업데이트합니다.
UpdatePortfolioShare: 포트폴리오 공유를 업데이트합니다.
CreatePortfolioShare: 포트폴리오를 AWS 계정과 공유합니다.
DeletePortfolioShare: 포트폴리오 공유를 중지합니다.
AcceptPortfolioShare: 포트폴리오를 공유하라는 제안을 수락합니다.
RejectPortfolioShare: 포트폴리오 공유 제안을 거부합니다.
ListAcceptedPortfolioShares: 이 계정에서 공유를 수락한 모든 포트폴리오의 세부 정보를 나열합니다.
ListPortfolioAccess: 포트폴리오에 액세스할 수 있는 계정 IDs를 나열합니다.

보안 주체 연결

카탈로그 관리자는 이러한 작업을 사용하여 보안 주체 연결에 필요한 모든 작업을 제공합니다.

AssociatePrincipalWithPortfolio: 보안 주체 ARN을 포트폴리오와 연결합니다.
DisassociatePrincipalFromPortfolio: 포트폴리오에서 보안 주체 ARN의 연결을 해제합니다.
ListPrincipalsForPortfolio: 포트폴리오와 연결된 모든 보안 주체 ARNs을 나열합니다.

Products

카탈로그 관리자는 이러한 작업을 사용하여 제품 관리에 필요한 모든 작업을 제공합니다.

SearchProductsAsAdmin: 제품에 대한 요약 및 상태 정보를 가져옵니다.
DescribeProductAsAdmin: 제품에 대한 정보를 가져옵니다.
CreateProduct: 제품을 생성합니다.
CopyProduct: 제품을 복사합니다.
DescribeCopyProductStatus: 제품 복사 작업의 상태를 가져옵니다.
UpdateProduct: 제품을 업데이트합니다.
DeleteProduct: 제품을 삭제합니다.
AssociateProductWithPortfolio: 제품을 포트폴리오와 연결합니다.
DisassociateProductFromPortfolio: 포트폴리오에서 제품의 연결을 해제합니다.

아티팩트 프로비저닝

카탈로그 관리자는 이러한 작업을 사용하여 프로비저닝 아티팩트(제품 버전이라고도 함)를 관리합니다.

DescribeProvisioningArtifact: 프로비저닝 아티팩트에 대한 정보를 가져옵니다.
CreateProvisioningArtifact: 제품에 대한 프로비저닝 아티팩트를 생성합니다.
DeleteProvisioningArtifact: 프로비저닝 아티팩트를 삭제합니다.
ListProvisioningArtifacts: 제품과 연결된 모든 프로비저닝 아티팩트를 나열합니다.
UpdateProvisioningArtifact: 프로비저닝 아티팩트를 업데이트합니다.

제약 조건

카탈로그 관리자는 이러한 작업으로 제약 조건을 관리합니다.

CreateConstraint: 제약 조건을 생성합니다.
DeleteConstraint: 제약 조건을 삭제합니다.
DescribeConstraint: 제약 조건에 대한 정보를 가져옵니다.
UpdateConstraint: 제약 조건을 업데이트합니다.
ListConstraintsForPortfolio: 포트폴리오 및 제품에 대한 제약 조건 정보를 가져옵니다.

서비스 작업

카탈로그 관리자는 이러한 작업을 사용하여 서비스 작업을 관리합니다.

AssociateServiceActionWithProvisioningArtifact: 셀프 서비스 작업을 프로비저닝 아티팩트와 연결합니다.
CreateServiceAction: 셀프 서비스 작업을 생성합니다.
DeleteServiceAction: 셀프 서비스 작업을 삭제합니다.
DescribeServiceAction: 셀프 서비스 작업을 설명합니다.
DescribeServiceActionExecutionParameters: 프로비저닝된 특정 제품에 대한 특정 셀프 서비스 작업의 기본 파라미터를 찾아 사용자에게 결과 맵을 반환합니다.
ExecuteProvisionedProductServiceAction: 프로비저닝된 제품에 대해 셀프 서비스 작업을 실행합니다.
UpdateServiceAction: 셀프 서비스 작업을 업데이트합니다.

TagOption

카탈로그 관리자는 이러한 작업을 사용하여 TagOptions를 관리합니다.

CreateTagOption: TagOption을 생성합니다.
ListTagOptions: TagOptions를 나열합니다.
DescribeTagOption: TagOption을 설명합니다.
UpdateTagOption: TagOption을 업데이트합니다.
AssociateTagOptionWithResource: TagOption을 리소스와 연결합니다.
DisassociateTagOptionFromResource: 리소스에서 TagOption의 연결을 해제합니다.
ListResourcesForTagOption: TagOption에 대한 리소스를 나열합니다.
DeleteTagOption: TagOption을 삭제합니다.

AppRegistry

엔터프라이즈에서 사용하는 애플리케이션, 리소스 및 애플리케이션 메타데이터의 리포지토리 역할을 합니다.

AssociateAttributeGroup: 속성 그룹을 애플리케이션과 연결하여 애플리케이션의 메타데이터를 그룹의 속성으로 보강합니다.
AssociateResource: 리소스를 애플리케이션과 연결합니다.
CreateApplication: 관련 클라우드 리소스 추상화 계층 구조에서 최상위 노드인 새 애플리케이션을 생성합니다.
CreateAttributeGroup: 사용자 정의 속성에 대한 컨테이너로 새 속성 그룹을 생성합니다.
DeleteApplication: 애플리케이션 ID 또는 이름으로 지정된 애플리케이션을 삭제합니다.
DeleteAttributeGroup: 속성 그룹 ID 또는 이름으로 지정된 속성 그룹을 삭제합니다.
DisassociateAttributeGroup: 속성 그룹을 애플리케이션에서 연결 해제하여 애플리케이션의 메타데이터에서 속성 그룹에 포함된 추가 속성을 제거합니다.
DisassociateResource: 애플리케이션에서 리소스를 연결 해제합니다.
GetApplication: 애플리케이션 중 하나에 대한 메타데이터 정보를 검색합니다.
GetAssociatedResource: 애플리케이션과 연결된 리소스를 가져옵니다.
GetAttributeGroup: 이름 또는 ID로 속성 그룹을 검색합니다.
ListApplications: 지정된 애플리케이션과 연결된 모든 속성 그룹을 나열합니다.
ListAssociatedAttributeGroups: 지정된 애플리케이션과 연결된 모든 속성 그룹을 나열합니다.
ListAssociatedResources: 지정된 애플리케이션과 연결된 모든 리소스를 나열합니다.
ListAttributeGroups: 액세스 권한이 있는 모든 속성 그룹을 나열합니다.
ListAttributeGroupsForApplication: 특정 애플리케이션과 연결된 모든 속성 그룹의 세부 정보를 나열합니다.
ListTagsForResource: 리소스의 모든 태그를 나열합니다.
TagResource: 지정된 리소스에 하나 이상의 태그(키-값 페어)를 할당합니다.
SyncResource: 리소스를 AppRegistry에 현재 기록된 것과 동기화합니다.
UntagResource: 리소스에서 태그를 제거합니다.
UpdateApplication: 기존 애플리케이션을 새 속성으로 업데이트합니다.
UpdateAttributeGroup: 기존 속성 그룹을 새 세부 정보로 업데이트합니다.

워크플로 예제

이 시나리오에서 관리자는를 사용하여 리소스를 생성하고 AWS Service Catalog 최종 사용자는 사용 가능한 제품을 찾고 제품을 프로비저닝합니다. 이는 예제 워크플로이며 AWS Service Catalog API를 사용하는 유일한 방법은 아닙니다.

관리자 작업

포트폴리오, 제품 보기, 제품, 제품 버전 및 제약 조건을 생성합니다.
제품에 IAM 사용자를 할당하여 액세스 권한을 부여합니다.

최종 사용자 작업

사용자가 인수 없이 SearchProducts를 호출합니다. 그러면 사용자가 액세스할 수 있는 제품 목록과 결과 범위를 지정하는 데 사용할 수 있는 "SearchDomain"이 반환됩니다.
사용자는 원하는 제품이 발견될 때까지 추가 검색 필터를 사용하여 SearchProducts를 계속 호출합니다.
사용자가 DescribeProductView를 호출하여이 제품의 프로비저닝 아티팩트(버전이라고도 함) 목록을 찾습니다. 이는 사용자가 실제로 프로비저닝하는 항목을 결정합니다.
사용자는 ListLaunchPaths를 호출하여 각 경로의 제약 조건과 함께이 제품의 경로 목록을 찾습니다. 이는 프로비저닝된 제품에 적용되는 제약 조건을 결정합니다.
프로비저닝 아티팩트와 경로를 선택한 후 사용자는 DescribeProvisioningParameters를 호출합니다. 이렇게 하면 프로비저닝 아티팩트와 경로를 사용하여 제품을 프로비저닝하기 전에 사용자가 제공해야 하는 파라미터 목록과 관리자가 제공하기로 결정한 추가 사용 지침이 반환됩니다.
사용자는 ProvisionProduct를 호출하여 제품, 프로비저닝 아티팩트, 경로 및 입력 파라미터를 지정합니다. 입력 파라미터는 키-값 페어의 목록으로, 여기서 키는 DescribeProvisioningParameters를 사용하여 가져오고 값은 사용자가 제공합니다(예: {ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}). 그러면 워크플로가 시작되어 지정된 AWS 리소스를 생성합니다. 또한 프로비저닝 요청을 추적하는 레코드 세부 정보와 기본 AWS 리소스를 나타내는 프로비저닝된 제품 객체를 생성합니다.
사용자는 DescribeRecord를 폴링하여 레코드 세부 정보의 상태가 IN_PROGRESS 상태에서 완료된 상태( SUCCEEDED 또는 )로 변경되는 시기를 확인합니다ERROR.
요청에 대한 레코드 세부 정보가 완료 상태이면 사용자는 DescribeRecord를 한 번 더 호출합니다. 출력은 생성된 리소스를 식별합니다.
사용자가 UpdateProvisionedProduct를 호출하여 기본 리소스를 업데이트합니다. 요청된 특정 업데이트에 따라이 작업은 중단 없이 일부 중단 없이 업데이트하거나 프로비저닝된 제품을 완전히 교체할 수 있습니다.
마지막으로 사용자는 TerminateProvisionedProduct를 호출하여 프로비저닝된 제품을 종료합니다.

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

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

문서 규칙

AWS 리전 콘솔 브랜딩 지원

문서 기록