AutoScalingPlansClient

Index > AutoScalingPlans > AutoScalingPlansClient

Auto-generated documentation for AutoScalingPlans type annotations stubs module types-aiobotocore-autoscaling-plans.

AutoScalingPlansClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_autoscaling_plans.client import AutoScalingPlansClient

session = Session()
async with session.client("autoscaling-plans") as client:
    client: AutoScalingPlansClient

Exceptions

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

Usage example

async with session.client("autoscaling-plans") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.ConcurrentUpdateException,
        client.InternalServiceException,
        client.InvalidNextTokenException,
        client.LimitExceededException,
        client.ObjectNotFoundException,
        client.ValidationException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("autoscaling-plans").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 session.client("autoscaling-plans").close method. boto3 documentation

Method definition

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

create_scaling_plan

Creates a scaling plan.

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

Method definition

await def create_scaling_plan(
    self,
    *,
    ScalingPlanName: str,
    ApplicationSource: ApplicationSourceTypeDef,  # (1)
    ScalingInstructions: Sequence[ScalingInstructionTypeDef],  # (2)
) -> CreateScalingPlanResponseTypeDef:  # (3)
    ...

1. See ApplicationSourceTypeDef
2. See ScalingInstructionTypeDef
3. See CreateScalingPlanResponseTypeDef

Usage example with kwargs

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 session.client("autoscaling-plans").delete_scaling_plan method. boto3 documentation

Method definition

await def delete_scaling_plan(
    self,
    *,
    ScalingPlanName: str,
    ScalingPlanVersion: int,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("autoscaling-plans").describe_scaling_plan_resources method. boto3 documentation

Method definition

await def describe_scaling_plan_resources(
    self,
    *,
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScalingPlanResourcesResponseTypeDef:  # (1)
    ...

1. See DescribeScalingPlanResourcesResponseTypeDef

Usage example with kwargs

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 session.client("autoscaling-plans").describe_scaling_plans method. boto3 documentation

Method definition

await def describe_scaling_plans(
    self,
    *,
    ScalingPlanNames: Sequence[str] = ...,
    ScalingPlanVersion: int = ...,
    ApplicationSources: Sequence[ApplicationSourceTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScalingPlansResponseTypeDef:  # (2)
    ...

1. See ApplicationSourceTypeDef
2. See DescribeScalingPlansResponseTypeDef

Usage example with kwargs

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 session.client("autoscaling-plans").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("autoscaling-plans").get_scaling_plan_resource_forecast_data method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("autoscaling-plans").update_scaling_plan method. boto3 documentation

Method definition

await def update_scaling_plan(
    self,
    *,
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ApplicationSource: ApplicationSourceTypeDef = ...,  # (1)
    ScalingInstructions: Sequence[ScalingInstructionTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See ApplicationSourceTypeDef
2. See ScalingInstructionTypeDef

Usage example with kwargs

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

parent.update_scaling_plan(**kwargs)

1. See UpdateScalingPlanRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> AutoScalingPlansClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

• client.get_paginator("describe_scaling_plan_resources") -> DescribeScalingPlanResourcesPaginator
• client.get_paginator("describe_scaling_plans") -> DescribeScalingPlansPaginator