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

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.

Usage example

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

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

Type checking example

from mypy_boto3_application_autoscaling.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

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

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

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

1. See ServiceNamespaceType
2. See ScalableDimensionType

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.describe_scheduled_actions(**kwargs)

1. See DescribeScheduledActionsRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("application-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:
    ...

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

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)
) -> PutScalingPolicyResponseTypeDef:  # (6)
    ...

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

Usage example with kwargs

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

Method definition

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

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

Usage example with kwargs

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

parent.put_scheduled_action(**kwargs)

1. See PutScheduledActionRequestRequestTypeDef

register_scalable_target

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

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

Method definition

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

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

Usage example with kwargs

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

parent.register_scalable_target(**kwargs)

1. See RegisterScalableTargetRequestRequestTypeDef

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