package arn

Import Path
	github.com/aws/aws-sdk-go-v2/aws/arn (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 3 packages

Involved Source Files

	   #d arn.go
		Package arn provides a parser for interacting with Amazon Resource Names.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type ARN (struct)
		ARN captures the individual fields of an Amazon Resource Name.
		See http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html for more information.

		Fields (total 5, all are exported)
			AccountID string
				The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. Note that the
				ARNs for some resources don't require an account number, so this component might be omitted.

			Partition string
				The partition that the resource is in. For standard AWS regions, the partition is "aws". If you have resources in
				other partitions, the partition is "aws-partitionname". For example, the partition for resources in the China
				(Beijing) region is "aws-cn".

			Region string
				The region the resource resides in. Note that the ARNs for some resources do not require a region, so this
				component might be omitted.

			Resource string
				The content of this part of the ARN varies by service. It often includes an indicator of the type of resource —
				for example, an IAM user or Amazon RDS database - followed by a slash (/) or a colon (:), followed by the
				resource name itself. Some services allows paths for resource names, as described in
				http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-paths.

			Service string
				The service namespace that identifies the AWS product (for example, Amazon S3, IAM, or Amazon RDS). For a list of
				namespaces, see
				http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces.

		Methods (only one, which is exported)
			( ARN) String() string
				String returns the canonical representation of the ARN

		Implements (at least 5, in which 2 are exported)
			 ARN : expvar.Var
			 ARN : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 ARN : github.com/aws/smithy-go/middleware.stringer
			 ARN : context.stringer
			 ARN : runtime.stringer
		As Outputs Of (at least 8, all are exported)
			func Parse(arn string) (ARN, error)
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.GetARNResourceFromContext(ctx context.Context) (ARN, bool)
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.ResourceRequest.ARN() ARN
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.AccessPointARN.GetARN() ARN
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.OutpostARN.GetARN() ARN
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.OutpostBucketARN.GetARN() ARN
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.Resource.GetARN() ARN
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.S3ObjectLambdaARN.GetARN() ARN
		As Inputs Of (at least 9, in which 4 are exported)
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.ParseAccessPointResource(a ARN, resParts []string) (arn.AccessPointARN, error)
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.ParseOutpostARNResource(a ARN, resParts []string) (arn.OutpostARN, error)
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.ParseResource(a ARN, resParser arn.ResourceParser) (resARN arn.Resource, err error)
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.ParseEndpointARN(v ARN) (arn.Resource, error)
			/* 5+ unexporteds ... *//* 5+ unexporteds: */
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.setARNResourceOnContext(ctx context.Context, value ARN) context.Context
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared/arn.parseBucketResource(a ARN, resParts []string) (bucketName string, err error)
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.accessPointResourceParser(a ARN) (arn.Resource, error)
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.parseOutpostAccessPointResource(a ARN, resParts []string) (arn.OutpostAccessPointARN, error)
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.parseS3ObjectLambdaAccessPointResource(a ARN, resParts []string) (arn.S3ObjectLambdaAccessPointARN, error)


Package-Level Functions (total 2, both are exported)

	 func IsARN(arn string) bool
		IsARN returns whether the given string is an arn
		by looking for whether the string starts with arn:

	 func Parse(arn string) (ARN, error)
		Parse parses an ARN into its constituent parts.

		Some example ARNs:
		arn:aws:elasticbeanstalk:us-east-1:123456789012:environment/My App/MyEnvironment
		arn:aws:iam::123456789012:user/David
		arn:aws:rds:eu-west-1:123456789012:db:mysql-db
		arn:aws:s3:::my_corporate_bucket/exampleobject.png


Package-Level Constants (total 10, none are exported)

	/* 10 unexporteds ... *//* 10 unexporteds: */
	const arnDelimiter = ":"
	const arnPrefix = "arn:"
	const arnSections = 6
	const invalidPrefix = "arn: invalid prefix"
		errors

	const invalidSections = "arn: not enough sections"
	const sectionAccountID = 4
	const sectionPartition = 1
		zero-indexed

	const sectionRegion = 3
	const sectionResource = 5
	const sectionService = 2

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)