powertools-lambda-python API reference

84 public APIs from powertools-lambda-python (aws-powertools/powertools-lambda-python) — 49 classes, 8 functions, 27 methods. Signatures extracted by static analysis of the actual source.

Repository: aws-powertools/powertools-lambda-python

Kind	Count
Classes	49
Functions	8
Methods	27

API list

classaws_lambda_powertools.event_handler.api_gateway.BaseRouter

Base class for Routing

classaws_lambda_powertools.event_handler.api_gateway.ResponseBuilder

Internally used Response builder

classaws_lambda_powertools.event_handler.api_gateway.Route

Internally used Route Configuration

classaws_lambda_powertools.event_handler.bedrock_agent.BedrockResponseBuilder

Bedrock Response Builder.

classaws_lambda_powertools.event_handler.exceptions.BadRequestError

Powertools class Bad Request Error (400)

classaws_lambda_powertools.event_handler.exceptions.ForbiddenError

Powertools class Forbidden Error (403)

classaws_lambda_powertools.event_handler.exceptions.NotFoundError

Powertools class Not Found Error (404)

classaws_lambda_powertools.event_handler.exceptions.ServiceError

Powertools class HTTP Service Error

classaws_lambda_powertools.event_handler.exceptions.UnauthorizedError

Powertools class Unauthorized Error (401)

classaws_lambda_powertools.event_handler.http_resolver.HttpResolverLocal

ASGI-compatible HTTP resolver.

classaws_lambda_powertools.event_handler.http_resolver.MockLambdaContext

Minimal Lambda context for HTTP adapter.

funcaws_lambda_powertools.event_handler.openapi.encoders.iso_format(o:datetime.date | datetime.time) -> str

ISO format for date and time

classaws_lambda_powertools.event_handler.openapi.exceptions.SerializationError

Base exception for all encoding errors

classaws_lambda_powertools.event_handler.openapi.swagger_ui.oauth2.OAuth2Config

OAuth2 configuration for Swagger UI

classaws_lambda_powertools.event_handler.openapi.types.OpenAPIResponseHeader

OpenAPI Response Header Object

classaws_lambda_powertools.event_handler.request.Request

Represents the resolved HTTP request.

methodaws_lambda_powertools.event_handler.request.Request.method() -> str

HTTP method in upper-case, e.g.

classaws_lambda_powertools.exceptions.InvalidEnvelopeExpressionError

When JMESPath fails to parse expression

classaws_lambda_powertools.logging.buffer.config.LoggerBufferConfig

Configuration for log buffering behavior.

methodaws_lambda_powertools.logging.buffer.config.LoggerBufferConfig.buffer_at_verbosity() -> str

Minimum log level to buffer.

methodaws_lambda_powertools.logging.buffer.config.LoggerBufferConfig.flush_on_error_log() -> bool

Flag to flush buffer on error.

methodaws_lambda_powertools.logging.buffer.config.LoggerBufferConfig.max_bytes() -> int

Maximum buffer size in bytes.

classaws_lambda_powertools.logging.exceptions.OrphanedChildLoggerError

Orphaned Child logger exception

methodaws_lambda_powertools.logging.logger.Logger.clear_buffer() -> None

Clear the internal buffer cache.

method

aws_lambda_powertools.logging.logger.Logger.structure_logs(append:bool=False, formatter_options:dict | None=None, **keys) -> None

Sets logging formatting to JSON.

classaws_lambda_powertools.metrics.exceptions.MetricValueError

When metric value isn't a valid number

classaws_lambda_powertools.metrics.exceptions.SchemaValidationError

When serialization fail schema validation

funcaws_lambda_powertools.metrics.functions.convert_timestamp_to_emf_format(timestamp:int | datetime) -> int

Converts a timestamp to EMF compatible format.

classaws_lambda_powertools.metrics.provider.base.BaseProvider

Interface to create a metrics provider.

methodaws_lambda_powertools.metrics.provider.base.BaseProvider.add_cold_start_metric(context:LambdaContext) -> Any

Abstract method for clear metric instance.

methodaws_lambda_powertools.metrics.provider.base.BaseProvider.add_metric(*args:Any, **kwargs:Any) -> Any

Abstract method for adding a metric.

methodaws_lambda_powertools.metrics.provider.base.BaseProvider.clear_metrics(*args:Any, **kwargs) -> None

Abstract method for clear metric instance.

methodaws_lambda_powertools.metrics.provider.base.BaseProvider.flush_metrics(*args:Any, **kwargs) -> Any

Abstract method for flushing a metric.

methodaws_lambda_powertools.metrics.provider.base.BaseProvider.serialize_metric_set(*args:Any, **kwargs:Any) -> Any

Abstract method for serialize a metric.

funcaws_lambda_powertools.shared.functions.dataclass_to_dict(data) -> dict

Dump standard dataclass as dict.

funcaws_lambda_powertools.shared.functions.pydantic_to_dict(data) -> dict

Dump Pydantic model v1 and v2 as dict.

funcaws_lambda_powertools.shared.functions.resolve_max_age(env:str, choice:int | None) -> int

Resolve max age value

funcaws_lambda_powertools.shared.functions.strtobool(value:str) -> bool

Convert a string representation of truth to True or False.

methodaws_lambda_powertools.tracing.base.BaseProvider.patch_all() -> None

Instrument all supported libraries

classaws_lambda_powertools.utilities.batch.base.BasePartialProcessor

Abstract class for batch processors.

classaws_lambda_powertools.utilities.circuit_breaker_alpha.config.CircuitBreakerConfig

Tunables for a circuit breaker.

classaws_lambda_powertools.utilities.circuit_breaker_alpha.exceptions.CircuitBreakerError

Base error class.

classaws_lambda_powertools.utilities.circuit_breaker_alpha.states.CircuitState

The state of a circuit.

classaws_lambda_powertools.utilities.data_classes.api_gateway_authorizer_event.APIGatewayRouteArn

A parsed route arn

classaws_lambda_powertools.utilities.data_classes.api_gateway_authorizer_event.HttpVerb

Enum of http methods / verbs

classaws_lambda_powertools.utilities.data_classes.appsync_authorizer_event.AppSyncAuthorizerEventRequestContext

Request context

method

aws_lambda_powertools.utilities.data_classes.appsync_authorizer_event.AppSyncAuthorizerEventRequestContext.account_id() -> str

AWS Account ID

method

aws_lambda_powertools.utilities.data_classes.appsync_authorizer_event.AppSyncAuthorizerEventRequestContext.api_id() -> str

AppSync API ID

method

aws_lambda_powertools.utilities.data_classes.appsync_authorizer_event.AppSyncAuthorizerEventRequestContext.query_string() -> str

GraphQL query string

method

aws_lambda_powertools.utilities.data_classes.appsync_authorizer_event.AppSyncAuthorizerEventRequestContext.request_id() -> str

Requestt ID

method

aws_lambda_powertools.utilities.data_classes.appsync_authorizer_event.AppSyncAuthorizerEventRequestContext.variables() -> dict

GraphQL variables

classaws_lambda_powertools.utilities.data_classes.appsync_resolver_event.AppSyncIdentityIAM

AWS_IAM authorization

methodaws_lambda_powertools.utilities.data_classes.appsync_resolver_event.AppSyncIdentityIAM.user_arn() -> str

The ARN of the IAM user.

methodaws_lambda_powertools.utilities.data_classes.cloud_watch_custom_widget_event.TimeRange.mode() -> str

The time range mode, i.e.

methodaws_lambda_powertools.utilities.data_classes.cloud_watch_custom_widget_event.TimeZone.label() -> str

The time range label.

classaws_lambda_powertools.utilities.data_classes.code_pipeline_job_event.CodePipelineData

CodePipeline Job Data

classaws_lambda_powertools.utilities.data_classes.common.CaseInsensitiveDict

Case insensitive dict implementation.

methodaws_lambda_powertools.utilities.data_classes.common.DictWrapper.raw_event() -> dict[str, Any]

The original raw event dict

methodaws_lambda_powertools.utilities.data_classes.s3_event.S3Object.etag() -> str

Object eTag.

methodaws_lambda_powertools.utilities.data_classes.s3_event.S3Object.key() -> str

Object key

methodaws_lambda_powertools.utilities.data_classes.s3_event.S3Object.size() -> int

Object byte size

classaws_lambda_powertools.utilities.data_classes.sqs_event.SQSRecord

An Amazon SQS message

methodaws_lambda_powertools.utilities.data_classes.sqs_event.SQSRecord.aws_region() -> str

aws region eg: us-east-1

methodaws_lambda_powertools.utilities.data_classes.sqs_event.SQSRecord.message_id() -> str

A unique identifier for the message.

methodaws_lambda_powertools.utilities.data_classes.sqs_event.SQSRecord.queue_url() -> str

The URL of the queue.

classaws_lambda_powertools.utilities.data_masking.exceptions.DataMaskingDecryptValueError

Decrypting an invalid field.

classaws_lambda_powertools.utilities.data_masking.exceptions.DataMaskingFieldNotFoundError

Field not found.

classaws_lambda_powertools.utilities.data_masking.exceptions.DataMaskingUnsupportedTypeError

UnsupportedType Error

classaws_lambda_powertools.utilities.feature_flags.schema.TimeKeys

Possible keys when using time rules

classaws_lambda_powertools.utilities.feature_flags.schema.TimeValues

Possible values when using time rules

classaws_lambda_powertools.utilities.idempotency.exceptions.IdempotencyInvalidStatusError

An invalid status was provided

classaws_lambda_powertools.utilities.idempotency.hook.IdempotentHookFunction

The IdempotentHookFunction.

classaws_lambda_powertools.utilities.idempotency.persistence.datarecord.DataRecord

Data Class for idempotency records.

classaws_lambda_powertools.utilities.kafka.consumer_records.ConsumerRecordRecords

A Kafka Consumer Record

classaws_lambda_powertools.utilities.kafka.deserializer.base.DeserializerBase

Abstract base class for deserializers.

classaws_lambda_powertools.utilities.kafka.deserializer.json.JsonDeserializer

Deserializer for JSON formatted data.

funcaws_lambda_powertools.utilities.metadata.lambda_metadata.clear_metadata_cache() -> None

Clear the cached metadata.

classaws_lambda_powertools.utilities.parameters.base.BaseProvider

Abstract Base Class for Parameter providers

funcaws_lambda_powertools.utilities.serialization.base64_from_str(data:str) -> str

Encode str as base64 string

classaws_lambda_powertools.utilities.streaming.s3_object.S3Object

Seekable and streamable S3 Object reader.

classaws_lambda_powertools.utilities.streaming.transformations.csv.CsvTransform

CSV data transform.

classaws_lambda_powertools.utilities.streaming.transformations.gzip.GzipTransform

Gzip data transform.

classaws_lambda_powertools.utilities.streaming.transformations.zip.ZipTransform

Zip data transform.

classaws_lambda_powertools.utilities.validation.exceptions.InvalidSchemaFormatError

When JSON Schema is in invalid format

About this data

These signatures were extracted from the public source of aws-powertools/powertools-lambda-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries