Skip to content

AutoScalingClient

Index > AutoScaling > AutoScalingClient

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

AutoScalingClient

Type annotations and code completion for boto3.client("autoscaling"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_autoscaling.client import AutoScalingClient

def get_autoscaling_client() -> AutoScalingClient:
    return Session().client("autoscaling")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("autoscaling").exceptions structure.

Usage example
client = boto3.client("autoscaling")

try:
    do_something(client)
except (
    client.ActiveInstanceRefreshNotFoundFault,
    client.AlreadyExistsFault,
    client.ClientError,
    client.InstanceRefreshInProgressFault,
    client.InvalidNextToken,
    client.LimitExceededFault,
    client.ResourceContentionFault,
    client.ResourceInUseFault,
    client.ScalingActivityInProgressFault,
    client.ServiceLinkedRoleFailure,
) as e:
    print(e)
Type checking example
from mypy_boto3_autoscaling.client import Exceptions

def handle_error(exc: Exceptions.ActiveInstanceRefreshNotFoundFault) -> None:
    ...

Methods

attach_instances

Attaches one or more EC2 instances to the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").attach_instances method. boto3 documentation

Method definition
def attach_instances(
    self,
    *,
    AutoScalingGroupName: str,
    InstanceIds: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AttachInstancesQueryRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.attach_instances(**kwargs)
  1. See AttachInstancesQueryRequestTypeDef

attach_load_balancer_target_groups

Attaches one or more target groups to the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").attach_load_balancer_target_groups method. boto3 documentation

Method definition
def attach_load_balancer_target_groups(
    self,
    *,
    AutoScalingGroupName: str,
    TargetGroupARNs: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AttachLoadBalancerTargetGroupsTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TargetGroupARNs": ...,
}

parent.attach_load_balancer_target_groups(**kwargs)
  1. See AttachLoadBalancerTargetGroupsTypeRequestTypeDef

attach_load_balancers

.

Type annotations and code completion for boto3.client("autoscaling").attach_load_balancers method. boto3 documentation

Method definition
def attach_load_balancers(
    self,
    *,
    AutoScalingGroupName: str,
    LoadBalancerNames: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AttachLoadBalancersTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "LoadBalancerNames": ...,
}

parent.attach_load_balancers(**kwargs)
  1. See AttachLoadBalancersTypeRequestTypeDef

batch_delete_scheduled_action

Deletes one or more scheduled actions for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").batch_delete_scheduled_action method. boto3 documentation

Method definition
def batch_delete_scheduled_action(
    self,
    *,
    AutoScalingGroupName: str,
    ScheduledActionNames: Sequence[str],
) -> BatchDeleteScheduledActionAnswerTypeDef:  # (1)
    ...
  1. See BatchDeleteScheduledActionAnswerTypeDef
Usage example with kwargs
kwargs: BatchDeleteScheduledActionTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledActionNames": ...,
}

parent.batch_delete_scheduled_action(**kwargs)
  1. See BatchDeleteScheduledActionTypeRequestTypeDef

batch_put_scheduled_update_group_action

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").batch_put_scheduled_update_group_action method. boto3 documentation

Method definition
def batch_put_scheduled_update_group_action(
    self,
    *,
    AutoScalingGroupName: str,
    ScheduledUpdateGroupActions: Sequence[ScheduledUpdateGroupActionRequestTypeDef],  # (1)
) -> BatchPutScheduledUpdateGroupActionAnswerTypeDef:  # (2)
    ...
  1. See ScheduledUpdateGroupActionRequestTypeDef
  2. See BatchPutScheduledUpdateGroupActionAnswerTypeDef
Usage example with kwargs
kwargs: BatchPutScheduledUpdateGroupActionTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledUpdateGroupActions": ...,
}

parent.batch_put_scheduled_update_group_action(**kwargs)
  1. See BatchPutScheduledUpdateGroupActionTypeRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("autoscaling").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_instance_refresh

Cancels an instance refresh operation in progress.

Type annotations and code completion for boto3.client("autoscaling").cancel_instance_refresh method. boto3 documentation

Method definition
def cancel_instance_refresh(
    self,
    *,
    AutoScalingGroupName: str,
) -> CancelInstanceRefreshAnswerTypeDef:  # (1)
    ...
  1. See CancelInstanceRefreshAnswerTypeDef
Usage example with kwargs
kwargs: CancelInstanceRefreshTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.cancel_instance_refresh(**kwargs)
  1. See CancelInstanceRefreshTypeRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("autoscaling").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

complete_lifecycle_action

Completes the lifecycle action for the specified token or instance with the specified result.

Type annotations and code completion for boto3.client("autoscaling").complete_lifecycle_action method. boto3 documentation

Method definition
def complete_lifecycle_action(
    self,
    *,
    LifecycleHookName: str,
    AutoScalingGroupName: str,
    LifecycleActionResult: str,
    LifecycleActionToken: str = ...,
    InstanceId: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CompleteLifecycleActionTypeRequestTypeDef = {  # (1)
    "LifecycleHookName": ...,
    "AutoScalingGroupName": ...,
    "LifecycleActionResult": ...,
}

parent.complete_lifecycle_action(**kwargs)
  1. See CompleteLifecycleActionTypeRequestTypeDef

create_auto_scaling_group

We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Creates an Auto Scaling group with the specified name and attributes.

Type annotations and code completion for boto3.client("autoscaling").create_auto_scaling_group method. boto3 documentation

Method definition
def create_auto_scaling_group(
    self,
    *,
    AutoScalingGroupName: str,
    MinSize: int,
    MaxSize: int,
    LaunchConfigurationName: str = ...,
    LaunchTemplate: LaunchTemplateSpecificationTypeDef = ...,  # (1)
    MixedInstancesPolicy: MixedInstancesPolicyTypeDef = ...,  # (2)
    InstanceId: str = ...,
    DesiredCapacity: int = ...,
    DefaultCooldown: int = ...,
    AvailabilityZones: Sequence[str] = ...,
    LoadBalancerNames: Sequence[str] = ...,
    TargetGroupARNs: Sequence[str] = ...,
    HealthCheckType: str = ...,
    HealthCheckGracePeriod: int = ...,
    PlacementGroup: str = ...,
    VPCZoneIdentifier: str = ...,
    TerminationPolicies: Sequence[str] = ...,
    NewInstancesProtectedFromScaleIn: bool = ...,
    CapacityRebalance: bool = ...,
    LifecycleHookSpecificationList: Sequence[LifecycleHookSpecificationTypeDef] = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    ServiceLinkedRoleARN: str = ...,
    MaxInstanceLifetime: int = ...,
    Context: str = ...,
    DesiredCapacityType: str = ...,
    DefaultInstanceWarmup: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (5)
    ...
  1. See LaunchTemplateSpecificationTypeDef
  2. See MixedInstancesPolicyTypeDef
  3. See LifecycleHookSpecificationTypeDef
  4. See TagTypeDef
  5. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateAutoScalingGroupTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "MinSize": ...,
    "MaxSize": ...,
}

parent.create_auto_scaling_group(**kwargs)
  1. See CreateAutoScalingGroupTypeRequestTypeDef

create_launch_configuration

Creates a launch configuration.

Type annotations and code completion for boto3.client("autoscaling").create_launch_configuration method. boto3 documentation

Method definition
def create_launch_configuration(
    self,
    *,
    LaunchConfigurationName: str,
    ImageId: str = ...,
    KeyName: str = ...,
    SecurityGroups: Sequence[str] = ...,
    ClassicLinkVPCId: str = ...,
    ClassicLinkVPCSecurityGroups: Sequence[str] = ...,
    UserData: str = ...,
    InstanceId: str = ...,
    InstanceType: str = ...,
    KernelId: str = ...,
    RamdiskId: str = ...,
    BlockDeviceMappings: Sequence[BlockDeviceMappingTypeDef] = ...,  # (1)
    InstanceMonitoring: InstanceMonitoringTypeDef = ...,  # (2)
    SpotPrice: str = ...,
    IamInstanceProfile: str = ...,
    EbsOptimized: bool = ...,
    AssociatePublicIpAddress: bool = ...,
    PlacementTenancy: str = ...,
    MetadataOptions: InstanceMetadataOptionsTypeDef = ...,  # (3)
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...
  1. See BlockDeviceMappingTypeDef
  2. See InstanceMonitoringTypeDef
  3. See InstanceMetadataOptionsTypeDef
  4. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateLaunchConfigurationTypeRequestTypeDef = {  # (1)
    "LaunchConfigurationName": ...,
}

parent.create_launch_configuration(**kwargs)
  1. See CreateLaunchConfigurationTypeRequestTypeDef

create_or_update_tags

Creates or updates tags for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").create_or_update_tags method. boto3 documentation

Method definition
def create_or_update_tags(
    self,
    *,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateOrUpdateTagsTypeRequestTypeDef = {  # (1)
    "Tags": ...,
}

parent.create_or_update_tags(**kwargs)
  1. See CreateOrUpdateTagsTypeRequestTypeDef

delete_auto_scaling_group

Deletes the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").delete_auto_scaling_group method. boto3 documentation

Method definition
def delete_auto_scaling_group(
    self,
    *,
    AutoScalingGroupName: str,
    ForceDelete: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteAutoScalingGroupTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.delete_auto_scaling_group(**kwargs)
  1. See DeleteAutoScalingGroupTypeRequestTypeDef

delete_launch_configuration

Deletes the specified launch configuration.

Type annotations and code completion for boto3.client("autoscaling").delete_launch_configuration method. boto3 documentation

Method definition
def delete_launch_configuration(
    self,
    *,
    LaunchConfigurationName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: LaunchConfigurationNameTypeRequestTypeDef = {  # (1)
    "LaunchConfigurationName": ...,
}

parent.delete_launch_configuration(**kwargs)
  1. See LaunchConfigurationNameTypeRequestTypeDef

delete_lifecycle_hook

Deletes the specified lifecycle hook.

Type annotations and code completion for boto3.client("autoscaling").delete_lifecycle_hook method. boto3 documentation

Method definition
def delete_lifecycle_hook(
    self,
    *,
    LifecycleHookName: str,
    AutoScalingGroupName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteLifecycleHookTypeRequestTypeDef = {  # (1)
    "LifecycleHookName": ...,
    "AutoScalingGroupName": ...,
}

parent.delete_lifecycle_hook(**kwargs)
  1. See DeleteLifecycleHookTypeRequestTypeDef

delete_notification_configuration

Deletes the specified notification.

Type annotations and code completion for boto3.client("autoscaling").delete_notification_configuration method. boto3 documentation

Method definition
def delete_notification_configuration(
    self,
    *,
    AutoScalingGroupName: str,
    TopicARN: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteNotificationConfigurationTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TopicARN": ...,
}

parent.delete_notification_configuration(**kwargs)
  1. See DeleteNotificationConfigurationTypeRequestTypeDef

delete_policy

Deletes the specified scaling policy.

Type annotations and code completion for boto3.client("autoscaling").delete_policy method. boto3 documentation

Method definition
def delete_policy(
    self,
    *,
    PolicyName: str,
    AutoScalingGroupName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeletePolicyTypeRequestTypeDef = {  # (1)
    "PolicyName": ...,
}

parent.delete_policy(**kwargs)
  1. See DeletePolicyTypeRequestTypeDef

delete_scheduled_action

Deletes the specified scheduled action.

Type annotations and code completion for boto3.client("autoscaling").delete_scheduled_action method. boto3 documentation

Method definition
def delete_scheduled_action(
    self,
    *,
    AutoScalingGroupName: str,
    ScheduledActionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteScheduledActionTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledActionName": ...,
}

parent.delete_scheduled_action(**kwargs)
  1. See DeleteScheduledActionTypeRequestTypeDef

delete_tags

Deletes the specified tags.

Type annotations and code completion for boto3.client("autoscaling").delete_tags method. boto3 documentation

Method definition
def delete_tags(
    self,
    *,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteTagsTypeRequestTypeDef = {  # (1)
    "Tags": ...,
}

parent.delete_tags(**kwargs)
  1. See DeleteTagsTypeRequestTypeDef

delete_warm_pool

Deletes the warm pool for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").delete_warm_pool method. boto3 documentation

Method definition
def delete_warm_pool(
    self,
    *,
    AutoScalingGroupName: str,
    ForceDelete: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteWarmPoolTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.delete_warm_pool(**kwargs)
  1. See DeleteWarmPoolTypeRequestTypeDef

describe_account_limits

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

Type annotations and code completion for boto3.client("autoscaling").describe_account_limits method. boto3 documentation

Method definition
def describe_account_limits(
    self,
) -> DescribeAccountLimitsAnswerTypeDef:  # (1)
    ...
  1. See DescribeAccountLimitsAnswerTypeDef

describe_adjustment_types

Describes the available adjustment types for step scaling and simple scaling policies.

Type annotations and code completion for boto3.client("autoscaling").describe_adjustment_types method. boto3 documentation

Method definition
def describe_adjustment_types(
    self,
) -> DescribeAdjustmentTypesAnswerTypeDef:  # (1)
    ...
  1. See DescribeAdjustmentTypesAnswerTypeDef

describe_auto_scaling_groups

Gets information about the Auto Scaling groups in the account and Region.

Type annotations and code completion for boto3.client("autoscaling").describe_auto_scaling_groups method. boto3 documentation

Method definition
def describe_auto_scaling_groups(
    self,
    *,
    AutoScalingGroupNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxRecords: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> AutoScalingGroupsTypeTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See AutoScalingGroupsTypeTypeDef
Usage example with kwargs
kwargs: AutoScalingGroupNamesTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupNames": ...,
}

parent.describe_auto_scaling_groups(**kwargs)
  1. See AutoScalingGroupNamesTypeRequestTypeDef

describe_auto_scaling_instances

Gets information about the Auto Scaling instances in the account and Region.

Type annotations and code completion for boto3.client("autoscaling").describe_auto_scaling_instances method. boto3 documentation

Method definition
def describe_auto_scaling_instances(
    self,
    *,
    InstanceIds: Sequence[str] = ...,
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> AutoScalingInstancesTypeTypeDef:  # (1)
    ...
  1. See AutoScalingInstancesTypeTypeDef
Usage example with kwargs
kwargs: DescribeAutoScalingInstancesTypeRequestTypeDef = {  # (1)
    "InstanceIds": ...,
}

parent.describe_auto_scaling_instances(**kwargs)
  1. See DescribeAutoScalingInstancesTypeRequestTypeDef

describe_auto_scaling_notification_types

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

Type annotations and code completion for boto3.client("autoscaling").describe_auto_scaling_notification_types method. boto3 documentation

Method definition
def describe_auto_scaling_notification_types(
    self,
) -> DescribeAutoScalingNotificationTypesAnswerTypeDef:  # (1)
    ...
  1. See DescribeAutoScalingNotificationTypesAnswerTypeDef

describe_instance_refreshes

Gets information about the instance refreshes for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").describe_instance_refreshes method. boto3 documentation

Method definition
def describe_instance_refreshes(
    self,
    *,
    AutoScalingGroupName: str,
    InstanceRefreshIds: Sequence[str] = ...,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> DescribeInstanceRefreshesAnswerTypeDef:  # (1)
    ...
  1. See DescribeInstanceRefreshesAnswerTypeDef
Usage example with kwargs
kwargs: DescribeInstanceRefreshesTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_instance_refreshes(**kwargs)
  1. See DescribeInstanceRefreshesTypeRequestTypeDef

describe_launch_configurations

Gets information about the launch configurations in the account and Region.

Type annotations and code completion for boto3.client("autoscaling").describe_launch_configurations method. boto3 documentation

Method definition
def describe_launch_configurations(
    self,
    *,
    LaunchConfigurationNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> LaunchConfigurationsTypeTypeDef:  # (1)
    ...
  1. See LaunchConfigurationsTypeTypeDef
Usage example with kwargs
kwargs: LaunchConfigurationNamesTypeRequestTypeDef = {  # (1)
    "LaunchConfigurationNames": ...,
}

parent.describe_launch_configurations(**kwargs)
  1. See LaunchConfigurationNamesTypeRequestTypeDef

describe_lifecycle_hook_types

Describes the available types of lifecycle hooks.

Type annotations and code completion for boto3.client("autoscaling").describe_lifecycle_hook_types method. boto3 documentation

Method definition
def describe_lifecycle_hook_types(
    self,
) -> DescribeLifecycleHookTypesAnswerTypeDef:  # (1)
    ...
  1. See DescribeLifecycleHookTypesAnswerTypeDef

describe_lifecycle_hooks

Gets information about the lifecycle hooks for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").describe_lifecycle_hooks method. boto3 documentation

Method definition
def describe_lifecycle_hooks(
    self,
    *,
    AutoScalingGroupName: str,
    LifecycleHookNames: Sequence[str] = ...,
) -> DescribeLifecycleHooksAnswerTypeDef:  # (1)
    ...
  1. See DescribeLifecycleHooksAnswerTypeDef
Usage example with kwargs
kwargs: DescribeLifecycleHooksTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_lifecycle_hooks(**kwargs)
  1. See DescribeLifecycleHooksTypeRequestTypeDef

describe_load_balancer_target_groups

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").describe_load_balancer_target_groups method. boto3 documentation

Method definition
def describe_load_balancer_target_groups(
    self,
    *,
    AutoScalingGroupName: str,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> DescribeLoadBalancerTargetGroupsResponseTypeDef:  # (1)
    ...
  1. See DescribeLoadBalancerTargetGroupsResponseTypeDef
Usage example with kwargs
kwargs: DescribeLoadBalancerTargetGroupsRequestRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_load_balancer_target_groups(**kwargs)
  1. See DescribeLoadBalancerTargetGroupsRequestRequestTypeDef

describe_load_balancers

Gets information about the load balancers for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").describe_load_balancers method. boto3 documentation

Method definition
def describe_load_balancers(
    self,
    *,
    AutoScalingGroupName: str,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> DescribeLoadBalancersResponseTypeDef:  # (1)
    ...
  1. See DescribeLoadBalancersResponseTypeDef
Usage example with kwargs
kwargs: DescribeLoadBalancersRequestRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_load_balancers(**kwargs)
  1. See DescribeLoadBalancersRequestRequestTypeDef

describe_metric_collection_types

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

Type annotations and code completion for boto3.client("autoscaling").describe_metric_collection_types method. boto3 documentation

Method definition
def describe_metric_collection_types(
    self,
) -> DescribeMetricCollectionTypesAnswerTypeDef:  # (1)
    ...
  1. See DescribeMetricCollectionTypesAnswerTypeDef

describe_notification_configurations

Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.

Type annotations and code completion for boto3.client("autoscaling").describe_notification_configurations method. boto3 documentation

Method definition
def describe_notification_configurations(
    self,
    *,
    AutoScalingGroupNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> DescribeNotificationConfigurationsAnswerTypeDef:  # (1)
    ...
  1. See DescribeNotificationConfigurationsAnswerTypeDef
Usage example with kwargs
kwargs: DescribeNotificationConfigurationsTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupNames": ...,
}

parent.describe_notification_configurations(**kwargs)
  1. See DescribeNotificationConfigurationsTypeRequestTypeDef

describe_policies

Gets information about the scaling policies in the account and Region.

Type annotations and code completion for boto3.client("autoscaling").describe_policies method. boto3 documentation

Method definition
def describe_policies(
    self,
    *,
    AutoScalingGroupName: str = ...,
    PolicyNames: Sequence[str] = ...,
    PolicyTypes: Sequence[str] = ...,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> PoliciesTypeTypeDef:  # (1)
    ...
  1. See PoliciesTypeTypeDef
Usage example with kwargs
kwargs: DescribePoliciesTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_policies(**kwargs)
  1. See DescribePoliciesTypeRequestTypeDef

describe_scaling_activities

Gets information about the scaling activities in the account and Region.

Type annotations and code completion for boto3.client("autoscaling").describe_scaling_activities method. boto3 documentation

Method definition
def describe_scaling_activities(
    self,
    *,
    ActivityIds: Sequence[str] = ...,
    AutoScalingGroupName: str = ...,
    IncludeDeletedGroups: bool = ...,
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> ActivitiesTypeTypeDef:  # (1)
    ...
  1. See ActivitiesTypeTypeDef
Usage example with kwargs
kwargs: DescribeScalingActivitiesTypeRequestTypeDef = {  # (1)
    "ActivityIds": ...,
}

parent.describe_scaling_activities(**kwargs)
  1. See DescribeScalingActivitiesTypeRequestTypeDef

describe_scaling_process_types

Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.

Type annotations and code completion for boto3.client("autoscaling").describe_scaling_process_types method. boto3 documentation

Method definition
def describe_scaling_process_types(
    self,
) -> ProcessesTypeTypeDef:  # (1)
    ...
  1. See ProcessesTypeTypeDef

describe_scheduled_actions

Gets information about the scheduled actions that haven't run or that have not reached their end time.

Type annotations and code completion for boto3.client("autoscaling").describe_scheduled_actions method. boto3 documentation

Method definition
def describe_scheduled_actions(
    self,
    *,
    AutoScalingGroupName: str = ...,
    ScheduledActionNames: Sequence[str] = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> ScheduledActionsTypeTypeDef:  # (1)
    ...
  1. See ScheduledActionsTypeTypeDef
Usage example with kwargs
kwargs: DescribeScheduledActionsTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_scheduled_actions(**kwargs)
  1. See DescribeScheduledActionsTypeRequestTypeDef

describe_tags

Describes the specified tags.

Type annotations and code completion for boto3.client("autoscaling").describe_tags method. boto3 documentation

Method definition
def describe_tags(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> TagsTypeTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See TagsTypeTypeDef
Usage example with kwargs
kwargs: DescribeTagsTypeRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_tags(**kwargs)
  1. See DescribeTagsTypeRequestTypeDef

describe_termination_policy_types

Describes the termination policies supported by Amazon EC2 Auto Scaling.

Type annotations and code completion for boto3.client("autoscaling").describe_termination_policy_types method. boto3 documentation

Method definition
def describe_termination_policy_types(
    self,
) -> DescribeTerminationPolicyTypesAnswerTypeDef:  # (1)
    ...
  1. See DescribeTerminationPolicyTypesAnswerTypeDef

describe_warm_pool

Gets information about a warm pool and its instances.

Type annotations and code completion for boto3.client("autoscaling").describe_warm_pool method. boto3 documentation

Method definition
def describe_warm_pool(
    self,
    *,
    AutoScalingGroupName: str,
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeWarmPoolAnswerTypeDef:  # (1)
    ...
  1. See DescribeWarmPoolAnswerTypeDef
Usage example with kwargs
kwargs: DescribeWarmPoolTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_warm_pool(**kwargs)
  1. See DescribeWarmPoolTypeRequestTypeDef

detach_instances

Removes one or more instances from the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").detach_instances method. boto3 documentation

Method definition
def detach_instances(
    self,
    *,
    AutoScalingGroupName: str,
    ShouldDecrementDesiredCapacity: bool,
    InstanceIds: Sequence[str] = ...,
) -> DetachInstancesAnswerTypeDef:  # (1)
    ...
  1. See DetachInstancesAnswerTypeDef
Usage example with kwargs
kwargs: DetachInstancesQueryRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ShouldDecrementDesiredCapacity": ...,
}

parent.detach_instances(**kwargs)
  1. See DetachInstancesQueryRequestTypeDef

detach_load_balancer_target_groups

Detaches one or more target groups from the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").detach_load_balancer_target_groups method. boto3 documentation

Method definition
def detach_load_balancer_target_groups(
    self,
    *,
    AutoScalingGroupName: str,
    TargetGroupARNs: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DetachLoadBalancerTargetGroupsTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TargetGroupARNs": ...,
}

parent.detach_load_balancer_target_groups(**kwargs)
  1. See DetachLoadBalancerTargetGroupsTypeRequestTypeDef

detach_load_balancers

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").detach_load_balancers method. boto3 documentation

Method definition
def detach_load_balancers(
    self,
    *,
    AutoScalingGroupName: str,
    LoadBalancerNames: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DetachLoadBalancersTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "LoadBalancerNames": ...,
}

parent.detach_load_balancers(**kwargs)
  1. See DetachLoadBalancersTypeRequestTypeDef

disable_metrics_collection

Disables group metrics collection for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").disable_metrics_collection method. boto3 documentation

Method definition
def disable_metrics_collection(
    self,
    *,
    AutoScalingGroupName: str,
    Metrics: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DisableMetricsCollectionQueryRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.disable_metrics_collection(**kwargs)
  1. See DisableMetricsCollectionQueryRequestTypeDef

enable_metrics_collection

Enables group metrics collection for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").enable_metrics_collection method. boto3 documentation

Method definition
def enable_metrics_collection(
    self,
    *,
    AutoScalingGroupName: str,
    Granularity: str,
    Metrics: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: EnableMetricsCollectionQueryRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "Granularity": ...,
}

parent.enable_metrics_collection(**kwargs)
  1. See EnableMetricsCollectionQueryRequestTypeDef

enter_standby

Moves the specified instances into the standby state.

Type annotations and code completion for boto3.client("autoscaling").enter_standby method. boto3 documentation

Method definition
def enter_standby(
    self,
    *,
    AutoScalingGroupName: str,
    ShouldDecrementDesiredCapacity: bool,
    InstanceIds: Sequence[str] = ...,
) -> EnterStandbyAnswerTypeDef:  # (1)
    ...
  1. See EnterStandbyAnswerTypeDef
Usage example with kwargs
kwargs: EnterStandbyQueryRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ShouldDecrementDesiredCapacity": ...,
}

parent.enter_standby(**kwargs)
  1. See EnterStandbyQueryRequestTypeDef

execute_policy

Executes the specified policy.

Type annotations and code completion for boto3.client("autoscaling").execute_policy method. boto3 documentation

Method definition
def execute_policy(
    self,
    *,
    PolicyName: str,
    AutoScalingGroupName: str = ...,
    HonorCooldown: bool = ...,
    MetricValue: float = ...,
    BreachThreshold: float = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: ExecutePolicyTypeRequestTypeDef = {  # (1)
    "PolicyName": ...,
}

parent.execute_policy(**kwargs)
  1. See ExecutePolicyTypeRequestTypeDef

exit_standby

Moves the specified instances out of the standby state.

Type annotations and code completion for boto3.client("autoscaling").exit_standby method. boto3 documentation

Method definition
def exit_standby(
    self,
    *,
    AutoScalingGroupName: str,
    InstanceIds: Sequence[str] = ...,
) -> ExitStandbyAnswerTypeDef:  # (1)
    ...
  1. See ExitStandbyAnswerTypeDef
Usage example with kwargs
kwargs: ExitStandbyQueryRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.exit_standby(**kwargs)
  1. See ExitStandbyQueryRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("autoscaling").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_predictive_scaling_forecast

Retrieves the forecast data for a predictive scaling policy.

Type annotations and code completion for boto3.client("autoscaling").get_predictive_scaling_forecast method. boto3 documentation

Method definition
def get_predictive_scaling_forecast(
    self,
    *,
    AutoScalingGroupName: str,
    PolicyName: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
) -> GetPredictiveScalingForecastAnswerTypeDef:  # (1)
    ...
  1. See GetPredictiveScalingForecastAnswerTypeDef
Usage example with kwargs
kwargs: GetPredictiveScalingForecastTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "PolicyName": ...,
    "StartTime": ...,
    "EndTime": ...,
}

parent.get_predictive_scaling_forecast(**kwargs)
  1. See GetPredictiveScalingForecastTypeRequestTypeDef

put_lifecycle_hook

Creates or updates a lifecycle hook for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").put_lifecycle_hook method. boto3 documentation

Method definition
def put_lifecycle_hook(
    self,
    *,
    LifecycleHookName: str,
    AutoScalingGroupName: str,
    LifecycleTransition: str = ...,
    RoleARN: str = ...,
    NotificationTargetARN: str = ...,
    NotificationMetadata: str = ...,
    HeartbeatTimeout: int = ...,
    DefaultResult: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: PutLifecycleHookTypeRequestTypeDef = {  # (1)
    "LifecycleHookName": ...,
    "AutoScalingGroupName": ...,
}

parent.put_lifecycle_hook(**kwargs)
  1. See PutLifecycleHookTypeRequestTypeDef

put_notification_configuration

Configures an Auto Scaling group to send notifications when specified events take place.

Type annotations and code completion for boto3.client("autoscaling").put_notification_configuration method. boto3 documentation

Method definition
def put_notification_configuration(
    self,
    *,
    AutoScalingGroupName: str,
    TopicARN: str,
    NotificationTypes: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: PutNotificationConfigurationTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TopicARN": ...,
    "NotificationTypes": ...,
}

parent.put_notification_configuration(**kwargs)
  1. See PutNotificationConfigurationTypeRequestTypeDef

put_scaling_policy

Creates or updates a scaling policy for an Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").put_scaling_policy method. boto3 documentation

Method definition
def put_scaling_policy(
    self,
    *,
    AutoScalingGroupName: str,
    PolicyName: str,
    PolicyType: str = ...,
    AdjustmentType: str = ...,
    MinAdjustmentStep: int = ...,
    MinAdjustmentMagnitude: int = ...,
    ScalingAdjustment: int = ...,
    Cooldown: int = ...,
    MetricAggregationType: str = ...,
    StepAdjustments: Sequence[StepAdjustmentTypeDef] = ...,  # (1)
    EstimatedInstanceWarmup: int = ...,
    TargetTrackingConfiguration: TargetTrackingConfigurationTypeDef = ...,  # (2)
    Enabled: bool = ...,
    PredictiveScalingConfiguration: PredictiveScalingConfigurationTypeDef = ...,  # (3)
) -> PolicyARNTypeTypeDef:  # (4)
    ...
  1. See StepAdjustmentTypeDef
  2. See TargetTrackingConfigurationTypeDef
  3. See PredictiveScalingConfigurationTypeDef
  4. See PolicyARNTypeTypeDef
Usage example with kwargs
kwargs: PutScalingPolicyTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "PolicyName": ...,
}

parent.put_scaling_policy(**kwargs)
  1. See PutScalingPolicyTypeRequestTypeDef

put_scheduled_update_group_action

Creates or updates a scheduled scaling action for an Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").put_scheduled_update_group_action method. boto3 documentation

Method definition
def put_scheduled_update_group_action(
    self,
    *,
    AutoScalingGroupName: str,
    ScheduledActionName: str,
    Time: Union[datetime, str] = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Recurrence: str = ...,
    MinSize: int = ...,
    MaxSize: int = ...,
    DesiredCapacity: int = ...,
    TimeZone: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: PutScheduledUpdateGroupActionTypeRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledActionName": ...,
}

parent.put_scheduled_update_group_action(**kwargs)
  1. See PutScheduledUpdateGroupActionTypeRequestTypeDef

put_warm_pool

Creates or updates a warm pool for the specified Auto Scaling group.

Type annotations and code completion for boto3.client("autoscaling").put_warm_pool method.