UpdateAgreement - AWS Transfer Family
구문 요청요청 파라미터응답 구문Response ElementsErrors참고

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

UpdateAgreement

기존 계약의 일부 파라미터를 업데이트합니다. 업데이트할 파라미터의 새 값과 함께 업데이트하려는 계약의 AgreementId과 ServerId를 입력합니다.

구문 요청

{
   "AccessRole": "string",
   "AgreementId": "string",
   "BaseDirectory": "string",
   "Description": "string",
   "LocalProfileId": "string",
   "PartnerProfileId": "string",
   "ServerId": "string",
   "Status": "string"
}

요청 파라미터

모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.

요청은 JSON 형식의 다음 데이터를 수락합니다.

AccessRole

커넥터는 AS2 또는 SFTP 프로토콜을 사용하여 파일을 전송하는 데 사용됩니다. 액세스 역할에 사용할 AWS Identity and Access Management 역할의 Amazon 리소스 이름(ARN)을 입력합니다.

AS2 커넥터의 경우

를 사용하면 를 호출StartFileTransfer하고 요청 파라미터 에서 파일 경로를 지정하여 파일을 보낼 AS2수 있습니다SendFilePaths. 파일의 상위 디렉터리(예: 의 경우 --send-file-paths /bucket/dir/file.txt상위 디렉터리는 /bucket/dir/)를 사용하여 처리된 AS2 메시지 파일을 임시로 저장하고, 파트너로부터 받을 MDN 때 를 저장하고, 전송의 관련 메타데이터가 포함된 최종 JSON 파일을 작성합니다. 따라서 AccessRole은(는) StartFileTransfer 요청에 사용된 파일 위치의 상위 디렉터리에 대한 읽기 및 쓰기 액세스를 제공해야 합니다. 또한 StartFileTransfer와(과) 함께 전송하려는 파일의 상위 디렉터리에 대한 읽기 및 쓰기 액세스 권한을 제공해야 합니다.

AS2 커넥터에 기본 인증을 사용하는 경우 액세스 역할에 보안 암호에 대한 secretsmanager:GetSecretValue 권한이 필요합니다. Secrets Manager의 AWS 관리형 키 대신 고객 관리형 키를 사용하여 보안 암호를 암호화하면 역할에도 해당 키에 대한 kms:Decrypt 권한도 필요합니다.

SFTP 커넥터의 경우

액세스 역할이 StartFileTransfer 요청에서 사용된 파일 위치의 상위 디렉터리에 대한 읽기 및 쓰기 액세스 권한을 제공하는지 확인하세요. 또한 역할이 에 대한 secretsmanager:GetSecretValue 권한을 제공하는지 확인합니다 AWS Secrets Manager.

유형: 문자열

길이 제약: 최소 길이는 20. 최대 길이는 2,048.

패턴: arn:.*role/\S+

필수 여부: 아니요

AgreementId

계약의 고유 식별자입니다. 계약을 생성하면 이 식별자가 반환됩니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

Pattern: a-([0-9a-f]{17})

필수 여부: 예

BaseDirectory

전송되는 파일의 랜딩 디렉터리(폴더)를 변경하려면 사용할 버킷 폴더(예: /DOC-EXAMPLE-BUCKET/home/mydirectory )를 입력합니다.

타입: 문자열

길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 1024입니다.

패턴: (|/.*)

필수 여부: 아니요

Description

기존 설명을 대체하려면 계약에 대한 간단한 설명을 제공하세요.

타입: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 200입니다.

패턴: [\p{Graph}]+

Required: No

LocalProfileId

AS2 로컬 프로필의 고유 식별자입니다.

로컬 프로필 식별자를 변경하려면 여기에 새 값을 입력합니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

패턴: p-([0-9a-f]{17})

필수 여부: 아니요

PartnerProfileId

파트너 프로필의 고유 식별자입니다. 파트너 프로필 식별자를 변경하려면 여기에 새 값을 입력하세요.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

패턴: p-([0-9a-f]{17})

필수 여부: 아니요

ServerId

서버 인스턴스에 대해 시스템에서 할당한 고유 식별자입니다. 이는 계약에서 사용하는 특정 서버를 나타냅니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

Pattern: s-([0-9a-f]{17})

필수 여부: 예

Status

계약 상태를 업데이트하여 비활성 계약을 활성화하거나 그 반대로 업데이트할 수 있습니다.

타입: 문자열

유효 값: ACTIVE | INACTIVE

필수 항목 여부: 아니요

응답 구문

{
   "AgreementId": "string"
}

Response Elements

작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.

다음 데이터는 서비스에서 JSON 형식으로 반환됩니다.

AgreementId

계약의 고유 식별자입니다. 계약을 생성하면 이 식별자가 반환됩니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

패턴: a-([0-9a-f]{17})

Errors

모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.

InternalServiceError

이 예외는 AWS Transfer Family 서비스에서 오류가 발생할 때 발생합니다.

HTTP 상태 코드: 500

InvalidRequestException

이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.

HTTP 상태 코드: 400

ResourceExistsException

요청된 리소스가 존재하지 않거나 명령에 지정된 리전이 아닌 다른 리전에 있습니다.

HTTP 상태 코드: 400

ResourceNotFoundException

AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.

HTTP 상태 코드: 400

ServiceUnavailableException

AWS Transfer Family 서비스를 사용할 수 없으므로 요청이 실패했습니다.

HTTP 상태 코드: 500

ThrottlingException

요청 제한 때문에 요청이 거부되었습니다.

HTTP 상태 코드: 400

참고

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