awsservicemap

README

aws-servicemap

Not all AWS services are supported in all regions. Use this go module to determine if a service is supported in a specific region and more.

Uses https://api.regional-table.region-services.aws.a2z.com/index.json as the source of truth.

Functions

• IsServiceInRegion
• GetRegionsForService
• GetServicesForRegion
• GetAllRegions
• GetAllServices

Examples

IsServiceInRegion

package main

import (
	"fmt"
	"log"

	"github.com/bishopfox/awsservicemap"
)

func main() {
	// JsonFileSource options: "EMBEDDED_IN_PACKAGE", "DOWNLOAD_FROM_AWS"
	
	// When using "EMBEDDED_IN_PACKAGE" this package does not make any external HTTP
	// requests, but the data might be slightly out of date
	
	// When using "DOWNLOAD_FROM_AWS" this package makes an external 
	// HTTP request, but you get real-time data.

	servicemap := &awsservicemap.AwsServiceMap{
		JsonFileSource: "EMBEDDED_IN_PACKAGE",
	}

	// Check if franddetector is supported in eu-south-2?
	res, err := servicemap.IsServiceInRegion("frauddetector", "eu-south-2")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(res)
}

Output:

false

GetRegionsForService

package main

import (
	"fmt"
	"log"

	"github.com/bishopfox/awsservicemap"
)

func main() {
	
	// JsonFileSource options: "EMBEDDED_IN_PACKAGE", "DOWNLOAD_FROM_AWS"
	// When using "EMBEDDED_IN_PACKAGE" this package does not make any external HTTP requests, but the data might be slightly out of date
	// When using "DOWNLOAD_FROM_AWS" this package makes an external HTTP request, but you get real-time data.

	servicemap := &awsservicemap.AwsServiceMap{
		JsonFileSource: "DOWNLOAD_FROM_AWS",
	}
	
	// Check what regions support grafana?
	regions, err := servicemap.GetRegionsForService("grafana")
	if err != nil {
		log.Fatal(err)
	}
		fmt.Println(regions)

}

Output:

[ap-northeast-1 ap-northeast-2 ap-southeast-1 ap-southeast-2 eu-central-1 eu-west-1 eu-west-2 us-east-1 us-east-2 us-west-2]

GetServicesForRegion

package main

import (
	"fmt"
	"log"

	"github.com/bishopfox/awsservicemap"
)

func main() {
	
	// JsonFileSource options: "EMBEDDED_IN_PACKAGE", "DOWNLOAD_FROM_AWS"
	// When using "EMBEDDED_IN_PACKAGE" this package does not make any external HTTP requests, but the data might be slightly out of date
	// When using "DOWNLOAD_FROM_AWS" this package makes an external HTTP request, but you get real-time data.

	servicemap := &awsservicemap.AwsServiceMap{
		JsonFileSource: "DOWNLOAD_FROM_AWS",
	}
	
	// Check what services are supported in eu-south-2
	services, err := servicemap.GetServicesForRegion("eu-south-2")
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(services)
}

Output:

[route53 ssm codedeploy ec2 cloudtrail redshift iam es sqs apigateway stepfunctions privatelink acm artifact cloudformation kinesis phd rds trustedadvisor vpc directconnect aurora ebs fargate eventbridge xray emr secretsmanager swf marketplace cloudwatch dms organizations elasticache kms support sns vpn autoscaling ecr elb s3 dynamodb config cloudfront lambda ecs]

GetAllRegions

package main

import (
	"fmt"
	"log"

	"github.com/bishopfox/awsservicemap"
)

func main() {
	
	// JsonFileSource options: "EMBEDDED_IN_PACKAGE", "DOWNLOAD_FROM_AWS"
	// When using "EMBEDDED_IN_PACKAGE" this package does not make any external HTTP requests, but the data might be slightly out of date
	// When using "DOWNLOAD_FROM_AWS" this package makes an external HTTP request, but you get real-time data.

	servicemap := &awsservicemap.AwsServiceMap{
		JsonFileSource: "DOWNLOAD_FROM_AWS",
	}
	
	// List all of the regions
	totalRegions, err := servicemap.GetAllRegions()
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(totalRegions)

}

Output:

[ap-east-1 ap-northeast-1 ap-northeast-2 ap-south-1 ap-southeast-2 ca-central-1 eu-west-2 eu-west-3 us-east-1 us-east-2 ap-southeast-1 eu-central-1 eu-north-1 eu-west-1 us-gov-west-1 us-west-1 us-west-2 ap-northeast-3 cn-north-1 eu-central-2 sa-east-1 af-south-1 ap-southeast-3 eu-south-1 eu-south-2 me-central-1 cn-northwest-1 me-south-1 us-gov-east-1]

GetAllServices

package main

import (
	"fmt"
	"log"

	"github.com/bishopfox/awsservicemap"
)

func main() {
	
	// JsonFileSource options: "EMBEDDED_IN_PACKAGE", "DOWNLOAD_FROM_AWS"
	// When using "EMBEDDED_IN_PACKAGE" this package does not make any external HTTP requests, but the data might be slightly out of date
	// When using "DOWNLOAD_FROM_AWS" this package makes an external HTTP request, but you get real-time data.

	servicemap := &awsservicemap.AwsServiceMap{
		JsonFileSource: "DOWNLOAD_FROM_AWS",
	}
	
	// List all of the services
	totalServices, err := servicemap.GetAllServices()
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(totalServices)
}

Output:

[translate route53 lookoutmetrics opsworkspuppetenterprise datasync frauddetector shield mwaa cloudshell servicediscovery sagemaker elastictranscoder devops-guru transitgateway ivs rosa elastic-inference ssm codedeploy iotdevicedefender ahl ec2 inspector2 quicksight cloudtrail greengrass polly athena rdsvmware groundstation chatbot redshift iam iot1click-projects filecache iotevents kinesisanalytics honeycode es dataexchange guardduty nimble vmwarecloudonaws firehose kinesisvideo appstream deepcomposer mq ram cloudsearch sso managedservices iotanalytics wellarchitectedtool sqs compute-optimizer braket waf glue outposts medialive apigateway proton stepfunctions budgets license-manager ds privatelink acm personalize artifact eks fms workspaces-web cloudformation kinesis cloudenduredisasterrecovery clouddirectory cognito-identity phd datapipeline controltower lumberyard rds grafana wam codeartifact fsx-ontap detective lightsail iotsitewise kafka trustedadvisor vpc directconnect aurora iot ebs chime aiq cloudenduremigration resiliencehub comprehend fargate backup mediapackage globalaccelerator snowcone drs kendra devicefarm eventbridge lex-runtime appflow xray textract cloudhsmv2 neptune fis amplify auditmanager emr workdocs secretsmanager swf augmentedairuntime marketplace batch mgn transfer ses codepipeline application-autoscaling timestream lakeformation mgh transcribemedical opsworks cloudwatch opsworkschefautomate amazonlocationservice codestar cloud9 workspaces managedblockchain snowball dms serverlessrepo robomaker pinpoint elasticbeanstalk transcribe organizations iotdevicemanagement macie aps elasticache mcs connect kms forecast support sns vpn m2 network-firewall storagegateway autoscaling servicecatalog fsx-lustre appsync snowmobile mediatailor ecr iottwinmaker elb codecommit memorydb lookoutvision s3 sms deepracer codeguruprofiler efs qldb mediaconvert fsx-openzfs comprehendmedical gamelift dynamodb docdb mediaconnect alexaforbusiness config cloudfront workmail securityhub appmesh deeplens cur sumerian rekognition lambda freertosota fsx-windows discovery ecs codebuild mediastore costexplorer]

Thanks

Thanks to Christophe Tafani-Dereeper (@christophetd) for the idea to make this a consumable go package and the help along the way.

Documentation

Index

• type AwsServiceMap
  • func NewServiceMap() *AwsServiceMap
  • func (m *AwsServiceMap) GetAllRegions() ([]string, error)
  • func (m *AwsServiceMap) GetAllServices() ([]string, error)
  • func (m *AwsServiceMap) GetRegionsForService(reqService string) ([]string, error)
  • func (m *AwsServiceMap) GetServicesForRegion(reqRegion string) ([]string, error)
  • func (m *AwsServiceMap) IsServiceInRegion(reqService string, reqRegion string) (bool, error)
• type JsonFileSource
  • func (JsonFileSource) Values() []JsonFileSource

Types

type AwsServiceMap

type AwsServiceMap struct {
	JsonFileSource JsonFileSource
}

func NewServiceMap

func NewServiceMap() *AwsServiceMap

Function that uses the constructor pattern. You can use this or instantiate your struct without it.

func (*AwsServiceMap) GetAllRegions

func (m *AwsServiceMap) GetAllRegions() ([]string, error)

Returns a slice of strings that represent all observed regions

func (*AwsServiceMap) GetAllServices

func (m *AwsServiceMap) GetAllServices() ([]string, error)

func (*AwsServiceMap) GetRegionsForService

func (m *AwsServiceMap) GetRegionsForService(reqService string) ([]string, error)

Returns a slice of strings that represent all regions that support the specific service

func (*AwsServiceMap) GetServicesForRegion

func (m *AwsServiceMap) GetServicesForRegion(reqRegion string) ([]string, error)

Returns a slice of strings that represent all service supported in a specific region

func (*AwsServiceMap) IsServiceInRegion

func (m *AwsServiceMap) IsServiceInRegion(reqService string, reqRegion string) (bool, error)

Is a specific service supported in a specific region. Returns true/false

type JsonFileSource

type JsonFileSource string

When using "EMBEDDED_IN_PACKAGE" this package does not make any external HTTP requests, but the data might be slightly out of date When using "DOWNLOAD_FROM_AWS" this package makes an external HTTP request, but you get real-time data.

const (
	JsonFileSourceEmbedded JsonFileSource = "EMBEDDED_IN_PACKAGE"
	JsonFileSourceDownload JsonFileSource = "DOWNLOAD_FROM_AWS"
)

Enum values for JsonFileSource

func (JsonFileSource) Values

func (JsonFileSource) Values() []JsonFileSource