package endpoints

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

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	      endpoints.go
	      go_module_metadata.go
Package-Level Type Names (total 10, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type CredentialScope (struct)
		CredentialScope is the credential scope of a region and service

		Fields (total 2, both are exported)
			Region string
			Service string

	 type DefaultKey (struct)
		DefaultKey is a compound map key of a variant and other values.

		Fields (total 2, both are exported)
			ServiceVariant ServiceVariant
			Variant EndpointVariant

	 type Endpoint (struct)
		Endpoint is a service endpoint description

		Fields (total 6, all are exported)
			CredentialScope CredentialScope
			Deprecated aws.Ternary
				Indicates that this endpoint is deprecated.

			Hostname string
			Protocols []string
			SignatureVersions []string
			Unresolveable aws.Ternary
				True if the endpoint cannot be resolved for this partition/region/service

		Methods (total 3, in which 1 are exported)
			( Endpoint) IsZero() bool
				IsZero returns whether the endpoint structure is an empty (zero) value.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*Endpoint) mergeIn(other Endpoint)
			( Endpoint) resolve(partition, region string, def Endpoint, options Options) (aws.Endpoint, error)
		Implements (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Endpoint : github.com/go-pg/zerochecker.isZeroer
			 Endpoint : github.com/vmihailenco/msgpack/v5.isZeroer
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func Partition.endpointForRegion(region string, variant EndpointVariant, serviceVariant ServiceVariant, endpoints Endpoints) Endpoint
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func (*Endpoint).mergeIn(other Endpoint)
			func Endpoint.resolve(partition, region string, def Endpoint, options Options) (aws.Endpoint, error)

	 type EndpointKey (struct)
		EndpointKey is a compound map key of a region and associated variant value.

		Fields (total 3, all are exported)
			Region string
			ServiceVariant ServiceVariant
			Variant EndpointVariant

	 type Endpoints (map)
		Endpoints is a map of service config regions to endpoints

		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func Partition.endpointForRegion(region string, variant EndpointVariant, serviceVariant ServiceVariant, endpoints Endpoints) Endpoint

	 type EndpointVariant uint64 (basic type)
		EndpointVariant is a bit field to describe the endpoints attributes.

		As Outputs Of (at least one exported)
			func Options.GetEndpointVariant() (v EndpointVariant)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func Partition.endpointForRegion(region string, variant EndpointVariant, serviceVariant ServiceVariant, endpoints Endpoints) Endpoint
		As Types Of (total 2, both are exported)
			const DualStackVariant
			const FIPSVariant

	 type Options (struct)
		Options provide configuration needed to direct how endpoints are resolved.

		Fields (total 7, all are exported)
			DisableHTTPS bool
				Disable usage of HTTPS (TLS / SSL)

			LogDeprecated bool
				LogDeprecated indicates that deprecated endpoints should be logged to the provided logger.

			Logger logging.Logger
				Logger is a logging implementation that log events should be sent to.

			ResolvedRegion string
				ResolvedRegion is the resolved region string. If provided (non-zero length) it takes priority
				over the region name passed to the ResolveEndpoint call.

			ServiceVariant ServiceVariant
				ServiceVariant is a bitfield of service specified endpoint variant data.

			UseDualStackEndpoint aws.DualStackEndpointState
				Instruct the resolver to use a service endpoint that supports dual-stack.
				If a service does not have a dual-stack endpoint an error will be returned by the resolver.

			UseFIPSEndpoint aws.FIPSEndpointState
				Instruct the resolver to use a service endpoint that supports FIPS.
				If a service does not have a FIPS endpoint an error will be returned by the resolver.

		Methods (only one, which is exported)
			( Options) GetEndpointVariant() (v EndpointVariant)
				GetEndpointVariant returns the EndpointVariant for the variant associated options.

		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/endpoints.transformToSharedOptions(options endpoints.Options) Options
		As Inputs Of (at least 4, in which 2 are exported)
			func Partition.ResolveEndpoint(region string, options Options) (resolved aws.Endpoint, err error)
			func Partitions.ResolveEndpoint(region string, opts Options) (aws.Endpoint, error)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func Endpoint.resolve(partition, region string, def Endpoint, options Options) (aws.Endpoint, error)
			func Partition.canResolveEndpoint(region string, opts Options) bool

	 type Partition (struct)
		Partition is an AWS partition description for a service and its' region endpoints.

		Fields (total 6, all are exported)
			Defaults map[DefaultKey]Endpoint
			Endpoints Endpoints
			ID string
			IsRegionalized bool
			PartitionEndpoint string
			RegionRegex *regexp.Regexp
		Methods (total 3, in which 1 are exported)
			( Partition) ResolveEndpoint(region string, options Options) (resolved aws.Endpoint, err error)
				ResolveEndpoint resolves and service endpoint for the given region and options.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			( Partition) canResolveEndpoint(region string, opts Options) bool
			( Partition) endpointForRegion(region string, variant EndpointVariant, serviceVariant ServiceVariant, endpoints Endpoints) Endpoint

	 type Partitions ([])
		Partitions is a slice of partition

		Methods (only one, which is exported)
			( Partitions) ResolveEndpoint(region string, opts Options) (aws.Endpoint, error)
				ResolveEndpoint resolves a service endpoint for the given region and options.

		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var github.com/aws/aws-sdk-go-v2/service/s3/internal/endpoints.defaultPartitions

	 type ServiceVariant uint64 (basic type)
		ServiceVariant is a bit field to describe the service endpoint attributes.

		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func Partition.endpointForRegion(region string, variant EndpointVariant, serviceVariant ServiceVariant, endpoints Endpoints) Endpoint


Package-Level Functions (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func getByPriority(s []string, p []string, def string) string
	 func getEndpointScheme(protocols []string, disableHTTPS bool) string
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var protocolPriority []string
	  var signerPriority []string
Package-Level Constants (total 5, in which 2 are exported)

	const DualStackVariant EndpointVariant = 4611686018427387904
		DualStackVariant indicates that the endpoint is DualStack capable.

	const FIPSVariant EndpointVariant = 9223372036854775808
		FIPSVariant indicates that the endpoint is FIPS capable.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	const defaultProtocol = "https"
	const defaultSigner = "v4"
	const goModuleVersion = "2.4.23"
		goModuleVersion is the tagged release for this module

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