FreeTierClient

Index > FreeTier > FreeTierClient

Auto-generated documentation for FreeTier type annotations stubs module types-boto3-freetier.

FreeTierClient

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

# FreeTierClient usage example

from boto3.session import Session
from types_boto3_freetier.client import FreeTierClient

def get_freetier_client() -> FreeTierClient:
    return Session().client("freetier")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("freetier")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_freetier.client import Exceptions

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

Methods

can_paginate

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

Returns a specific activity record that is available to the customer.

Type annotations and code completion for boto3.client("freetier").get_account_activity method. boto3 documentation

# get_account_activity method definition

def get_account_activity(
    self,
    *,
    activityId: str,
    languageCode: LanguageCodeType = ...,  # (1)
) -> GetAccountActivityResponseTypeDef:  # (2)
    ...

1. See LanguageCodeType
2. See GetAccountActivityResponseTypeDef

# get_account_activity method usage example with argument unpacking

kwargs: GetAccountActivityRequestTypeDef = {  # (1)
    "activityId": ...,
}

parent.get_account_activity(**kwargs)

1. See GetAccountActivityRequestTypeDef

get_account_plan_state

This returns all of the information related to the state of the account plan related to Free Tier.

Type annotations and code completion for boto3.client("freetier").get_account_plan_state method. boto3 documentation

# get_account_plan_state method definition

def get_account_plan_state(
    self,
) -> GetAccountPlanStateResponseTypeDef:  # (1)
    ...

1. See GetAccountPlanStateResponseTypeDef

get_free_tier_usage

Returns a list of all Free Tier usage objects that match your filters.

Type annotations and code completion for boto3.client("freetier").get_free_tier_usage method. boto3 documentation

# get_free_tier_usage method definition

def get_free_tier_usage(
    self,
    *,
    filter: ExpressionTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetFreeTierUsageResponseTypeDef:  # (2)
    ...

1. See ExpressionTypeDef
2. See GetFreeTierUsageResponseTypeDef

# get_free_tier_usage method usage example with argument unpacking

kwargs: GetFreeTierUsageRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.get_free_tier_usage(**kwargs)

1. See GetFreeTierUsageRequestTypeDef

list_account_activities

Returns a list of activities that are available.

Type annotations and code completion for boto3.client("freetier").list_account_activities method. boto3 documentation

# list_account_activities method definition

def list_account_activities(
    self,
    *,
    filterActivityStatuses: Sequence[ActivityStatusType] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    languageCode: LanguageCodeType = ...,  # (2)
) -> ListAccountActivitiesResponseTypeDef:  # (3)
    ...

1. See Sequence[ActivityStatusType]
2. See LanguageCodeType
3. See ListAccountActivitiesResponseTypeDef

# list_account_activities method usage example with argument unpacking

kwargs: ListAccountActivitiesRequestTypeDef = {  # (1)
    "filterActivityStatuses": ...,
}

parent.list_account_activities(**kwargs)

1. See ListAccountActivitiesRequestTypeDef

upgrade_account_plan

The account plan type for the Amazon Web Services account.

Type annotations and code completion for boto3.client("freetier").upgrade_account_plan method. boto3 documentation

# upgrade_account_plan method definition

def upgrade_account_plan(
    self,
    *,
    accountPlanType: AccountPlanTypeType,  # (1)
) -> UpgradeAccountPlanResponseTypeDef:  # (2)
    ...

1. See AccountPlanTypeType
2. See UpgradeAccountPlanResponseTypeDef

# upgrade_account_plan method usage example with argument unpacking

kwargs: UpgradeAccountPlanRequestTypeDef = {  # (1)
    "accountPlanType": ...,
}

parent.upgrade_account_plan(**kwargs)

1. See UpgradeAccountPlanRequestTypeDef

get_paginator

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

• client.get_paginator("get_free_tier_usage") -> GetFreeTierUsagePaginator
• client.get_paginator("list_account_activities") -> ListAccountActivitiesPaginator