ApplicationAutoScalingClient

Index > ApplicationAutoScaling > ApplicationAutoScalingClient

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

ApplicationAutoScalingClient

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

# ApplicationAutoScalingClient usage example

from boto3.session import Session
from mypy_boto3_application_autoscaling.client import ApplicationAutoScalingClient

def get_application-autoscaling_client() -> ApplicationAutoScalingClient:
    return Session().client("application-autoscaling")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("application-autoscaling")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConcurrentUpdateException,
    client.exceptions.FailedResourceAccessException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.LimitExceededException,
    client.exceptions.ObjectNotFoundException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_application_autoscaling.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

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

delete_scaling_policy

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

Type annotations and code completion for boto3.client("application-autoscaling").delete_scaling_policy method. boto3 documentation

# delete_scaling_policy method definition

def delete_scaling_policy(
    self,
    *,
    PolicyName: str,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
) -> dict[str, Any]:
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType

# delete_scaling_policy method usage example with argument unpacking

kwargs: DeleteScalingPolicyRequestRequestTypeDef = {  # (1)
    "PolicyName": ...,
    "ServiceNamespace": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
}

parent.delete_scaling_policy(**kwargs)

1. See DeleteScalingPolicyRequestRequestTypeDef

delete_scheduled_action

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

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

# delete_scheduled_action method definition

def delete_scheduled_action(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ScheduledActionName: str,
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
) -> dict[str, Any]:
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType

# delete_scheduled_action method usage example with argument unpacking

kwargs: DeleteScheduledActionRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
    "ScheduledActionName": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
}

parent.delete_scheduled_action(**kwargs)

1. See DeleteScheduledActionRequestRequestTypeDef

deregister_scalable_target

Deregisters an Application Auto Scaling scalable target when you have finished using it.

Type annotations and code completion for boto3.client("application-autoscaling").deregister_scalable_target method. boto3 documentation

# deregister_scalable_target method definition

def deregister_scalable_target(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
) -> dict[str, Any]:
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType

# deregister_scalable_target method usage example with argument unpacking

kwargs: DeregisterScalableTargetRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
}

parent.deregister_scalable_target(**kwargs)

1. See DeregisterScalableTargetRequestRequestTypeDef

describe_scalable_targets

Gets information about the scalable targets in the specified namespace.

Type annotations and code completion for boto3.client("application-autoscaling").describe_scalable_targets method. boto3 documentation

# describe_scalable_targets method definition

def describe_scalable_targets(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceIds: Sequence[str] = ...,
    ScalableDimension: ScalableDimensionType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScalableTargetsResponseTypeDef:  # (3)
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See DescribeScalableTargetsResponseTypeDef

# describe_scalable_targets method usage example with argument unpacking

kwargs: DescribeScalableTargetsRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
}

parent.describe_scalable_targets(**kwargs)

1. See DescribeScalableTargetsRequestRequestTypeDef

describe_scaling_activities

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

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

# describe_scaling_activities method definition

def describe_scaling_activities(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str = ...,
    ScalableDimension: ScalableDimensionType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
    IncludeNotScaledActivities: bool = ...,
) -> DescribeScalingActivitiesResponseTypeDef:  # (3)
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See DescribeScalingActivitiesResponseTypeDef

# describe_scaling_activities method usage example with argument unpacking

kwargs: DescribeScalingActivitiesRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
}

parent.describe_scaling_activities(**kwargs)

1. See DescribeScalingActivitiesRequestRequestTypeDef

describe_scaling_policies

Describes the Application Auto Scaling scaling policies for the specified service namespace.

Type annotations and code completion for boto3.client("application-autoscaling").describe_scaling_policies method. boto3 documentation

# describe_scaling_policies method definition

def describe_scaling_policies(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    PolicyNames: Sequence[str] = ...,
    ResourceId: str = ...,
    ScalableDimension: ScalableDimensionType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScalingPoliciesResponseTypeDef:  # (3)
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See DescribeScalingPoliciesResponseTypeDef

# describe_scaling_policies method usage example with argument unpacking

kwargs: DescribeScalingPoliciesRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
}

parent.describe_scaling_policies(**kwargs)

1. See DescribeScalingPoliciesRequestRequestTypeDef

describe_scheduled_actions

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

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

# describe_scheduled_actions method definition

def describe_scheduled_actions(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ScheduledActionNames: Sequence[str] = ...,
    ResourceId: str = ...,
    ScalableDimension: ScalableDimensionType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScheduledActionsResponseTypeDef:  # (3)
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See DescribeScheduledActionsResponseTypeDef

# describe_scheduled_actions method usage example with argument unpacking

kwargs: DescribeScheduledActionsRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
}

parent.describe_scheduled_actions(**kwargs)

1. See DescribeScheduledActionsRequestRequestTypeDef

get_predictive_scaling_forecast

Retrieves the forecast data for a predictive scaling policy.

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

# get_predictive_scaling_forecast method definition

def get_predictive_scaling_forecast(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    PolicyName: str,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
) -> GetPredictiveScalingForecastResponseTypeDef:  # (3)
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See GetPredictiveScalingForecastResponseTypeDef

# get_predictive_scaling_forecast method usage example with argument unpacking

kwargs: GetPredictiveScalingForecastRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
    "PolicyName": ...,
    "StartTime": ...,
    "EndTime": ...,
}

parent.get_predictive_scaling_forecast(**kwargs)

1. See GetPredictiveScalingForecastRequestRequestTypeDef

list_tags_for_resource

Returns all the tags on the specified Application Auto Scaling scalable target.

Type annotations and code completion for boto3.client("application-autoscaling").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_scaling_policy

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

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

# put_scaling_policy method definition

def put_scaling_policy(
    self,
    *,
    PolicyName: str,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    PolicyType: PolicyTypeType = ...,  # (3)
    StepScalingPolicyConfiguration: StepScalingPolicyConfigurationTypeDef = ...,  # (4)
    TargetTrackingScalingPolicyConfiguration: TargetTrackingScalingPolicyConfigurationTypeDef = ...,  # (5)
    PredictiveScalingPolicyConfiguration: PredictiveScalingPolicyConfigurationTypeDef = ...,  # (6)
) -> PutScalingPolicyResponseTypeDef:  # (7)
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See PolicyTypeType
4. See StepScalingPolicyConfigurationTypeDef
5. See TargetTrackingScalingPolicyConfigurationTypeDef
6. See PredictiveScalingPolicyConfigurationTypeDef
7. See PutScalingPolicyResponseTypeDef

# put_scaling_policy method usage example with argument unpacking

kwargs: PutScalingPolicyRequestRequestTypeDef = {  # (1)
    "PolicyName": ...,
    "ServiceNamespace": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
}

parent.put_scaling_policy(**kwargs)

1. See PutScalingPolicyRequestRequestTypeDef

put_scheduled_action

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

Type annotations and code completion for boto3.client("application-autoscaling").put_scheduled_action method. boto3 documentation

# put_scheduled_action method definition

def put_scheduled_action(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ScheduledActionName: str,
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    Schedule: str = ...,
    Timezone: str = ...,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    ScalableTargetAction: ScalableTargetActionTypeDef = ...,  # (3)
) -> dict[str, Any]:
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See ScalableTargetActionTypeDef

# put_scheduled_action method usage example with argument unpacking

kwargs: PutScheduledActionRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
    "ScheduledActionName": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
}

parent.put_scheduled_action(**kwargs)

1. See PutScheduledActionRequestRequestTypeDef

register_scalable_target

Registers or updates a scalable target, which is the resource that you want to scale.

Type annotations and code completion for boto3.client("application-autoscaling").register_scalable_target method. boto3 documentation

# register_scalable_target method definition

def register_scalable_target(
    self,
    *,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    MinCapacity: int = ...,
    MaxCapacity: int = ...,
    RoleARN: str = ...,
    SuspendedState: SuspendedStateTypeDef = ...,  # (3)
    Tags: Mapping[str, str] = ...,
) -> RegisterScalableTargetResponseTypeDef:  # (4)
    ...

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See SuspendedStateTypeDef
4. See RegisterScalableTargetResponseTypeDef

# register_scalable_target method usage example with argument unpacking

kwargs: RegisterScalableTargetRequestRequestTypeDef = {  # (1)
    "ServiceNamespace": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
}

parent.register_scalable_target(**kwargs)

1. See RegisterScalableTargetRequestRequestTypeDef

tag_resource

Adds or edits tags on an Application Auto Scaling scalable target.

Type annotations and code completion for boto3.client("application-autoscaling").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Deletes tags from an Application Auto Scaling scalable target.

Type annotations and code completion for boto3.client("application-autoscaling").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("application-autoscaling").get_paginator method with overloads.

• client.get_paginator("describe_scalable_targets") -> DescribeScalableTargetsPaginator
• client.get_paginator("describe_scaling_activities") -> DescribeScalingActivitiesPaginator
• client.get_paginator("describe_scaling_policies") -> DescribeScalingPoliciesPaginator
• client.get_paginator("describe_scheduled_actions") -> DescribeScheduledActionsPaginator