Skip to main content

Python SDK for Apigatewayv2.

Project description

Getting Started

Installation

pip install aws-sdk-apigatewayv2

Usage

from aws_sdk_apigatewayv2 import AsyncApiGatewayV2Client


async def main():
    async with AsyncApiGatewayV2Client() as s3:
        # Example: call the create_api operation
        response = await s3.create_api()
        print(response["api_endpoint"])

Pagination

Some operations in this SDK support pagination. If the operation supports pagination it will have an iter_ prefixed method that returns an async iterator.

from aws_sdk_apigatewayv2 import AsyncApiGatewayV2Client


async def main():
    async with AsyncApiGatewayV2Client() as s3:
        # Example: paginate over list_routing_rules
        async for item in s3.iter_list_routing_rules():
            print(item)

Error Handling

The SDK raises exceptions for errors returned by the API. Catch them to handle failures gracefully.

from aws_sdk_apigatewayv2 import AsyncApiGatewayV2Client
from aws_sdk_apigatewayv2.error import BadRequestException


async def main():
    async with AsyncApiGatewayV2Client() as s3:
        try:
            await s3.create_api()
        except BadRequestException as e:
            print(f"Error: {e}")
            print(e.data)  # additional error data

Retrying

The SDK retries failed operations automatically. Retry behaviour follows the Smithy specification: errors are retried based on their is_retryable and is_throttling_error attributes. Throttling errors use a longer base delay. Network-level failures (connection errors and timeouts) are also retried. Non-retryable errors, such as client errors without the @retryable trait, are raised immediately without further attempts.

The number of attempts defaults to 3 and can be changed at the client level via retry_max_attempts, or per call via config_overrides.

from aws_sdk_apigatewayv2 import AsyncApiGatewayV2Client


async def main():
    async with AsyncApiGatewayV2Client() as s3:
        # Default: 3 attempts for every operation
        response = await s3.create_api()

        # Override per operation
        response = await s3.create_api(config_overrides={"retry_max_attempts": 5})

        # Disable retries for this call
        response = await s3.create_api(config_overrides={"retry_max_attempts": 1})

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws_sdk_apigatewayv2-0.1.0.tar.gz (210.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aws_sdk_apigatewayv2-0.1.0-py3-none-any.whl (565.3 kB view details)

Uploaded Python 3

File details

Details for the file aws_sdk_apigatewayv2-0.1.0.tar.gz.

File metadata

  • Download URL: aws_sdk_apigatewayv2-0.1.0.tar.gz
  • Upload date:
  • Size: 210.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for aws_sdk_apigatewayv2-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ac5b6358f8f62472cc11f80ffbc40ca93e77ad0b3c67a36f0425a0deedc8f040
MD5 71b1de59fe6d8a86d2d96d07adad844c
BLAKE2b-256 4e69a4eedd02f00e54ea4dbc666b021c52eb4e3c04abfbde26559d87149dbe7c

See more details on using hashes here.

File details

Details for the file aws_sdk_apigatewayv2-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: aws_sdk_apigatewayv2-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 565.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for aws_sdk_apigatewayv2-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ce64ca532811c6347f674d848e8243f86fbc2f95cac4064fd16006a6b8beee7
MD5 6a4542a0f722753c194ab5458608ed23
BLAKE2b-256 0761aa3ab8205f782223dc39c0684de7197cefefdcfd965382509b6087e02154

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page