CreateScheduledQuery - Amazon Timestream
구문 요청요청 파라미터응답 구문Response ElementsErrors참고

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

CreateScheduledQuery

구성된 일정에 따라 사용자를 대신하여 실행될 예약된 쿼리를 생성합니다. Timestream은 쿼리를 실행하기 위해ScheduledQueryExecutionRoleArn 파라미터의 일부로 제공된 실행 역할을 수임합니다. NotificationConfiguration 파라미터를 사용하여 예약된 쿼리 작업에 대한 알림을 구성할 수 있습니다.

구문 요청

{
   "ClientToken": "string",
   "ErrorReportConfiguration": { 
      "S3Configuration": { 
         "BucketName": "string",
         "EncryptionOption": "string",
         "ObjectKeyPrefix": "string"
      }
   },
   "KmsKeyId": "string",
   "Name": "string",
   "NotificationConfiguration": { 
      "SnsConfiguration": { 
         "TopicArn": "string"
      }
   },
   "QueryString": "string",
   "ScheduleConfiguration": { 
      "ScheduleExpression": "string"
   },
   "ScheduledQueryExecutionRoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetConfiguration": { 
      "TimestreamConfiguration": { 
         "DatabaseName": "string",
         "DimensionMappings": [ 
            { 
               "DimensionValueType": "string",
               "Name": "string"
            }
         ],
         "MeasureNameColumn": "string",
         "MixedMeasureMappings": [ 
            { 
               "MeasureName": "string",
               "MeasureValueType": "string",
               "MultiMeasureAttributeMappings": [ 
                  { 
                     "MeasureValueType": "string",
                     "SourceColumn": "string",
                     "TargetMultiMeasureAttributeName": "string"
                  }
               ],
               "SourceColumn": "string",
               "TargetMeasureName": "string"
            }
         ],
         "MultiMeasureMappings": { 
            "MultiMeasureAttributeMappings": [ 
               { 
                  "MeasureValueType": "string",
                  "SourceColumn": "string",
                  "TargetMultiMeasureAttributeName": "string"
               }
            ],
            "TargetMultiMeasureName": "string"
         },
         "TableName": "string",
         "TimeColumn": "string"
      }
   }
}

요청 파라미터

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

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

ClientToken

를 사용하면 ClientToken 가 CreateScheduledQuery idempotent로 호출합니다. 즉, 동일한 요청을 반복적으로 수행하면 동일한 결과가 생성됩니다. 동일한 CreateScheduledQuery 요청을 여러 번 수행하면 단일 요청을 수행하는 것과 동일한 효과가 있습니다.

  • 이 없이 CreateScheduledQuery 호출되면 ClientToken쿼리가 사용자를 대신하여 ClientToken를 SDK 생성합니다.

  • 8시간 후 동일한 ClientToken이 있는 요청은 새 요청으로 처리됩니다.

유형: 문자열

길이 제한: 최소 길이는 32입니다. 최대 길이 128.

필수 여부: 아니요

ErrorReportConfiguration

오류 보고를 위한 구성입니다. 쿼리 결과를 작성할 때 문제가 발생하면 오류 보고서가 생성됩니다.

유형: ErrorReportConfiguration 객체

필수 여부: 예

KmsKeyId

예약된 쿼리 리소스인 유휴를 암호화하는 데 사용되는 Amazon KMS 키입니다. Amazon KMS 키를 지정하지 않으면 예약된 쿼리 리소스가 Timestream 소유 Amazon KMS 키로 암호화됩니다. KMS 키를 지정하려면 키 ID, 키 ARN, 별칭 이름 또는 별칭 을 사용합니다ARN. 별칭 이름을 사용할 때 이름 앞에 alias/를 붙입니다.

를 암호화 유형SSE_KMS으로 ErrorReportConfiguration 사용하는 경우 저장 중 오류 보고서를 암호화하는 데도 동일한 KmsKeyId 가 사용됩니다.

유형: 문자열

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

필수 여부: 아니요

Name

예약된 쿼리의 이름입니다.

유형: 문자열

길이 제한: 최소 길이는 1. 최대 길이는 64.

Pattern: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+

필수 여부: 예

NotificationConfiguration

예약된 쿼리에 대한 알림 구성입니다. 쿼리 실행이 완료되거나 상태가 업데이트되거나 삭제할 때 Timestream에서 알림을 보냅니다.

유형: NotificationConfiguration 객체

필수 여부: 예

QueryString

실행할 쿼리 문자열입니다. 쿼리 문자열 @ 문자와 식별자로 파라미터 이름을 지정할 수 있습니다. 명명된 파라미터 @scheduled_runtime은 예약되어 있으며 쿼리 실행이 예약된 시간을 가져오기 위해 쿼리에서 사용할 수 있습니다.

ScheduleConfiguration 파라미터에 따라 계산된 타임스탬프는 각 쿼리 실행에 대한 @scheduled_runtime 파라미터 값이 됩니다. 2021-12-01 00:00:00에 실행되는 예약된 쿼리의 인스턴스를 예로 들 수 있습니다. 이 인스턴스에 대해 쿼리를 호출할 때 @scheduled_runtime 파라미터는 타임스탬프 2021-12-01 00:00:00으로 초기화됩니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 262144자입니다.

필수 여부: 예

ScheduleConfiguration

쿼리의 일정 구성입니다.

유형: ScheduleConfiguration 객체

필수 여부: 예

ScheduledQueryExecutionRoleArn

예약된 쿼리ARN를 실행할 때 Timestream이 수임할 IAM 역할의 입니다.

유형: 문자열

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

필수 여부: 예

Tags

예약된 쿼리에 레이블을 지정할 키-값 페어의 목록입니다.

유형: Tag객체 어레이

어레이 멤버: 최소 항목 수 0개. 최대 항목 수 200개.

필수 여부: 아니요

TargetConfiguration

쿼리 결과를 작성하는 데 사용되는 구성입니다.

유형: TargetConfiguration 객체

필수 항목 여부: 아니요

응답 구문

{
   "Arn": "string"
}

Response Elements

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

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

Arn

ARN 생성된 예약 쿼리에 대한 입니다.

유형: 문자열

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

Errors

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

AccessDeniedException

이 작업을 수행할 권한이 없습니다.

HTTP 상태 코드: 400

ConflictException

취소된 쿼리에 대한 결과를 폴링할 수 없습니다.

HTTP 상태 코드: 400

InternalServerException

내부 서버 오류로 인해 서비스가 이 요청을 완전히 처리할 수 없습니다.

HTTP 상태 코드: 400

InvalidEndpointException

요청된 엔드포인트가 유효하지 않습니다.

HTTP 상태 코드: 400

ServiceQuotaExceededException

서비스 할당량을 초과했습니다.

HTTP 상태 코드: 400

ThrottlingException

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

HTTP 상태 코드: 400

ValidationException

유효하지 않거나 잘못된 형식의 요청입니다.

HTTP 상태 코드: 400

참고

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