package presignedurl

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

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	      context.go
	   #d doc.go
		Package presignedurl provides the customizations for API clients to fill in
		presigned URLs into input parameters.

	      go_module_metadata.go
	      middleware.go
Package-Level Type Names (total 6, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Options (struct)
		Options provides the set of options needed by the presigned URL middleware.

		Fields (total 2, both are exported)
			Accessor ParameterAccessor
				Accessor are the parameter accessors used by this middleware

			Presigner URLPresigner
				Presigner is the URLPresigner used by the middleware

		As Inputs Of (at least one exported)
			func AddMiddleware(stack *middleware.Stack, opts Options) error

	 type ParameterAccessor (struct)
		ParameterAccessor provides an collection of accessor to for retrieving and
		setting the values needed to PresignedURL generation

		Fields (total 5, all are exported)
			CopyInput func(interface{}) (interface{}, error)
				CopyInput accessor points to a function that takes in an input, and returns a copy.

			GetPresignedURL func(interface{}) (string, bool, error)
				GetPresignedURL accessor points to a function that retrieves a presigned url if present

			GetSourceRegion func(interface{}) (string, bool, error)
				GetSourceRegion accessor points to a function that retrieves source region for presigned url

			SetDestinationRegion func(interface{}, string) error
				SetDestinationRegion accessor points to a function that sets destination region on api input struct

			SetPresignedURL func(interface{}, string) error
				SetPresignedURL accessor points to a function that sets presigned url on api input struct


	 type URLPresigner (interface)
		URLPresigner provides the interface to presign the input parameters in to a
		presigned URL.

		Methods (only one, which is exported)
			( URLPresigner) PresignURL(ctx context.Context, srcRegion string, params interface{}) (*v4.PresignedHTTPRequest, error)
				PresignURL presigns a URL.


	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type asIsPresigningMiddleware (struct)

		Methods (total 2, both are exported)
			( asIsPresigningMiddleware) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (out middleware.InitializeOutput, metadata middleware.Metadata, err error)
			( asIsPresigningMiddleware) ID() string
		Implements (at least 2, in which 1 are exported)
			 asIsPresigningMiddleware : github.com/aws/smithy-go/middleware.InitializeMiddleware
			/* at least one unexported ... *//* at least one unexported: */
			 asIsPresigningMiddleware : github.com/aws/smithy-go/middleware.ider

	 type isPresigningKey (struct)
	 type presign (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			options Options
		Methods (total 2, both are exported)
			(*presign) HandleInitialize(ctx context.Context, input middleware.InitializeInput, next middleware.InitializeHandler) (out middleware.InitializeOutput, metadata middleware.Metadata, err error)
			(*presign) ID() string
		Implements (at least 2, in which 1 are exported)
			*presign : github.com/aws/smithy-go/middleware.InitializeMiddleware
			/* at least one unexported ... *//* at least one unexported: */
			*presign : github.com/aws/smithy-go/middleware.ider


Package-Level Functions (total 5, all are exported)

	 func AddAsIsPresigingMiddleware(stack *middleware.Stack) error
		AddAsIsPresigingMiddleware adds a middleware to the head of the stack that
		will update the stack's context to be flagged as being invoked for the
		purpose of presigning.

	 func AddMiddleware(stack *middleware.Stack, opts Options) error
		AddMiddleware adds the Presign URL middleware to the middleware stack.

	 func GetIsPresigning(ctx context.Context) bool
		GetIsPresigning returns if the context contains the isPresigning sentinel
		value for presigning flows.

		Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues
		to clear all stack values.

	 func RemoveMiddleware(stack *middleware.Stack) error
		RemoveMiddleware removes the Presign URL middleware from the stack.

	 func WithIsPresigning(ctx context.Context) context.Context
		WithIsPresigning adds the isPresigning sentinel value to a context to signal
		that the middleware stack is using the presign flow.

		Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues
		to clear all stack values.


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

	/* one unexported ... *//* one unexported: */
	const goModuleVersion = "1.9.23"
		goModuleVersion is the tagged release for this module

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