package arn

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

Dependency Relation
	imports 3 packages, and imported by 3 packages

Involved Source Files

	      accesspoint_arn.go
	      arn.go
	      outpost_arn.go
	      s3_object_lambda_arn.go
Package-Level Type Names (total 9, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AccessPointARN (struct)
		AccessPointARN provides representation

		Fields (total 7, all are exported)
			ARN arn.ARN
			AccessPointName string
			ARN.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.

			ARN.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".

			ARN.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.

			ARN.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.

			ARN.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 (total 2, both are exported)
			( AccessPointARN) GetARN() arn.ARN
				GetARN returns the base ARN for the Access Point resource

			( AccessPointARN) String() string
				String returns the canonical representation of the ARN

		Implements (at least 6, in which 3 are exported)
			 AccessPointARN : Resource
			 AccessPointARN : expvar.Var
			 AccessPointARN : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 AccessPointARN : github.com/aws/smithy-go/middleware.stringer
			 AccessPointARN : context.stringer
			 AccessPointARN : runtime.stringer
		As Outputs Of (at least one exported)
			func ParseAccessPointResource(a arn.ARN, resParts []string) (AccessPointARN, error)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/customizations.buildAccessPointHostPrefix(ctx context.Context, req *http.Request, tv AccessPointARN) (context.Context, error)

	 type InvalidARNError (struct)
		InvalidARNError provides the error for an invalid ARN error.

		Fields (total 2, both are exported)
			ARN arn.ARN
			Reason string
		Methods (only one, which is exported)
			( InvalidARNError) Error() string
				Error returns a string denoting the occurred InvalidARNError

		Implements (at least one exported)
			 InvalidARNError : error

	 type OutpostAccessPointARN (struct)
		OutpostAccessPointARN represents outpost access point ARN.

		Fields (total 9, all are exported)
			AccessPointARN AccessPointARN
			AccessPointARN.ARN arn.ARN
			AccessPointARN.AccessPointName string
			AccessPointARN.ARN.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.

			AccessPointARN.ARN.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".

			AccessPointARN.ARN.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.

			AccessPointARN.ARN.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.

			AccessPointARN.ARN.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.

			OutpostID string
		Methods (total 3, all are exported)
			( OutpostAccessPointARN) GetARN() arn.ARN
				GetARN returns the base ARN for the Access Point resource

			( OutpostAccessPointARN) GetOutpostID() string
				GetOutpostID returns the outpost id of outpost access point arn

			( OutpostAccessPointARN) String() string
				String returns the canonical representation of the ARN

		Implements (at least 7, in which 4 are exported)
			 OutpostAccessPointARN : OutpostARN
			 OutpostAccessPointARN : Resource
			 OutpostAccessPointARN : expvar.Var
			 OutpostAccessPointARN : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 OutpostAccessPointARN : github.com/aws/smithy-go/middleware.stringer
			 OutpostAccessPointARN : context.stringer
			 OutpostAccessPointARN : runtime.stringer
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.parseOutpostAccessPointResource(a awsarn.ARN, resParts []string) (OutpostAccessPointARN, error)

	 type OutpostARN (interface)
		OutpostARN interface that should be satisfied by outpost ARNs

		Methods (total 3, all are exported)
			( OutpostARN) GetARN() arn.ARN
			( OutpostARN) GetOutpostID() string
			( OutpostARN) String() string
		Implemented By (at least 2, both are exported)
			 OutpostAccessPointARN
			 OutpostBucketARN
		Implements (at least 6, in which 3 are exported)
			 OutpostARN : Resource
			 OutpostARN : expvar.Var
			 OutpostARN : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 OutpostARN : github.com/aws/smithy-go/middleware.stringer
			 OutpostARN : context.stringer
			 OutpostARN : runtime.stringer
		As Outputs Of (at least one exported)
			func ParseOutpostARNResource(a arn.ARN, resParts []string) (OutpostARN, error)

	 type OutpostBucketARN (struct)
		OutpostBucketARN represents the outpost bucket ARN.

		Fields (total 8, all are exported)
			ARN arn.ARN
			ARN.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.

			ARN.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".

			ARN.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.

			ARN.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.

			ARN.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.

			BucketName string
			OutpostID string
		Methods (total 3, all are exported)
			( OutpostBucketARN) GetARN() arn.ARN
				GetARN retrives the base ARN from outpost bucket ARN resource

			( OutpostBucketARN) GetOutpostID() string
				GetOutpostID returns the outpost id of outpost bucket arn

			( OutpostBucketARN) String() string
				String returns the canonical representation of the ARN

		Implements (at least 7, in which 4 are exported)
			 OutpostBucketARN : OutpostARN
			 OutpostBucketARN : Resource
			 OutpostBucketARN : expvar.Var
			 OutpostBucketARN : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 OutpostBucketARN : github.com/aws/smithy-go/middleware.stringer
			 OutpostBucketARN : context.stringer
			 OutpostBucketARN : runtime.stringer

	 type Resource (interface)
		Resource provides the interfaces abstracting ARNs of specific resource
		types.

		Methods (total 2, both are exported)
			( Resource) GetARN() arn.ARN
			( Resource) String() string
		Implemented By (at least 6, all are exported)
			 AccessPointARN
			 OutpostAccessPointARN
			 OutpostARN (interface)
			 OutpostBucketARN
			 S3ObjectLambdaAccessPointARN
			 S3ObjectLambdaARN (interface)
		Implements (at least 5, in which 2 are exported)
			 Resource : expvar.Var
			 Resource : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 Resource : github.com/aws/smithy-go/middleware.stringer
			 Resource : context.stringer
			 Resource : runtime.stringer
		As Outputs Of (at least 3, in which 2 are exported)
			func ParseResource(a arn.ARN, resParser ResourceParser) (resARN Resource, err error)
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.ParseEndpointARN(v awsarn.ARN) (Resource, error)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.accessPointResourceParser(a awsarn.ARN) (Resource, error)
		As Inputs Of (at least 11, all are exported)
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewClientConfiguredForAccelerateError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewClientConfiguredForCrossRegionFIPSError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewClientConfiguredForDualStackError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewClientConfiguredForFIPSError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewClientPartitionMismatchError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewClientRegionMismatchError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewFailedToResolveEndpointError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewFIPSConfigurationError(resource Resource, clientPartitionID, clientRegion string, err error) s3shared.ConfigurationError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewInvalidARNError(resource Resource, err error) s3shared.InvalidARNError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewInvalidARNWithFIPSError(resource Resource, err error) s3shared.InvalidARNError
			func github.com/aws/aws-sdk-go-v2/service/internal/s3shared.NewInvalidARNWithUnsupportedPartitionError(resource Resource, err error) s3shared.InvalidARNError

	 type ResourceParser (func)
		ResourceParser provides the function for parsing an ARN's resource
		component into a typed resource.

		As Inputs Of (at least one exported)
			func ParseResource(a arn.ARN, resParser ResourceParser) (resARN Resource, err error)

	 type S3ObjectLambdaAccessPointARN (struct)
		S3ObjectLambdaAccessPointARN is an S3ObjectLambdaARN for the Access Point resource type

		Fields (total 8, all are exported)
			AccessPointARN AccessPointARN
			AccessPointARN.ARN arn.ARN
			AccessPointARN.AccessPointName string
			AccessPointARN.ARN.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.

			AccessPointARN.ARN.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".

			AccessPointARN.ARN.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.

			AccessPointARN.ARN.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.

			AccessPointARN.ARN.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 (total 3, in which 2 are exported)
			( S3ObjectLambdaAccessPointARN) GetARN() arn.ARN
				GetARN returns the base ARN for the Access Point resource

			( S3ObjectLambdaAccessPointARN) String() string
				String returns the canonical representation of the ARN

			/* one unexported ... *//* one unexported: */
			( S3ObjectLambdaAccessPointARN) isS3ObjectLambdasARN()
		Implements (at least 7, in which 4 are exported)
			 S3ObjectLambdaAccessPointARN : Resource
			 S3ObjectLambdaAccessPointARN : S3ObjectLambdaARN
			 S3ObjectLambdaAccessPointARN : expvar.Var
			 S3ObjectLambdaAccessPointARN : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 S3ObjectLambdaAccessPointARN : github.com/aws/smithy-go/middleware.stringer
			 S3ObjectLambdaAccessPointARN : context.stringer
			 S3ObjectLambdaAccessPointARN : runtime.stringer
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/aws/aws-sdk-go-v2/service/s3/internal/arn.parseS3ObjectLambdaAccessPointResource(a awsarn.ARN, resParts []string) (S3ObjectLambdaAccessPointARN, error)

	 type S3ObjectLambdaARN (interface)
		S3ObjectLambdaARN represents an ARN for the s3-object-lambda service

		Methods (total 3, in which 2 are exported)
			( S3ObjectLambdaARN) GetARN() arn.ARN
			( S3ObjectLambdaARN) String() string
			/* one unexported ... *//* one unexported: */
			( S3ObjectLambdaARN) isS3ObjectLambdasARN()
		Implemented By (at least one exported)
			 S3ObjectLambdaAccessPointARN
		Implements (at least 6, in which 3 are exported)
			 S3ObjectLambdaARN : Resource
			 S3ObjectLambdaARN : expvar.Var
			 S3ObjectLambdaARN : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 S3ObjectLambdaARN : github.com/aws/smithy-go/middleware.stringer
			 S3ObjectLambdaARN : context.stringer
			 S3ObjectLambdaARN : runtime.stringer


Package-Level Functions (total 8, in which 5 are exported)

	 func IsARN(s string) bool
		IsARN returns whether the given string is an ARN

	 func ParseAccessPointResource(a arn.ARN, resParts []string) (AccessPointARN, error)
		ParseAccessPointResource attempts to parse the ARN's resource as an
		AccessPoint resource.

		Supported Access point resource format:
		  - Access point format: arn:{partition}:s3:{region}:{accountId}:accesspoint/{accesspointName}
		  - example: arn:aws:s3:us-west-2:012345678901:accesspoint/myaccesspoint

	 func ParseOutpostARNResource(a arn.ARN, resParts []string) (OutpostARN, error)
		ParseOutpostARNResource will parse a provided ARNs resource using the appropriate ARN format
		and return a specific OutpostARN type

		Currently supported outpost ARN formats:
		* Outpost AccessPoint ARN format:
		  - ARN format: arn:{partition}:s3-outposts:{region}:{accountId}:outpost/{outpostId}/accesspoint/{accesspointName}
		  - example: arn:aws:s3-outposts:us-west-2:012345678901:outpost/op-1234567890123456/accesspoint/myaccesspoint

		* Outpost Bucket ARN format:
		  - ARN format: arn:{partition}:s3-outposts:{region}:{accountId}:outpost/{outpostId}/bucket/{bucketName}
		  - example: arn:aws:s3-outposts:us-west-2:012345678901:outpost/op-1234567890123456/bucket/mybucket

		Other outpost ARN formats may be supported and added in the future.

	 func ParseResource(a arn.ARN, resParser ResourceParser) (resARN Resource, err error)
		ParseResource parses an AWS ARN into a typed resource for the S3 API.

	 func SplitResource(v string) []string
		SplitResource splits the resource components by the ARN resource delimiters.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func isFIPS(region string) bool
	 func isSupportedServiceARN(service string) bool
	 func parseBucketResource(a arn.ARN, resParts []string) (bucketName string, err error)
		parseBucketResource attempts to parse the ARN's bucket resource and retrieve the
		bucket resource id.

		parseBucketResource only parses the bucket resource id.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var supportedServiceARN []string

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