Skip to content

Type definitions#

Index > AutoScalingPlans > Type definitions

Auto-generated documentation for AutoScalingPlans type annotations stubs module mypy-boto3-autoscaling-plans.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TagFilterTypeDef#

# TagFilterTypeDef definition

class TagFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

MetricDimensionTypeDef#

# MetricDimensionTypeDef definition

class MetricDimensionTypeDef(TypedDict):
    Name: str,
    Value: str,

DatapointTypeDef#

# DatapointTypeDef definition

class DatapointTypeDef(TypedDict):
    Timestamp: NotRequired[datetime],
    Value: NotRequired[float],

DeleteScalingPlanRequestRequestTypeDef#

# DeleteScalingPlanRequestRequestTypeDef definition

class DeleteScalingPlanRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeScalingPlanResourcesRequestRequestTypeDef#

# DescribeScalingPlanResourcesRequestRequestTypeDef definition

class DescribeScalingPlanResourcesRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PredefinedLoadMetricSpecificationTypeDef#

# PredefinedLoadMetricSpecificationTypeDef definition

class PredefinedLoadMetricSpecificationTypeDef(TypedDict):
    PredefinedLoadMetricType: LoadMetricTypeType,  # (1)
    ResourceLabel: NotRequired[str],
  1. See LoadMetricTypeType

PredefinedScalingMetricSpecificationTypeDef#

# PredefinedScalingMetricSpecificationTypeDef definition

class PredefinedScalingMetricSpecificationTypeDef(TypedDict):
    PredefinedScalingMetricType: ScalingMetricTypeType,  # (1)
    ResourceLabel: NotRequired[str],
  1. See ScalingMetricTypeType

ApplicationSourceTypeDef#

# ApplicationSourceTypeDef definition

class ApplicationSourceTypeDef(TypedDict):
    CloudFormationStackARN: NotRequired[str],
    TagFilters: NotRequired[Sequence[TagFilterTypeDef]],  # (1)
  1. See TagFilterTypeDef

CreateScalingPlanResponseTypeDef#

# CreateScalingPlanResponseTypeDef definition

class CreateScalingPlanResponseTypeDef(TypedDict):
    ScalingPlanVersion: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CustomizedLoadMetricSpecificationPaginatorTypeDef#

# CustomizedLoadMetricSpecificationPaginatorTypeDef definition

class CustomizedLoadMetricSpecificationPaginatorTypeDef(TypedDict):
    MetricName: str,
    Namespace: str,
    Statistic: MetricStatisticType,  # (2)
    Dimensions: NotRequired[List[MetricDimensionTypeDef]],  # (1)
    Unit: NotRequired[str],
  1. See MetricDimensionTypeDef
  2. See MetricStatisticType

CustomizedLoadMetricSpecificationTypeDef#

# CustomizedLoadMetricSpecificationTypeDef definition

class CustomizedLoadMetricSpecificationTypeDef(TypedDict):
    MetricName: str,
    Namespace: str,
    Statistic: MetricStatisticType,  # (2)
    Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]],  # (1)
    Unit: NotRequired[str],
  1. See MetricDimensionTypeDef
  2. See MetricStatisticType

CustomizedScalingMetricSpecificationPaginatorTypeDef#

# CustomizedScalingMetricSpecificationPaginatorTypeDef definition

class CustomizedScalingMetricSpecificationPaginatorTypeDef(TypedDict):
    MetricName: str,
    Namespace: str,
    Statistic: MetricStatisticType,  # (2)
    Dimensions: NotRequired[List[MetricDimensionTypeDef]],  # (1)
    Unit: NotRequired[str],
  1. See MetricDimensionTypeDef
  2. See MetricStatisticType

CustomizedScalingMetricSpecificationTypeDef#

# CustomizedScalingMetricSpecificationTypeDef definition

class CustomizedScalingMetricSpecificationTypeDef(TypedDict):
    MetricName: str,
    Namespace: str,
    Statistic: MetricStatisticType,  # (2)
    Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]],  # (1)
    Unit: NotRequired[str],
  1. See MetricDimensionTypeDef
  2. See MetricStatisticType

GetScalingPlanResourceForecastDataResponseTypeDef#

# GetScalingPlanResourceForecastDataResponseTypeDef definition

class GetScalingPlanResourceForecastDataResponseTypeDef(TypedDict):
    Datapoints: List[DatapointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatapointTypeDef
  2. See ResponseMetadataTypeDef

DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef#

# DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef definition

class DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetScalingPlanResourceForecastDataRequestRequestTypeDef#

# GetScalingPlanResourceForecastDataRequestRequestTypeDef definition

class GetScalingPlanResourceForecastDataRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    ForecastDataType: ForecastDataTypeType,  # (3)
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See ForecastDataTypeType

DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef#

# DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef definition

class DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef(TypedDict):
    ScalingPlanNames: NotRequired[Sequence[str]],
    ScalingPlanVersion: NotRequired[int],
    ApplicationSources: NotRequired[Sequence[ApplicationSourceTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ApplicationSourceTypeDef
  2. See PaginatorConfigTypeDef

DescribeScalingPlansRequestRequestTypeDef#

# DescribeScalingPlansRequestRequestTypeDef definition

class DescribeScalingPlansRequestRequestTypeDef(TypedDict):
    ScalingPlanNames: NotRequired[Sequence[str]],
    ScalingPlanVersion: NotRequired[int],
    ApplicationSources: NotRequired[Sequence[ApplicationSourceTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ApplicationSourceTypeDef

TargetTrackingConfigurationPaginatorTypeDef#

# TargetTrackingConfigurationPaginatorTypeDef definition

class TargetTrackingConfigurationPaginatorTypeDef(TypedDict):
    TargetValue: float,
    PredefinedScalingMetricSpecification: NotRequired[PredefinedScalingMetricSpecificationTypeDef],  # (1)
    CustomizedScalingMetricSpecification: NotRequired[CustomizedScalingMetricSpecificationPaginatorTypeDef],  # (2)
    DisableScaleIn: NotRequired[bool],
    ScaleOutCooldown: NotRequired[int],
    ScaleInCooldown: NotRequired[int],
    EstimatedInstanceWarmup: NotRequired[int],
  1. See PredefinedScalingMetricSpecificationTypeDef
  2. See CustomizedScalingMetricSpecificationPaginatorTypeDef

TargetTrackingConfigurationTypeDef#

# TargetTrackingConfigurationTypeDef definition

class TargetTrackingConfigurationTypeDef(TypedDict):
    TargetValue: float,
    PredefinedScalingMetricSpecification: NotRequired[PredefinedScalingMetricSpecificationTypeDef],  # (1)
    CustomizedScalingMetricSpecification: NotRequired[CustomizedScalingMetricSpecificationTypeDef],  # (2)
    DisableScaleIn: NotRequired[bool],
    ScaleOutCooldown: NotRequired[int],
    ScaleInCooldown: NotRequired[int],
    EstimatedInstanceWarmup: NotRequired[int],
  1. See PredefinedScalingMetricSpecificationTypeDef
  2. See CustomizedScalingMetricSpecificationTypeDef

ScalingInstructionPaginatorTypeDef#

# ScalingInstructionPaginatorTypeDef definition

class ScalingInstructionPaginatorTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    MinCapacity: int,
    MaxCapacity: int,
    TargetTrackingConfigurations: List[TargetTrackingConfigurationPaginatorTypeDef],  # (3)
    PredefinedLoadMetricSpecification: NotRequired[PredefinedLoadMetricSpecificationTypeDef],  # (4)
    CustomizedLoadMetricSpecification: NotRequired[CustomizedLoadMetricSpecificationPaginatorTypeDef],  # (5)
    ScheduledActionBufferTime: NotRequired[int],
    PredictiveScalingMaxCapacityBehavior: NotRequired[PredictiveScalingMaxCapacityBehaviorType],  # (6)
    PredictiveScalingMaxCapacityBuffer: NotRequired[int],
    PredictiveScalingMode: NotRequired[PredictiveScalingModeType],  # (7)
    ScalingPolicyUpdateBehavior: NotRequired[ScalingPolicyUpdateBehaviorType],  # (8)
    DisableDynamicScaling: NotRequired[bool],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See TargetTrackingConfigurationPaginatorTypeDef
  4. See PredefinedLoadMetricSpecificationTypeDef
  5. See CustomizedLoadMetricSpecificationPaginatorTypeDef
  6. See PredictiveScalingMaxCapacityBehaviorType
  7. See PredictiveScalingModeType
  8. See ScalingPolicyUpdateBehaviorType

ScalingPolicyPaginatorTypeDef#

# ScalingPolicyPaginatorTypeDef definition

class ScalingPolicyPaginatorTypeDef(TypedDict):
    PolicyName: str,
    PolicyType: PolicyTypeType,  # (1)
    TargetTrackingConfiguration: NotRequired[TargetTrackingConfigurationPaginatorTypeDef],  # (2)
  1. See PolicyTypeType
  2. See TargetTrackingConfigurationPaginatorTypeDef

ScalingInstructionTypeDef#

# ScalingInstructionTypeDef definition

class ScalingInstructionTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    MinCapacity: int,
    MaxCapacity: int,
    TargetTrackingConfigurations: Sequence[TargetTrackingConfigurationTypeDef],  # (3)
    PredefinedLoadMetricSpecification: NotRequired[PredefinedLoadMetricSpecificationTypeDef],  # (4)
    CustomizedLoadMetricSpecification: NotRequired[CustomizedLoadMetricSpecificationTypeDef],  # (5)
    ScheduledActionBufferTime: NotRequired[int],
    PredictiveScalingMaxCapacityBehavior: NotRequired[PredictiveScalingMaxCapacityBehaviorType],  # (6)
    PredictiveScalingMaxCapacityBuffer: NotRequired[int],
    PredictiveScalingMode: NotRequired[PredictiveScalingModeType],  # (7)
    ScalingPolicyUpdateBehavior: NotRequired[ScalingPolicyUpdateBehaviorType],  # (8)
    DisableDynamicScaling: NotRequired[bool],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See TargetTrackingConfigurationTypeDef
  4. See PredefinedLoadMetricSpecificationTypeDef
  5. See CustomizedLoadMetricSpecificationTypeDef
  6. See PredictiveScalingMaxCapacityBehaviorType
  7. See PredictiveScalingModeType
  8. See ScalingPolicyUpdateBehaviorType

ScalingPolicyTypeDef#

# ScalingPolicyTypeDef definition

class ScalingPolicyTypeDef(TypedDict):
    PolicyName: str,
    PolicyType: PolicyTypeType,  # (1)
    TargetTrackingConfiguration: NotRequired[TargetTrackingConfigurationTypeDef],  # (2)
  1. See PolicyTypeType
  2. See TargetTrackingConfigurationTypeDef

ScalingPlanPaginatorTypeDef#

# ScalingPlanPaginatorTypeDef definition

class ScalingPlanPaginatorTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ApplicationSource: ApplicationSourceTypeDef,  # (1)
    ScalingInstructions: List[ScalingInstructionPaginatorTypeDef],  # (2)
    StatusCode: ScalingPlanStatusCodeType,  # (3)
    StatusMessage: NotRequired[str],
    StatusStartTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
  1. See ApplicationSourceTypeDef
  2. See ScalingInstructionPaginatorTypeDef
  3. See ScalingPlanStatusCodeType

ScalingPlanResourcePaginatorTypeDef#

# ScalingPlanResourcePaginatorTypeDef definition

class ScalingPlanResourcePaginatorTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    ScalingStatusCode: ScalingStatusCodeType,  # (4)
    ScalingPolicies: NotRequired[List[ScalingPolicyPaginatorTypeDef]],  # (3)
    ScalingStatusMessage: NotRequired[str],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See ScalingPolicyPaginatorTypeDef
  4. See ScalingStatusCodeType

CreateScalingPlanRequestRequestTypeDef#

# CreateScalingPlanRequestRequestTypeDef definition

class CreateScalingPlanRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ApplicationSource: ApplicationSourceTypeDef,  # (1)
    ScalingInstructions: Sequence[ScalingInstructionTypeDef],  # (2)
  1. See ApplicationSourceTypeDef
  2. See ScalingInstructionTypeDef

ScalingPlanTypeDef#

# ScalingPlanTypeDef definition

class ScalingPlanTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ApplicationSource: ApplicationSourceTypeDef,  # (1)
    ScalingInstructions: List[ScalingInstructionTypeDef],  # (2)
    StatusCode: ScalingPlanStatusCodeType,  # (3)
    StatusMessage: NotRequired[str],
    StatusStartTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
  1. See ApplicationSourceTypeDef
  2. See ScalingInstructionTypeDef
  3. See ScalingPlanStatusCodeType

UpdateScalingPlanRequestRequestTypeDef#

# UpdateScalingPlanRequestRequestTypeDef definition

class UpdateScalingPlanRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ApplicationSource: NotRequired[ApplicationSourceTypeDef],  # (1)
    ScalingInstructions: NotRequired[Sequence[ScalingInstructionTypeDef]],  # (2)
  1. See ApplicationSourceTypeDef
  2. See ScalingInstructionTypeDef

ScalingPlanResourceTypeDef#

# ScalingPlanResourceTypeDef definition

class ScalingPlanResourceTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    ScalingStatusCode: ScalingStatusCodeType,  # (4)
    ScalingPolicies: NotRequired[List[ScalingPolicyTypeDef]],  # (3)
    ScalingStatusMessage: NotRequired[str],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See ScalingPolicyTypeDef
  4. See ScalingStatusCodeType

DescribeScalingPlansResponsePaginatorTypeDef#

# DescribeScalingPlansResponsePaginatorTypeDef definition

class DescribeScalingPlansResponsePaginatorTypeDef(TypedDict):
    ScalingPlans: List[ScalingPlanPaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingPlanPaginatorTypeDef
  2. See ResponseMetadataTypeDef

DescribeScalingPlanResourcesResponsePaginatorTypeDef#

# DescribeScalingPlanResourcesResponsePaginatorTypeDef definition

class DescribeScalingPlanResourcesResponsePaginatorTypeDef(TypedDict):
    ScalingPlanResources: List[ScalingPlanResourcePaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingPlanResourcePaginatorTypeDef
  2. See ResponseMetadataTypeDef

DescribeScalingPlansResponseTypeDef#

# DescribeScalingPlansResponseTypeDef definition

class DescribeScalingPlansResponseTypeDef(TypedDict):
    ScalingPlans: List[ScalingPlanTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingPlanTypeDef
  2. See ResponseMetadataTypeDef

DescribeScalingPlanResourcesResponseTypeDef#

# DescribeScalingPlanResourcesResponseTypeDef definition

class DescribeScalingPlanResourcesResponseTypeDef(TypedDict):
    ScalingPlanResources: List[ScalingPlanResourceTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingPlanResourceTypeDef
  2. See ResponseMetadataTypeDef