Skip to content

Type definitions#

Index > PI > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TagTypeDef#

# TagTypeDef definition

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

AnalysisReportTypeDef#

# AnalysisReportTypeDef definition

class AnalysisReportTypeDef(TypedDict):
    AnalysisReportId: str,
    Identifier: NotRequired[str],
    ServiceType: NotRequired[ServiceTypeType],  # (1)
    CreateTime: NotRequired[datetime],
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    Status: NotRequired[AnalysisStatusType],  # (2)
    Insights: NotRequired[List[InsightTypeDef]],  # (3)
  1. See ServiceTypeType
  2. See AnalysisStatusType
  3. See InsightTypeDef

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DataPointTypeDef#

# DataPointTypeDef definition

class DataPointTypeDef(TypedDict):
    Timestamp: datetime,
    Value: float,

PerformanceInsightsMetricTypeDef#

# PerformanceInsightsMetricTypeDef definition

class PerformanceInsightsMetricTypeDef(TypedDict):
    Metric: NotRequired[str],
    DisplayName: NotRequired[str],
    Dimensions: NotRequired[Dict[str, str]],
    Value: NotRequired[float],

DeletePerformanceAnalysisReportRequestRequestTypeDef#

# DeletePerformanceAnalysisReportRequestRequestTypeDef definition

class DeletePerformanceAnalysisReportRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    AnalysisReportId: str,
  1. See ServiceTypeType

DimensionGroupTypeDef#

# DimensionGroupTypeDef definition

class DimensionGroupTypeDef(TypedDict):
    Group: str,
    Dimensions: NotRequired[Sequence[str]],
    Limit: NotRequired[int],

DimensionKeyDescriptionTypeDef#

# DimensionKeyDescriptionTypeDef definition

class DimensionKeyDescriptionTypeDef(TypedDict):
    Dimensions: NotRequired[Dict[str, str]],
    Total: NotRequired[float],
    AdditionalMetrics: NotRequired[Dict[str, float]],
    Partitions: NotRequired[List[float]],

ResponsePartitionKeyTypeDef#

# ResponsePartitionKeyTypeDef definition

class ResponsePartitionKeyTypeDef(TypedDict):
    Dimensions: Dict[str, str],

DimensionDetailTypeDef#

# DimensionDetailTypeDef definition

class DimensionDetailTypeDef(TypedDict):
    Identifier: NotRequired[str],

DimensionKeyDetailTypeDef#

# DimensionKeyDetailTypeDef definition

class DimensionKeyDetailTypeDef(TypedDict):
    Value: NotRequired[str],
    Dimension: NotRequired[str],
    Status: NotRequired[DetailStatusType],  # (1)
  1. See DetailStatusType

FeatureMetadataTypeDef#

# FeatureMetadataTypeDef definition

class FeatureMetadataTypeDef(TypedDict):
    Status: NotRequired[FeatureStatusType],  # (1)
  1. See FeatureStatusType

GetDimensionKeyDetailsRequestRequestTypeDef#

# GetDimensionKeyDetailsRequestRequestTypeDef definition

class GetDimensionKeyDetailsRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    Group: str,
    GroupIdentifier: str,
    RequestedDimensions: NotRequired[Sequence[str]],
  1. See ServiceTypeType

GetPerformanceAnalysisReportRequestRequestTypeDef#

# GetPerformanceAnalysisReportRequestRequestTypeDef definition

class GetPerformanceAnalysisReportRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    AnalysisReportId: str,
    TextFormat: NotRequired[TextFormatType],  # (2)
    AcceptLanguage: NotRequired[AcceptLanguageType],  # (3)
  1. See ServiceTypeType
  2. See TextFormatType
  3. See AcceptLanguageType

GetResourceMetadataRequestRequestTypeDef#

# GetResourceMetadataRequestRequestTypeDef definition

class GetResourceMetadataRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
  1. See ServiceTypeType

RecommendationTypeDef#

# RecommendationTypeDef definition

class RecommendationTypeDef(TypedDict):
    RecommendationId: NotRequired[str],
    RecommendationDescription: NotRequired[str],

ListAvailableResourceDimensionsRequestRequestTypeDef#

# ListAvailableResourceDimensionsRequestRequestTypeDef definition

class ListAvailableResourceDimensionsRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    Metrics: Sequence[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ServiceTypeType

ListAvailableResourceMetricsRequestRequestTypeDef#

# ListAvailableResourceMetricsRequestRequestTypeDef definition

class ListAvailableResourceMetricsRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    MetricTypes: Sequence[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ServiceTypeType

ResponseResourceMetricTypeDef#

# ResponseResourceMetricTypeDef definition

class ResponseResourceMetricTypeDef(TypedDict):
    Metric: NotRequired[str],
    Description: NotRequired[str],
    Unit: NotRequired[str],

ListPerformanceAnalysisReportsRequestRequestTypeDef#

# ListPerformanceAnalysisReportsRequestRequestTypeDef definition

class ListPerformanceAnalysisReportsRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    ListTags: NotRequired[bool],
  1. See ServiceTypeType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    ResourceARN: str,
  1. See ServiceTypeType

ResponseResourceMetricKeyTypeDef#

# ResponseResourceMetricKeyTypeDef definition

class ResponseResourceMetricKeyTypeDef(TypedDict):
    Metric: str,
    Dimensions: NotRequired[Dict[str, str]],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    ResourceARN: str,
    TagKeys: Sequence[str],
  1. See ServiceTypeType

AnalysisReportSummaryTypeDef#

# AnalysisReportSummaryTypeDef definition

class AnalysisReportSummaryTypeDef(TypedDict):
    AnalysisReportId: NotRequired[str],
    CreateTime: NotRequired[datetime],
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    Status: NotRequired[AnalysisStatusType],  # (1)
    Tags: NotRequired[List[TagTypeDef]],  # (2)
  1. See AnalysisStatusType
  2. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (2)
  1. See ServiceTypeType
  2. See TagTypeDef

CreatePerformanceAnalysisReportRequestRequestTypeDef#

# CreatePerformanceAnalysisReportRequestRequestTypeDef definition

class CreatePerformanceAnalysisReportRequestRequestTypeDef(TypedDict):
    ServiceType: ServiceTypeType,  # (1)
    Identifier: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See ServiceTypeType
  2. See TagTypeDef

CreatePerformanceAnalysisReportResponseTypeDef#

# CreatePerformanceAnalysisReportResponseTypeDef definition

class CreatePerformanceAnalysisReportResponseTypeDef(TypedDict):
    AnalysisReportId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetPerformanceAnalysisReportResponseTypeDef#

# GetPerformanceAnalysisReportResponseTypeDef definition

class GetPerformanceAnalysisReportResponseTypeDef(TypedDict):
    AnalysisReport: AnalysisReportTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisReportTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

DataTypeDef#

# DataTypeDef definition

class DataTypeDef(TypedDict):
    PerformanceInsightsMetric: NotRequired[PerformanceInsightsMetricTypeDef],  # (1)
  1. See PerformanceInsightsMetricTypeDef

DescribeDimensionKeysRequestRequestTypeDef#

# 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],
  1. See ServiceTypeType
  2. See DimensionGroupTypeDef
  3. See DimensionGroupTypeDef

MetricQueryTypeDef#

# MetricQueryTypeDef definition

class MetricQueryTypeDef(TypedDict):
    Metric: str,
    GroupBy: NotRequired[DimensionGroupTypeDef],  # (1)
    Filter: NotRequired[Mapping[str, str]],
  1. See DimensionGroupTypeDef

DescribeDimensionKeysResponseTypeDef#

# DescribeDimensionKeysResponseTypeDef 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#

# DimensionGroupDetailTypeDef definition

class DimensionGroupDetailTypeDef(TypedDict):
    Group: NotRequired[str],
    Dimensions: NotRequired[List[DimensionDetailTypeDef]],  # (1)
  1. See DimensionDetailTypeDef

GetDimensionKeyDetailsResponseTypeDef#

# GetDimensionKeyDetailsResponseTypeDef definition

class GetDimensionKeyDetailsResponseTypeDef(TypedDict):
    Dimensions: List[DimensionKeyDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DimensionKeyDetailTypeDef
  2. See ResponseMetadataTypeDef

GetResourceMetadataResponseTypeDef#

# GetResourceMetadataResponseTypeDef definition

class GetResourceMetadataResponseTypeDef(TypedDict):
    Identifier: str,
    Features: Dict[str, FeatureMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FeatureMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListAvailableResourceMetricsResponseTypeDef#

# ListAvailableResourceMetricsResponseTypeDef definition

class ListAvailableResourceMetricsResponseTypeDef(TypedDict):
    Metrics: List[ResponseResourceMetricTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResponseResourceMetricTypeDef
  2. See ResponseMetadataTypeDef

MetricKeyDataPointsTypeDef#

# MetricKeyDataPointsTypeDef definition

class MetricKeyDataPointsTypeDef(TypedDict):
    Key: NotRequired[ResponseResourceMetricKeyTypeDef],  # (1)
    DataPoints: NotRequired[List[DataPointTypeDef]],  # (2)
  1. See ResponseResourceMetricKeyTypeDef
  2. See DataPointTypeDef

ListPerformanceAnalysisReportsResponseTypeDef#

# ListPerformanceAnalysisReportsResponseTypeDef definition

class ListPerformanceAnalysisReportsResponseTypeDef(TypedDict):
    AnalysisReports: List[AnalysisReportSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisReportSummaryTypeDef
  2. See ResponseMetadataTypeDef

InsightTypeDef#

# InsightTypeDef definition

class InsightTypeDef(TypedDict):
    InsightId: str,
    InsightType: NotRequired[str],
    Context: NotRequired[ContextTypeType],  # (1)
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    Severity: NotRequired[SeverityType],  # (2)
    SupportingInsights: NotRequired[List[Dict[str, Any]]],
    Description: NotRequired[str],
    Recommendations: NotRequired[List[RecommendationTypeDef]],  # (3)
    InsightData: NotRequired[List[DataTypeDef]],  # (4)
    BaselineData: NotRequired[List[DataTypeDef]],  # (4)
  1. See ContextTypeType
  2. See SeverityType
  3. See RecommendationTypeDef
  4. See DataTypeDef
  5. See DataTypeDef

GetResourceMetricsRequestRequestTypeDef#

# 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)
  1. See ServiceTypeType
  2. See MetricQueryTypeDef
  3. See PeriodAlignmentType

MetricDimensionGroupsTypeDef#

# MetricDimensionGroupsTypeDef definition

class MetricDimensionGroupsTypeDef(TypedDict):
    Metric: NotRequired[str],
    Groups: NotRequired[List[DimensionGroupDetailTypeDef]],  # (1)
  1. See DimensionGroupDetailTypeDef

GetResourceMetricsResponseTypeDef#

# GetResourceMetricsResponseTypeDef 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#

# ListAvailableResourceDimensionsResponseTypeDef definition

class ListAvailableResourceDimensionsResponseTypeDef(TypedDict):
    MetricDimensions: List[MetricDimensionGroupsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricDimensionGroupsTypeDef
  2. See ResponseMetadataTypeDef