Package: github.com/aws/aws-sdk-go-v2/service/internal/s3shared

package s3shared Import Path github.com/aws/aws-sdk-go-v2/service/internal/s3shared (on go.dev) Dependency Relation imports 13 packages, and imported by 2 packages

Involved Source Files arn_lookup.go endpoint_error.go go_module_metadata.go host_id.go metadata.go metadata_retriever.go resource_request.go response_error.go response_error_middleware.go update_endpoint.go xml_utils.go

Package-Level Type Names (total 13, in which 8 are exported)

/* sort exporteds by: alphabet | popularity */

type ARNLookup (struct) ARNLookup is the initial middleware that looks up if an arn is provided. This middleware is responsible for fetching ARN from a arnable field, and registering the ARN on middleware context. This middleware must be executed before input validation step or any other arn processing middleware. Fields (only one, which is exported) GetARNValue func(interface{}) (*string, bool) GetARNValue takes in a input interface and returns a ptr to string and a bool Methods (total 2, both are exported) (*ARNLookup) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (out middleware.InitializeOutput, metadata middleware.Metadata, err error) HandleInitialize handles the behavior of this initialize step (*ARNLookup) ID() string ID for the middleware Implements (at least 2, in which 1 are exported) *ARNLookup : github.com/aws/smithy-go/middleware.InitializeMiddleware /* at least one unexported ... *//* at least one unexported: */ *ARNLookup : github.com/aws/smithy-go/middleware.ider

type ConfigurationError (struct) ConfigurationError is used to denote a client configuration error Fields (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ clientPartitionID string clientRegion string message string origErr error resource arn.Resource Methods (total 2, both are exported) ( ConfigurationError) Error() string Error returns the Configuration error string ( ConfigurationError) Unwrap() error OrigErr is the original error wrapped by Configuration Error Implements (at least one exported) ConfigurationError : error As Outputs Of (at least 8, all are exported) func NewClientConfiguredForAccelerateError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError func NewClientConfiguredForCrossRegionFIPSError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError func NewClientConfiguredForDualStackError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError func NewClientConfiguredForFIPSError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError func NewClientPartitionMismatchError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError func NewClientRegionMismatchError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError func NewFailedToResolveEndpointError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError func NewFIPSConfigurationError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError

type EnableDualstack (struct) EnableDualstack represents middleware struct for enabling dualstack support Deprecated: See EndpointResolverOptions' UseDualStackEndpoint support Fields (total 2, both are exported) DefaultServiceID string DefaultServiceID is the service id prefix used in endpoint resolving by default service-id is 's3' and 's3-control' for service s3, s3control. UseDualstack bool UseDualstack indicates if dualstack endpoint resolving is to be enabled Methods (total 2, both are exported) (*EnableDualstack) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (out middleware.SerializeOutput, metadata middleware.Metadata, err error) HandleSerialize handles serializer middleware behavior when middleware is executed (*EnableDualstack) ID() string ID returns the middleware ID. Implements (at least 2, in which 1 are exported) *EnableDualstack : github.com/aws/smithy-go/middleware.SerializeMiddleware /* at least one unexported ... *//* at least one unexported: */ *EnableDualstack : github.com/aws/smithy-go/middleware.ider

type ErrorComponents (struct) ErrorComponents represents the error response fields that will be deserialized from an xml error response body Fields (total 4, all are exported) Code string HostID string Message string RequestID string As Outputs Of (at least 3, all are exported) func GetErrorResponseComponents(r io.Reader, options ErrorResponseDeserializerOptions) (ErrorComponents, error) func GetUnwrappedErrorResponseComponents(r io.Reader) (ErrorComponents, error) func GetWrappedErrorResponseComponents(r io.Reader) (ErrorComponents, error)

type ErrorResponseDeserializerOptions (struct) ErrorResponseDeserializerOptions represents error response deserializer options for s3 and s3-control service Fields (total 3, all are exported) IsWrappedWithErrorTag bool IsWrappedWithErrorTag represents if error response's code, msg is wrapped within an additional <Error> tag StatusCode int StatusCode is status code of error response UseStatusCode bool UseStatusCode denotes if status code should be used to retrieve error code, msg As Inputs Of (at least one exported) func GetErrorResponseComponents(r io.Reader, options ErrorResponseDeserializerOptions) (ErrorComponents, error)

type InvalidARNError (struct) InvalidARNError denotes the error for Invalid ARN Fields (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ message string origErr error resource arn.Resource Methods (total 2, both are exported) ( InvalidARNError) Error() string Error returns the InvalidARN error string ( InvalidARNError) Unwrap() error OrigErr is the original error wrapped by Invalid ARN Error Implements (at least one exported) InvalidARNError : error As Outputs Of (at least 3, all are exported) func NewInvalidARNError(resource arn.Resource, err error) InvalidARNError func NewInvalidARNWithFIPSError(resource arn.Resource, err error) InvalidARNError func NewInvalidARNWithUnsupportedPartitionError(resource arn.Resource, err error) InvalidARNError

type ResourceRequest (struct) ResourceRequest represents an ARN resource and api request metadata Fields (total 6, all are exported) PartitionID string PartitionID is the resolved partition id for the provided request region RequestRegion string RequestRegion is the region configured on the request config Resource arn.Resource SigningRegion string SigningRegion is the signing region resolved for the request UseARNRegion bool UseARNRegion indicates if client should use the region provided in an ARN resource UseFIPS bool UseFIPS indicates if te client is configured for FIPS Methods (total 5, all are exported) ( ResourceRequest) ARN() awsarn.ARN ARN returns the resource ARN ( ResourceRequest) AllowCrossRegion() bool AllowCrossRegion returns a bool value to denote if S3UseARNRegion flag is set ( ResourceRequest) IsCrossPartition() (bool, error) IsCrossPartition returns true if request is configured for region of another partition, than the partition that resource ARN region resolves to. IsCrossPartition will not return an error, if request is not configured with a specific partition id. This might happen if customer provides custom endpoint url, but does not associate a partition id with it. ( ResourceRequest) IsCrossRegion() bool IsCrossRegion returns true if request signing region is not same as arn region ( ResourceRequest) ResourceConfiguredForFIPS() bool ResourceConfiguredForFIPS returns true if resource ARNs region is FIPS Deprecated: FIPS will not be present in the ARN region 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.validateRegionForResourceRequest(resourceRequest ResourceRequest) error

type ResponseError (struct) ResponseError provides the HTTP centric error type wrapping the underlying error with the HTTP response value and the deserialized RequestID. Fields (total 5, all are exported) HostID string HostID associated with response error ResponseError *awshttp.ResponseError ResponseError.RequestID string RequestID associated with response error ResponseError.ResponseError.Err error ResponseError.ResponseError.Response *http.Response Methods (total 7, all are exported) (*ResponseError) As(target interface{}) bool As populates target and returns true if the type of target is a error type that the ResponseError embeds, (e.g.S3 HTTP ResponseError) (*ResponseError) Error() string Error returns the formatted error ( ResponseError) HTTPResponse() *http.Response HTTPResponse returns the HTTP response received from the service. ( ResponseError) HTTPStatusCode() int HTTPStatusCode returns the HTTP response status code received from the service. (*ResponseError) ServiceHostID() string ServiceHostID returns the host id associated with Response Error ( ResponseError) ServiceRequestID() string ServiceRequestID returns the request id associated with Response Error ( ResponseError) Unwrap() error Unwrap returns the nested error if any, or nil. Implements (at least 2, both are exported) *ResponseError : github.com/aws/aws-sdk-go-v2/service/s3.ResponseError *ResponseError : error

/* 5 unexporteds ... *//* 5 unexporteds: */

type arnResourceKey (struct) arnResourceKey is the key set on context used to identify, retrive an ARN resource if present on the context.

type clonedInputKey (struct) clonedInputKey used to denote if request input was cloned.

type errorWrapper (struct) Methods (total 2, both are exported) (*errorWrapper) HandleDeserialize(ctx context.Context, in middleware.DeserializeInput, next middleware.DeserializeHandler) (out middleware.DeserializeOutput, metadata middleware.Metadata, err error) (*errorWrapper) ID() string ID returns the middleware identifier Implements (at least 2, in which 1 are exported) *errorWrapper : github.com/aws/smithy-go/middleware.DeserializeMiddleware /* at least one unexported ... *//* at least one unexported: */ *errorWrapper : github.com/aws/smithy-go/middleware.ider

type hostID (struct) hostID is used to retrieve host id from response metadata

type metadataRetriever (struct) Methods (total 2, both are exported) (*metadataRetriever) HandleDeserialize(ctx context.Context, in middleware.DeserializeInput, next middleware.DeserializeHandler) (out middleware.DeserializeOutput, metadata middleware.Metadata, err error) (*metadataRetriever) ID() string ID returns the middleware identifier Implements (at least 2, in which 1 are exported) *metadataRetriever : github.com/aws/smithy-go/middleware.DeserializeMiddleware /* at least one unexported ... *//* at least one unexported: */ *metadataRetriever : github.com/aws/smithy-go/middleware.ider

Package-Level Functions (total 23, in which 22 are exported)

func AddMetadataRetrieverMiddleware(stack *middleware.Stack) error AddMetadataRetrieverMiddleware adds request id, host id retriever middleware

func AddResponseErrorMiddleware(stack *middleware.Stack) error AddResponseErrorMiddleware adds response error wrapper middleware

func GetARNResourceFromContext(ctx context.Context) (arn.ARN, bool) GetARNResourceFromContext returns an ARN from context and a bool indicating presence of ARN on ctx. Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func GetErrorResponseComponents(r io.Reader, options ErrorResponseDeserializerOptions) (ErrorComponents, error) GetErrorResponseComponents retrieves error components according to passed in options

func GetHostIDMetadata(metadata middleware.Metadata) (string, bool) GetHostIDMetadata retrieves the host id from middleware metadata returns host id as string along with a boolean indicating presence of hostId on middleware metadata.

func GetUnwrappedErrorResponseComponents(r io.Reader) (ErrorComponents, error) GetUnwrappedErrorResponseComponents returns the error fields from an xml error response body

func GetWrappedErrorResponseComponents(r io.Reader) (ErrorComponents, error) GetWrappedErrorResponseComponents returns the error fields from an xml error response body in which error code, and message are wrapped by a <Error> tag

func IsClonedInput(ctx context.Context) bool IsClonedInput retrieves if context key for cloned input was set. If set, we can infer that the reuqest input was cloned previously. Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func IsFIPS(region string) bool IsFIPS returns true if region is a fips pseudo-region Deprecated: FIPS should be specified via EndpointOptions.

func NewClientConfiguredForAccelerateError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewClientConfiguredForAccelerateError denotes client config error for unsupported S3 accelerate

func NewClientConfiguredForCrossRegionFIPSError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewClientConfiguredForCrossRegionFIPSError denotes client config error for unsupported cross region FIPS request

func NewClientConfiguredForDualStackError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewClientConfiguredForDualStackError denotes client config error for unsupported S3 Dual-stack

func NewClientConfiguredForFIPSError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewClientConfiguredForFIPSError denotes client config error for unsupported cross region FIPS access

func NewClientPartitionMismatchError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewClientPartitionMismatchError stub

func NewClientRegionMismatchError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewClientRegionMismatchError denotes cross region access error

func NewFailedToResolveEndpointError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewFailedToResolveEndpointError denotes endpoint resolving error

func NewFIPSConfigurationError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError NewFIPSConfigurationError denotes a configuration error when a client or request is configured for FIPS

func NewInvalidARNError(resource arn.Resource, err error) InvalidARNError NewInvalidARNError denotes invalid arn error

func NewInvalidARNWithFIPSError(resource arn.Resource, err error) InvalidARNError NewInvalidARNWithFIPSError ARN not supported for FIPS region Deprecated: FIPS will not appear in the ARN region component.

func NewInvalidARNWithUnsupportedPartitionError(resource arn.Resource, err error) InvalidARNError NewInvalidARNWithUnsupportedPartitionError ARN not supported for the target partition

func SetClonedInputKey(ctx context.Context, value bool) context.Context SetClonedInputKey sets a key on context to denote input was cloned previously. Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func SetHostIDMetadata(metadata *middleware.Metadata, id string) SetHostIDMetadata sets the provided host id over middleware metadata

/* one unexported ... *//* one unexported: */

func setARNResourceOnContext(ctx context.Context, value arn.ARN) context.Context SetARNResourceOnContext sets the S3 ARN on the context. Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

Package-Level Constants (total 4, none are exported) /* 4 unexporteds ... *//* 4 unexporteds: */

const configurationErrorErrCode = "ConfigurationError"

const goModuleVersion = "1.13.23" goModuleVersion is the tagged release for this module

const invalidARNErrorErrCode = "InvalidARNError"

const metadataRetrieverID = "S3MetadataRetriever"