geomaps

package module
v1.0.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 5, 2025 License: Apache-2.0 Imports: 41 Imported by: 2

Documentation

Overview

Package geomaps provides the API client, operations, and parameter types for Amazon Location Service Maps V2. 

Integrate high-quality base map data into your applications using [MapLibre].

Capabilities include:

  • Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.

  • Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.

  • Generation of static map images for scenarios where interactive maps aren't suitable, such as:

  • Embedding in emails or documents

  • Displaying in low-bandwidth environments

  • Creating printable maps

  • Enhancing application performance by reducing client-side rendering

Index

Constants

View Source 
const ServiceAPIVersion = "2020-11-19"
View Source 
const ServiceID = "Geo Maps"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Location Service Maps V2.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) GetGlyphs 

func (c *Client) GetGlyphs(ctx context.Context, params *GetGlyphsInput, optFns ...func(*Options)) (*GetGlyphsOutput, error)

Returns the map's glyphs.

func (*Client) GetSprites 

func (c *Client) GetSprites(ctx context.Context, params *GetSpritesInput, optFns ...func(*Options)) (*GetSpritesOutput, error)

Returns the map's sprites.

func (*Client) GetStaticMap 

func (c *Client) GetStaticMap(ctx context.Context, params *GetStaticMapInput, optFns ...func(*Options)) (*GetStaticMapOutput, error)

Provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.

func (*Client) GetStyleDescriptor 

func (c *Client) GetStyleDescriptor(ctx context.Context, params *GetStyleDescriptorInput, optFns ...func(*Options)) (*GetStyleDescriptorOutput, error)

Returns information about the style.

func (*Client) GetTile 

func (c *Client) GetTile(ctx context.Context, params *GetTileInput, optFns ...func(*Options)) (*GetTileOutput, error)

Returns a tile. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

type EndpointParameters 

type EndpointParameters struct {
	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetGlyphsInput 

type GetGlyphsInput struct {

	// Name of the FontStack to retrieve.
	//
	// Example: Amazon Ember Bold,Noto Sans Bold .
	//
	// The supported font stacks are as follows:
	//
	//   - Amazon Ember Bold
	//
	//   - Amazon Ember Bold Italic
	//
	//   - Amazon Ember Bold,Noto Sans Bold
	//
	//   - Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
	//
	//   - Amazon Ember Condensed RC BdItalic
	//
	//   - Amazon Ember Condensed RC Bold
	//
	//   - Amazon Ember Condensed RC Bold Italic
	//
	//   - Amazon Ember Condensed RC Bold,Noto Sans Bold
	//
	//   - Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed
	//   Bold
	//
	//   - Amazon Ember Condensed RC Light
	//
	//   - Amazon Ember Condensed RC Light Italic
	//
	//   - Amazon Ember Condensed RC LtItalic
	//
	//   - Amazon Ember Condensed RC Regular
	//
	//   - Amazon Ember Condensed RC Regular Italic
	//
	//   - Amazon Ember Condensed RC Regular,Noto Sans Regular
	//
	//   - Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic
	//   Condensed Regular
	//
	//   - Amazon Ember Condensed RC RgItalic
	//
	//   - Amazon Ember Condensed RC ThItalic
	//
	//   - Amazon Ember Condensed RC Thin
	//
	//   - Amazon Ember Condensed RC Thin Italic
	//
	//   - Amazon Ember Heavy
	//
	//   - Amazon Ember Heavy Italic
	//
	//   - Amazon Ember Light
	//
	//   - Amazon Ember Light Italic
	//
	//   - Amazon Ember Medium
	//
	//   - Amazon Ember Medium Italic
	//
	//   - Amazon Ember Medium,Noto Sans Medium
	//
	//   - Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
	//
	//   - Amazon Ember Regular
	//
	//   - Amazon Ember Regular Italic
	//
	//   - Amazon Ember Regular Italic,Noto Sans Italic
	//
	//   - Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular
	//
	//   - Amazon Ember Regular,Noto Sans Regular
	//
	//   - Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
	//
	//   - Amazon Ember Thin
	//
	//   - Amazon Ember Thin Italic
	//
	//   - AmazonEmberCdRC_Bd
	//
	//   - AmazonEmberCdRC_BdIt
	//
	//   - AmazonEmberCdRC_Lt
	//
	//   - AmazonEmberCdRC_LtIt
	//
	//   - AmazonEmberCdRC_Rg
	//
	//   - AmazonEmberCdRC_RgIt
	//
	//   - AmazonEmberCdRC_Th
	//
	//   - AmazonEmberCdRC_ThIt
	//
	//   - AmazonEmber_Bd
	//
	//   - AmazonEmber_BdIt
	//
	//   - AmazonEmber_He
	//
	//   - AmazonEmber_HeIt
	//
	//   - AmazonEmber_Lt
	//
	//   - AmazonEmber_LtIt
	//
	//   - AmazonEmber_Md
	//
	//   - AmazonEmber_MdIt
	//
	//   - AmazonEmber_Rg
	//
	//   - AmazonEmber_RgIt
	//
	//   - AmazonEmber_Th
	//
	//   - AmazonEmber_ThIt
	//
	//   - Noto Sans Black
	//
	//   - Noto Sans Black Italic
	//
	//   - Noto Sans Bold
	//
	//   - Noto Sans Bold Italic
	//
	//   - Noto Sans Extra Bold
	//
	//   - Noto Sans Extra Bold Italic
	//
	//   - Noto Sans Extra Light
	//
	//   - Noto Sans Extra Light Italic
	//
	//   - Noto Sans Italic
	//
	//   - Noto Sans Light
	//
	//   - Noto Sans Light Italic
	//
	//   - Noto Sans Medium
	//
	//   - Noto Sans Medium Italic
	//
	//   - Noto Sans Regular
	//
	//   - Noto Sans Semi Bold
	//
	//   - Noto Sans Semi Bold Italic
	//
	//   - Noto Sans Thin
	//
	//   - Noto Sans Thin Italic
	//
	//   - NotoSans-Bold
	//
	//   - NotoSans-Italic
	//
	//   - NotoSans-Medium
	//
	//   - NotoSans-Regular
	//
	//   - Open Sans Regular,Arial Unicode MS Regular
	//
	// This member is required.
	FontStack *string

	// A Unicode range of characters to download glyphs for. This must be aligned to
	// multiples of 256.
	//
	// Example: 0-255.pdf
	//
	// This member is required.
	FontUnicodeRange *string
	// contains filtered or unexported fields
}

type GetGlyphsOutput 

type GetGlyphsOutput struct {

	// The Glyph, as a binary blob.
	Blob []byte

	// Header that instructs caching configuration for the client.
	CacheControl *string

	// Header that represents the format of the response. The response returns the
	// following as the HTTP body.
	ContentType *string

	// The glyph's Etag.
	ETag *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSpritesInput 

type GetSpritesInput struct {

	// Sets color tone for map such as dark and light for specific map styles. It
	// applies to only vector map styles such as Standard and Monochrome.
	//
	// Example: Light
	//
	// Default value: Light
	//
	// Valid values for ColorScheme are case sensitive.
	//
	// This member is required.
	ColorScheme types.ColorScheme

	// Sprites API: The name of the sprite file to retrieve, following pattern
	// sprites(@2x)?\.(png|json) .
	//
	// Example: sprites.png
	//
	// This member is required.
	FileName *string

	// Style specifies the desired map style for the Sprites APIs.
	//
	// This member is required.
	Style types.MapStyle

	// Optimizes map styles for specific use case or industry. You can choose allowed
	// variant only with Standard map style.
	//
	// Example: Default
	//
	// Valid values for Variant are case sensitive.
	//
	// This member is required.
	Variant types.Variant
	// contains filtered or unexported fields
}

type GetSpritesOutput 

type GetSpritesOutput struct {

	// The body of the sprite sheet or JSON offset file (image/png or
	// application/json, depending on input).
	Blob []byte

	// Header that instructs caching configuration for the client.
	CacheControl *string

	// Header that represents the format of the response. The response returns the
	// following as the HTTP body.
	ContentType *string

	// The sprite's Etag.
	ETag *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStaticMapInput 

type GetStaticMapInput struct {

	// The map scaling parameter to size the image, icons, and labels. It follows the
	// pattern of ^map(@2x)?$ .
	//
	// Example: map, map@2x
	//
	// This member is required.
	FileName *string

	// Specifies the height of the map image.
	//
	// This member is required.
	Height *int32

	// Specifies the width of the map image.
	//
	// This member is required.
	Width *int32

	// Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate
	// separated by a comma. The API will generate an image to encompass all of the
	// provided coordinates.
	//
	// Cannot be used with Zoom and or Radius
	//
	// Example: 97.170451,78.039098,99.045536,27.176178
	BoundedPositions *string

	// Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and
	// north-easterly edges of the image. The underlying area becomes the view of the
	// image.
	//
	// Example: -123.17075,49.26959,-123.08125,49.31429
	BoundingBox *string

	// Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of
	// the image. This parameter requires that either zoom or radius is set.
	//
	// Cannot be used with Zoom and or Radius
	//
	// Example: 49.295,-123.108
	Center *string

	// Takes in a string to draw geometries on the image. The input is a comma
	// separated format as follows format: [Lon, Lat]
	//
	// Example:
	// line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog
	// Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B
	//
	// Currently it supports the following geometry types: point, line and polygon. It
	// does not support multiPoint , multiLine and multiPolgyon.
	CompactOverlay *string

	// Takes in a string to draw geometries on the image. The input is a valid GeoJSON
	// collection object.
	//
	// Example: {"type":"FeatureCollection","features":
	// [{"type":"Feature","geometry":{"type":"MultiPoint","coordinates":
	// [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties":
	// {"color":"#00DD00"}}]}
	GeoJsonOverlay *string

	// Optional: The API key to be used for authorization. Either an API key or valid
	// SigV4 signature must be provided when making a request.
	Key *string

	// Applies additional space (in pixels) around overlay feature to prevent them
	// from being cut or obscured.
	//
	// Value for max and min is determined by:
	//
	// Min: 1
	//
	// Max: min(height, width)/4
	//
	// Example: 100
	Padding *int32

	// Used with center parameter, it specifies the zoom of the image where you can
	// control it on a granular level. Takes in any value >= 1 .
	//
	// Example: 1500
	//
	// Cannot be used with Zoom .
	//
	// Unit: Meters
	Radius *int64

	// Displays a scale on the bottom right of the map image with the unit specified
	// in the input.
	//
	// Example: KilometersMiles, Miles, Kilometers, MilesKilometers
	ScaleBarUnit types.ScaleBarUnit

	// Style specifies the desired map style for the Style APIs.
	Style types.StaticMapStyle

	// Specifies the zoom level of the map image.
	//
	// Cannot be used with Radius .
	Zoom *float32
	// contains filtered or unexported fields
}

type GetStaticMapOutput 

type GetStaticMapOutput struct {

	// The pricing bucket for which the request is charged at.
	//
	// This member is required.
	PricingBucket *string

	// The blob represents a map image as a jpeg for the GetStaticMap API.
	Blob []byte

	// Header that instructs caching configuration for the client.
	CacheControl *string

	// Header that represents the format of the response. The response returns the
	// following as the HTTP body.
	ContentType *string

	// The static map's Etag.
	ETag *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStyleDescriptorInput 

type GetStyleDescriptorInput struct {

	// Style specifies the desired map style.
	//
	// This member is required.
	Style types.MapStyle

	// Sets color tone for map such as dark and light for specific map styles. It
	// applies to only vector map styles such as Standard and Monochrome.
	//
	// Example: Light
	//
	// Default value: Light
	//
	// Valid values for ColorScheme are case sensitive.
	ColorScheme types.ColorScheme

	// Optional: The API key to be used for authorization. Either an API key or valid
	// SigV4 signature must be provided when making a request.
	Key *string

	// Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.
	//
	// The following political views are currently supported:
	//
	//   - ARG : Argentina's view on the Southern Patagonian Ice Field and Tierra Del
	//   Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands
	//
	//   - EGY : Egypt's view on Bir Tawil
	//
	//   - IND : India's view on Gilgit-Baltistan
	//
	//   - KEN : Kenya's view on the Ilemi Triangle
	//
	//   - MAR : Morocco's view on Western Sahara
	//
	//   - PAK : Pakistan's view on Jammu and Kashmir and the Junagadh Area
	//
	//   - RUS : Russia's view on Crimea
	//
	//   - SDN : Sudan's view on the Halaib Triangle
	//
	//   - SRB : Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
	//
	//   - SUR : Suriname's view on the Courantyne Headwaters and Lawa Headwaters
	//
	//   - SYR : Syria's view on the Golan Heights
	//
	//   - TUR : Turkey's view on Cyprus and Northern Cyprus
	//
	//   - TZA : Tanzania's view on Lake Malawi
	//
	//   - URY : Uruguay's view on Rincon de Artigas
	//
	//   - VNM : Vietnam's view on the Paracel Islands and Spratly Islands
	PoliticalView *string
	// contains filtered or unexported fields
}

type GetStyleDescriptorOutput 

type GetStyleDescriptorOutput struct {

	// This Blob contains the body of the style descriptor which is in
	// application/json format.
	Blob []byte

	// Header that instructs caching configuration for the client.
	CacheControl *string

	// Header that represents the format of the response. The response returns the
	// following as the HTTP body.
	ContentType *string

	// The style descriptor's Etag.
	ETag *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTileInput 

type GetTileInput struct {

	// Specifies the desired tile set.
	//
	// Valid Values: raster.satellite | vector.basemap
	//
	// This member is required.
	Tileset *string

	// The X axis value for the map tile. Must be between 0 and 19.
	//
	// This member is required.
	X *string

	// The Y axis value for the map tile.
	//
	// This member is required.
	Y *string

	// The zoom value for the map tile.
	//
	// This member is required.
	Z *string

	// Optional: The API key to be used for authorization. Either an API key or valid
	// SigV4 signature must be provided when making a request.
	Key *string
	// contains filtered or unexported fields
}

type GetTileOutput 

type GetTileOutput struct {

	// The pricing bucket for which the request is charged at.
	//
	// This member is required.
	PricingBucket *string

	// The blob represents a vector tile in mvt format for the GetTile API.
	Blob []byte

	// Header that instructs caching configuration for the client.
	CacheControl *string

	// Header that represents the format of the response. The response returns the
	// following as the HTTP body.
	ContentType *string

	// The pricing bucket for which the request is charged at.
	ETag *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.