Typed dictionaries#
Auto-generated documentation for PI type annotations stubs module mypy-boto3-pi.
DataPointTypeDef#
# DataPointTypeDef usage example
from mypy_boto3_pi.type_defs import DataPointTypeDef
def get_value() -> DataPointTypeDef:
return {
"Timestamp": ...,
"Value": ...,
}
# DataPointTypeDef definition
class DataPointTypeDef(TypedDict):
Timestamp: datetime,
Value: float,
DimensionGroupTypeDef#
# DimensionGroupTypeDef usage example
from mypy_boto3_pi.type_defs import DimensionGroupTypeDef
def get_value() -> DimensionGroupTypeDef:
return {
"Group": ...,
}
# DimensionGroupTypeDef definition
class DimensionGroupTypeDef(TypedDict):
Group: str,
Dimensions: NotRequired[Sequence[str]],
Limit: NotRequired[int],
DimensionKeyDescriptionTypeDef#
# DimensionKeyDescriptionTypeDef usage example
from mypy_boto3_pi.type_defs import DimensionKeyDescriptionTypeDef
def get_value() -> DimensionKeyDescriptionTypeDef:
return {
"Dimensions": ...,
}
# DimensionKeyDescriptionTypeDef definition
class DimensionKeyDescriptionTypeDef(TypedDict):
Dimensions: NotRequired[Dict[str, str]],
Total: NotRequired[float],
AdditionalMetrics: NotRequired[Dict[str, float]],
Partitions: NotRequired[List[float]],
ResponsePartitionKeyTypeDef#
# ResponsePartitionKeyTypeDef usage example
from mypy_boto3_pi.type_defs import ResponsePartitionKeyTypeDef
def get_value() -> ResponsePartitionKeyTypeDef:
return {
"Dimensions": ...,
}
# ResponsePartitionKeyTypeDef definition
class ResponsePartitionKeyTypeDef(TypedDict):
Dimensions: Dict[str, str],
DimensionDetailTypeDef#
# DimensionDetailTypeDef usage example
from mypy_boto3_pi.type_defs import DimensionDetailTypeDef
def get_value() -> DimensionDetailTypeDef:
return {
"Identifier": ...,
}
# DimensionDetailTypeDef definition
class DimensionDetailTypeDef(TypedDict):
Identifier: NotRequired[str],
DimensionKeyDetailTypeDef#
# DimensionKeyDetailTypeDef usage example
from mypy_boto3_pi.type_defs import DimensionKeyDetailTypeDef
def get_value() -> DimensionKeyDetailTypeDef:
return {
"Value": ...,
}
# DimensionKeyDetailTypeDef definition
class DimensionKeyDetailTypeDef(TypedDict):
Value: NotRequired[str],
Dimension: NotRequired[str],
Status: NotRequired[DetailStatusType], # (1)
- See DetailStatusType
FeatureMetadataTypeDef#
# FeatureMetadataTypeDef usage example
from mypy_boto3_pi.type_defs import FeatureMetadataTypeDef
def get_value() -> FeatureMetadataTypeDef:
return {
"Status": ...,
}
# FeatureMetadataTypeDef definition
class FeatureMetadataTypeDef(TypedDict):
Status: NotRequired[FeatureStatusType], # (1)
GetDimensionKeyDetailsRequestRequestTypeDef#
# GetDimensionKeyDetailsRequestRequestTypeDef usage example
from mypy_boto3_pi.type_defs import GetDimensionKeyDetailsRequestRequestTypeDef
def get_value() -> GetDimensionKeyDetailsRequestRequestTypeDef:
return {
"ServiceType": ...,
"Identifier": ...,
"Group": ...,
"GroupIdentifier": ...,
}
# GetDimensionKeyDetailsRequestRequestTypeDef definition
class GetDimensionKeyDetailsRequestRequestTypeDef(TypedDict):
ServiceType: ServiceTypeType, # (1)
Identifier: str,
Group: str,
GroupIdentifier: str,
RequestedDimensions: NotRequired[Sequence[str]],
- See ServiceTypeType
GetResourceMetadataRequestRequestTypeDef#
# GetResourceMetadataRequestRequestTypeDef usage example
from mypy_boto3_pi.type_defs import GetResourceMetadataRequestRequestTypeDef
def get_value() -> GetResourceMetadataRequestRequestTypeDef:
return {
"ServiceType": ...,
"Identifier": ...,
}
# GetResourceMetadataRequestRequestTypeDef definition
class GetResourceMetadataRequestRequestTypeDef(TypedDict):
ServiceType: ServiceTypeType, # (1)
Identifier: str,
- See ServiceTypeType
ListAvailableResourceDimensionsRequestRequestTypeDef#
# ListAvailableResourceDimensionsRequestRequestTypeDef usage example
from mypy_boto3_pi.type_defs import ListAvailableResourceDimensionsRequestRequestTypeDef
def get_value() -> ListAvailableResourceDimensionsRequestRequestTypeDef:
return {
"ServiceType": ...,
"Identifier": ...,
"Metrics": ...,
}
# ListAvailableResourceDimensionsRequestRequestTypeDef definition
class ListAvailableResourceDimensionsRequestRequestTypeDef(TypedDict):
ServiceType: ServiceTypeType, # (1)
Identifier: str,
Metrics: Sequence[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See ServiceTypeType
ListAvailableResourceMetricsRequestRequestTypeDef#
# ListAvailableResourceMetricsRequestRequestTypeDef usage example
from mypy_boto3_pi.type_defs import ListAvailableResourceMetricsRequestRequestTypeDef
def get_value() -> ListAvailableResourceMetricsRequestRequestTypeDef:
return {
"ServiceType": ...,
"Identifier": ...,
"MetricTypes": ...,
}
# ListAvailableResourceMetricsRequestRequestTypeDef definition
class ListAvailableResourceMetricsRequestRequestTypeDef(TypedDict):
ServiceType: ServiceTypeType, # (1)
Identifier: str,
MetricTypes: Sequence[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See ServiceTypeType
ResponseResourceMetricTypeDef#
# ResponseResourceMetricTypeDef usage example
from mypy_boto3_pi.type_defs import ResponseResourceMetricTypeDef
def get_value() -> ResponseResourceMetricTypeDef:
return {
"Metric": ...,
}
# ResponseResourceMetricTypeDef definition
class ResponseResourceMetricTypeDef(TypedDict):
Metric: NotRequired[str],
Description: NotRequired[str],
Unit: NotRequired[str],
ResponseResourceMetricKeyTypeDef#
# ResponseResourceMetricKeyTypeDef usage example
from mypy_boto3_pi.type_defs import ResponseResourceMetricKeyTypeDef
def get_value() -> ResponseResourceMetricKeyTypeDef:
return {
"Metric": ...,
}
# ResponseResourceMetricKeyTypeDef definition
class ResponseResourceMetricKeyTypeDef(TypedDict):
Metric: str,
Dimensions: NotRequired[Dict[str, str]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_pi.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DescribeDimensionKeysRequestRequestTypeDef#
# DescribeDimensionKeysRequestRequestTypeDef usage example
from mypy_boto3_pi.type_defs import DescribeDimensionKeysRequestRequestTypeDef
def get_value() -> DescribeDimensionKeysRequestRequestTypeDef:
return {
"ServiceType": ...,
"Identifier": ...,
"StartTime": ...,
"EndTime": ...,
"Metric": ...,
"GroupBy": ...,
}
# DescribeDimensionKeysRequestRequestTypeDef definition
class DescribeDimensionKeysRequestRequestTypeDef(TypedDict):
ServiceType: ServiceTypeType, # (1)
Identifier: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Metric: str,
GroupBy: DimensionGroupTypeDef, # (2)
PeriodInSeconds: NotRequired[int],
AdditionalMetrics: NotRequired[Sequence[str]],
PartitionBy: NotRequired[DimensionGroupTypeDef], # (2)
Filter: NotRequired[Mapping[str, str]],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
MetricQueryTypeDef#
# MetricQueryTypeDef usage example
from mypy_boto3_pi.type_defs import MetricQueryTypeDef
def get_value() -> MetricQueryTypeDef:
return {
"Metric": ...,
}
# MetricQueryTypeDef definition
class MetricQueryTypeDef(TypedDict):
Metric: str,
GroupBy: NotRequired[DimensionGroupTypeDef], # (1)
Filter: NotRequired[Mapping[str, str]],
DescribeDimensionKeysResponseTypeDef#
# DescribeDimensionKeysResponseTypeDef usage example
from mypy_boto3_pi.type_defs import DescribeDimensionKeysResponseTypeDef
def get_value() -> DescribeDimensionKeysResponseTypeDef:
return {
"AlignedStartTime": ...,
"AlignedEndTime": ...,
"PartitionKeys": ...,
"Keys": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# DescribeDimensionKeysResponseTypeDef definition
class DescribeDimensionKeysResponseTypeDef(TypedDict):
AlignedStartTime: datetime,
AlignedEndTime: datetime,
PartitionKeys: List[ResponsePartitionKeyTypeDef], # (1)
Keys: List[DimensionKeyDescriptionTypeDef], # (2)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DimensionGroupDetailTypeDef#
# DimensionGroupDetailTypeDef usage example
from mypy_boto3_pi.type_defs import DimensionGroupDetailTypeDef
def get_value() -> DimensionGroupDetailTypeDef:
return {
"Group": ...,
}
# DimensionGroupDetailTypeDef definition
class DimensionGroupDetailTypeDef(TypedDict):
Group: NotRequired[str],
Dimensions: NotRequired[List[DimensionDetailTypeDef]], # (1)
GetDimensionKeyDetailsResponseTypeDef#
# GetDimensionKeyDetailsResponseTypeDef usage example
from mypy_boto3_pi.type_defs import GetDimensionKeyDetailsResponseTypeDef
def get_value() -> GetDimensionKeyDetailsResponseTypeDef:
return {
"Dimensions": ...,
"ResponseMetadata": ...,
}
# GetDimensionKeyDetailsResponseTypeDef definition
class GetDimensionKeyDetailsResponseTypeDef(TypedDict):
Dimensions: List[DimensionKeyDetailTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetResourceMetadataResponseTypeDef#
# GetResourceMetadataResponseTypeDef usage example
from mypy_boto3_pi.type_defs import GetResourceMetadataResponseTypeDef
def get_value() -> GetResourceMetadataResponseTypeDef:
return {
"Identifier": ...,
"Features": ...,
"ResponseMetadata": ...,
}
# GetResourceMetadataResponseTypeDef definition
class GetResourceMetadataResponseTypeDef(TypedDict):
Identifier: str,
Features: Dict[str, FeatureMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAvailableResourceMetricsResponseTypeDef#
# ListAvailableResourceMetricsResponseTypeDef usage example
from mypy_boto3_pi.type_defs import ListAvailableResourceMetricsResponseTypeDef
def get_value() -> ListAvailableResourceMetricsResponseTypeDef:
return {
"Metrics": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListAvailableResourceMetricsResponseTypeDef definition
class ListAvailableResourceMetricsResponseTypeDef(TypedDict):
Metrics: List[ResponseResourceMetricTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MetricKeyDataPointsTypeDef#
# MetricKeyDataPointsTypeDef usage example
from mypy_boto3_pi.type_defs import MetricKeyDataPointsTypeDef
def get_value() -> MetricKeyDataPointsTypeDef:
return {
"Key": ...,
}
# MetricKeyDataPointsTypeDef definition
class MetricKeyDataPointsTypeDef(TypedDict):
Key: NotRequired[ResponseResourceMetricKeyTypeDef], # (1)
DataPoints: NotRequired[List[DataPointTypeDef]], # (2)
GetResourceMetricsRequestRequestTypeDef#
# GetResourceMetricsRequestRequestTypeDef usage example
from mypy_boto3_pi.type_defs import GetResourceMetricsRequestRequestTypeDef
def get_value() -> GetResourceMetricsRequestRequestTypeDef:
return {
"ServiceType": ...,
"Identifier": ...,
"MetricQueries": ...,
"StartTime": ...,
"EndTime": ...,
}
# GetResourceMetricsRequestRequestTypeDef definition
class GetResourceMetricsRequestRequestTypeDef(TypedDict):
ServiceType: ServiceTypeType, # (1)
Identifier: str,
MetricQueries: Sequence[MetricQueryTypeDef], # (2)
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
PeriodInSeconds: NotRequired[int],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
PeriodAlignment: NotRequired[PeriodAlignmentType], # (3)
- See ServiceTypeType
- See MetricQueryTypeDef
- See PeriodAlignmentType
MetricDimensionGroupsTypeDef#
# MetricDimensionGroupsTypeDef usage example
from mypy_boto3_pi.type_defs import MetricDimensionGroupsTypeDef
def get_value() -> MetricDimensionGroupsTypeDef:
return {
"Metric": ...,
}
# MetricDimensionGroupsTypeDef definition
class MetricDimensionGroupsTypeDef(TypedDict):
Metric: NotRequired[str],
Groups: NotRequired[List[DimensionGroupDetailTypeDef]], # (1)
GetResourceMetricsResponseTypeDef#
# GetResourceMetricsResponseTypeDef usage example
from mypy_boto3_pi.type_defs import GetResourceMetricsResponseTypeDef
def get_value() -> GetResourceMetricsResponseTypeDef:
return {
"AlignedStartTime": ...,
"AlignedEndTime": ...,
"Identifier": ...,
"MetricList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetResourceMetricsResponseTypeDef definition
class GetResourceMetricsResponseTypeDef(TypedDict):
AlignedStartTime: datetime,
AlignedEndTime: datetime,
Identifier: str,
MetricList: List[MetricKeyDataPointsTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAvailableResourceDimensionsResponseTypeDef#
# ListAvailableResourceDimensionsResponseTypeDef usage example
from mypy_boto3_pi.type_defs import ListAvailableResourceDimensionsResponseTypeDef
def get_value() -> ListAvailableResourceDimensionsResponseTypeDef:
return {
"MetricDimensions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListAvailableResourceDimensionsResponseTypeDef definition
class ListAvailableResourceDimensionsResponseTypeDef(TypedDict):
MetricDimensions: List[MetricDimensionGroupsTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)