AWS Data Exchange 포함된 APIs에 대한 데이터 권한 생성

API의 리소스 정책에 다음 정책을 추가합니다.

{
"Effect": "Allow",
"Principal": {"Service": "dataexchange.amazonaws.com"},
"Action": "execute-api:Invoke",
"Resource": "*",
"Condition": {"StringEquals": {"aws:SourceAccount": "<account-id>"}}
}

account-id를 API 데이터 세트를 생성할 계정으로 변경하세요.

API Gateway 리소스가 있는 계정은 데이터 세트를 생성하는 계정과 동일한 계정에 속하지 않아도 됩니다.

웹 브라우저를 열어 AWS Data Exchange 콘솔에 로그인합니다.

왼쪽 탐색 창의 내 데이터에서 소유한 데이터 세트를 선택합니다.

소유한 데이터 세트에서 데이터 세트 생성을 선택하여 데이터 세트 생성 단계 마법사를 엽니다.

데이터 세트 유형 선택에서 Amazon API Gateway API를 선택합니다.

데이터 세트 정의에서 데이터 세트의 이름 및 설명을 입력합니다. 자세한 내용은 데이터 세트 모범 사례 단원을 참조하십시오.

(선택 사항) 태그 추가 — 선택 사항에 태그를 추가합니다.

생성(Create)을 선택합니다.

create-data-set 명령을 사용하여 API 데이터 세트를 생성합니다.

$ AWS dataexchange create-data-set \
-\\-asset-type API_GATEWAY_API \
-\\-description 'Data Set Description' \
-\\-name 'Data Set Name'

{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID",
"AssetType": "API_GATEWAY_API",
"CreatedAt": "2021-09-11T00:16:46.349000+00:00",
"Description": "Data Set Description",
"Id": "$DATA_SET_ID",
"Name": "Data Set Name",
"Origin": "OWNED",
"UpdatedAt": "2021-09-11T00:16:46.349000+00:00"
}

새 자산 유형 API_GATEWAY_API을 참고하세요.

데이터 세트 세부 정보 페이지의 데이터 세트 개요 섹션에서

1. (선택사항) 이름 편집을 선택하여 데이터 세트에 대한 정보를 수정합니다.

2. (선택 사항) 데이터 세트를 삭제하려면 삭제를 선택합니다.

개정 섹션에서 개정 생성을 선택합니다.

개정 정의에서 개정 목적을 설명하는 개정에 대한 선택적 설명을 제공하세요.

(선택 사항) 태그 추가 - 선택 사항에서 리소스와 관련된 태그를 추가합니다.

개정 생성을 선택합니다.

이전 단계에서 변경한 내용을 검토, 편집 또는 삭제합니다.

create-revision 명령을 사용하여 개정을 생성합니다.

$ AWS dataexchange create-revision \
-\\-data-set-id $DATA_SET_ID \
-\\-comment 'First Atlas Revision'
{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID",
"Comment": "First Atlas Revision",
"CreatedAt": "2021-09-11T00:18:49.160000+00:00",
"DataSetId": "$DATA_SET_ID",
"Finalized": false,
"Id": "$REVISION_ID",
"UpdatedAt": "2021-09-11T00:18:49.160000+00:00"
}

API 자산을 개정에 추가합니다.

데이터 세트 세부 정보 페이지의 API 자산 섹션에서 API 단계 추가를 선택합니다.

Amazon API Gateway API의 경우 API 단계 선택에서 입력 상자에 API를 입력하거나 드롭다운 목록에서 다음 중 하나를 선택합니다.

1. 다른에서 API AWS 계정를 선택한 경우 입력 상자에 API ID와 API 단계 이름을 입력합니다.

2. 이 단계에서 AWS 계정를 선택한 경우 드롭다운 목록에서 API 단계 이름을 선택합니다.

고급 구성 — 선택 사항에서 기존 Amazon API Gateway 사용량 계획 연결하여 기존 사용량 계획으로 정의된 제한 및 할당량 제한을 사용하도록 선택하고 API 키를 입력할 수 있습니다.

구독자를 위한 문서 API에서 수신자가 데이터 권한을 수락한 후 보게 될 API에 대한 세부 정보를 입력합니다.

1. API 이름에 수신자가 API 자산을 식별하는 데 사용할 수 있는 이름을 입력합니다.

   참고

   이 AWS 계정을 선택한 경우 API 이름이 자동으로 입력되며, 필요한 경우 이를수정할 수 있습니다.

   다른 AWS 계정 API를 선택한 경우 API 이름이 기본 이름이 되기 때문에 수신자가 해당 이름을 쉽게 이해할 수 있도록 수정해야 합니다.

2. OpenAPI 3.0 사양의 경우

   1. OpenAPI 3.0 사양 파일을 입력하거나 복사하여 붙여넣습니다.

   2. .JSON 파일에서 가져오기를 다음 로컬 컴퓨터에서 가져올 .json 파일을 선택합니다.

      가져온 사양이 상자에 표시됩니다.

   3. Amazon API Gateway에서 가져오기를 선택한 다음 가져올 사양을 선택합니다.

      가져온 사양이 상자에 표시됩니다.

3. 추가 설명서 - 선택 사항에 구독자가 API를 파악할 수 있는 유용한 추가 정보를 입력하세요. 마크다운이 지원됩니다.

API 단계 추가를 선택합니다.

API 자산을 데이터 세트로 가져오는 작업이 시작되었습니다.

작업이 완료되면 작업 섹션의 상태 필드가 완료됨으로 업데이트됩니다.

추가할 API가 더 있으면 2단계를 반복하세요.

개정 개요에서 개정과 자산을 검토합니다.

완료를 선택합니다.

create-job 명령을 사용하여 API 자산을 개정에 추가합니다.

$ AWS dataexchange create-job \
  -\\-type IMPORT_ASSET_FROM_API_GATEWAY_API \
  -\\-details '{"ImportAssetFromApiGatewayApi":{"DataSetId":"$DATA_SET_ID","RevisionId":"$REVISION_ID","ApiId":"$API_ID","Stage":"$API_STAGE","ProtocolType":"REST"}}'
{
    "Arn": "arn:aws:dataexchange:us-east-1:123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
        }
    },
    "Id": "$JOB_ID",
    "State": "WAITING",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:19.875000+00:00"
}

$ AWS dataexchange start-job -\\-job-id $JOB_ID
$ AWS dataexchange get-job -\\-job-id $JOB_ID
{
    "Arn": "arn:aws:dataexchange:us-east-1:0123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
            "ApiEndpoint": "string",
            "ApiKey": "string",
            "ApiName": "string",            
            "ApiDescription": "string",
            "ApiSpecificationDownloadUrl": "string",
            "ApiSpecificationDownloadUrlExpiresAt": "string"
        }
    },
    "Id": "$JOB_ID",
    "State": "COMPLETED",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:52.538000+00:00"
}

list-revision-assets 명령을 사용하여 새 자산이 제대로 생성되었는지 확인합니다.

$ AWS dataexchange list-revision-assets \
  -\\-data-set-id $DATA_SET_ID \
  -\\-revision-id $REVISION_ID
{
    "Assets": [
    {
        "Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID/assets/$ASSET_ID",
        "AssetDetails": {
            "ApiGatewayApiAsset": {
                "ApiEndpoint": "https://$API_ID.execute-api.us-east-1.amazonaws.com/$API_STAGE",
                "ApiId": "$API_ID",
                "ProtocolType": "REST",
                "Stage": "$API_STAGE"
            }
        },
        "AssetType": "API_GATEWAY_API",
        "CreatedAt": "2021-09-11T00:38:52.457000+00:00",
        "DataSetId": "$DATA_SET_ID",
        "Id": "$ASSET_ID",
        "Name": "$ASSET_ID/$API_STAGE",
        "RevisionId": "$REVISION_ID",
        "UpdatedAt": "2021-09-11T00:38:52.457000+00:00"
    }
    ]
}

개정 개요에서 완료 취소를 선택합니다.

개정이 완료 상태가 아니라는 메시지가 표시됩니다.

개정을 수정하려면 개정 개요에서 작업, 편집을 선택합니다.

변경한 다음 업데이트를 선택합니다.

변경 사항을 검토한 다음 완료를 선택합니다.

개정 개요에서 삭제를 선택합니다.

개정 삭제 대화 상자에 Delete를 입력한 후 삭제를 선택합니다.

AWS Data Exchange 콘솔의 왼쪽 탐색 창의 교환된 데이터 권한 부여에서 전송된 데이터 권한 부여를 선택합니다.

전송한 데이터 권한에서 데이터 권한 생성을 선택하여 데이터 권한 정의 마법사를 엽니다.

소유한 데이터 세트 선택 섹션에서 추가하려는 데이터 세트 옆의 확인란을 선택합니다.

권한 개요 섹션에서 데이터 권한 이름 및 데이터 권한 설명을 포함하여 수신자에게 표시되는 데이터 권한 관련 정보를 입력합니다.

다음을 선택합니다.

수신자 액세스 정보 섹션의 AWS 계정 ID에 데이터 권한을 받아야 하는 수신자 계정의 AWS 계정 ID를 입력합니다.

또한 수신자 액세스 정보 섹션의 액세스 종료 날짜에서 데이터 권한을 영구적으로 실행할지 여부(종료 날짜 없음)를 선택하거나 종료 날짜가 있어야 하는 경우 특정 종료 날짜를 선택한 다음 원하는 종료 날짜를 선택합니다.

Next(다음)를 선택합니다.

검토 및 전송 섹션에서 데이터 권한 정보를 검토합니다.

데이터 권한을 생성하여 선택한 수신자에게 보내려면 데이터 권한 생성 및 전송을 선택합니다.