@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Timestream Query
@version 2018-11-01
@auth AWS SigV4
@endpoints 15
@toc root(15)

@endpoint POST /
@required {QueryId: str}
@returns(200) {CancellationMessage: str?}

@endpoint POST /
@required {Name: str, QueryString: str, ScheduleConfiguration: ScheduleConfiguration, NotificationConfiguration: NotificationConfiguration, ScheduledQueryExecutionRoleArn: str, ErrorReportConfiguration: ErrorReportConfiguration}
@optional {TargetConfiguration: TargetConfiguration, ClientToken: str, Tags: [Tag], KmsKeyId: str}
@returns(200) {Arn: str}

@endpoint POST /
@required {ScheduledQueryArn: str}

@endpoint POST /
@returns(200) {MaxQueryTCU: int?, QueryPricingModel: str?}

@endpoint POST /
@returns(200) {Endpoints: [Endpoint]}

@endpoint POST /
@required {ScheduledQueryArn: str}
@returns(200) {ScheduledQuery: ScheduledQueryDescription{Arn: str, Name: str, QueryString: str, CreationTime: str(timestamp)?, State: str, PreviousInvocationTime: str(timestamp)?, NextInvocationTime: str(timestamp)?, ScheduleConfiguration: ScheduleConfiguration{ScheduleExpression: str}, NotificationConfiguration: NotificationConfiguration{SnsConfiguration: SnsConfiguration{TopicArn: str}}, TargetConfiguration: TargetConfiguration?{TimestreamConfiguration: TimestreamConfiguration{DatabaseName: str, TableName: str, TimeColumn: str, DimensionMappings: [DimensionMapping], MultiMeasureMappings: MultiMeasureMappings?, MixedMeasureMappings: [MixedMeasureMapping]?, MeasureNameColumn: str?}}, ScheduledQueryExecutionRoleArn: str?, KmsKeyId: str?, ErrorReportConfiguration: ErrorReportConfiguration?{S3Configuration: S3Configuration{BucketName: str, ObjectKeyPrefix: str?, EncryptionOption: str?}}, LastRunSummary: ScheduledQueryRunSummary?{InvocationTime: str(timestamp)?, TriggerTime: str(timestamp)?, RunStatus: str?, ExecutionStats: ExecutionStats?{ExecutionTimeInMillis: int(i64)?, DataWrites: int(i64)?, BytesMetered: int(i64)?, CumulativeBytesScanned: int(i64)?, RecordsIngested: int(i64)?, QueryResultRows: int(i64)?}, ErrorReportLocation: ErrorReportLocation?{S3ReportLocation: S3ReportLocation?}, FailureReason: str?}, RecentlyFailedRuns: [ScheduledQueryRunSummary]?}}

@endpoint POST /
@required {ScheduledQueryArn: str, InvocationTime: str(timestamp)}
@optional {ClientToken: str}

@endpoint POST /
@optional {MaxResults: int, NextToken: str}
@returns(200) {ScheduledQueries: [ScheduledQuery], NextToken: str?}

@endpoint POST /
@required {ResourceARN: str}
@optional {MaxResults: int, NextToken: str}
@returns(200) {Tags: [Tag], NextToken: str?}

@endpoint POST /
@required {QueryString: str}
@optional {ValidateOnly: bool}
@returns(200) {QueryString: str, Columns: [SelectColumn], Parameters: [ParameterMapping]}

@endpoint POST /
@required {QueryString: str}
@optional {ClientToken: str, NextToken: str, MaxRows: int}
@returns(200) {QueryId: str, NextToken: str?, Rows: [Row], ColumnInfo: [ColumnInfo], QueryStatus: QueryStatus?{ProgressPercentage: num(f64)?, CumulativeBytesScanned: int(i64)?, CumulativeBytesMetered: int(i64)?}}

@endpoint POST /
@required {ResourceARN: str, Tags: [Tag]}

@endpoint POST /
@required {ResourceARN: str, TagKeys: [str]}

@endpoint POST /
@optional {MaxQueryTCU: int, QueryPricingModel: str}
@returns(200) {MaxQueryTCU: int?, QueryPricingModel: str?}

@endpoint POST /
@required {ScheduledQueryArn: str, State: str}

@end