Skip to content

GlobalAccelerator module#

Index > GlobalAccelerator

Auto-generated documentation for GlobalAccelerator type annotations stubs module mypy-boto3-globalaccelerator.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and GlobalAccelerator.

From PyPI with pip#

Install boto3-stubs for GlobalAccelerator service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[globalaccelerator]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[globalaccelerator]'


# standalone installation
python -m pip install mypy-boto3-globalaccelerator

How to uninstall#

python -m pip uninstall -y mypy-boto3-globalaccelerator

Usage#

Code samples can be found in Examples.

GlobalAcceleratorClient#

Type annotations and code completion for boto3.client("globalaccelerator") as GlobalAcceleratorClient boto3 documentation

# GlobalAcceleratorClient usage example

from boto3.session import Session

from mypy_boto3_globalaccelerator.client import GlobalAcceleratorClient

def get_client() -> GlobalAcceleratorClient:
    return Session().client("globalaccelerator")

Paginators#

Type annotations and code completion for paginators from boto3.client("globalaccelerator").get_paginator("...").

# ListAcceleratorsPaginator usage example

from boto3.session import Session

from mypy_boto3_globalaccelerator.paginator import ListAcceleratorsPaginator

def get_list_accelerators_paginator() -> ListAcceleratorsPaginator:
    return Session().client("globalaccelerator").get_paginator("list_accelerators"))

Literals#

Type annotations for literals used in methods and schemas.

# AcceleratorStatusType usage example

from mypy_boto3_globalaccelerator.literals import AcceleratorStatusType

def get_value() -> AcceleratorStatusType:
    return "DEPLOYED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcceleratorAttributesTypeDef usage example

from mypy_boto3_globalaccelerator.type_defs import AcceleratorAttributesTypeDef

def get_value() -> AcceleratorAttributesTypeDef:
    return {
        "FlowLogsEnabled": ...,
    }