Typed dictionaries

Index > TimestreamQuery > Typed dictionaries

Auto-generated documentation for TimestreamQuery type annotations stubs module mypy-boto3-timestream-query.

CancelQueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import CancelQueryRequestRequestTypeDef

def get_value() -> CancelQueryRequestRequestTypeDef:
    return {
        "QueryId": ...,
    }

Definition

class CancelQueryRequestRequestTypeDef(TypedDict):
    QueryId: str,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ColumnInfoTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ColumnInfoTypeDef

def get_value() -> ColumnInfoTypeDef:
    return {
        "Type": ...,
    }

Definition

class ColumnInfoTypeDef(TypedDict):
    Type: TypeTypeDef,  # (1)
    Name: NotRequired[str],

1. See TypeTypeDef

ScheduleConfigurationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ScheduleConfigurationTypeDef

def get_value() -> ScheduleConfigurationTypeDef:
    return {
        "ScheduleExpression": ...,
    }

Definition

class ScheduleConfigurationTypeDef(TypedDict):
    ScheduleExpression: str,

TagTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }

Definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

RowTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import RowTypeDef

def get_value() -> RowTypeDef:
    return {
        "Data": ...,
    }

Definition

class RowTypeDef(TypedDict):
    Data: List[DatumTypeDef],  # (1)

1. See DatumTypeDef

TimeSeriesDataPointTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TimeSeriesDataPointTypeDef

def get_value() -> TimeSeriesDataPointTypeDef:
    return {
        "Time": ...,
        "Value": ...,
    }

Definition

class TimeSeriesDataPointTypeDef(TypedDict):
    Time: str,
    Value: DatumTypeDef,  # (1)

1. See DatumTypeDef

DeleteScheduledQueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import DeleteScheduledQueryRequestRequestTypeDef

def get_value() -> DeleteScheduledQueryRequestRequestTypeDef:
    return {
        "ScheduledQueryArn": ...,
    }

Definition

class DeleteScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,

EndpointTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import EndpointTypeDef

def get_value() -> EndpointTypeDef:
    return {
        "Address": ...,
        "CachePeriodInMinutes": ...,
    }

Definition

class EndpointTypeDef(TypedDict):
    Address: str,
    CachePeriodInMinutes: int,

DescribeScheduledQueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import DescribeScheduledQueryRequestRequestTypeDef

def get_value() -> DescribeScheduledQueryRequestRequestTypeDef:
    return {
        "ScheduledQueryArn": ...,
    }

Definition

class DescribeScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,

DimensionMappingTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import DimensionMappingTypeDef

def get_value() -> DimensionMappingTypeDef:
    return {
        "Name": ...,
        "DimensionValueType": ...,
    }

Definition

class DimensionMappingTypeDef(TypedDict):
    Name: str,
    DimensionValueType: DimensionValueTypeType,  # (1)

1. See DimensionValueTypeType

S3ConfigurationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import S3ConfigurationTypeDef

def get_value() -> S3ConfigurationTypeDef:
    return {
        "BucketName": ...,
    }

Definition

class S3ConfigurationTypeDef(TypedDict):
    BucketName: str,
    ObjectKeyPrefix: NotRequired[str],
    EncryptionOption: NotRequired[S3EncryptionOptionType],  # (1)

1. See S3EncryptionOptionType

S3ReportLocationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import S3ReportLocationTypeDef

def get_value() -> S3ReportLocationTypeDef:
    return {
        "BucketName": ...,
    }

Definition

class S3ReportLocationTypeDef(TypedDict):
    BucketName: NotRequired[str],
    ObjectKey: NotRequired[str],

ExecuteScheduledQueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ExecuteScheduledQueryRequestRequestTypeDef

def get_value() -> ExecuteScheduledQueryRequestRequestTypeDef:
    return {
        "ScheduledQueryArn": ...,
        "InvocationTime": ...,
    }

Definition

class ExecuteScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,
    InvocationTime: Union[datetime, str],
    ClientToken: NotRequired[str],

ExecutionStatsTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ExecutionStatsTypeDef

def get_value() -> ExecutionStatsTypeDef:
    return {
        "ExecutionTimeInMillis": ...,
    }

Definition

class ExecutionStatsTypeDef(TypedDict):
    ExecutionTimeInMillis: NotRequired[int],
    DataWrites: NotRequired[int],
    BytesMetered: NotRequired[int],
    RecordsIngested: NotRequired[int],
    QueryResultRows: NotRequired[int],

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListScheduledQueriesRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ListScheduledQueriesRequestRequestTypeDef

def get_value() -> ListScheduledQueriesRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

class ListScheduledQueriesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

MultiMeasureAttributeMappingTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import MultiMeasureAttributeMappingTypeDef

def get_value() -> MultiMeasureAttributeMappingTypeDef:
    return {
        "SourceColumn": ...,
        "MeasureValueType": ...,
    }

Definition

class MultiMeasureAttributeMappingTypeDef(TypedDict):
    SourceColumn: str,
    MeasureValueType: ScalarMeasureValueTypeType,  # (1)
    TargetMultiMeasureAttributeName: NotRequired[str],

1. See ScalarMeasureValueTypeType

SnsConfigurationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import SnsConfigurationTypeDef

def get_value() -> SnsConfigurationTypeDef:
    return {
        "TopicArn": ...,
    }

Definition

class SnsConfigurationTypeDef(TypedDict):
    TopicArn: str,

ParameterMappingTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ParameterMappingTypeDef

def get_value() -> ParameterMappingTypeDef:
    return {
        "Name": ...,
        "Type": ...,
    }

Definition

class ParameterMappingTypeDef(TypedDict):
    Name: str,
    Type: TypeTypeDef,  # (1)

1. See TypeTypeDef

PrepareQueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import PrepareQueryRequestRequestTypeDef

def get_value() -> PrepareQueryRequestRequestTypeDef:
    return {
        "QueryString": ...,
    }

Definition

class PrepareQueryRequestRequestTypeDef(TypedDict):
    QueryString: str,
    ValidateOnly: NotRequired[bool],

SelectColumnTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import SelectColumnTypeDef

def get_value() -> SelectColumnTypeDef:
    return {
        "Name": ...,
    }

Definition

class SelectColumnTypeDef(TypedDict):
    Name: NotRequired[str],
    Type: NotRequired[TypeTypeDef],  # (1)
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],
    Aliased: NotRequired[bool],

1. See TypeTypeDef

QueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import QueryRequestRequestTypeDef

def get_value() -> QueryRequestRequestTypeDef:
    return {
        "QueryString": ...,
    }

Definition

class QueryRequestRequestTypeDef(TypedDict):
    QueryString: str,
    ClientToken: NotRequired[str],
    NextToken: NotRequired[str],
    MaxRows: NotRequired[int],

QueryStatusTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import QueryStatusTypeDef

def get_value() -> QueryStatusTypeDef:
    return {
        "ProgressPercentage": ...,
    }

Definition

class QueryStatusTypeDef(TypedDict):
    ProgressPercentage: NotRequired[float],
    CumulativeBytesScanned: NotRequired[int],
    CumulativeBytesMetered: NotRequired[int],

TimestreamDestinationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TimestreamDestinationTypeDef

def get_value() -> TimestreamDestinationTypeDef:
    return {
        "DatabaseName": ...,
    }

Definition

class TimestreamDestinationTypeDef(TypedDict):
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],

TypeTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TypeTypeDef

def get_value() -> TypeTypeDef:
    return {
        "ScalarType": ...,
    }

Definition

class TypeTypeDef(TypedDict):
    ScalarType: NotRequired[ScalarTypeType],  # (1)
    ArrayColumnInfo: NotRequired[ColumnInfoTypeDef],  # (2)
    TimeSeriesMeasureValueColumnInfo: NotRequired[ColumnInfoTypeDef],  # (2)
    RowColumnInfo: NotRequired[List[ColumnInfoTypeDef]],  # (4)

1. See ScalarTypeType
2. See ColumnInfoTypeDef
3. See ColumnInfoTypeDef
4. See ColumnInfoTypeDef

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }

Definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateScheduledQueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import UpdateScheduledQueryRequestRequestTypeDef

def get_value() -> UpdateScheduledQueryRequestRequestTypeDef:
    return {
        "ScheduledQueryArn": ...,
        "State": ...,
    }

Definition

class UpdateScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,
    State: ScheduledQueryStateType,  # (1)

1. See ScheduledQueryStateType

CancelQueryResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import CancelQueryResponseTypeDef

def get_value() -> CancelQueryResponseTypeDef:
    return {
        "CancellationMessage": ...,
        "ResponseMetadata": ...,
    }

Definition

class CancelQueryResponseTypeDef(TypedDict):
    CancellationMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateScheduledQueryResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import CreateScheduledQueryResponseTypeDef

def get_value() -> CreateScheduledQueryResponseTypeDef:
    return {
        "Arn": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateScheduledQueryResponseTypeDef(TypedDict):
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

Definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagTypeDef
2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }

Definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)

1. See TagTypeDef

DatumTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import DatumTypeDef

def get_value() -> DatumTypeDef:
    return {
        "ScalarValue": ...,
    }

Definition

class DatumTypeDef(TypedDict):
    ScalarValue: NotRequired[str],
    TimeSeriesValue: NotRequired[List[TimeSeriesDataPointTypeDef]],  # (1)
    ArrayValue: NotRequired[List[DatumTypeDef]],  # (2)
    RowValue: NotRequired[RowTypeDef],  # (3)
    NullValue: NotRequired[bool],

1. See TimeSeriesDataPointTypeDef
2. See DatumTypeDef
3. See RowTypeDef

DescribeEndpointsResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import DescribeEndpointsResponseTypeDef

def get_value() -> DescribeEndpointsResponseTypeDef:
    return {
        "Endpoints": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeEndpointsResponseTypeDef(TypedDict):
    Endpoints: List[EndpointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EndpointTypeDef
2. See ResponseMetadataTypeDef

ErrorReportConfigurationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ErrorReportConfigurationTypeDef

def get_value() -> ErrorReportConfigurationTypeDef:
    return {
        "S3Configuration": ...,
    }

Definition

class ErrorReportConfigurationTypeDef(TypedDict):
    S3Configuration: S3ConfigurationTypeDef,  # (1)

1. See S3ConfigurationTypeDef

ErrorReportLocationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ErrorReportLocationTypeDef

def get_value() -> ErrorReportLocationTypeDef:
    return {
        "S3ReportLocation": ...,
    }

Definition

class ErrorReportLocationTypeDef(TypedDict):
    S3ReportLocation: NotRequired[S3ReportLocationTypeDef],  # (1)

1. See S3ReportLocationTypeDef

ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef

def get_value() -> ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

class ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

def get_value() -> ListTagsForResourceRequestListTagsForResourcePaginateTypeDef:
    return {
        "ResourceARN": ...,
    }

Definition

class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
    ResourceARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

QueryRequestQueryPaginateTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import QueryRequestQueryPaginateTypeDef

def get_value() -> QueryRequestQueryPaginateTypeDef:
    return {
        "QueryString": ...,
    }

Definition

class QueryRequestQueryPaginateTypeDef(TypedDict):
    QueryString: str,
    ClientToken: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

MixedMeasureMappingTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import MixedMeasureMappingTypeDef

def get_value() -> MixedMeasureMappingTypeDef:
    return {
        "MeasureValueType": ...,
    }

Definition

class MixedMeasureMappingTypeDef(TypedDict):
    MeasureValueType: MeasureValueTypeType,  # (1)
    MeasureName: NotRequired[str],
    SourceColumn: NotRequired[str],
    TargetMeasureName: NotRequired[str],
    MultiMeasureAttributeMappings: NotRequired[Sequence[MultiMeasureAttributeMappingTypeDef]],  # (2)

1. See MeasureValueTypeType
2. See MultiMeasureAttributeMappingTypeDef

MultiMeasureMappingsTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import MultiMeasureMappingsTypeDef

def get_value() -> MultiMeasureMappingsTypeDef:
    return {
        "MultiMeasureAttributeMappings": ...,
    }

Definition

class MultiMeasureMappingsTypeDef(TypedDict):
    MultiMeasureAttributeMappings: Sequence[MultiMeasureAttributeMappingTypeDef],  # (1)
    TargetMultiMeasureName: NotRequired[str],

1. See MultiMeasureAttributeMappingTypeDef

NotificationConfigurationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import NotificationConfigurationTypeDef

def get_value() -> NotificationConfigurationTypeDef:
    return {
        "SnsConfiguration": ...,
    }

Definition

class NotificationConfigurationTypeDef(TypedDict):
    SnsConfiguration: SnsConfigurationTypeDef,  # (1)

1. See SnsConfigurationTypeDef

PrepareQueryResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import PrepareQueryResponseTypeDef

def get_value() -> PrepareQueryResponseTypeDef:
    return {
        "QueryString": ...,
        "Columns": ...,
        "Parameters": ...,
        "ResponseMetadata": ...,
    }

Definition

class PrepareQueryResponseTypeDef(TypedDict):
    QueryString: str,
    Columns: List[SelectColumnTypeDef],  # (1)
    Parameters: List[ParameterMappingTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See SelectColumnTypeDef
2. See ParameterMappingTypeDef
3. See ResponseMetadataTypeDef

QueryResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import QueryResponseTypeDef

def get_value() -> QueryResponseTypeDef:
    return {
        "QueryId": ...,
        "NextToken": ...,
        "Rows": ...,
        "ColumnInfo": ...,
        "QueryStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

class QueryResponseTypeDef(TypedDict):
    QueryId: str,
    NextToken: str,
    Rows: List[RowTypeDef],  # (1)
    ColumnInfo: List[ColumnInfoTypeDef],  # (2)
    QueryStatus: QueryStatusTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See RowTypeDef
2. See ColumnInfoTypeDef
3. See QueryStatusTypeDef
4. See ResponseMetadataTypeDef

TargetDestinationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TargetDestinationTypeDef

def get_value() -> TargetDestinationTypeDef:
    return {
        "TimestreamDestination": ...,
    }

Definition

class TargetDestinationTypeDef(TypedDict):
    TimestreamDestination: NotRequired[TimestreamDestinationTypeDef],  # (1)

1. See TimestreamDestinationTypeDef

ScheduledQueryRunSummaryTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ScheduledQueryRunSummaryTypeDef

def get_value() -> ScheduledQueryRunSummaryTypeDef:
    return {
        "InvocationTime": ...,
    }

Definition

class ScheduledQueryRunSummaryTypeDef(TypedDict):
    InvocationTime: NotRequired[datetime],
    TriggerTime: NotRequired[datetime],
    RunStatus: NotRequired[ScheduledQueryRunStatusType],  # (1)
    ExecutionStats: NotRequired[ExecutionStatsTypeDef],  # (2)
    ErrorReportLocation: NotRequired[ErrorReportLocationTypeDef],  # (3)
    FailureReason: NotRequired[str],

1. See ScheduledQueryRunStatusType
2. See ExecutionStatsTypeDef
3. See ErrorReportLocationTypeDef

TimestreamConfigurationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TimestreamConfigurationTypeDef

def get_value() -> TimestreamConfigurationTypeDef:
    return {
        "DatabaseName": ...,
        "TableName": ...,
        "TimeColumn": ...,
        "DimensionMappings": ...,
    }

Definition

class TimestreamConfigurationTypeDef(TypedDict):
    DatabaseName: str,
    TableName: str,
    TimeColumn: str,
    DimensionMappings: Sequence[DimensionMappingTypeDef],  # (1)
    MultiMeasureMappings: NotRequired[MultiMeasureMappingsTypeDef],  # (2)
    MixedMeasureMappings: NotRequired[Sequence[MixedMeasureMappingTypeDef]],  # (3)
    MeasureNameColumn: NotRequired[str],

1. See DimensionMappingTypeDef
2. See MultiMeasureMappingsTypeDef
3. See MixedMeasureMappingTypeDef

ScheduledQueryTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ScheduledQueryTypeDef

def get_value() -> ScheduledQueryTypeDef:
    return {
        "Arn": ...,
        "Name": ...,
        "State": ...,
    }

Definition

class ScheduledQueryTypeDef(TypedDict):
    Arn: str,
    Name: str,
    State: ScheduledQueryStateType,  # (1)
    CreationTime: NotRequired[datetime],
    PreviousInvocationTime: NotRequired[datetime],
    NextInvocationTime: NotRequired[datetime],
    ErrorReportConfiguration: NotRequired[ErrorReportConfigurationTypeDef],  # (2)
    TargetDestination: NotRequired[TargetDestinationTypeDef],  # (3)
    LastRunStatus: NotRequired[ScheduledQueryRunStatusType],  # (4)

1. See ScheduledQueryStateType
2. See ErrorReportConfigurationTypeDef
3. See TargetDestinationTypeDef
4. See ScheduledQueryRunStatusType

TargetConfigurationTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import TargetConfigurationTypeDef

def get_value() -> TargetConfigurationTypeDef:
    return {
        "TimestreamConfiguration": ...,
    }

Definition

class TargetConfigurationTypeDef(TypedDict):
    TimestreamConfiguration: TimestreamConfigurationTypeDef,  # (1)

1. See TimestreamConfigurationTypeDef

ListScheduledQueriesResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ListScheduledQueriesResponseTypeDef

def get_value() -> ListScheduledQueriesResponseTypeDef:
    return {
        "ScheduledQueries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListScheduledQueriesResponseTypeDef(TypedDict):
    ScheduledQueries: List[ScheduledQueryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ScheduledQueryTypeDef
2. See ResponseMetadataTypeDef

CreateScheduledQueryRequestRequestTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import CreateScheduledQueryRequestRequestTypeDef

def get_value() -> CreateScheduledQueryRequestRequestTypeDef:
    return {
        "Name": ...,
        "QueryString": ...,
        "ScheduleConfiguration": ...,
        "NotificationConfiguration": ...,
        "ScheduledQueryExecutionRoleArn": ...,
        "ErrorReportConfiguration": ...,
    }

Definition

class CreateScheduledQueryRequestRequestTypeDef(TypedDict):
    Name: str,
    QueryString: str,
    ScheduleConfiguration: ScheduleConfigurationTypeDef,  # (1)
    NotificationConfiguration: NotificationConfigurationTypeDef,  # (2)
    ScheduledQueryExecutionRoleArn: str,
    ErrorReportConfiguration: ErrorReportConfigurationTypeDef,  # (3)
    TargetConfiguration: NotRequired[TargetConfigurationTypeDef],  # (4)
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
    KmsKeyId: NotRequired[str],

1. See ScheduleConfigurationTypeDef
2. See NotificationConfigurationTypeDef
3. See ErrorReportConfigurationTypeDef
4. See TargetConfigurationTypeDef
5. See TagTypeDef

ScheduledQueryDescriptionTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import ScheduledQueryDescriptionTypeDef

def get_value() -> ScheduledQueryDescriptionTypeDef:
    return {
        "Arn": ...,
        "Name": ...,
        "QueryString": ...,
        "State": ...,
        "ScheduleConfiguration": ...,
        "NotificationConfiguration": ...,
    }

Definition

class ScheduledQueryDescriptionTypeDef(TypedDict):
    Arn: str,
    Name: str,
    QueryString: str,
    State: ScheduledQueryStateType,  # (1)
    ScheduleConfiguration: ScheduleConfigurationTypeDef,  # (2)
    NotificationConfiguration: NotificationConfigurationTypeDef,  # (3)
    CreationTime: NotRequired[datetime],
    PreviousInvocationTime: NotRequired[datetime],
    NextInvocationTime: NotRequired[datetime],
    TargetConfiguration: NotRequired[TargetConfigurationTypeDef],  # (4)
    ScheduledQueryExecutionRoleArn: NotRequired[str],
    KmsKeyId: NotRequired[str],
    ErrorReportConfiguration: NotRequired[ErrorReportConfigurationTypeDef],  # (5)
    LastRunSummary: NotRequired[ScheduledQueryRunSummaryTypeDef],  # (6)
    RecentlyFailedRuns: NotRequired[List[ScheduledQueryRunSummaryTypeDef]],  # (7)

1. See ScheduledQueryStateType
2. See ScheduleConfigurationTypeDef
3. See NotificationConfigurationTypeDef
4. See TargetConfigurationTypeDef
5. See ErrorReportConfigurationTypeDef
6. See ScheduledQueryRunSummaryTypeDef
7. See ScheduledQueryRunSummaryTypeDef

DescribeScheduledQueryResponseTypeDef

Usage Example

from mypy_boto3_timestream_query.type_defs import DescribeScheduledQueryResponseTypeDef

def get_value() -> DescribeScheduledQueryResponseTypeDef:
    return {
        "ScheduledQuery": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeScheduledQueryResponseTypeDef(TypedDict):
    ScheduledQuery: ScheduledQueryDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ScheduledQueryDescriptionTypeDef
2. See ResponseMetadataTypeDef