Skip to content

Typed dictionaries

Index > PI > Typed dictionaries

Auto-generated documentation for PI type annotations stubs module mypy-boto3-pi.

DataPointTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DataPointTypeDef

def get_value() -> DataPointTypeDef:
    return {
        "Timestamp": ...,
        "Value": ...,
    }
Definition
class DataPointTypeDef(TypedDict):
    Timestamp: datetime,
    Value: float,

DimensionGroupTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DimensionGroupTypeDef

def get_value() -> DimensionGroupTypeDef:
    return {
        "Group": ...,
    }
Definition
class DimensionGroupTypeDef(TypedDict):
    Group: str,
    Dimensions: NotRequired[Sequence[str]],
    Limit: NotRequired[int],

DimensionKeyDescriptionTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DimensionKeyDescriptionTypeDef

def get_value() -> DimensionKeyDescriptionTypeDef:
    return {
        "Dimensions": ...,
    }
Definition
class DimensionKeyDescriptionTypeDef(TypedDict):
    Dimensions: NotRequired[Dict[str, str]],
    Total: NotRequired[float],
    AdditionalMetrics: NotRequired[Dict[str, float]],
    Partitions: NotRequired[List[float]],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_pi.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,

ResponsePartitionKeyTypeDef

Usage Example
from mypy_boto3_pi.type_defs import ResponsePartitionKeyTypeDef

def get_value() -> ResponsePartitionKeyTypeDef:
    return {
        "Dimensions": ...,
    }
Definition
class ResponsePartitionKeyTypeDef(TypedDict):
    Dimensions: Dict[str, str],

DimensionDetailTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DimensionDetailTypeDef

def get_value() -> DimensionDetailTypeDef:
    return {
        "Identifier": ...,
    }
Definition
class DimensionDetailTypeDef(TypedDict):
    Identifier: NotRequired[str],

DimensionKeyDetailTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DimensionKeyDetailTypeDef

def get_value() -> DimensionKeyDetailTypeDef:
    return {
        "Value": ...,
    }
Definition
class DimensionKeyDetailTypeDef(TypedDict):
    Value: NotRequired[str],
    Dimension: NotRequired[str],
    Status: NotRequired[DetailStatusType],  # (1)
  1. See DetailStatusType

FeatureMetadataTypeDef

Usage Example
from mypy_boto3_pi.type_defs import FeatureMetadataTypeDef

def get_value() -> FeatureMetadataTypeDef:
    return {
        "Status": ...,
    }
Definition
class FeatureMetadataTypeDef(TypedDict):
    Status: NotRequired[FeatureStatusType],  # (1)
  1. See FeatureStatusType

GetDimensionKeyDetailsRequestRequestTypeDef

Usage Example
from mypy_boto3_pi.type_defs import GetDimensionKeyDetailsRequestRequestTypeDef

def get_value() -> GetDimensionKeyDetailsRequestRequestTypeDef:
    return {
        "ServiceType": ...,
        "Identifier": ...,
        "Group": ...,
        "GroupIdentifier": ...,
    }
Definition
class GetDimensionKeyDetailsRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    Group: str,
    GroupIdentifier: str,
    RequestedDimensions: NotRequired[Sequence[str]],
  1. See ServiceTypeType

GetResourceMetadataRequestRequestTypeDef

Usage Example
from mypy_boto3_pi.type_defs import GetResourceMetadataRequestRequestTypeDef

def get_value() -> GetResourceMetadataRequestRequestTypeDef:
    return {
        "ServiceType": ...,
        "Identifier": ...,
    }
Definition
class GetResourceMetadataRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
  1. See ServiceTypeType

ListAvailableResourceDimensionsRequestRequestTypeDef

Usage Example
from mypy_boto3_pi.type_defs import ListAvailableResourceDimensionsRequestRequestTypeDef

def get_value() -> ListAvailableResourceDimensionsRequestRequestTypeDef:
    return {
        "ServiceType": ...,
        "Identifier": ...,
        "Metrics": ...,
    }
Definition
class ListAvailableResourceDimensionsRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    Metrics: Sequence[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ServiceTypeType

ListAvailableResourceMetricsRequestRequestTypeDef

Usage Example
from mypy_boto3_pi.type_defs import ListAvailableResourceMetricsRequestRequestTypeDef

def get_value() -> ListAvailableResourceMetricsRequestRequestTypeDef:
    return {
        "ServiceType": ...,
        "Identifier": ...,
        "MetricTypes": ...,
    }
Definition
class ListAvailableResourceMetricsRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    MetricTypes: Sequence[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ServiceTypeType

ResponseResourceMetricTypeDef

Usage Example
from mypy_boto3_pi.type_defs import ResponseResourceMetricTypeDef

def get_value() -> ResponseResourceMetricTypeDef:
    return {
        "Metric": ...,
    }
Definition
class ResponseResourceMetricTypeDef(TypedDict):
    Metric: NotRequired[str],
    Description: NotRequired[str],
    Unit: NotRequired[str],

ResponseResourceMetricKeyTypeDef

Usage Example
from mypy_boto3_pi.type_defs import ResponseResourceMetricKeyTypeDef

def get_value() -> ResponseResourceMetricKeyTypeDef:
    return {
        "Metric": ...,
    }
Definition
class ResponseResourceMetricKeyTypeDef(TypedDict):
    Metric: str,
    Dimensions: NotRequired[Dict[str, str]],

DescribeDimensionKeysRequestRequestTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DescribeDimensionKeysRequestRequestTypeDef

def get_value() -> DescribeDimensionKeysRequestRequestTypeDef:
    return {
        "ServiceType": ...,
        "Identifier": ...,
        "StartTime": ...,
        "EndTime": ...,
        "Metric": ...,
        "GroupBy": ...,
    }
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],
  1. See ServiceTypeType
  2. See DimensionGroupTypeDef
  3. See DimensionGroupTypeDef

MetricQueryTypeDef

Usage Example
from mypy_boto3_pi.type_defs import MetricQueryTypeDef

def get_value() -> MetricQueryTypeDef:
    return {
        "Metric": ...,
    }
Definition
class MetricQueryTypeDef(TypedDict):
    Metric: str,
    GroupBy: NotRequired[DimensionGroupTypeDef],  # (1)
    Filter: NotRequired[Mapping[str, str]],
  1. See DimensionGroupTypeDef

DescribeDimensionKeysResponseTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DescribeDimensionKeysResponseTypeDef

def get_value() -> DescribeDimensionKeysResponseTypeDef:
    return {
        "AlignedStartTime": ...,
        "AlignedEndTime": ...,
        "PartitionKeys": ...,
        "Keys": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeDimensionKeysResponseTypeDef(TypedDict):
    AlignedStartTime: datetime,
    AlignedEndTime: datetime,
    PartitionKeys: List[ResponsePartitionKeyTypeDef],  # (1)
    Keys: List[DimensionKeyDescriptionTypeDef],  # (2)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ResponsePartitionKeyTypeDef
  2. See DimensionKeyDescriptionTypeDef
  3. See ResponseMetadataTypeDef

DimensionGroupDetailTypeDef

Usage Example
from mypy_boto3_pi.type_defs import DimensionGroupDetailTypeDef

def get_value() -> DimensionGroupDetailTypeDef:
    return {
        "Group": ...,
    }
Definition
class DimensionGroupDetailTypeDef(TypedDict):
    Group: NotRequired[str],
    Dimensions: NotRequired[List[DimensionDetailTypeDef]],  # (1)
  1. See DimensionDetailTypeDef

GetDimensionKeyDetailsResponseTypeDef

Usage Example
from mypy_boto3_pi.type_defs import GetDimensionKeyDetailsResponseTypeDef

def get_value() -> GetDimensionKeyDetailsResponseTypeDef:
    return {
        "Dimensions": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetDimensionKeyDetailsResponseTypeDef(TypedDict):
    Dimensions: List[DimensionKeyDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DimensionKeyDetailTypeDef
  2. See ResponseMetadataTypeDef

GetResourceMetadataResponseTypeDef

Usage Example
from mypy_boto3_pi.type_defs import GetResourceMetadataResponseTypeDef

def get_value() -> GetResourceMetadataResponseTypeDef:
    return {
        "Identifier": ...,
        "Features": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetResourceMetadataResponseTypeDef(TypedDict):
    Identifier: str,
    Features: Dict[str, FeatureMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FeatureMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListAvailableResourceMetricsResponseTypeDef

Usage Example
from mypy_boto3_pi.type_defs import ListAvailableResourceMetricsResponseTypeDef

def get_value() -> ListAvailableResourceMetricsResponseTypeDef:
    return {
        "Metrics": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListAvailableResourceMetricsResponseTypeDef(TypedDict):
    Metrics: List[ResponseResourceMetricTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResponseResourceMetricTypeDef
  2. See ResponseMetadataTypeDef

MetricKeyDataPointsTypeDef

Usage Example
from mypy_boto3_pi.type_defs import MetricKeyDataPointsTypeDef

def get_value() -> MetricKeyDataPointsTypeDef:
    return {
        "Key": ...,
    }
Definition
class MetricKeyDataPointsTypeDef(TypedDict):
    Key: NotRequired[ResponseResourceMetricKeyTypeDef],  # (1)
    DataPoints: NotRequired[List[DataPointTypeDef]],  # (2)
  1. See ResponseResourceMetricKeyTypeDef
  2. See DataPointTypeDef

GetResourceMetricsRequestRequestTypeDef

Usage Example
from mypy_boto3_pi.type_defs import GetResourceMetricsRequestRequestTypeDef

def get_value() -> GetResourceMetricsRequestRequestTypeDef:
    return {
        "ServiceType": ...,
        "Identifier": ...,
        "MetricQueries": ...,
        "StartTime": ...,
        "EndTime": ...,
    }
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],
  1. See ServiceTypeType
  2. See MetricQueryTypeDef

MetricDimensionGroupsTypeDef

Usage Example
from mypy_boto3_pi.type_defs import MetricDimensionGroupsTypeDef

def get_value() -> MetricDimensionGroupsTypeDef:
    return {
        "Metric": ...,
    }
Definition
class MetricDimensionGroupsTypeDef(TypedDict):
    Metric: NotRequired[str],
    Groups: NotRequired[List[DimensionGroupDetailTypeDef]],  # (1)
  1. See DimensionGroupDetailTypeDef

GetResourceMetricsResponseTypeDef

Usage Example
from mypy_boto3_pi.type_defs import GetResourceMetricsResponseTypeDef

def get_value() -> GetResourceMetricsResponseTypeDef:
    return {
        "AlignedStartTime": ...,
        "AlignedEndTime": ...,
        "Identifier": ...,
        "MetricList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetResourceMetricsResponseTypeDef(TypedDict):
    AlignedStartTime: datetime,
    AlignedEndTime: datetime,
    Identifier: str,
    MetricList: List[MetricKeyDataPointsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricKeyDataPointsTypeDef
  2. See ResponseMetadataTypeDef

ListAvailableResourceDimensionsResponseTypeDef

Usage Example
from mypy_boto3_pi.type_defs import ListAvailableResourceDimensionsResponseTypeDef

def get_value() -> ListAvailableResourceDimensionsResponseTypeDef:
    return {
        "MetricDimensions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListAvailableResourceDimensionsResponseTypeDef(TypedDict):
    MetricDimensions: List[MetricDimensionGroupsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricDimensionGroupsTypeDef
  2. See ResponseMetadataTypeDef