Skip to content

AutoScalingPlansClient#

Index > AutoScalingPlans > AutoScalingPlansClient

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

AutoScalingPlansClient#

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

# AutoScalingPlansClient usage example

from boto3.session import Session
from mypy_boto3_autoscaling_plans.client import AutoScalingPlansClient

def get_autoscaling-plans_client() -> AutoScalingPlansClient:
    return Session().client("autoscaling-plans")

Exceptions#

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

# Exceptions.exceptions usage example

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

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConcurrentUpdateException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.LimitExceededException,
    client.exceptions.ObjectNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_autoscaling_plans.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("autoscaling-plans").can_paginate method. boto3 documentation

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_scaling_plan#

Creates a scaling plan.

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

# create_scaling_plan method definition

def create_scaling_plan(
    self,
    *,
    ScalingPlanName: str,
    ApplicationSource: Union[ApplicationSourceTypeDef, ApplicationSourceExtraOutputTypeDef],  # (1)
    ScalingInstructions: Sequence[Union[ScalingInstructionTypeDef, ScalingInstructionExtraOutputTypeDef]],  # (2)
) -> CreateScalingPlanResponseTypeDef:  # (3)
    ...
  1. See ApplicationSourceTypeDef ApplicationSourceExtraOutputTypeDef
  2. See ScalingInstructionTypeDef ScalingInstructionExtraOutputTypeDef
  3. See CreateScalingPlanResponseTypeDef 
# create_scaling_plan method usage example with argument unpacking

kwargs: CreateScalingPlanRequestRequestTypeDef = {  # (1)
    "ScalingPlanName": ...,
    "ApplicationSource": ...,
    "ScalingInstructions": ...,
}

parent.create_scaling_plan(**kwargs)
  1. See CreateScalingPlanRequestRequestTypeDef

delete_scaling_plan#

Deletes the specified scaling plan.

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

# delete_scaling_plan method definition

def delete_scaling_plan(
    self,
    *,
    ScalingPlanName: str,
    ScalingPlanVersion: int,
) -> Dict[str, Any]:
    ...
# delete_scaling_plan method usage example with argument unpacking

kwargs: DeleteScalingPlanRequestRequestTypeDef = {  # (1)
    "ScalingPlanName": ...,
    "ScalingPlanVersion": ...,
}

parent.delete_scaling_plan(**kwargs)
  1. See DeleteScalingPlanRequestRequestTypeDef

describe_scaling_plan_resources#

Describes the scalable resources in the specified scaling plan.

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

# describe_scaling_plan_resources method definition

def describe_scaling_plan_resources(
    self,
    *,
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScalingPlanResourcesResponseTypeDef:  # (1)
    ...
  1. See DescribeScalingPlanResourcesResponseTypeDef 
# describe_scaling_plan_resources method usage example with argument unpacking

kwargs: DescribeScalingPlanResourcesRequestRequestTypeDef = {  # (1)
    "ScalingPlanName": ...,
    "ScalingPlanVersion": ...,
}

parent.describe_scaling_plan_resources(**kwargs)
  1. See DescribeScalingPlanResourcesRequestRequestTypeDef

describe_scaling_plans#

Describes one or more of your scaling plans.

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

# describe_scaling_plans method definition

def describe_scaling_plans(
    self,
    *,
    ScalingPlanNames: Sequence[str] = ...,
    ScalingPlanVersion: int = ...,
    ApplicationSources: Sequence[Union[ApplicationSourceTypeDef, ApplicationSourceExtraOutputTypeDef]] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScalingPlansResponseTypeDef:  # (2)
    ...
  1. See ApplicationSourceTypeDef ApplicationSourceExtraOutputTypeDef
  2. See DescribeScalingPlansResponseTypeDef 
# describe_scaling_plans method usage example with argument unpacking

kwargs: DescribeScalingPlansRequestRequestTypeDef = {  # (1)
    "ScalingPlanNames": ...,
}

parent.describe_scaling_plans(**kwargs)
  1. See DescribeScalingPlansRequestRequestTypeDef

generate_presigned_url#

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

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

get_scaling_plan_resource_forecast_data#

Retrieves the forecast data for a scalable resource.

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

# get_scaling_plan_resource_forecast_data method definition

def get_scaling_plan_resource_forecast_data(
    self,
    *,
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    ForecastDataType: ForecastDataTypeType,  # (3)
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
) -> GetScalingPlanResourceForecastDataResponseTypeDef:  # (4)
    ...
  1. See ServiceNamespaceType
  2. See ScalableDimensionType
  3. See ForecastDataTypeType
  4. See GetScalingPlanResourceForecastDataResponseTypeDef 
# get_scaling_plan_resource_forecast_data method usage example with argument unpacking

kwargs: GetScalingPlanResourceForecastDataRequestRequestTypeDef = {  # (1)
    "ScalingPlanName": ...,
    "ScalingPlanVersion": ...,
    "ServiceNamespace": ...,
    "ResourceId": ...,
    "ScalableDimension": ...,
    "ForecastDataType": ...,
    "StartTime": ...,
    "EndTime": ...,
}

parent.get_scaling_plan_resource_forecast_data(**kwargs)
  1. See GetScalingPlanResourceForecastDataRequestRequestTypeDef

update_scaling_plan#

Updates the specified scaling plan.

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

# update_scaling_plan method definition

def update_scaling_plan(
    self,
    *,
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ApplicationSource: Union[ApplicationSourceTypeDef, ApplicationSourceExtraOutputTypeDef] = ...,  # (1)
    ScalingInstructions: Sequence[Union[ScalingInstructionTypeDef, ScalingInstructionExtraOutputTypeDef]] = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See ApplicationSourceTypeDef ApplicationSourceExtraOutputTypeDef
  2. See ScalingInstructionTypeDef ScalingInstructionExtraOutputTypeDef 
# update_scaling_plan method usage example with argument unpacking

kwargs: UpdateScalingPlanRequestRequestTypeDef = {  # (1)
    "ScalingPlanName": ...,
    "ScalingPlanVersion": ...,
}

parent.update_scaling_plan(**kwargs)
  1. See UpdateScalingPlanRequestRequestTypeDef

get_paginator#

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