Skip to content

Type definitions#

Index > ApplicationAutoScaling > Type definitions

Auto-generated documentation for ApplicationAutoScaling type annotations stubs module mypy-boto3-application-autoscaling.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AlarmTypeDef#

# AlarmTypeDef definition

class AlarmTypeDef(TypedDict):
    AlarmName: str,
    AlarmARN: str,

MetricDimensionTypeDef#

# MetricDimensionTypeDef definition

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

DeleteScalingPolicyRequestRequestTypeDef#

# DeleteScalingPolicyRequestRequestTypeDef definition

class DeleteScalingPolicyRequestRequestTypeDef(TypedDict):
    PolicyName: str,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType

DeleteScheduledActionRequestRequestTypeDef#

# DeleteScheduledActionRequestRequestTypeDef definition

class DeleteScheduledActionRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ScheduledActionName: str,
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType

DeregisterScalableTargetRequestRequestTypeDef#

# DeregisterScalableTargetRequestRequestTypeDef definition

class DeregisterScalableTargetRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeScalableTargetsRequestRequestTypeDef#

# DescribeScalableTargetsRequestRequestTypeDef definition

class DescribeScalableTargetsRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceIds: NotRequired[Sequence[str]],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DescribeScalingActivitiesRequestRequestTypeDef#

# DescribeScalingActivitiesRequestRequestTypeDef definition

class DescribeScalingActivitiesRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: NotRequired[str],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    IncludeNotScaledActivities: NotRequired[bool],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType

DescribeScalingPoliciesRequestRequestTypeDef#

# DescribeScalingPoliciesRequestRequestTypeDef definition

class DescribeScalingPoliciesRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    PolicyNames: NotRequired[Sequence[str]],
    ResourceId: NotRequired[str],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType

DescribeScheduledActionsRequestRequestTypeDef#

# DescribeScheduledActionsRequestRequestTypeDef definition

class DescribeScheduledActionsRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ScheduledActionNames: NotRequired[Sequence[str]],
    ResourceId: NotRequired[str],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

NotScaledReasonTypeDef#

# NotScaledReasonTypeDef definition

class NotScaledReasonTypeDef(TypedDict):
    Code: str,
    MaxCapacity: NotRequired[int],
    MinCapacity: NotRequired[int],
    CurrentCapacity: NotRequired[int],

PredefinedMetricSpecificationTypeDef#

# PredefinedMetricSpecificationTypeDef definition

class PredefinedMetricSpecificationTypeDef(TypedDict):
    PredefinedMetricType: MetricTypeType,  # (1)
    ResourceLabel: NotRequired[str],
  1. See MetricTypeType

ScalableTargetActionTypeDef#

# ScalableTargetActionTypeDef definition

class ScalableTargetActionTypeDef(TypedDict):
    MinCapacity: NotRequired[int],
    MaxCapacity: NotRequired[int],

SuspendedStateTypeDef#

# SuspendedStateTypeDef definition

class SuspendedStateTypeDef(TypedDict):
    DynamicScalingInSuspended: NotRequired[bool],
    DynamicScalingOutSuspended: NotRequired[bool],
    ScheduledScalingSuspended: NotRequired[bool],

StepAdjustmentTypeDef#

# StepAdjustmentTypeDef definition

class StepAdjustmentTypeDef(TypedDict):
    ScalingAdjustment: int,
    MetricIntervalLowerBound: NotRequired[float],
    MetricIntervalUpperBound: NotRequired[float],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Mapping[str, str],

TargetTrackingMetricDimensionTypeDef#

# TargetTrackingMetricDimensionTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

DescribeScalableTargetsRequestDescribeScalableTargetsPaginateTypeDef#

# DescribeScalableTargetsRequestDescribeScalableTargetsPaginateTypeDef definition

class DescribeScalableTargetsRequestDescribeScalableTargetsPaginateTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceIds: NotRequired[Sequence[str]],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See PaginatorConfigTypeDef

DescribeScalingActivitiesRequestDescribeScalingActivitiesPaginateTypeDef#

# DescribeScalingActivitiesRequestDescribeScalingActivitiesPaginateTypeDef definition

class DescribeScalingActivitiesRequestDescribeScalingActivitiesPaginateTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: NotRequired[str],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    IncludeNotScaledActivities: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See PaginatorConfigTypeDef

DescribeScalingPoliciesRequestDescribeScalingPoliciesPaginateTypeDef#

# DescribeScalingPoliciesRequestDescribeScalingPoliciesPaginateTypeDef definition

class DescribeScalingPoliciesRequestDescribeScalingPoliciesPaginateTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    PolicyNames: NotRequired[Sequence[str]],
    ResourceId: NotRequired[str],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See PaginatorConfigTypeDef

DescribeScheduledActionsRequestDescribeScheduledActionsPaginateTypeDef#

# DescribeScheduledActionsRequestDescribeScheduledActionsPaginateTypeDef definition

class DescribeScheduledActionsRequestDescribeScheduledActionsPaginateTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ScheduledActionNames: NotRequired[Sequence[str]],
    ResourceId: NotRequired[str],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See PaginatorConfigTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutScalingPolicyResponseTypeDef#

# PutScalingPolicyResponseTypeDef definition

class PutScalingPolicyResponseTypeDef(TypedDict):
    PolicyARN: str,
    Alarms: List[AlarmTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlarmTypeDef
  2. See ResponseMetadataTypeDef

RegisterScalableTargetResponseTypeDef#

# RegisterScalableTargetResponseTypeDef definition

class RegisterScalableTargetResponseTypeDef(TypedDict):
    ScalableTargetARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ScalingActivityTypeDef#

# ScalingActivityTypeDef definition

class ScalingActivityTypeDef(TypedDict):
    ActivityId: str,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    Description: str,
    Cause: str,
    StartTime: datetime,
    StatusCode: ScalingActivityStatusCodeType,  # (3)
    EndTime: NotRequired[datetime],
    StatusMessage: NotRequired[str],
    Details: NotRequired[str],
    NotScaledReasons: NotRequired[List[NotScaledReasonTypeDef]],  # (4)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See ScalingActivityStatusCodeType
  4. See NotScaledReasonTypeDef

ScheduledActionTypeDef#

# ScheduledActionTypeDef definition

class ScheduledActionTypeDef(TypedDict):
    ScheduledActionName: str,
    ScheduledActionARN: str,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    Schedule: str,
    ResourceId: str,
    CreationTime: datetime,
    Timezone: NotRequired[str],
    ScalableDimension: NotRequired[ScalableDimensionType],  # (2)
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    ScalableTargetAction: NotRequired[ScalableTargetActionTypeDef],  # (3)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See ScalableTargetActionTypeDef

PutScheduledActionRequestRequestTypeDef#

# PutScheduledActionRequestRequestTypeDef definition

class PutScheduledActionRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ScheduledActionName: str,
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    Schedule: NotRequired[str],
    Timezone: NotRequired[str],
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    ScalableTargetAction: NotRequired[ScalableTargetActionTypeDef],  # (3)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See ScalableTargetActionTypeDef

RegisterScalableTargetRequestRequestTypeDef#

# RegisterScalableTargetRequestRequestTypeDef definition

class RegisterScalableTargetRequestRequestTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    MinCapacity: NotRequired[int],
    MaxCapacity: NotRequired[int],
    RoleARN: NotRequired[str],
    SuspendedState: NotRequired[SuspendedStateTypeDef],  # (3)
    Tags: NotRequired[Mapping[str, str]],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See SuspendedStateTypeDef

ScalableTargetTypeDef#

# ScalableTargetTypeDef definition

class ScalableTargetTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    MinCapacity: int,
    MaxCapacity: int,
    RoleARN: str,
    CreationTime: datetime,
    SuspendedState: NotRequired[SuspendedStateTypeDef],  # (3)
    ScalableTargetARN: NotRequired[str],
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See SuspendedStateTypeDef

StepScalingPolicyConfigurationTypeDef#

# StepScalingPolicyConfigurationTypeDef definition

class StepScalingPolicyConfigurationTypeDef(TypedDict):
    AdjustmentType: NotRequired[AdjustmentTypeType],  # (1)
    StepAdjustments: NotRequired[List[StepAdjustmentTypeDef]],  # (2)
    MinAdjustmentMagnitude: NotRequired[int],
    Cooldown: NotRequired[int],
    MetricAggregationType: NotRequired[MetricAggregationTypeType],  # (3)
  1. See AdjustmentTypeType
  2. See StepAdjustmentTypeDef
  3. See MetricAggregationTypeType

TargetTrackingMetricTypeDef#

# TargetTrackingMetricTypeDef definition

class TargetTrackingMetricTypeDef(TypedDict):
    Dimensions: NotRequired[List[TargetTrackingMetricDimensionTypeDef]],  # (1)
    MetricName: NotRequired[str],
    Namespace: NotRequired[str],
  1. See TargetTrackingMetricDimensionTypeDef

DescribeScalingActivitiesResponseTypeDef#

# DescribeScalingActivitiesResponseTypeDef definition

class DescribeScalingActivitiesResponseTypeDef(TypedDict):
    ScalingActivities: List[ScalingActivityTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingActivityTypeDef
  2. See ResponseMetadataTypeDef

DescribeScheduledActionsResponseTypeDef#

# DescribeScheduledActionsResponseTypeDef definition

class DescribeScheduledActionsResponseTypeDef(TypedDict):
    ScheduledActions: List[ScheduledActionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduledActionTypeDef
  2. See ResponseMetadataTypeDef

DescribeScalableTargetsResponseTypeDef#

# DescribeScalableTargetsResponseTypeDef definition

class DescribeScalableTargetsResponseTypeDef(TypedDict):
    ScalableTargets: List[ScalableTargetTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalableTargetTypeDef
  2. See ResponseMetadataTypeDef

TargetTrackingMetricStatTypeDef#

# TargetTrackingMetricStatTypeDef definition

class TargetTrackingMetricStatTypeDef(TypedDict):
    Metric: TargetTrackingMetricTypeDef,  # (1)
    Stat: str,
    Unit: NotRequired[str],
  1. See TargetTrackingMetricTypeDef

TargetTrackingMetricDataQueryTypeDef#

# TargetTrackingMetricDataQueryTypeDef definition

class TargetTrackingMetricDataQueryTypeDef(TypedDict):
    Id: str,
    Expression: NotRequired[str],
    Label: NotRequired[str],
    MetricStat: NotRequired[TargetTrackingMetricStatTypeDef],  # (1)
    ReturnData: NotRequired[bool],
  1. See TargetTrackingMetricStatTypeDef

CustomizedMetricSpecificationTypeDef#

# CustomizedMetricSpecificationTypeDef definition

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

TargetTrackingScalingPolicyConfigurationTypeDef#

# TargetTrackingScalingPolicyConfigurationTypeDef definition

class TargetTrackingScalingPolicyConfigurationTypeDef(TypedDict):
    TargetValue: float,
    PredefinedMetricSpecification: NotRequired[PredefinedMetricSpecificationTypeDef],  # (1)
    CustomizedMetricSpecification: NotRequired[CustomizedMetricSpecificationTypeDef],  # (2)
    ScaleOutCooldown: NotRequired[int],
    ScaleInCooldown: NotRequired[int],
    DisableScaleIn: NotRequired[bool],
  1. See PredefinedMetricSpecificationTypeDef
  2. See CustomizedMetricSpecificationTypeDef

PutScalingPolicyRequestRequestTypeDef#

# PutScalingPolicyRequestRequestTypeDef definition

class PutScalingPolicyRequestRequestTypeDef(TypedDict):
    PolicyName: str,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    PolicyType: NotRequired[PolicyTypeType],  # (3)
    StepScalingPolicyConfiguration: NotRequired[StepScalingPolicyConfigurationTypeDef],  # (4)
    TargetTrackingScalingPolicyConfiguration: NotRequired[TargetTrackingScalingPolicyConfigurationTypeDef],  # (5)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See PolicyTypeType
  4. See StepScalingPolicyConfigurationTypeDef
  5. See TargetTrackingScalingPolicyConfigurationTypeDef

ScalingPolicyTypeDef#

# ScalingPolicyTypeDef definition

class ScalingPolicyTypeDef(TypedDict):
    PolicyARN: str,
    PolicyName: str,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    PolicyType: PolicyTypeType,  # (3)
    CreationTime: datetime,
    StepScalingPolicyConfiguration: NotRequired[StepScalingPolicyConfigurationTypeDef],  # (4)
    TargetTrackingScalingPolicyConfiguration: NotRequired[TargetTrackingScalingPolicyConfigurationTypeDef],  # (5)
    Alarms: NotRequired[List[AlarmTypeDef]],  # (6)
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See PolicyTypeType
  4. See StepScalingPolicyConfigurationTypeDef
  5. See TargetTrackingScalingPolicyConfigurationTypeDef
  6. See AlarmTypeDef

DescribeScalingPoliciesResponseTypeDef#

# DescribeScalingPoliciesResponseTypeDef definition

class DescribeScalingPoliciesResponseTypeDef(TypedDict):
    ScalingPolicies: List[ScalingPolicyTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingPolicyTypeDef
  2. See ResponseMetadataTypeDef