s3shared

Documentation

Index

• func IsCrossRegion(req *request.Request, otherRegion string) bool
• func IsFIPS(clientRegion string) bool
• type ConfigurationError
  • 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 NewFIPSConfigurationError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError
  • func NewFailedToResolveEndpointError(resource arn.Resource, clientPartitionID, clientRegion string, err error) ConfigurationError
  • func (e ConfigurationError) Code() string
  • func (e ConfigurationError) Error() string
  • func (e ConfigurationError) Message() string
  • func (e ConfigurationError) OrigErr() error
• type InvalidARNError
  • func NewInvalidARNError(resource arn.Resource, err error) InvalidARNError
  • func NewInvalidARNWithCustomEndpointError(resource arn.Resource, err error) InvalidARNError
  • func NewInvalidARNWithFIPSError(resource arn.Resource, err error) InvalidARNError
  • func NewInvalidARNWithUnsupportedPartitionError(resource arn.Resource, err error) InvalidARNError
  • func (e InvalidARNError) Code() string
  • func (e InvalidARNError) Error() string
  • func (e InvalidARNError) Message() string
  • func (e InvalidARNError) OrigErr() error
• type ResourceRequest
  • func (r ResourceRequest) ARN() awsarn.ARN
  • func (r ResourceRequest) AllowCrossRegion() bool
  • func (r ResourceRequest) HasCustomEndpoint() bool
  • func (r ResourceRequest) IsCrossPartition() bool
  • func (r ResourceRequest) IsCrossRegion() bool
  • func (r ResourceRequest) ResourceConfiguredForFIPS() bool
  • func (r ResourceRequest) UseFIPS() bool

Functions

func IsCrossRegion

func IsCrossRegion(req *request.Request, otherRegion string) bool

IsCrossRegion returns true if request signing region is not same as configured region

func IsFIPS

func IsFIPS(clientRegion string) bool

IsFIPS returns true if region is a fips region

Types

type ConfigurationError

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

ConfigurationError is used to denote a client configuration error

func NewClientConfiguredForAccelerateError

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

NewClientConfiguredForAccelerateError denotes client config error for unsupported S3 accelerate

func NewClientConfiguredForCrossRegionFIPSError

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

NewClientConfiguredForCrossRegionFIPSError denotes client config error for unsupported cross region FIPS request

func NewClientConfiguredForDualStackError

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

NewClientConfiguredForDualStackError denotes client config error for unsupported S3 Dual-stack

func NewClientConfiguredForFIPSError

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

NewClientConfiguredForFIPSError denotes client config error for unsupported cross region FIPS access

func NewClientPartitionMismatchError

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

NewClientPartitionMismatchError stub

func NewClientRegionMismatchError

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

NewClientRegionMismatchError denotes cross region access error

func NewFIPSConfigurationError

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 NewFailedToResolveEndpointError

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

NewFailedToResolveEndpointError denotes endpoint resolving error

func (ConfigurationError) Code

func (e ConfigurationError) Code() string

Code returns configuration error's error-code

func (ConfigurationError) Error

func (e ConfigurationError) Error() string

Error returns the Configuration error string

func (ConfigurationError) Message

func (e ConfigurationError) Message() string

Message returns the configuration error message

func (ConfigurationError) OrigErr

func (e ConfigurationError) OrigErr() error

OrigErr is the original error wrapped by Configuration Error

type InvalidARNError

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

InvalidARNError denotes the error for Invalid ARN

func NewInvalidARNError

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

NewInvalidARNError denotes invalid arn error

func NewInvalidARNWithCustomEndpointError

func NewInvalidARNWithCustomEndpointError(resource arn.Resource, err error) InvalidARNError

NewInvalidARNWithCustomEndpointError ARN not supported for custom clients endpoints

func NewInvalidARNWithFIPSError

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

func NewInvalidARNWithUnsupportedPartitionError(resource arn.Resource, err error) InvalidARNError

NewInvalidARNWithUnsupportedPartitionError ARN not supported for the target partition

func (InvalidARNError) Code

func (e InvalidARNError) Code() string

Code returns the invalid ARN error code

func (InvalidARNError) Error

func (e InvalidARNError) Error() string

Error returns the InvalidARNError

func (InvalidARNError) Message

func (e InvalidARNError) Message() string

Message returns the message for Invalid ARN error

func (InvalidARNError) OrigErr

func (e InvalidARNError) OrigErr() error

OrigErr is the original error wrapped by Invalid ARN Error

type ResourceRequest

type ResourceRequest struct {
	Resource arn.Resource
	Request  *request.Request
}

ResourceRequest represents the request and arn resource

func (ResourceRequest) ARN

func (r ResourceRequest) ARN() awsarn.ARN

ARN returns the resource ARN

func (ResourceRequest) AllowCrossRegion

func (r ResourceRequest) AllowCrossRegion() bool

AllowCrossRegion returns a bool value to denote if S3UseARNRegion flag is set

func (ResourceRequest) HasCustomEndpoint

func (r ResourceRequest) HasCustomEndpoint() bool

HasCustomEndpoint returns true if custom client endpoint is provided

func (ResourceRequest) IsCrossPartition

func (r ResourceRequest) IsCrossPartition() bool

IsCrossPartition returns true if client is configured for another partition, than the partition that resource ARN region resolves to.

func (ResourceRequest) IsCrossRegion

func (r ResourceRequest) IsCrossRegion() bool

IsCrossRegion returns true if ARN region is different than client configured region

func (ResourceRequest) ResourceConfiguredForFIPS

func (r ResourceRequest) ResourceConfiguredForFIPS() bool

ResourceConfiguredForFIPS returns true if resource ARNs region is FIPS

Deprecated: FIPS pseudo-regions will not be in the ARN

func (ResourceRequest) UseFIPS

func (r ResourceRequest) UseFIPS() bool

UseFIPS returns true if request config region is FIPS