기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

작업 커넥터 APIs

작업 커넥터 APIs 사용하면 Amazon Quick과 외부 서비스 간의 연결을 프로그래밍 방식으로 생성하고 관리할 수 있습니다. 이러한 APIs 사용자가 Amazon Quick 채팅 인터페이스 및 자동화된 워크플로에서 직접 타사 애플리케이션에서 작업을 수행할 수 있는 작업 통합 기능을 지원합니다.

작업 커넥터 APIs란 무엇입니까?

작업 커넥터는 자사 및 타사 애플리케이션과의 통합을 지원하는 기본 리소스 역할을 합니다. 이러한 APIs 통해 애플리케이션에 인증하고, 권한을 관리하고, Amazon Quick 애플리케이션 내에서 사용자가 사용할 수 있는 작업을 제어할 수 있습니다.

작업 커넥터 APIs 작업 통합을 지원하는 방법

작업 커넥터 APIs Amazon Quick 작업 통합을 위한 백엔드 인프라를 제공합니다. API를 통해 작업 커넥터를 생성할 때 다음을 수행할 수 있는 보안 연결을 설정합니다.

APIs는 Amazon Quick을 외부 서비스와 안전하게 연결하는 데 필요한 복잡한 인증 흐름, 자격 증명 관리 및 권한 제어를 처리합니다.

인증 방법

작업 커넥터 APIs 다양한 사용 사례 및 보안 요구 사항을 수용하기 위해 여러 인증 방법을 지원합니다.

관리형 인증(3LO)

3레깅 OAuth는 타사 서비스에 대한 개인 액세스를 위한 가장 간단한 설정을 제공합니다.

Service-to-service 인증(2LO)

복잡한 엔터프라이즈 통합의 경우:

API 키 인증

자동화된 워크플로에 대한 간소화된 인증:

기본 인증

기본 인증은 간단한 사용자 이름/암호 인증 방법을 제공합니다.

없음

인증이 필요하지 않음:

권한 및 액세스 제어

작업 커넥터 APIs 액세스 제어 목록(ACLs)을 통해 포괄적인 권한 제어를 구현합니다.

리소스 수준 권한

권한 관리를 위한 API 작업

지원되는 커넥터 범주

이중 용도 커넥터

이러한 커넥터는 작업 통합과 지식 기반 생성을 모두 지원합니다.

작업 전용 커넥터

지식 기반 기능이 없는 작업 실행을 위한 전문 지식:

지식 기반 전용 커넥터

작업 기능이 없는 지식 기반 통합에 중점을 둡니다.

API 수명 주기 관리

보안 인증 정보 관리

연결 업데이트

UpdateActionConnector API를 사용하여 다음을 수행합니다.

모니터링 및 문제 해결

속도 제한 및 할당량

작업 커넥터 APIs 표준 AWS API 속도 제한을 구현합니다.

크로스 계정 지원

Amazon S3 커넥터의 경우 APIs 교차 계정 액세스를 지원합니다.

오류 처리 및 문제 해결

작업 커넥터 APIs 표준 AWS 오류 응답을 반환합니다.

일반적인 오류 유형

애플리케이션에서 적절한 오류 처리를 구현하여 이러한 시나리오를 정상적으로 관리하고 사용자에게 의미 있는 피드백을 제공합니다.

AWS CLI에서 작업 커넥터 APIs 사용

AWS CLI를 사용하여 프로그래밍 방식으로 작업 커넥터를 관리할 수 있습니다. 다음 예제에서는 일반 자리 표시자 값을 사용하는 일반적인 작업을 보여줍니다.

작업 커넥터 생성

create-action-connector 명령을 사용하여 외부 서비스와 통합하기 위한 새 작업 커넥터를 생성합니다.

aws quicksight create-action-connector \
  --aws-account-id "123456789012" \
  --name "MyS3Connector" \
  --action-connector-id "my-s3-connector-id" \
  --type "AMAZON_S3" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/MyConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" \
  --description "S3 connector for automation workflows" \
  --region "us-east-1"
            

작업 커넥터 나열

list-action-connectors 명령을 사용하여 계정의 모든 작업 커넥터를 검색합니다.

aws quicksight list-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 10 \
  --region "us-east-1"
            

작업 커넥터 설명

describe-action-connector 명령을 사용하여 특정 작업 커넥터에 대한 자세한 정보를 가져옵니다.

aws quicksight describe-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
            

작업 커넥터 업데이트

update-action-connector 명령을 사용하여 기존 작업 커넥터의 구성을 수정합니다.

aws quicksight update-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --name "UpdatedS3Connector" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/UpdatedConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" "DeleteBucket" \
  --region "us-east-1"
            

작업 커넥터 검색

search-action-connectors 명령을 사용하여 특정 기준에 따라 작업 커넥터를 찾습니다.

aws quicksight search-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 5 \
  --filters '[{
    "Name": "ACTION_CONNECTOR_NAME",
    "Operator": "StringLike",
    "Value": "S3"
  }]' \
  --region "us-east-1"
            

작업 커넥터 권한 관리

update-action-connector-permissions 명령을 사용하여 작업 커넥터에 대한 권한을 부여하거나 취소합니다.

aws quicksight update-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --grant-permissions '[{
    "Actions": [
      "quicksight:DescribeActionConnector",
      "quicksight:UpdateActionConnector",
      "quicksight:DeleteActionConnector"
    ],
    "Principal": "arn:aws:quicksight:us-east-1:123456789012:user/default/myuser"
  }]' \
  --region "us-east-1"
            

작업 커넥터 권한 보기

describe-action-connector-permissions 명령을 사용하여 작업 커넥터에 대한 현재 권한을 봅니다.

aws quicksight describe-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
            

작업 커넥터 삭제

delete-action-connector 명령을 사용하여 계정에서 작업 커넥터를 제거합니다.

aws quicksight delete-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
            

다음 단계

작업 커넥터 APIs 이해한 후 다음을 수행할 수 있습니다.