arnmatch 0.3.0

arnmatch - parse AWS ARNs into structured data

arnmatch

Parse AWS ARNs into structured data.

Features

• Zero runtime dependencies
• 300+ AWS services, 2000+ resource types supported
• Patterns auto-generated from AWS official documentation
• CLI and library interface
• Extracts resource type, ID, and name with smart heuristics

Installation

pip install arnmatch

Quick Start

CLI

$ arnmatch "arn:aws:lambda:us-east-1:123456789012:function:my-function"
aws_service: lambda
aws_region: us-east-1
aws_account: 123456789012
resource_type: function
resource_id: my-function
resource_name: my-function

Library

from arnmatch import arnmatch

arn = "arn:aws:lambda:us-east-1:123456789012:function:my-function"
result = arnmatch(arn)

print(result.aws_service)    # lambda
print(result.aws_region)     # us-east-1
print(result.aws_account)    # 123456789012
print(result.resource_type)  # function
print(result.resource_id)    # my-function
print(result.resource_name)  # my-function
print(result.attributes)     # {'Partition': 'aws', 'Region': 'us-east-1', ...}

API Reference

arnmatch(arn: str) -> ARN

Parse an ARN string and return structured data.

Raises ARNError if the ARN format is invalid or no pattern matches.

ARN

Dataclass with parsed ARN components:

Field	Type	Description
aws_partition	str	AWS partition (aws, aws-cn, aws-us-gov)
aws_service	str	AWS service name
aws_region	str	AWS region (may be empty for global resources)
aws_account	str	AWS account ID
resource_type	str	Canonical resource type from AWS docs
resource_types	list[str]	All known names for this resource type
attributes	dict[str, str]	All captured attributes from the pattern

Properties:

Property	Description
resource_id	Resource identifier (prefers groups ending in Id, falls back to Name, then last group)
resource_name	Resource name (prefers groups ending in Name, falls back to resource_id)

ARNError

Exception raised when ARN parsing fails. Inherits from ValueError.

Development

Prerequisites: uv

make lint       # Run ruff linter
make build      # Build wheel and tarball
make publish    # Build and upload to PyPI
make clean      # Remove build artifacts

Regenerate patterns from AWS docs:

cd codegen && uv run codegen.py