CreateReportPlan
보고서 계획을 생성합니다. 보고서 계획은 보고서의 내용과 AWS Backup이 이를 전달하는 위치에 대한 정보가 들어 있는 문서입니다.
이미 존재하는 플랜으로 CreateReportPlan을 호출하면 AlreadyExistsException 예외를 받습니다.
Request Syntax
POST /audit/report-plans HTTP/1.1
Content-type: application/json
{
"IdempotencyToken": "string",
"ReportDeliveryChannel": {
"Formats": [ "string" ],
"S3BucketName": "string",
"S3KeyPrefix": "string"
},
"ReportPlanDescription": "string",
"ReportPlanName": "string",
"ReportPlanTags": {
"string" : "string"
},
"ReportSetting": {
"Accounts": [ "string" ],
"FrameworkArns": [ "string" ],
"NumberOfFrameworks": number,
"OrganizationUnits": [ "string" ],
"Regions": [ "string" ],
"ReportTemplate": "string"
}
}URI 요청 파라미터
요청은 URI 파라미터를 사용하지 않습니다.
요청 본문
요청은 JSON 형식으로 다음 데이터를 받습니다.
- IdempotencyToken
-
고객이 선택한 문자열로,
CreateReportPlanInput에 대한 동일한 호출을 구분하는 데 사용할 수 있습니다. 동일한 멱등성 토큰으로 성공적인 요청을 다시 시도하면 아무런 작업 없이 성공 메시지가 표시됩니다.유형: 문자열
필수 항목 여부: 아니요
- ReportDeliveryChannel
-
보고서를 전송하는 위치와 방법, 특히 Amazon S3 버킷 이름, S3 키 접두사 및 보고서 형식에 대한 정보가 들어 있는 구조입니다.
유형: ReportDeliveryChannel 객체
필수 여부: 예
- ReportPlanDescription
-
보고서 계획에 대한 최대 1,024자의 설명(선택 사항)입니다.
유형: 문자열
길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 1024입니다.
패턴:
.*\S.*Required: No
- ReportPlanName
-
보고서 계획의 고유 이름입니다. 이름은 문자로 시작하고 문자(a~z, A~Z), 숫자(0~9) 및 밑줄(_)로 구성된 1~256자여야 합니다.
유형: 문자열
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.
Pattern:
[a-zA-Z][_a-zA-Z0-9]*필수 여부: 예
- ReportPlanTags
-
보고서 계획에 할당할 태그입니다.
유형: 문자열 대 문자열 맵
필수 항목 여부: 아니요
- ReportSetting
-
보고서에 대한 보고서 템플릿을 식별합니다. 보고서는 보고서 템플릿을 사용하여 작성됩니다. 보고서 템플릿은 다음과 같습니다.
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT보고서 템플릿이
RESOURCE_COMPLIANCE_REPORT또는CONTROL_COMPLIANCE_REPORT인 경우 이 API 리소스는 AWS 리전 및 프레임워크별 보고서 범위도 설명합니다.유형: ReportSetting 객체
필수 여부: 예
응답 구문
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- CreationTime
-
백업 저장소가 생성된 날짜 및 시간(Unix 형식 및 협정 세계시(UTC))입니다.
CreationTime의 값은 밀리초 단위로 정확합니다. 예를 들어, 1516925490.087이라는 값은 2018년 1월 26일 금요일 오전 12:11:30.087을 나타냅니다.유형: 타임스탬프
- ReportPlanArn
-
리소스를 고유하게 식별하는 Amazon 리소스 이름(ARN)입니다. ARN의 형식은 리소스 유형에 따라 달라집니다.
유형: String
- ReportPlanName
-
보고서 계획의 고유 이름입니다.
유형: 문자열
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.
Pattern:
[a-zA-Z][_a-zA-Z0-9]*
Errors
모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- AlreadyExistsException
-
필수 리소스가 이미 존재합니다.
HTTP 상태 코드: 400
- InvalidParameterValueException
-
파라미터의 값에 문제가 있음을 나타냅니다. 예를 들어 값이 범위를 벗어난 경우가 이에 해당합니다.
HTTP 상태 코드: 400
- LimitExceededException
-
요청의 한도가 초과되었습니다(예: 요청에 허용되는 최대 항목 수).
HTTP 상태 코드: 400
- MissingParameterValueException
-
필수 파라미터가 누락되었음을 나타냅니다.
HTTP 상태 코드: 400
- ServiceUnavailableException
-
요청이 서버의 일시적 장애 때문에 실패했습니다.
HTTP 상태 코드: 500
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
