Skip to main content

Parse ARNs using Python

Project description

arnparse

Parse ARNs using Python

Build Status

Motivation

Sometimes, you want to parse an Amazon Resource Name (ARN) into its components to get some useful information from the ARN (e.g. AWS region, account ID, etc).

You can find documentation on ARNs and their components here: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Installation

pip install arnparse

Examples

S3 Object

from arnparse import arnparse

arn = arnparse('arn:aws:s3:::my_corporate_bucket/exampleobject.png')

assert arn.partition == 'aws'
assert arn.service == 's3'
assert arn.region is None
assert arn.account_id is None
assert arn.resource_type is None
assert arn.resource == 'my_corporate_bucket/exampleobject.png'

VPC

from arnparse import arnparse

arn = arnparse('arn:aws:ec2:us-east-1:123456789012:vpc/vpc-fd580e98')

assert arn.partition == 'aws'
assert arn.service == 'ec2'
assert arn.region == 'us-east-1'
assert arn.account_id == '123456789012'
assert arn.resource_type == 'vpc'
assert arn.resource == 'vpc-fd580e98'

CloudWatch Alarm

from arnparse import arnparse

arn = arnparse('arn:aws:cloudwatch:us-east-1:123456789012:alarm:MyAlarmName')

assert arn.partition == 'aws'
assert arn.service == 'cloudwatch'
assert arn.region == 'us-east-1'
assert arn.account_id == '123456789012'
assert arn.resource_type == 'alarm'
assert arn.resource == 'MyAlarmName'

SNS Topic

from arnparse import arnparse

arn = arnparse('arn:aws:sns:*:123456789012:my_corporate_topic')

assert arn.partition == 'aws'
assert arn.service == 'sns'
assert arn.region == '*'
assert arn.account_id == '123456789012'
assert arn.resource_type is None
assert arn.resource == 'my_corporate_topic'

API Gateway

from arnparse import arnparse

arn = arnparse('arn:aws:apigateway:us-east-1::a123456789012bc3de45678901f23a45:/test/mydemoresource/*')

assert arn.partition == 'aws'
assert arn.service == 'apigateway'
assert arn.region == 'us-east-1'
assert arn.account_id is None
assert arn.resource_type is None
assert arn.resource == 'a123456789012bc3de45678901f23a45:/test/mydemoresource/*'

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

arnparse-0.0.2.tar.gz (2.7 kB view hashes)

Uploaded Source

Built Distribution

arnparse-0.0.2-py2.py3-none-any.whl (2.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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